Skip to content

Commit 924c228

Browse files
author
Yara Shahin
committed
add migration guide for ip320 users
1 parent 8dc3c32 commit 924c228

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

battery_state_broadcaster/doc/userdoc.rst

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,3 +86,40 @@ An example parameter file for this controller is available in the `test director
8686

8787
.. literalinclude:: ../test/battery_state_broadcaster_params.yaml
8888
:language: yaml
89+
90+
Migration for ``ipa320/ros_battery_monitoring`` users
91+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
92+
93+
If you were previously using the ``battery_state_broadcaster`` from the ``ipa320/ros_battery_monitoring package``, you can switch directly to this package. The configuration style using ``sensor_name`` is still supported for backward compatibility, but it may be removed in a future release.
94+
95+
To adapt your setup to the new ``battery_state_broadcaster`` configuration:
96+
97+
1. Update your hardware interface name from ``voltage`` → ``battery_voltage``.
98+
99+
2. Convert your controller parameters from
100+
101+
.. code-block:: yaml
102+
103+
battery_state_broadcaster:
104+
ros__parameters:
105+
sensor_name: "battery_state"
106+
design_capacity: 100.0
107+
# https://github.com/ros2/common_interfaces/blob/rolling/sensor_msgs/msg/BatteryState.msg
108+
power_supply_technology: 2
109+
110+
to:
111+
112+
.. code-block:: yaml
113+
114+
battery_state_broadcaster:
115+
ros__parameters:
116+
state_joints: ["battery_state"]
117+
battery_state:
118+
design_capacity: 100.0
119+
power_supply_technology: 2
120+
121+
**Notes**:
122+
123+
- Parameters must provide **either** sensor_name **or** state_joints.
124+
- If both are empty → the broadcaster will fail to configure.
125+
- If both are set → the broadcaster will throw an error.

0 commit comments

Comments
 (0)