diff --git a/config/README.md b/config/README.md index 9d7354f..8b3ee68 100644 --- a/config/README.md +++ b/config/README.md @@ -10,29 +10,30 @@ The SD card used on the RP2040 Rust Robot is used to store configuration, path f The `config.ini` file contains the configuration for the robot. The file is in the INI format and contains the following sections and key/values: ### `[STRAIGHT_MOTION]` This section contains the configuration for straight motion calculations -| Key | Type | Description | -|+-+|+-+|+--| -| `straight_left_power` | float | The power to apply to the left motor when moving straight. The value is a float between 0 and 1. | + +| Key | Type | Description | +| :--------------------: | :---: | :------------------------------------------------------------------------------------------------ | +| `straight_left_power` | float | The power to apply to the left motor when moving straight. The value is a float between 0 and 1. | | `straight_right_power` | float | The power to apply to the right motor when moving straight. The value is a float between 0 and 1. | -| `straight_pid_p` | float | The proportional gain for the straight motion PID controller. The value is a float. | -| `straight_pid_i` | float | The integral gain for the straight motion PID controller. The value is a float. | -| `straight_pid_d` | float | The derivative gain for the straight motion PID controller. The value is a float. | +| `straight_pid_p` | float | The proportional gain for the straight motion PID controller. The value is a float. | +| `straight_pid_i` | float | The integral gain for the straight motion PID controller. The value is a float. | +| `straight_pid_d` | float | The derivative gain for the straight motion PID controller. The value is a float. | ### `[TURN_MOTION]` This section contains the configuration for turn motion calculations -| Key | Type | Description | -|+-+|+-+|+--| -| `turn_left_left_power` | float | The power to apply to the left motor when turning left. The value is a float between 0 and 1. | -| `turn_left_right_power` | float | The power to apply to the right motor when turning left. The value is a float between 0 and 1. | -| `turn_right_left_power` | float | The power to apply to the left motor when turning right. The value is a float between 0 and 1. | -| `turn_right_right_power` | float | The power to apply to the right motor when turning right. The value is a float between 0 and 1. | -| `turn_left_stop_angle_delta` | float | The angle delta to stop turning left. The value is a float. Negative values indicate motors will be stopped before the target angle is reached, positive values indicate motors will be stopped after the target angle is reached. | +| Key | Type | Description | +| :---------------------------: | :---: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `turn_left_left_power` | float | The power to apply to the left motor when turning left. The value is a float between 0 and 1. | +| `turn_left_right_power` | float | The power to apply to the right motor when turning left. The value is a float between 0 and 1. | +| `turn_right_left_power` | float | The power to apply to the left motor when turning right. The value is a float between 0 and 1. | +| `turn_right_right_power` | float | The power to apply to the right motor when turning right. The value is a float between 0 and 1. | +| `turn_left_stop_angle_delta` | float | The angle delta to stop turning left. The value is a float. Negative values indicate motors will be stopped before the target angle is reached, positive values indicate motors will be stopped after the target angle is reached. | | `turn_right_stop_angle_delta` | float | The angle delta to stop turning right. The value is a float. Negative values indicate motors will be stopped before the target angle is reached, positive values indicate motors will be stopped after the target angle is reached. | ### `[GENERAL]` This section contains general configuration for the robot -| Key | Type | Description | -|+-+|+-+|+--| -| `wheel_ticks_per_mm` | float | The number of encoder ticks per millimeter of wheel travel. The value is an float. | -| `idle_message` | string | The message to display on the LCD display when the robot is idle. The value is a string. | +| Key | Type | Description | +| :------------------: | :----: | :--------------------------------------------------------------------------------------- | +| `wheel_ticks_per_mm` | float | The number of encoder ticks per millimeter of wheel travel. The value is an float. | +| `idle_message` | string | The message to display on the LCD display when the robot is idle. The value is a string. |