Skip to content

Commit 7fbfb62

Browse files
committed
Update firmware parameters
1 parent d3ea021 commit 7fbfb62

1 file changed

Lines changed: 41 additions & 17 deletions

File tree

docs/leo-rover/documentation/ros-api.mdx

Lines changed: 41 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -283,59 +283,83 @@ documented in [picamera2 documentation (Appendix C)].
283283

284284
:::info
285285

286-
The parameters for `/firmware` node can be overridden by modifying the
287-
`/etc/ros/firmware_overrides.yaml` file.
286+
The parameters for the `firmware` node are not meant to be changed directly by
287+
the users. Instead, the `firmware_parameter_bridge` node provides a set of
288+
parameters duplicating the firmware parameters, and setting those will update
289+
the firmware parameters accordingly.
288290

289291
:::
290292

291-
- `wheels/encoder_resolution` (type: `float`, default: `878.4`)
293+
- `wheels.encoder_resolution` (type: `float`, default: `878.4`)
292294

293295
The resolution of the wheel encoder in counts per rotation.
294296

295-
- `wheels/torque_constant` (type: `float`, default: `1.17647`)
297+
- `wheels.torque_constant` (type: `float`, default: `1.17647`)
296298

297299
The torque (in newton-meters) produced by the wheel per 1 Ampere of winding
298300
current.
299301

300-
- `wheels/pid/p` (type: `float`, default: `0.0`)
302+
- `wheels.pid.kp` (type: `float`, default: `2.64`)
301303

302-
The P constant of the PID regulator.
304+
The proportional gain of the PID regulator.
303305

304-
- `wheels/pid/i` (type: `float`, default: `0.005`)
306+
- `wheels.pid.ki` (type: `float`, default: `42.24`)
305307

306-
The I constant of the PID regulator.
308+
The integral gain of the PID regulator.
307309

308-
- `wheels/pid/d` (type: `float`, default: `0.0`)
310+
- `wheels.pid.kd` (type: `float`, default: `0.11`)
309311

310-
The D constant of the PID regulator.
312+
The derivative gain of the PID regulator.
311313

312-
- `wheels/pwm_duty_limit` (type: `float`, default: `100.0`)
314+
- `wheels.max_voltage` (type: `float`, default: `26.0`)
313315

314-
The limit of the PWM duty applied to the motor in percent.
316+
Maximum voltage (in Volts) that can be applied to the wheels. If the battery
317+
voltage is above this value, the controller will scale down the PWM duty cycle
318+
to avoid applying voltage higher than this to the wheels.
315319

316-
- `controller/wheel_radius` (type: `float`, default: `0.0625`)
320+
- `controller.wheel_radius` (type: `float`, default: `0.0625`)
317321

318322
The radius of the wheel in meters.
319323

320-
- `controller/wheel_separation` (type: `float`, default: `0.358`)
324+
- `controller.wheel_separation` (type: `float`, default: `0.358`)
321325

322326
The distance (in meters) between the centers of the left and right wheels.
323327

324-
- `controller/wheel_base` (type: `float`, default: `0.3052`)
328+
- `controller.wheel_base` (type: `float`, default: `0.3052`)
325329

326330
The distance (in meters) between the centers of the rear and front wheels.
327331

328-
- `controller/angular_velocity_multiplier` (type: `float`, default: `1.76`)
332+
- `controller.angular_velocity_multiplier` (type: `float`, default: `1.76`)
329333

330334
The angular velocity in `cmd_vel` command is multiplied by this parameter and
331335
the calculated odometry has its angular velocity divided by this parameter.
332336

333-
- `controller/input_timeout` (type: `int`, default: `500`)
337+
- `controller.input_timeout` (type: `int`, default: `500`)
334338

335339
The timeout (in milliseconds) for the `cmd_vel` commands. The controller will
336340
be disabled if it does not receive a command within the specified time. If set
337341
to 0, the timeout is disabled.
338342

343+
- `controller.linear_acceleration` (type: `float`, default: `0.5`)
344+
345+
The linear acceleration (in $\frac{m}{s^2}$) applied to the robot when
346+
accelerating.
347+
348+
- `controller.linear_deceleration` (type: `float`, default: `2.0`)
349+
350+
The linear deceleration (in $\frac{m}{s^2}$) applied to the robot when
351+
decelerating (when the absolute linear velocity is decreasing).
352+
353+
- `controller.angular_acceleration` (type: `float`, default: `1.0`)
354+
355+
The angular acceleration (in $\frac{rad}{s^2}$) applied to the robot when
356+
accelerating.
357+
358+
- `controller.angular_deceleration` (type: `float`, default: `4.0`)
359+
360+
The angular deceleration (in $\frac{rad}{s^2}$) applied to the robot when
361+
decelerating (when the absolute angular velocity is decreasing).
362+
339363
- `battery_min_voltage` (type: `float`, default: `10.0`)
340364

341365
The voltage (in Volts) below which the battery is considered low. If the

0 commit comments

Comments
 (0)