Skip to content

Commit e54cbb5

Browse files
authored
Add table for input ports in condition nodes (#647)
Signed-off-by: Maurice-1235 <[email protected]>
1 parent f6a11d8 commit e54cbb5

File tree

4 files changed

+72
-2
lines changed

4 files changed

+72
-2
lines changed

configuration/packages/bt-plugins/conditions/InitialPoseReceived.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ Input Ports
1010

1111
:initial_pose_received:
1212

13-
===== ========================
14-
Type Default
13+
===== =========================
14+
Type Default
1515
----- -------------------------
1616
bool "{initial_pose_received}"
1717
===== =========================

configuration/packages/bt-plugins/conditions/IsBatteryCharging.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,19 @@ IsBatteryCharging
66
Checks if the battery is charging by subscribing to a ``sensor_msgs/BatteryState`` topic and checking if the power_supply_status is ``POWER_SUPPLY_STATUS_CHARGING``.
77
Returns SUCCESS in that case, FAILURE otherwise.
88

9+
Input Ports
10+
-----------
11+
12+
:battery_topic:
13+
=============== ===================
14+
Type Default
15+
--------------- -------------------
16+
string "/battery_status"
17+
=============== ===================
18+
19+
Description
20+
Topic for battery info.
21+
922
Example
1023
-------
1124

configuration/packages/bt-plugins/conditions/IsBatteryLow.rst

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,39 @@ Checks if battery is low by subscribing to a ``sensor_msgs/BatteryState`` topic
77
By default percentage (in range 0 to 1) is used to check for low battery. Set the ``is_voltage`` parameter to `true` to use voltage.
88
Returns SUCCESS when battery percentage/voltage is lower than the specified value, FAILURE otherwise.
99

10+
Input Ports
11+
-----------
12+
13+
:min_battery:
14+
====== =======
15+
Type Default
16+
------ -------
17+
double 0.0
18+
====== =======
19+
20+
Description
21+
Min battery percentage or voltage before triggering.
22+
23+
:battery_topic:
24+
=============== ===================
25+
Type Default
26+
--------------- -------------------
27+
string "/battery_status"
28+
=============== ===================
29+
30+
Description
31+
Topic for battery info.
32+
33+
:is_voltage:
34+
====== =======
35+
Type Default
36+
------ -------
37+
bool false
38+
====== =======
39+
40+
Description
41+
If true voltage will be used to check for low battery.
42+
1043
Example
1144
-------
1245

configuration/packages/bt-plugins/conditions/PathExpiringTimer.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,30 @@ PathExpiringTimer
66
Checks if the timer has expired. Returns success if the timer has expired, otherwise it returns failure.
77
The timer will reset if the path gets updated.
88

9+
Input Ports
10+
-----------
11+
12+
:seconds:
13+
====== =======
14+
Type Default
15+
------ -------
16+
double 1.0
17+
====== =======
18+
19+
Description
20+
Time to check if expired.
21+
22+
:path:
23+
==================================== =======
24+
Type Default
25+
------------------------------------ -------
26+
nav_msgs::msg::Path N/A
27+
==================================== =======
28+
29+
Description
30+
Check if path has been updated to enable timer reset.
31+
32+
933
Example
1034
-------
1135

0 commit comments

Comments
 (0)