The sphinx_ros_example package.

The sphinx_ros_example package contains all sorts of ROS objects, purely for example purposes. Objects can be referenced just like the familiar default Sphinx references, e.g. sphinx_ros_example/Foo will link the proper message, and sphinx_ros_example/Bar will link to the proper service. We can also use the ~ to prevent displaying the package name, e.g. Foo still points to the right message.

Author:

J. Doe
Maintainer:

J. Doe
Links:
Version:

1.2
License:

MIT

Dependencies

Build:
  • message_generation
  • std_msgs
Build export:

std_msgs
Build tool:

catkin
Execution:
  • message_runtime
  • std_msgs

Messages

message sphinx_ros_example/Foo
Parameters:
  • header (Header) – Header of the message.
  • pose (geometry_msgs/Pose) – The 3D pose of the foo that is detected.
  • color (string) – The color of the foo.

Services

service sphinx_ros_example/Bar
Request parameters:
 

one_way (sphinx_ros_example/Foo) – The request parameter.
Response parameters:
 
  • or_another (int8) – The response parameter.
  • highway (uint16) – The correct way.

Actions

action sphinx_ros_example/FooBar
Goal parameters:
 

setpoint (geometry_msgs/Point) – The setpoint to reach.
Result parameters:
 

steady_state_error (geometry_msgs/Point) – Error between achieved point and setpoint.
Feedback parameters:
 
  • tracking_error (geometry_msgs/Point) – Error between ideal trajectory and current trajectory.
  • power (float32[]) – Current power usage per joint.