Skip to content

Commit 72f3e0d

Browse files
committed
update documentation
1 parent bdfdad5 commit 72f3e0d

File tree

2 files changed

+20
-6
lines changed

2 files changed

+20
-6
lines changed

flowstate/aic_flowstate_ros_bridge/README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,25 @@ export INTRINSIC_CLUSTER="vmp-xxxx-xxxxxxx"
3939
```
4040

4141
<!-- todo(johntgz) documentation -->
42-
## Interfaces
42+
## ROS 2 Interfaces
4343

4444
### Services
4545

46+
| Service Name | Service Type | Description |
47+
| :--- | :--- | :--- |
48+
| `/aic_controller/change_target_mode` | `aic_control_interfaces/srv/ChangeTargetMode` | Select the target mode (Cartesian or joint) to define the expected input. The controller will subscribe to either `/aic_controller/pose_commands` or `/aic_controller/joint_commands` accordingly. |
49+
| `/aic_controller/restart_bridge` | `std_srvs/srv/Trigger` | Triggers the restart of the controller bridge. To be called after robot faults occur and are cleared. |
50+
4651
### Published Topics
4752

48-
### Subscribed Topics
53+
| Topic | Message Type | Description |
54+
| :--- | :--- | :--- |
55+
| `/aic_controller/controller_state` | `aic_control_interfaces/msg/ControllerState` | Data on current TCP pose and velocity, reference TCP pose, TCP tracking error and reference joint efforts. |
56+
57+
### Command Topics
58+
The bridge listens to the following topics as motion commands for the controller.
59+
60+
| Topic | Message Type | Description |
61+
| :--- | :--- | :--- |
62+
| `/aic_controller/joint_commands` | `aic_control_interfaces/msg/JointMotionUpdate` | Target configurations for joint-space control. |
63+
| `/aic_controller/pose_commands` | `aic_control_interfaces/msg/MotionUpdate` | Target poses for Cartesian-space control. |

flowstate/aic_flowstate_ros_bridge/src/robot_control_bridge.cpp

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -298,11 +298,10 @@ bool RobotControlBridge::initialize(
298298
// by a "reset to initial" for the Flowstate scene
299299
rcl_jump_threshold_t jump_threshold;
300300
jump_threshold.on_clock_change = true;
301-
// Values of 0 would disable detecting forward/backward time jumps.
302-
// Trigger pos_jump callback if the time jumps forward/backward by at least 1
303-
// second (1e9 nanoseconds)
304-
// jump_threshold.min_forward.nanoseconds = 1 * (1000000000);
301+
// Values of 0 would disable callbacks from forward time jumps.
305302
jump_threshold.min_forward.nanoseconds = 0;
303+
// Trigger restart of controller bridge if the time jumps backward by at least
304+
// 1 second
306305
jump_threshold.min_backward.nanoseconds = 1 * (-1000000000);
307306
data_->jump_handler_ =
308307
data_->node_interfaces_

0 commit comments

Comments
 (0)