Skip to content

Commit ae865a9

Browse files
author
Felix Exner
authored
Merge pull request #156 from UniversalRobots/ros_documentation
Use section commands for each individual topic/service/parameter url
2 parents fcc4ae3 + a7d2783 commit ae865a9

File tree

4 files changed

+504
-498
lines changed

4 files changed

+504
-498
lines changed

controller_stopper/README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
11
# controller_stopper
22

3-
A small helper node that stops and restarts ROS controllers based on a boolean status topic.
4-
5-
When the status goes to `false`, all running controllers except a set of predefined
6-
*consistent_controllers* get stopped. If status returns to `true` the stopped controllers are
7-
restarted.
3+
A small helper node that stops and restarts ROS controllers based on a boolean status topic. When the status goes to `false`, all running controllers except a set of predefined *consistent_controllers* get stopped. If status returns to `true` the stopped controllers are restarted.
84

95
## Nodes
6+
107
### controller_stopper_node
118

129

1310

1411
#### Parameters
15-
* **"consistent_controllers (list of strings)"**
1612

17-
Consistent controllers will not be stopped when the robot stops. Defaults to ["joint_state_controller"]
13+
##### consistent_controllers (default: ["joint_state_controller"])
14+
15+
Consistent controllers will not be stopped when the robot stops. Defaults to ["joint_state_controller"]
1816

1917
#### Service Clients
20-
* **"controller_manager/list_controllers"** ([controller_manager_msgs::ListControllers](http://docs.ros.org/api/controller_manager_msgs/html/srv/ListControllers.html))
2118

22-
Controller manager service to list controllers
19+
##### controller_manager/list_controllers ([controller_manager_msgs/ListControllers](http://docs.ros.org/api/controller_manager_msgs/html/srv/ListControllers.html))
2320

24-
* **"controller_manager/switch_controller"** ([controller_manager_msgs::SwitchController](http://docs.ros.org/api/controller_manager_msgs/html/srv/SwitchController.html))
21+
Controller manager service to list controllers
2522

26-
Controller manager service to switch controllers
23+
##### controller_manager/switch_controller ([controller_manager_msgs/SwitchController](http://docs.ros.org/api/controller_manager_msgs/html/srv/SwitchController.html))
24+
25+
Controller manager service to switch controllers
2726

2827
#### Subscribed topics
29-
* **"robot_running"** ([std_msgs::Bool](http://docs.ros.org/api/std_msgs/html/msg/Bool.html))
3028

31-
Subscribes to a robot's running state topic. Ideally this topic is latched and only publishes on changes. However, this node only reacts on state changes, so a state published each cycle would also be fine.
29+
##### robot_running ([std_msgs/Bool](http://docs.ros.org/api/std_msgs/html/msg/Bool.html))
30+
31+
Subscribes to a robot's running state topic. Ideally this topic is latched and only publishes on changes. However, this node only reacts on state changes, so a state published each cycle would also be fine.
3232

0 commit comments

Comments
 (0)