Skip to content

Add README dora-rs usage documentation for dora-openarm node I/O#10

Merged
kou merged 6 commits into
mainfrom
copilot/add-usage-section-to-readme
May 12, 2026
Merged

Add README dora-rs usage documentation for dora-openarm node I/O#10
kou merged 6 commits into
mainfrom
copilot/add-usage-section-to-readme

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 12, 2026

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.

Copilot AI assigned Copilot and kou May 12, 2026
Copilot AI linked an issue May 12, 2026 that may be closed by this pull request
Copilot AI changed the title [WIP] Update README with usage section for dora-rs node Add README usage documentation for dora-openarm node I/O May 12, 2026
Copilot finished work on behalf of kou May 12, 2026 05:07
Copilot AI requested a review from kou May 12, 2026 05:07
Comment thread README.md Outdated
Comment on lines +7 to +13
Run the node with:

```console
dora-openarm [--side {right,left}] [--config PATH] [--align-trigger gripper]
[--align-threshold RAD] [--[no-]stop]
[--[no-]refresh-every-request]
```
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread README.md Outdated
Comment on lines +31 to +35
- `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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot Use table not list.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated in e153946. The README inputs and outputs are now documented with tables instead of lists.

Copilot AI changed the title Add README usage documentation for dora-openarm node I/O Add README dora-rs usage documentation for dora-openarm node I/O May 12, 2026
Copilot finished work on behalf of kou May 12, 2026 05:38
Copilot AI requested a review from kou May 12, 2026 05:38
Comment thread README.md Outdated
@kou kou marked this pull request as ready for review May 12, 2026 05:49
Copilot AI review requested due to automatic review settings May 12, 2026 05:49
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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-openarm as 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_position struct form and state output structure).

@kou kou merged commit b41a8c9 into main May 12, 2026
8 checks passed
@kou kou deleted the copilot/add-usage-section-to-readme branch May 12, 2026 05:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add the usage section to README

3 participants