docs: add generated SKILL.md discovery view
Browse files
SKILL.md
ADDED
|
@@ -0,0 +1,60 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
name: rskill-moveit-joints
|
| 3 |
+
description: >-
|
| 4 |
+
S1 ROS action skill (weightless). Capabilities: reach. Plan and execute a collision-free motion to a target JOINT configuration via MoveIt's MoveGroup (self + planning-scene collision checked). Provide one target angle per planning-group joint. Defaults target the Franka Panda home pose; override the manifest to retarget. Use when you have a joint-space goal (e.g. a policy's in-distribution starting pose); for a Cartesian end-effector target use rskill-moveit-eef-pose instead. Discovery view of an OpenRAL rSkill — NOT directly runnable by an agent harness; it runs via rSkill.from_pretrained + the robot HAL.
|
| 5 |
+
metadata:
|
| 6 |
+
openral_rskill: true # generated discovery view of an rSkill
|
| 7 |
+
schema_version: 0.1
|
| 8 |
+
rskill_id: OpenRAL/rskill-moveit-joints
|
| 9 |
+
manifest: ./rskill.yaml
|
| 10 |
+
role: s1
|
| 11 |
+
kind: ros_action
|
| 12 |
+
embodiment_tags: [franka_panda, ur5e, ur10e, so100_follower, openarm, rizon4, sawyer, widowx]
|
| 13 |
+
actions: [reach]
|
| 14 |
+
chunk_size: 1
|
| 15 |
+
latency_budget: {per_chunk_ms: 2000.0}
|
| 16 |
+
license_code: Apache-2.0
|
| 17 |
+
license_weights: apache-2.0
|
| 18 |
+
paper_url: https://moveit.picknik.ai/
|
| 19 |
+
---
|
| 20 |
+
|
| 21 |
+
# rskill-moveit-joints — rSkill discovery view
|
| 22 |
+
|
| 23 |
+
> **Generated view, not a hand-written skill.** This `SKILL.md` is a discovery-only
|
| 24 |
+
> mirror of [`rskill.yaml`](./rskill.yaml), produced by `tools/generate_rskill_skillmd.py`.
|
| 25 |
+
> It lets tools that read the standard agent-skill format find and reason about this
|
| 26 |
+
> OpenRAL rSkill. The `rskill.yaml` manifest is the single source of truth
|
| 27 |
+
> (CLAUDE.md §1.3). Do not edit by hand — edit the manifest and regenerate.
|
| 28 |
+
|
| 29 |
+
## What it is
|
| 30 |
+
|
| 31 |
+
An OpenRAL **ROS action skill (weightless)** (`role: s1`, `kind: ros_action`). Plan and execute a collision-free motion to a target JOINT configuration via MoveIt's MoveGroup (self + planning-scene collision checked). Provide one target angle per planning-group joint. Defaults target the Franka Panda home pose; override the manifest to retarget. Use when you have a joint-space goal (e.g. a policy's in-distribution starting pose); for a Cartesian end-effector target use rskill-moveit-eef-pose instead.
|
| 32 |
+
|
| 33 |
+
## Capabilities
|
| 34 |
+
|
| 35 |
+
- **Verbs:** reach
|
| 36 |
+
- **Embodiments:** franka_panda · ur5e · ur10e · so100_follower · openarm · rizon4 · sawyer · widowx
|
| 37 |
+
|
| 38 |
+
## Why this is discovery-only
|
| 39 |
+
|
| 40 |
+
An agent skill is natural-language instructions loaded into an LLM's context. An rSkill
|
| 41 |
+
is an executable artifact: it carries a typed capability/embodiment contract
|
| 42 |
+
a runtime, and a license/provenance gate — none of which fit in freeform markdown. So an
|
| 43 |
+
agent can use this view to *select* the right skill, but cannot *execute* it by loading
|
| 44 |
+
this file. Execution always goes through the OpenRAL loader and the robot HAL.
|
| 45 |
+
|
| 46 |
+
## License
|
| 47 |
+
|
| 48 |
+
- **Code:** Apache-2.0. This is a weightless rSkill (the manifest *is* the artifact).
|
| 49 |
+
|
| 50 |
+
## How to actually run it (not via an agent harness)
|
| 51 |
+
|
| 52 |
+
```python
|
| 53 |
+
from openral_rskill import rSkill
|
| 54 |
+
|
| 55 |
+
skill = rSkill.from_pretrained("OpenRAL/rskill-moveit-joints")
|
| 56 |
+
# the loader validates embodiment / sensors / runtime / quantization against the target
|
| 57 |
+
# RobotDescription and enforces the weight-license gate before any weights load.
|
| 58 |
+
```
|
| 59 |
+
|
| 60 |
+
See [`rskill.yaml`](./rskill.yaml) for the authoritative, validated manifest.
|