Skip to main content

Documentation Index

Fetch the complete documentation index at: https://motorbridge.seeedstudio.com/llms.txt

Use this file to discover all available pages before exploring further.

最佳实践:发布与版本

支持的 Python 版本

motorbridge SDK 支持以下 Python 版本:
版本状态说明
Python 3.10✅ 支持最低版本
Python 3.11✅ 支持推荐
Python 3.12✅ 支持最新稳定版
Python 3.13✅ 支持最新版本
Python 3.14✅ 支持预发布版
Python 3.9 及更早❌ 不支持使用 3.10+

版本号规则

SDK 遵循 语义化版本 当前源码对齐:
组件源文件当前版本
Git 发布标签motorbridge 仓库v0.3.3
Python 包bindings/python/pyproject.toml0.3.3
Rust workspace cratesCargo.toml[workspace.package]0.3.3
主版本.次版本.补丁版本[-预发布标识]

示例:
0.1.0   - 初始发布
0.1.1   - Bug 修复
0.1.2   - 另一个 Bug 修复
0.2.0   - 新功能,向后兼容
1.0.0   - 稳定 API,与 0.x 有破坏性变更
1.1.0a1 - Alpha 预发布
1.1.0b1 - Beta 预发布
1.1.0rc1 - 候选版本

版本类别

类别示例稳定性
稳定版0.3.3生产就绪
预发布0.3.3a1仅测试
开发版0.3.3.dev1内部使用

安装渠道

PyPI(生产)

# 最新稳定版
pip install motorbridge

# 特定版本
pip install motorbridge==0.3.3

# 升级
pip install --upgrade motorbridge

TestPyPI(预发布)

# 从 TestPyPI 安装
pip install -i https://test.pypi.org/simple/ motorbridge==0.3.3a1
预发布版本可能有破坏性变更,不推荐用于生产环境。

Git 安装

# 从 Git 安装
pip install git+https://github.com/tianrking/motorbridge@v0.3.3

# 安装特定分支
pip install git+https://github.com/tianrking/motorbridge@main

检查已安装版本

命令行

# 使用 pip
pip show motorbridge

# 使用 Python CLI
motorbridge-cli -v

# 使用 Rust CLI
motor_cli -v

# 使用 Python
python3 -c "import importlib.metadata; print(importlib.metadata.version('motorbridge'))"
python3 -c "import motorbridge; print(motorbridge.get_version())"

代码中检查

import motorbridge

import importlib.metadata
print(f"motorbridge 版本: {importlib.metadata.version('motorbridge')}")
print(f"motorbridge API 版本: {motorbridge.get_version()}")

升级策略

保守升级

保持在稳定版本,只升级修复 Bug:
# 当前: 任意旧 0.x 版本
# 升级到最新稳定版: 0.3.3
pip install --upgrade motorbridge

# 或特定补丁
pip install motorbridge==0.3.3

早期采用者

在开发环境测试预发布版本:
# 开发环境
pip install -i https://test.pypi.org/simple/ motorbridge==0.3.3b1

# 测试代码
python3 -m pytest tests/

# 生产环境保持稳定
pip install motorbridge==0.3.3

固定版本

用于可复现部署:
# requirements.txt
motorbridge==0.3.3
或使用版本约束:
# 允许补丁更新,阻止次版本/主版本变更
motorbridge>=0.3.3,<0.4.0

API 稳定性

版本 0.x(当前)

  • 次版本之间 API 可能变更
  • 破坏性变更在发布说明中记录
  • 建议固定版本

版本 1.0+(未来)

  • 语义化版本保证
  • 破坏性变更只在主版本中
  • 移除前有弃用警告

变更日志

v0.3.3

  • 新增统一版本查询:Python motorbridge.__version__motorbridge.get_version()motorbridge-cli -v 和 Rust motor_cli -v
  • Python CLI 关闭长选项缩写,robstride-write-param --mode save 这类错误参数会直接报错,不会误解析成 --model save
  • Python robstride-write-paramdamiao-write-param 新增统一 --store 1
  • Rust CLI 对齐 RobStride/Damiao 写参保存语义
  • RobStride type 22 保存会发送官方 payload 并等待状态 ACK

v0.3.2

  • RobStride 故障帧只更新故障缓存,不再污染最新运动状态
  • Python binding/CLI 可查询最近一次厂商故障码,同时保留最后一帧真实状态

v0.3.1

  • 新增 ABI/Python 详细故障状态访问接口
  • 改进 RobStride 过温/故障诊断链路

v0.2.9

  • 新增 RobStride host_id 精确 ABI:motor_handle_robstride_ping_host_idmotor_handle_robstride_get_param_f32_host_id
  • 新增 Python 包装方法:robstride_ping_host_id(...)robstride_get_param_f32_host_id(...)
  • 统一校验 RobStride motor_id / device_id1..255feedback_id / host_id0..255
  • Rust 与 Python 的 RobStride 扫描现在会精确探测每个 --feedback-ids host_id
  • Canonical Mintlify 文档迁移到同级 motorbridge-docs 仓库

v0.2.5

  • Python CLI 新增 id-set --vendor robstride,支持 RobStride device_id 更新
  • Rust/Python RobStride 扫描默认 host_id 候选统一为 0xFD,0xFF,0xFE,0x00,0xAA

v0.2.3

  • 重构 ABI FFI 层,减少 controller/motor 分发重复代码
  • 合并厂商参数 FFI 入口
  • 对齐 core、厂商控制器、Python binding 和 websocket gateway 的运行时/控制路径稳健性修复

弃用政策

  1. 公告: 功能在发布说明中标记为弃用
  2. 警告: 添加运行时弃用警告
  3. 宽限期: 至少一个次版本
  4. 移除: 在下一个主版本/次版本中移除
# 弃用警告示例
import warnings

def old_function():
    warnings.warn(
        "old_function 已弃用,请使用 new_function",
        DeprecationWarning,
        stacklevel=2
    )
    return new_function()

发布检查清单

维护者发布新版本:

1. 更新版本号

# 更新 bindings/python/pyproject.toml 中的 [project].version
version = "0.3.3"

2. 更新变更日志

  • 记录所有变更
  • 注明破坏性变更

3. 打标签

git tag v0.3.3
git push origin v0.3.3

4. 构建包

MOTORBRIDGE_LIB=../../target/release/libmotor_abi.so \
MOTORBRIDGE_WS_GATEWAY_BIN=../../target/release/ws_gateway \
python -m build

5. 上传到 TestPyPI

twine upload -r testpypi dist/*

6. 验证安装

pip install -i https://test.pypi.org/simple/ motorbridge==0.3.3
python3 -m pytest tests/

7. 上传到 PyPI

twine upload dist/*

重要规则

切勿重复上传同一包版本。一旦版本上传到 PyPI,就无法覆盖。新上传必须增加版本号。

上传失败处理

# 错误:尝试重新上传同一版本
twine upload dist/motorbridge-0.3.3.tar.gz
# 错误: 文件已存在

# 解决方案:增加版本号
# 更新 __version__ = "0.3.3"
# 重新构建并上传

CI/CD 集成

GitHub Actions 示例

name: Publish

on:
  release:
    types: [published]

jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Build
        run: |
          MOTORBRIDGE_LIB=../../target/release/libmotor_abi.so \
          MOTORBRIDGE_WS_GATEWAY_BIN=../../target/release/ws_gateway \
          python -m build

      - name: Publish to PyPI
        run: twine upload dist/*
        env:
          TWINE_TOKEN: ${{ secrets.PYPI_TOKEN }}

版本兼容性表

SDK 版本最低 Python推荐传输说明
0.1.53.10SocketCAN初始发布
0.1.63.10SocketCAN添加 RobStride 参数
0.2.93.10SocketCAN后台轮询默认启用
0.3.33.10SocketCAN / PCAN版本查询、CLI 写参 --store 1、RobStride 保存 ACK 对齐

下一步