Add README dora-rs usage documentation for dora-openarm node I/O#10
Conversation
Agent-Logs-Url: https://github.com/enactic/dora-openarm/sessions/3b125e18-8c31-44e4-813d-081cf4db3fe3 Co-authored-by: kou <27350+kou@users.noreply.github.com>
| Run the node with: | ||
|
|
||
| ```console | ||
| dora-openarm [--side {right,left}] [--config PATH] [--align-trigger gripper] | ||
| [--align-threshold RAD] [--[no-]stop] | ||
| [--[no-]refresh-every-request] | ||
| ``` |
There was a problem hiding this comment.
@copilot This is used as a dora-rs node. So we should add a sample dora-rs dataflow configuration instead of command line signature.
For data collection:
nodes:
# ...
- id: follower-right
build: pip install dora-openarm
path: dora-openarm
args: "--side right --align-trigger gripper"
inputs:
# Event ID is only used. Event value isn't used.
request_position: leader/right_follower_position
move_position: leader/right_follower_position
outputs:
- position
- status
- id: follower-left
build: pip install -e nodes/dora-openarm
# build: pip install dora-openarm
path: dora-openarm
# Please configure!
args: "--side left --align-trigger gripper"
inputs:
# Event ID is only used. Event value isn't used.
request_position: leader/left_follower_position
move_position: leader/left_follower_position
outputs:
- position
- status
# ...Add a link to https://github.com/enactic/dora-openarm-data-collection for full example configuration.
There was a problem hiding this comment.
Updated in e153946. The README usage section now shows a dora-rs dataflow YAML example and links to the full dora-openarm-data-collection configuration.
| - `request_position`: Requests the current arm position. | ||
| - `request_state`: Requests the current arm state. | ||
| - `move_position`: Sends a new target position to the arm. The value may be a | ||
| position array directly, or a struct containing `new_position`. When the node | ||
| has not been initialized yet, this input first drives the alignment step. |
There was a problem hiding this comment.
Updated in e153946. The README inputs and outputs are now documented with tables instead of lists.
Agent-Logs-Url: https://github.com/enactic/dora-openarm/sessions/138c8974-85aa-45c6-a245-890d6eab5c9e Co-authored-by: kou <27350+kou@users.noreply.github.com>
Agent-Logs-Url: https://github.com/enactic/dora-openarm/sessions/138c8974-85aa-45c6-a245-890d6eab5c9e Co-authored-by: kou <27350+kou@users.noreply.github.com>
Agent-Logs-Url: https://github.com/enactic/dora-openarm/sessions/138c8974-85aa-45c6-a245-890d6eab5c9e Co-authored-by: kou <27350+kou@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Updates the repository README to fully document how dora-openarm is used as a dora-rs node, including its CLI arguments and the Dora input/output interface, so users can configure it correctly from the README alone.
Changes:
- Added a sample dora-rs dataflow YAML snippet for running
dora-openarmas a node. - Documented node CLI arguments (
--side,--config, alignment options, stop/refresh flags) in a table. - Documented the Dora interface with explicit Inputs/Outputs tables and clarified accepted data shapes (including
move_positionstruct form andstateoutput structure).
Fix GH-9
The README did not describe how to use this package as a dora-rs node or what inputs and outputs it exposes. This updates the documentation to make the node interface explicit from the README alone.