Skip to content

Commit f50cfc9

Browse files
bjsowaCopilot
andauthored
Apply suggestions from code review
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
1 parent a6a0cc8 commit f50cfc9

1 file changed

Lines changed: 8 additions & 7 deletions

File tree

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

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -213,8 +213,8 @@ the system can be overridden in the `/etc/ros/parameter_overrides.yaml` file.
213213
Check the file for more details and examples.
214214

215215
The parameters not marked as `read-only` can also be changed at runtime using
216-
command line tools such as `ros2 param set` or graphical tools like
217-
`rqt_reconfigure`.
216+
command line tools such as `ros2 param set` or graphical tools like `rqt` with
217+
the `rqt_reconfigure` plugin (run `rqt -s rqt_reconfigure`).
218218

219219
:::
220220

@@ -284,9 +284,9 @@ documented in [picamera2 documentation (Appendix C)].
284284
:::info
285285

286286
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.
287+
users. Instead, set the corresponding parameters on the
288+
`firmware_parameter_bridge` node (it mirrors the firmware parameters and
289+
forwards updates to `firmware`).
290290

291291
:::
292292

@@ -336,8 +336,9 @@ A $K_p$ of 10.0 would contribute 2.0 $V$ to the output voltage, a $K_i$ of 50.0
336336
would contribute 10.0 $V$ per second of sustained error.
337337

338338
The firmware employs anti-windup measures to prevent the integral term from
339-
accumulating excessively when the output voltage is saturated at the battery
340-
voltage.
339+
accumulating excessively when the output voltage is saturated at the maximum
340+
available/applied voltage (e.g. limited by battery voltage and/or
341+
`wheels.max_voltage`).
341342

342343
:::
343344

0 commit comments

Comments
 (0)