联系销售
返回Wiki

机器人中心SDK <unk> Python API参考

对于机器人中心SDK的 python API参考:LinkerO6,L1Robot,SessionManager,传感器框架类,RC CLI命令,REST终端点. pip安装机器人中心.

开始

  • T68
  • T69)
  • 包装进口

类 连接O6

  • T72)
  • ,我知道,我知道.
  • T74

类L1机器人

  • ,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
  • ,我不想说.
  • 其他类型的数据

类 传感器框架

  • T79

类 会议管理器

  • ,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
  • ,我很高兴能看到你.
  • 现在,我们要做什么?

剩余的API

  • 电话会议.
  • 道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道道

参考

  • [环境变量]
  • 支持设备

维基导航

  • [←所有文章]
  • 快速启动的SDK
  • 会议的URL和电话
  • ,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,

查看

  • 机器人学院的研究人员
  • ,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
  • 问一个问题.

T0 Python 包的完整参考.涵盖所有公共类,方法,属性,CLI命令,REST终端点和环境变量.

包装: T1 字thon: 3.9+ 安装: T2

Python SDK 链接O6 L1Robot 会议管理器 REST API

概述

概述

T3 SDK是将机器人设备连接到机器人中心平台,传感器数据流,管理远程操作会议和上传集录音的主要接口.它配备CLI (T4) 用于快速设备连接和Python API用于定制数据收集管道.

所有设备类都继承了T5,并暴露了相同的T6 /T7接口,使得编写硬件无知收集脚本变得简单.

命令行界面

信息通信系统指令

T8 CLI 随着包装自动安装. 运行T9以查看完整的选项列表.

安装机器人中心 帮助

Command Description
rc devices Scan all serial and network interfaces for connected hardware. Prints device type, port, firmware version, and status.
rc connect Auto-detect a supported device, create a platform session, start streaming, and open the browser panel.
rc connect --device Force a specific device type. Values: linker-o6, l1. Skips auto-detection.
rc connect --port Bind to a specific serial port instead of scanning. E.g. /dev/ttyUSB0 or COM3.
rc connect --mock Start a synthetic data session with no physical hardware required. All SDK features and the browser panel are fully functional.
rc connect --no-browser Suppress automatic browser launch. Session URL is printed to stdout.
rc session <SESSION_ID> Show session metadata: status, device type, creation time, episode count, deep link, and upload URL.

包装

包装进口

所有公共类型均可直接从最高级别包中进口:

机器人中心进口LinkerO6,L1Robot,SessionManager

单个子模块也可用于高级用途:

机器人中心.设备进口LinkerO6,L1Robot 从机器人中心.session进口SessionManager 从机器人中心.框架进口传感器框架

类

链接O6

类链接O6(基础设备)

操作器用于LinkerBot O6精巧的手动系统.同时处理USB连续框架 (RCSV T14协议在921600 baud),包验证,会议创建和实时框架流动.

类方法 连接口,假设

连接到O6手机系统,返回连接设备实例. 自动创建平台会议,并开始传感器流.

Parameter Type Description
port optional str None
mock optional bool When True, generates synthetic O6 sensor data. No physical device required. Default: False.

返回 T20 连接设备实例. 如果没有O6设备,则增加T21和T22.

机器人中心进口 LinkerO6

设备 = LinkerO6.连接() 或有明确的端口: 设备 = LinkerO6.connect(port="/dev/ttyUSB0") 或模拟模式: 连接器件=LinkerO6.连接器件

电脑系统的系统

产量传感器从设备到达时的框架. 阻塞到调用T23或设备断开.每个框架包含左手和右手状态的快照.

Parameter Type Description
No parameters.

T25形状: T26.值正常化为0.0 (开放) 到1.0 (完全关闭).

在设备.流中的框架中: 的,的,的,的,的,的,的,的,的,的,的,的,的,的,的,的,的,的,的,的,的,的,的,的,的,的,的,的,的,的,的,的,的,的,的,的,的,的,的,的,的,的,,的,的,的,,的,的,的,的,的,的,的,的,的,的,的,的,的,的,的,的,的,的,的,的, 现在,我们可以说是"数据"的. 印表: (f"L指数: {左.get('指数',0):.3f} R指数: {右.get('指数',0):.3f}")

设备.停止() → 没有

停止流媒体,关闭连接. 无需多次打电话. 自动地冲除任何缓冲框,并在一个活动时完成当前录音节目.

属性

没有平台会议 ID 分配在连接时间. T27如果没有会议创建.

没有 对于直播电话板的浏览器URL. 例如T28.

设备.端口 str 连接设备的连接端口路径.例如 T29.在模拟模式下: T30.

设备.设备_类型 str "linker_o6"

设备.设备_家庭 str "dexhand"

类

机器人

类L1机器人(基础设备)

驾驶员为VLAI L1移动操纵器.通过ROS2 / CAN-FD通信. 流通关节状态,抓住器位置,基速度,升降高度,电池百分比和摄像头可用性.

类方法 机器人.连接 港口 没有,假设

在硬件模式下,需要ROS2环境和L1 CAN-FD接口才能活跃.

Parameter Type Description
port optional str None
mock optional bool Generate synthetic L1 state data. No ROS2 or physical robot required. Default: False.

返回 T33 连接设备实例. 如果ROS2界面不可用,则增加T34.

机器人.流) → 变速器

机器人L1的产量传感器框架. 每个框架都包含了机器人的状态的完整快照.

T36 T37结构下面.

机器人.停止() → 没有

停止流媒体,关闭ROS2 / CAN-FD连接. 完成任何活跃的录音节目.

L1Robot 的传感器框架数据结构

T38字典为L1Robot框架有以下形状:

现在, 关节: { "左_臂": [j1, j2, j3, j4, j5, j6, j7], #度, 7-DOF "右手": [j1, j2, j3, j4, j5, j6, j7], #度, 7-DOF "左_抓住器":0.0, # 0.0 =完全开放,1.0 =完全关闭 "右_抓住器": 0.0, ,我知道. 根据"基" "vx":0.0, #前进速度,m/s "vy":0.0, #侧速度,m/s "wz": 0.0, #率,rad/s ,我知道. "升高"1060毫米,体升高 "电池_pct": 85.0, #电荷状态,0.0100.0 摄像头: { "胸部": 确实,如果摄像头流活跃 手:假, 假的, ,我知道. 现在,我们要去做什么?

类

传感器框架

类 传感器框架

单个时间标记读取器件. T39.所有属性都是仅读的.

属性

时刻标志浮动 时刻标志 Unix时代标志,在该装置上捕获的时刻分辨率为微秒.

系统的设备识别器. 对于LinkerBot O6: T40.

对于LinkerBot O6: T41.对于VLAI L1: T42.

根据设备类型,方案不同. 参见上述每个类型的文档.

文件的数据是从设备中收到的原始电缆格式包字节.

类

会议管理员

类 会议管理器

平台会议API的低级客户端. 设备类内部使用,但也可用于直接集成 (例如从自定义代理或外部管弦系统创建会议).

会议管理器.__init____(基础_url=RC_PLATFORM_URL)

T43默认为T44,但可以通过T45环境变量被覆盖.

Parameter Type Description
base_url optional str Platform backend URL. Override for self-hosted deployments or staging environments.

任何类型的设备,设备,硬件,连续程序,任何类型

在平台上创建一个新的远程操作会话. 返回所有需要开始流媒体的凭证,并打开浏览器面板.

Parameter Type Description
device_type str SDK device type. E.g. "linker_o6", "l1".
device_id optional str None
hardware_serial optional str None

返回 T48,用钥匙:

Key Type Description
session_id str Unique session identifier. E.g. "RC-XXXX-XXXX".
deep_link str Full browser URL for the teleop panel.
ws_url str WebSocket relay URL for frame streaming.
guest_token str Short-lived token for unauthenticated browser access to this session.
expires_at str ISO 8601 expiry timestamp for the session.
device_type str Echo of the requested device type.

从机器人中心.session进口SessionManager

会议管理员 (mgr) 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间: 时间 打印(会议["深度_链接"]) T98

们们都在们的们里.

检索现有会议的当前元数据.

Parameter Type Description
session_id str The session ID returned by create_session() or rc session.

返回 T52 会议的元数据包括状态,集数,流媒体状态和深度链接.如果会议不存在,则增加T53.

直接集成

平台 REST API

下面的REST终端点是SDK使用的 HTTP API.当Python SDK不合适时,使用它们进行直接集成 (例如非Python代理,嵌入式系统或服务器侧编排).

所有终端点都与T54相对.验证使用T55或在T56标题中的API键.

电话会议

  • 创建一个新的SDK会议. 身体: T57
  • 获取 /api/teleop/sessions/{id}/sdk-info 获取现有会议的会议元数据,流媒体状态和WebSocket URL.

管道 L1

  • 开始一个数据处理管道启动一个L1会议. 返回一个T58.
  • 检查一个会议的处理管道状态.
  • 通过管道ID获取全管道运行详情,包括每个阶段状态和输出文物.
  • 标准/高效/研究级 (标准/高效/研究级) 处理级配置列表.

配置

环境变量

Variable Default Description
RC_PLATFORM_URL https://platform.roboticscenter.ai Backend URL used by SessionManager and all CLI commands. Override for self-hosted or staging deployments.

子设置: T61 或在项目根中放置一个 T62文件,如果安装,SDK使用 T63.

硬件

支持设备

Device --device flag Protocol Status
LinkerBot O6 linker-o6 USB Serial — RCSV AA55 header, 921600 baud Production
VLAI L1 l1 ROS2 / CAN-FD Production

每个版本中都会添加更多设备.查看T67输出,查看动态发现的硬件,或者查看[LinkerBot O6硬件指南]T95) 查看设备特定的设置说明.

机器人技术新吗 这是一个SDK集成器的技术API参考.如果你正在学习机器人技术的基础知识手臂,电话,模拟,ROS 2 首先访问[RCSV机器人学院]T96.