LeRobot documentation

远程操作员

You are viewing main version, which requires installation from source. If you'd like regular pip install, checkout the latest stable version (v0.6.1).
Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

远程操作员

遥操作者生成供机器人执行的动作——例如主臂、游戏手柄、键盘或手机。它们都实现了 Teleoperator 接口,因此针对该接口编写的录制脚本可适用于任何输入设备。

请参阅 手机遥操作 和 Isaac Teleop 了解设置指南,以及 机器人模仿学习 了解录制工作流。对于核心集之外的社区维护设备,请参阅 第三方机器人与遥操作器。若要添加您自己的遥操作器,请参阅 使用您自己的硬件。

遥操作员

类 lerobot.teleoperators.Teleoperator

< >

( config: TeleoperatorConfig )

参数

  • config_class (RobotConfig) — 此遥操作器预期的配置类。
  • name (str) — 用于标识此遥操作类型的唯一名称。

所有兼容 LeRobot 的遥操作设备的基础抽象类。

此类为与物理遥操作器交互提供了标准化接口。 子类必须实现所有抽象方法和属性才能被使用。

连接

< >

( calibrate: bool = True )

参数

  • calibrate (bool) — 如果为 True,则在连接后,如果遥操作器尚未校准或需要校准,则自动对其进行校准(这取决于硬件)。

与遥操作员建立通信。

断开连接

< >

( )

断开与遥操作器的连接,并执行任何必要的清理工作。

配置

< >

( )

对遥操作器应用任何一次性或运行时配置。 这可能包括设置电机参数、控制模式或初始状态。

calibrate

< >

( )

如有必要,请校准遥操作器。如果没有,此操作应为空操作。

此方法应收集任何必要的数据(例如,电机偏移量),并相应地更新 :pyattr:calibration 字典。

get_action

< >

( ) → RobotAction

返回值

RobotAction

一个扁平字典,表示遥操作者当前的操作。其结构应与 :pymeth:observation_features 相匹配。

从遥操作员处获取当前操作。

发送反馈

< >

( feedback: dict ) → dict[str, Any]

参数

  • feedback (dict[str, Any]) — 表示所需反馈的字典。其结构应与 :pymeth:feedback_features 相匹配。

返回值

dict[str, Any]

实际发送到电机的动作,可能会经过裁剪或修改,例如通过速度安全限制。

向遥操作员发送反馈操作命令。

action_features

< >

( )

一个字典,用于描述遥操作器生成的动作的结构和类型。其结构(键)应与 :pymeth:get_action 返回的内容的结构相匹配。如果值是简单值,则字典中的值应为该值的类型,例如,对于单个本体感觉值(关节的目标位置/速度),类型为 float

注意:无论机器人是否已连接,都应能够调用此属性。

feedback_features

< >

( )

一个描述机器人所期望的反馈动作结构和类型的字典。其结构(键)应与传递给 :pymeth:send_feedback 的内容的结构相匹配。如果值是简单值,则字典中的值应为该值的类型,例如,对于单个本体感觉值(关节的目标位置/速度),类型为 float

注意:无论机器人是否已连接,都应能够调用此属性。

is_connected

< >

( )

遥操作者当前是否已连接。如果为 False,调用 :pymeth:get_action 或 :pymeth:send_feedback 时应抛出错误。

is_calibrated

< >

( )

遥操作器当前是否已校准。如果不适用,则应始终为 True

TeleoperatorConfig

类 lerobot.teleoperators.TeleoperatorConfig

< >

( id: str | None = Nonecalibration_dir: pathlib.Path | None = None )

make_teleoperator_from_config

lerobot.teleoperators.make_teleoperator_from_config

< >

( config: TeleoperatorConfig )

Update on GitHub