Wikiに戻る

ロボティクスセンター SDK <unk> Python API参照

ロボティクスセンター SDK の Python API 参照: LinkerO6, L1Robot, SessionManager, SensorFrame クラス, rc CLI コマンド, REST エンドポイント. pip ロボティクスセンターをインストールする.

スタートする

  • T68
  • [CLI コマンド]
  • [パッケージ輸入]

クラス リンクERO6

  • [接続 ] ] ]
  • 流出する
  • 停止する
  • [属性] T74

クラス L1ロボット

  • 関連付け (T75)
  • 流出する
  • 停止する
  • [センサフレーム.データ]

クラス センサーフレーム

  • [属性]

クラス セッションマネージャー

  • T81) T81)
  • 会議は, 会議の時間

REST API

  • [テレオップセッション]
  • [L1パイプライン]

参照

  • [環境変数]
  • [サポートされたデバイス]

ウィキナビゲーション

  • [←すべての記事]
  • [SDK クイックスタート]
  • [セッションのURL&Teleop]
  • [VLAI L1ガイド]
  • [リンクボットO6ガイド ]

参照

Python パッケージの完全な参照.すべての公開クラス,方法,属性, CLI コマンド, REST エンドポイント,環境変数をカバーする.

パッケージ: T1 パイトン: 3.9+ インストール: T2

Python SDK リンクERO6 L1 ロボット セッションマネージャ REST API

概要

概要

T3 SDKは,ロボット機器をロボットセンタープラットフォームに接続し,センサーデータをストリーミングし,遠隔操作セッションを管理し,エピソード録音をアップロードする主なインターフェースである. 迅速なデバイス接続のためのCLI (T4) とカスタムデータ収集パイプラインのためのPython APIを搭載する.

すべてのデバイスクラスは T5から継承され,同じ T6 / T7インターフェースを暴露し,ハードウェア不認識のコレクションスクリプトを書くことが容易になります.

コマンドラインインターフェース

CLI コマンド

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 ロボティクスセンター.セッションインポート SessionManager ロボティクスセンター.フレームからインポート SensorFrame

クラス

リンクERO6

クラス リンクERO6(ベースデバイス)

ドライバーはLinkerBot O6の手動システムです.USBシリアルフレーム (RCSV T14プロトコルで921600 baud),パケット認証,セッション作成,左と右の両手でリアルタイムフレームストリーミングを同時に処理します.

クラスメソッド LinkerO6.connect ポート=None, mock=False) → LinkerO6

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.connect (リンクERO6.接続) ポートを明示して 装置 = LinkerO6.connect ((port="/dev/ttyUSB0") #または偽モード: 装置 = LinkerO6.connect(mock=True)

装置.ストリーム() → 逆行器[センサフレーム]

装置から到着する際に,受動センサーフレームをブロックする. T23が呼び出されるまでブロックする.またはデバイスが断つ.各フレームには左手と右手状態の瞬時に収録される.

Parameter Type Description
No parameters.

T25形: T26.値が正常化される 0.0 (開いている) から 1.0 (完全に閉ざされている)

装置.ストリームにおけるフレーム ( frame) において: 図表は,Figure.data.get (Figure.data.get) フレーム.データ.Get (右) print(f"Lインデックス: {left.get('index', 0):.3f} Rインデックス: {right.get('index', 0):.3f}")

装置.停止() → 存在しない

ストリーミングを停止し,シリアル接続を閉じる. 何度も電話する安全. 自律的にバッファリングフレームをフローッシュし,当時の録音エピソードを終了します.

属性

接続時に割り当てられたプラットフォームセッションIDはありません. T27 セッションが作成されていない場合.

デバイス.セッション_url str 〇 無 直接の電波パネルのブラウザのURLは全部ありません.例えば T28.

装置.ポート str 装置が接続されているシリアルポートパス.例えば T29.模擬モードでは: T30.

デバイス.デバイス_type str "linker_o6"

デバイス.デバイス_ファミリー str "dexhand"

クラス

L1ロボット

クラス L1ロボット(ベースデバイス)

VLAI L1 モバイル操作機のドライバー. ROS2 / CAN-FDを通じて通信する. ストリーム関節状態,グリッパー位置,ベース速度,リフト高度,バッテリーパーセント,カメラ利用可能.

クラスメソッド L1Robot.connect ポート=None,偽=偽) → L1Robot

L1 ロボットに接続して接続されたデバイスインスタンスを返します.ハードウェアモードでは,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 の センサーフレーム.データ構造

L1Robotフレームの T38辞書には以下の形があります.

やってみよう "関節" "左_arm": [j1, j2, j3, j4, j5, j6, j7], #度, 7-DOF "右_arm": [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, # yaw rate,rad/s ♪ "リフト_高度_mm": 1060, 千米でトーソリフト高度 "バッテリー_pct": 85.0, #充電状態,0.0100.0 "カメラ" "胸" は true, # true カメラのストリームがアクティブである場合 "左腕"は偽物 "右腕"は偽物 ♪ やってみよう

クラス

センサーフレーム

クラス センサーフレーム

デバイスから単一のタイムスタンプ読み込み. T39で返済. すべての属性は読み込みのみです.

属性

frame.timestamp float 装置にフレームが撮影された瞬間微秒分辨率を持つUnix epoch timestamp.

frame.device_id str プラットフォームデバイス識別子.LinkerBot O6 T40.

frame.device_type str SDKデバイスタイプ文字列.LinkerBot O6: T41.VLAI L1: T42.

frame.data dict 構造化されたセンサーの有用荷. 装置タイプによってスケーマが異なります.

frame.raw bytes デバイスから受信されたオリジナルワイヤルフォーマットパケットバイト.エピソード録音で文字どおりアーカイブ.

クラス

セッション管理者

クラス セッションマネージャー

プラットフォームセッション 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.

mgr.create_session(device_type, device_id=None, hardware_serial=None) → dict

プラットフォームで新しい遠隔操作セッションを作成します. ストリーミングを開始し,ブラウザパネルを開くために必要なすべての認証を返します.

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.

ロボティクスセンター.セッションインポート SessionManager

mgr =セッションマネージャー (※) 接続器\o6",ハードウェア_serial="LBO6-001") プリント・セッション (深度リンク) T98

mgr.get_session_info(session_id) → dict

既存のセッションの現在のメタデータを取得する.

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 エージェント,埋め込みシステム,またはサーバーサイドオーケストレーション) を直接統合するために使用する.

認証は, T55または API キーを使用して, T56 ヘッダーを使用します.

テレオップセッション

  • POST /api/teleop/session/create-sdk 新しいSDKセッションを作成する.
  • GET /api/teleop/sessions/{id}/sdk-info 既存のセッションのセッションメタデータ,ストリーミング状態,WebSocket URLを取得する.

L1パイプライン

  • POST /api/l1/sessions/{id}/pipeline/start L1セッションでデータ処理パイプラインを起動します. T58を返します.
  • 処理パイプラインの状態をセッションで調査する.
  • 管道IDによってパイプラインの全般な実行詳細を入手し,各段階の状態と出力アーテファクトを含む.
  • GET /api/l1/tier 処理レベル構成の利用可能リスト (標準/高信頼性/研究グレード).

構成

環境変数

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 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 ロボティクスアカデミー に訪問してください. 5分間のインストールガイドについては,SDK 素早いスタート](T97 を参照してください.