Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/build-ubuntu20.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ on:
ref:
description: Git ref to build
required: true
default: v0.1.0
default: v2.0.0
version:
description: Release version without the v prefix
required: true
default: 0.1.0
default: 2.0.0

permissions:
contents: read
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
with:
python-version: "3.12"
- name: Install uv
run: python -m pip install uv==0.12.5
run: python -m pip install uv==0.13.7
- name: Sync locked environment
run: uv sync --frozen --all-groups
- name: Unit tests
Expand All @@ -44,11 +44,11 @@ jobs:
with:
python-version: "3.12"
- name: Install uv
run: python -m pip install uv==0.12.5
run: python -m pip install uv==0.13.7
- name: Export and audit locked runtime dependencies
run: |
uv export --frozen --format requirements-txt --no-dev --no-emit-project --no-emit-workspace --output-file /tmp/requirements.txt
uvx pip-audit --requirement /tmp/requirements.txt
uvx --python 3.12 pip-audit --requirement /tmp/requirements.txt

secrets:
runs-on: ubuntu-latest
Expand Down
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# Forge Controls

[English](README.md) | [简体中文](README_zh.md)

## BREAKING CHANGE: Forge 2.x / Dora 1.x migration

This migration from Forge 1.x / Dora 0.4.x requires coordinated deployment. Align the Forge packages, Dora CLI/coordinator/daemon, this node and its peer nodes before connecting a dataflow; replacing only one node in a Forge 1.x deployment is unsupported. Rebuild and redeploy executable artifacts with the matching environment. Keep `stable/1.x` for deployments that still use the previous stack.

The validated Python baseline is `forge-msgs==2.1.0`, `Pillow==13.0.0`, `forge-common==2.1.0`, the applicable `forge-robot` / `forge-policy` / `forge-kinematics` / `forge-tool` packages at `2.0.0`, and `dora-rs==1.0.1`. Respect this repository's Python and SDK platform requirements. Forge package families have independent versions. Rust nodes retain the published `forge_msgs` crate `2.0.0` with Dora `1.0.1`; Python Msgs `2.1.0` does not require a nonexistent Rust `2.1.0` release. The `forge_msgs.v1` message namespace remains unchanged.

This notice describes the deployment break from the previous stack; it does not declare hardware, real-model or sustained-run acceptance complete. See [this round's verification report](migration/msgs-2.1.0-report.json) for actual tests and outstanding gates.

Reusable motion execution and control capabilities for Forge/Dora robotics dataflows.

The workspace provides lightweight motion controllers that consume Dora action payloads from
Expand Down Expand Up @@ -34,3 +44,9 @@ It also checks that missing or invalid required arguments produce argparse exit
this source repository and retain their respective licenses; see
[NOTICE](NOTICE) and [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).
Review the complete bundled artifact before publishing standalone executables.

## Forge 2.x migration

This branch prepares node version `2.0.0` for Dora 1.x, frozen to Dora `1.0.1` for migration validation. It uses the official Forge 2.x distributions; Common is at least `2.1.0`. Regenerated locks and all executable entrypoints are part of the change.

Every change report must list repository, changes and test evidence, including per-node `dora run` records and a chained test containing `adapter-forge-gateway`. Unavailable hardware/model checks remain pending. Source PRs do not publish stable releases or synchronize GitLab; synchronization follows full acceptance.
29 changes: 29 additions & 0 deletions README_zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Forge Controls

[English](README.md) | [简体中文](README_zh.md)

## BREAKING CHANGE:Forge 2.x / Dora 1.x 迁移

本次从 Forge 1.x / Dora 0.4.x 升级需要协同部署。节点对接前必须对齐 Forge 包、Dora CLI/coordinator/daemon、本节点及上下游节点的版本;不支持在 Forge 1.x 部署中只替换单个节点。可执行产物也需要使用匹配环境重新构建和部署。仍使用旧技术栈的部署请保留在 `stable/1.x`。

本轮验证的 Python 基线为 `forge-msgs==2.1.0`、`Pillow==13.0.0`、`forge-common==2.1.0`、按需使用的 `forge-robot` / `forge-policy` / `forge-kinematics` / `forge-tool` 为 `2.0.0`,以及 `dora-rs==1.0.1`。同时遵守本仓库的 Python 和 SDK 平台要求。Forge 各包族独立发布,无需强行使用同一个版本号。Rust 节点继续使用已发布的 `forge_msgs` crate `2.0.0` 和 Dora `1.0.1`;Python Msgs `2.1.0` 不要求升级到尚未发布的 Rust `2.1.0`。消息命名空间 `forge_msgs.v1` 保持不变。

这里的 breaking change 指旧技术栈的部署迁移,不代表真机、真实模型或长时间运行已完成验收。实际测试和未完成项见[本轮验证报告](migration/msgs-2.1.0-report.json)。

提供 Forge/Dora 数据流可复用的关节轨迹控制器与夹爪动作控制器。

- `forge-joint-trajectory-controller`:处理轨迹目标、反馈、结果及取消。
- `forge-gripper-action-controller`:处理夹爪目标、反馈、结果及取消。
- `examples/` 中提供配置、模拟执行器及独立运行示例。

使用 Python 3.12,在根目录执行 `uv sync --frozen --all-packages --dev` 安装工作区。
两个入口均接受 `--config`;使用 `--help` 查看参数。

测试执行 `uv run pytest --import-mode=importlib packages`。
模拟执行器验证软件控制合同,真机连接、运动限制及最终发布包仍需独立验收。

## Forge 2.x 迁移

本分支准备节点版本 `2.0.0`,适配 Dora 1.x,迁移验证锁定 Dora `1.0.1`。使用正式 Forge 2.x 分发包;Common 至少为 `2.1.0`。此次更新包括依赖锁文件与各独立可执行入口。

每轮报告必须列出仓库、改动和测试证据,包括各节点的 `dora run` 记录,以及包含 `adapter-forge-gateway` 的串联测试。缺少硬件或模型的验收项保持待验证。源码 PR 不等于正式发布;整体验收通过后再同步 GitLab。
205 changes: 205 additions & 0 deletions migration/forge2-report.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,205 @@
{
"repository": "operator-controls",
"node_candidate_version": "2.0.0",
"changes": [
"Upgrade both trajectory and gripper controller workspace packages.",
"Synchronize English/Chinese root README guidance and frozen dependencies."
],
"software_tests": {
"log": "ci-tests.log",
"summary": [
"61 passed in 0.27s"
]
},
"dora_cli": "1.0.1",
"runtime_records": [
{
"repo": "operator-controls",
"entry": "joint-trajectory-controller",
"mode": "single",
"command": [
"${WORKSPACE}/.test-env/bin/dora",
"run",
"${WORKSPACE}/validation/forge2/runtime/joint-trajectory-controller/single/dataflow.yaml",
"--stop-after",
"6s"
],
"exit_code": 0,
"elapsed_seconds": 6.135,
"passed": true,
"error": null,
"scope": "Startup, timer processing and normal Dora stop only; no hardware or action execution."
},
{
"repo": "operator-controls",
"entry": "gripper-action-controller",
"mode": "single",
"command": [
"${WORKSPACE}/.test-env/bin/dora",
"run",
"${WORKSPACE}/validation/forge2/runtime/gripper-action-controller/single/dataflow.yaml",
"--stop-after",
"6s"
],
"exit_code": 0,
"elapsed_seconds": 6.108,
"passed": true,
"error": null,
"scope": "Startup, timer processing and normal Dora stop only; no hardware or action execution."
},
{
"repo": "operator-controls",
"entry": "joint-trajectory-controller",
"command": [
"${WORKSPACE}/.test-env/bin/dora",
"run",
"${WORKSPACE}/validation/forge2/runtime/joint-trajectory-controller/chain/dataflow.yaml",
"--stop-after",
"10s"
],
"includes_gateway": true,
"passed": true,
"scope": "Production node with simulated state/actuator; Gateway receives state and commands. No hardware.",
"state": {
"running_time": 1.187,
"current_frame_count": 33,
"sensors": {
"joints": {
"joint1": 0.0,
"joint2": 0.0,
"joint3": 0.0,
"joint4": 0.0,
"joint5": 0.0,
"joint6": 0.0
},
"command": {
"joint1": 0.00045875000000000006,
"joint2": 0.00045875000000000006,
"joint3": 0.00045875000000000006,
"joint4": 0.00045875000000000006,
"joint5": 0.00045875000000000006,
"joint6": 0.00045875000000000006
}
},
"runtime": {
"phase": "running",
"sim_status": {
"status_name": "UNINITIALIZED",
"status_code": 0
},
"record_status": {
"record_state": "IDLE",
"episode_count": 0,
"current_frame_count": 0
},
"playback_status": {
"playback_state": "IDLE",
"current_time_ns": 0,
"total_messages": 0,
"mcap_path": null,
"error": null
},
"readiness": {
"ready": true,
"missing": [],
"runtime_phase": "running",
"proprio_state_ready": true,
"required_images_ready": true,
"images": {},
"state_clients": 1,
"image_clients": 0,
"state_client_ready": true,
"image_client_ready": false
},
"last_error": null
}
},
"exit_code": 0,
"fixture": {
"passed": true,
"commands": 430,
"terminal_results": [
{
"goal_id": "smoke-goal",
"goal_status": "succeeded"
}
],
"scope": "Simulated actuator only"
}
},
{
"repo": "operator-controls",
"entry": "gripper-action-controller",
"command": [
"${WORKSPACE}/.test-env/bin/dora",
"run",
"${WORKSPACE}/validation/forge2/runtime/gripper-action-controller/chain/dataflow.yaml",
"--stop-after",
"10s"
],
"includes_gateway": true,
"passed": true,
"scope": "Production node with simulated state/actuator; Gateway receives state and commands. No hardware.",
"state": {
"running_time": 1.098,
"current_frame_count": 33,
"sensors": {
"joints": {
"joint1": 0.0
},
"command": {
"joint1": 0.02
}
},
"runtime": {
"phase": "running",
"sim_status": {
"status_name": "UNINITIALIZED",
"status_code": 0
},
"record_status": {
"record_state": "IDLE",
"episode_count": 0,
"current_frame_count": 0
},
"playback_status": {
"playback_state": "IDLE",
"current_time_ns": 0,
"total_messages": 0,
"mcap_path": null,
"error": null
},
"readiness": {
"ready": true,
"missing": [],
"runtime_phase": "running",
"proprio_state_ready": true,
"required_images_ready": true,
"images": {},
"state_clients": 1,
"image_clients": 0,
"state_client_ready": true,
"image_client_ready": false
},
"last_error": null
}
},
"exit_code": 0,
"fixture": {
"passed": true,
"commands": 437,
"terminal_results": [
{
"goal_id": "smoke-goal",
"goal_status": "succeeded"
}
],
"scope": "Simulated actuator only"
}
}
],
"runtime_missing": null,
"acceptance": "Pending final platform artifacts, applicable hardware/model execution and rollback/sustained-run gates.",
"pillow_dependency": "Node locks currently resolve published Forge Msgs 2.0.0. Security audit remains dependent on Forge PR #3 and a published security-fixed Msgs release; no vulnerability suppression was added.",
"gitlab_synchronization": "Not started; follows full acceptance."
}
Loading
Loading