AdrianLlopart commited on
Commit
0d56c06
Β·
verified Β·
1 Parent(s): e1f772b

docs: HF model card for OpenRAL/rskill-moveit-multi-eef_pose v0.1.0

Browse files
Files changed (1) hide show
  1. README.md +15 -17
README.md CHANGED
@@ -19,25 +19,24 @@ tags:
19
  inference: false
20
  ---
21
 
22
- # rskill-moveit-eef-pose
23
 
24
  > **OpenRAL rSkill** β€” wraps the upstream `moveit_msgs/action/MoveGroup`
25
  > action server so the Reasoner can dispatch a collision-free Cartesian
26
  > end-effector pose goal (position + orientation) through the same
27
  > `ExecuteRskill` path used by VLA skills. No model weights β€” the manifest
28
  > is the entire artefact. New under
29
- > [ADR-0054](../../docs/adr/0054-moveit-goal-builder-library.md)'s
30
  > `rskill-moveit-*` family.
31
 
32
- This package uses `kind: ros_action` (see
33
- [ADR-0024](../../docs/adr/0024-ros-wrapped-rskills.md)) β€” a discriminator
34
  on `RSkillManifest.kind` that selects the
35
  [`ROSActionRskill`](../../python/rskill/src/openral_rskill/ros_action_rskill.py)
36
  engine at resolve time, with `ros_integration.goal_builder: pose` selecting
37
  the [`PoseGoalRskill`](../../python/rskill/src/openral_rskill/pose_goal_rskill.py)
38
- goal-lowering adapter (ADR-0054). It is the generic Cartesian sibling of
39
- [`rskill-moveit-look-at`](../rskill-moveit-look-at/) (gaze is a computed-pose
40
- specialisation) and of [`rskill-moveit-joints`](../rskill-moveit-joints/)
41
  (joint-space). The engine constructs an `rclpy.action.ActionClient` on the
42
  host `RskillRunnerNode`, sends one goal built from the lowered `pose` block,
43
  awaits the result, and replays the returned `trajectory_msgs/JointTrajectory`
@@ -100,7 +99,7 @@ actuation path.
100
 
101
  ### Observation β†’ action contract
102
 
103
- Input is the ADR-0026 `goal_params_json` `pose` block; output is a joint
104
  trajectory replayed one waypoint per `step()` as a 1-row `JOINT_POSITION`
105
  `Action` chunk.
106
 
@@ -121,7 +120,7 @@ of every `ActionChunk` today
121
  Packing the full trajectory as one chunk with `horizon=N` would let
122
  waypoints 1..N actuate unchecked.
123
 
124
- ### GPU-accelerated planning (cuMotion, ADR-0065)
125
 
126
  On a host that clears the cuMotion GPU floor (`RobotCapabilities.supports_cumotion()`
127
  β€” Ampere+, CUDA β‰₯ 13, ~8 GB VRAM), the runner sets
@@ -178,7 +177,7 @@ reads the `link_name ← tool_frame` offset from TF:
178
 
179
  | Field | Value |
180
  | --- | --- |
181
- | `name` | `OpenRAL/rskill-moveit-eef-pose` |
182
  | `version` | `0.1.0` |
183
  | `license` | `apache-2.0` |
184
  | `kind` | `ros_action` |
@@ -212,7 +211,7 @@ ros2 launch moveit_resources_panda_moveit_config demo.launch.py
212
 
213
  # 2. Dispatch a Cartesian end-effector pose goal:
214
  ros2 action send_goal /openral/execute_rskill openral_msgs/action/ExecuteRskill \
215
- "{rskill_id: 'OpenRAL/rskill-moveit-eef-pose', deadline_s: 30.0, prompt: 'move to pre-grasp',
216
  goal_params_json: '{\"pose\": {\"position\": [0.4, 0.0, 0.5], \"orientation\": [0.0, 0.0, 0.0, 1.0]}}'}"
217
  ```
218
 
@@ -220,12 +219,12 @@ ros2 action send_goal /openral/execute_rskill openral_msgs/action/ExecuteRskill
220
 
221
  - **Reachability is the planner's call.** A pose outside the arm's dexterous
222
  workspace simply fails to plan β€” there is no base-repositioning fallback
223
- here (that is the navigate rung of the ladder, ADR-0044 Phase 4).
224
  - **OpenRAL safety supervisor does not do collision checking.** We trust
225
  MoveIt's internal FCL pass; the per-joint envelope check still runs per
226
  waypoint. Kernel-side collision checking is a separate ADR + multi-PR effort.
227
  - **No velocity / jerk bound at the supervisor.** Same posture as
228
- `rskill-moveit-joints`: the per-joint position envelope runs per
229
  waypoint; richer bounds are tracked separately.
230
 
231
  ## License
@@ -233,13 +232,12 @@ ros2 action send_goal /openral/execute_rskill openral_msgs/action/ExecuteRskill
233
  The rSkill package itself (this manifest + README) is **Apache-2.0**. The
234
  wrapped MoveIt code (`moveit_msgs` IDL, `moveit2` planners) is **BSD-3-Clause**
235
  and lives outside this repository β€” installed via `ros-${ROS_DISTRO}-moveit`.
236
- Per [ADR-0012](../../docs/adr/0012-open-core-licensing.md) both postures are
237
- commercial-use-permissive.
238
 
239
  ## See also
240
 
241
- - [ADR-0054 β€” MoveIt goal-builder library + rskill-moveit-* rename](../../docs/adr/0054-moveit-goal-builder-library.md)
242
- - [ADR-0024 β€” ROS-wrapped rSkills](../../docs/adr/0024-ros-wrapped-rskills.md)
243
  - [`openral_rskill.ros_action_rskill`](../../python/rskill/src/openral_rskill/ros_action_rskill.py) β€” engine source
244
  - [`openral_rskill.pose_goal_rskill`](../../python/rskill/src/openral_rskill/pose_goal_rskill.py) β€” goal-lowering adapter
245
  - [`rskills/rskill-moveit-joints/`](../rskill-moveit-joints/) β€” sibling joint-space MoveIt wrapper
 
19
  inference: false
20
  ---
21
 
22
+ # rskill-moveit-multi-eef_pose
23
 
24
  > **OpenRAL rSkill** β€” wraps the upstream `moveit_msgs/action/MoveGroup`
25
  > action server so the Reasoner can dispatch a collision-free Cartesian
26
  > end-effector pose goal (position + orientation) through the same
27
  > `ExecuteRskill` path used by VLA skills. No model weights β€” the manifest
28
  > is the entire artefact. New under
29
+ > the
30
  > `rskill-moveit-*` family.
31
 
32
+ This package uses `kind: ros_action` β€” a discriminator
 
33
  on `RSkillManifest.kind` that selects the
34
  [`ROSActionRskill`](../../python/rskill/src/openral_rskill/ros_action_rskill.py)
35
  engine at resolve time, with `ros_integration.goal_builder: pose` selecting
36
  the [`PoseGoalRskill`](../../python/rskill/src/openral_rskill/pose_goal_rskill.py)
37
+ goal-lowering adapter. It is the generic Cartesian sibling of
38
+ [`rskill-moveit-multi-look_at`](../rskill-moveit-look-at/) (gaze is a computed-pose
39
+ specialisation) and of [`rskill-moveit-multi-joints`](../rskill-moveit-joints/)
40
  (joint-space). The engine constructs an `rclpy.action.ActionClient` on the
41
  host `RskillRunnerNode`, sends one goal built from the lowered `pose` block,
42
  awaits the result, and replays the returned `trajectory_msgs/JointTrajectory`
 
99
 
100
  ### Observation β†’ action contract
101
 
102
+ Input is the `goal_params_json` `pose` block; output is a joint
103
  trajectory replayed one waypoint per `step()` as a 1-row `JOINT_POSITION`
104
  `Action` chunk.
105
 
 
120
  Packing the full trajectory as one chunk with `horizon=N` would let
121
  waypoints 1..N actuate unchecked.
122
 
123
+ ### GPU-accelerated planning (cuMotion)
124
 
125
  On a host that clears the cuMotion GPU floor (`RobotCapabilities.supports_cumotion()`
126
  β€” Ampere+, CUDA β‰₯ 13, ~8 GB VRAM), the runner sets
 
177
 
178
  | Field | Value |
179
  | --- | --- |
180
+ | `name` | `OpenRAL/rskill-moveit-multi-eef_pose` |
181
  | `version` | `0.1.0` |
182
  | `license` | `apache-2.0` |
183
  | `kind` | `ros_action` |
 
211
 
212
  # 2. Dispatch a Cartesian end-effector pose goal:
213
  ros2 action send_goal /openral/execute_rskill openral_msgs/action/ExecuteRskill \
214
+ "{rskill_id: 'OpenRAL/rskill-moveit-multi-eef_pose', deadline_s: 30.0, prompt: 'move to pre-grasp',
215
  goal_params_json: '{\"pose\": {\"position\": [0.4, 0.0, 0.5], \"orientation\": [0.0, 0.0, 0.0, 1.0]}}'}"
216
  ```
217
 
 
219
 
220
  - **Reachability is the planner's call.** A pose outside the arm's dexterous
221
  workspace simply fails to plan β€” there is no base-repositioning fallback
222
+ here (that is the navigate rung of the ladder).
223
  - **OpenRAL safety supervisor does not do collision checking.** We trust
224
  MoveIt's internal FCL pass; the per-joint envelope check still runs per
225
  waypoint. Kernel-side collision checking is a separate ADR + multi-PR effort.
226
  - **No velocity / jerk bound at the supervisor.** Same posture as
227
+ `rskill-moveit-multi-joints`: the per-joint position envelope runs per
228
  waypoint; richer bounds are tracked separately.
229
 
230
  ## License
 
232
  The rSkill package itself (this manifest + README) is **Apache-2.0**. The
233
  wrapped MoveIt code (`moveit_msgs` IDL, `moveit2` planners) is **BSD-3-Clause**
234
  and lives outside this repository β€” installed via `ros-${ROS_DISTRO}-moveit`.
235
+ Both postures are commercial-use-permissive.
 
236
 
237
  ## See also
238
 
239
+ - MoveIt goal-builder library + rskill-moveit-* rename
240
+ - ROS-wrapped rSkills
241
  - [`openral_rskill.ros_action_rskill`](../../python/rskill/src/openral_rskill/ros_action_rskill.py) β€” engine source
242
  - [`openral_rskill.pose_goal_rskill`](../../python/rskill/src/openral_rskill/pose_goal_rskill.py) β€” goal-lowering adapter
243
  - [`rskills/rskill-moveit-joints/`](../rskill-moveit-joints/) β€” sibling joint-space MoveIt wrapper