Add genericroboticarm documentation page#29
Open
dsmits wants to merge 1 commit into
Open
Conversation
Covers installation, starting the server, teaching positions (including per-OS storage paths for position graphs), SiLA2 control features, and adaptation to new hardware. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
cantordust
reviewed
Jun 22, 2026
Comment on lines
+77
to
+91
| Position graphs are saved as `.gml` files named `position_graph_<ArmName>.gml` in the platform's user config directory: | ||
|
|
||
| | OS | Path | | ||
| |----|------| | ||
| | Linux | `~/.config/GenericRoboticArm/` | | ||
| | macOS | `~/Library/Preferences/GenericRoboticArm/` | | ||
| | Windows | `%LOCALAPPDATA%\GenericRoboticArm\GenericRoboticArm\` | | ||
|
|
||
| The exact path is printed at startup: `Using <path> to load/store position graph.` | ||
|
|
||
| A custom directory can be set by passing `graph_dir` in a custom arm implementation. | ||
|
|
||
| ### Position naming convention | ||
|
|
||
| Positions are referenced by a string identifier. When addressing a specific device slot from the orchestrator, the default convention is `<device><slot_index>` (concatenation). The Dash visualisation shows the current position graph and the arm's current location. |
Member
There was a problem hiding this comment.
Would it make sense to also point to the site parser here?
cantordust
approved these changes
Jun 22, 2026
| genericroboticarm --arm-impl path/to/your_implementation.py | ||
| ``` | ||
|
|
||
| See the [adaption guide](https://gitlab.com/OpenLabAutomation/device-integration/genericroboticarm/-/blob/main/docs/adaption.md) in the source repository for details. |
Member
There was a problem hiding this comment.
I think 'adaptation' would be OK here, despite the template name :).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Covers installation, starting the server, teaching positions (including per-OS storage paths for position graphs), SiLA2 control features, and adaptation to new hardware.