参考指南 User 接口
Fourier-GRX User 接口使用 zenoh 进行通信,zenoh 是一个分布式系统的数据共享和协作平台 (https://zenoh.io/)。
User 接口主要分为以下4类:
comm
:通信相关信息 robot
:机器人状态信息 task
:任务相关信息 grx
:fourier-grx 库相关信息,通用机器人相关内容(主要是人形)
对应的 zenoh 接口 topic 的 key 格式为:
- key 可以是 [“comm”, “robot”, “task”, “grx”]
fourier-grx/dynalink_interface/{key}/server
:机器人主控程序发出的状态信息 [机器人作为服务器] fourier-grx/dynalink_interface/{key}/client
:机器人主控程序接收的指令信息 [用户机作为客户端]
状态信息
comm/server 接口协议 (状态信息)
key 说明列表:
key | 说明 | 数据类型 | 具体描述 |
flag_heart_beat | 心跳标志 | bool | 1: 机器人已启动 |
robot/server 接口协议 (状态信息)
key 说明列表:
key | 说明 | 数据类型 | 具体描述 |
sensor_usb_imus_quat_value | 传感器 IMU 数据 | array(float, float, float, float) | 传感器 IMU 数据,四元数表示姿态,顺序为 x, y, z, w |
sensor_usb_imus_euler_value | 传感器 IMU 数据 | array(float, float, float) | 传感器 IMU 数据,欧拉角表示姿态,顺序为 roll, pitch, yaw |
sensor_usb_imus_ang_vel_value | 传感器 IMU 数据 | array(float, float, float) | 传感器 IMU 数据,角速度表示姿态,顺序为 x, y, z |
sensor_usb_imus_lin_acc_value | 传感器 IMU 数据 | array(float, float, float) | 传感器 IMU 数据,线加速度表示姿态,顺序为 x, y, z |
key | 说明 | 数据类型 | 具体描述 |
actuator_measured_position | 电机位置 | array(float) | 电机测量位置,单位为角度 |
actuator_measured_velocity | 电机速度 | array(float) | 电机测量速度,单位为角度/秒 |
actuator_measured_kinetic | 电机力矩 | array(float) | 电机测量力矩,单位为牛顿米 |
actuator_measured_current | 电机电流 | array(float) | 电机测量电流,单位为安培 |
actuator_output_position | 电机位置 | array(float) | 电机指令位置,单位为角度 |
actuator_output_velocity | 电机速度 | array(float) | 电机指令速度,单位为角度/秒 |
actuator_output_kinetic | 电机力矩 | array(float) | 电机指令力矩,单位为牛顿米 |
actuator_output_current | 电机电流 | array(float) | 电机指令电流,单位为安培 |
key | 说明 | 数据类型 | 具体描述 |
joint_measured_position | 关节位置 | array(float) | 关节测量位置,单位为角度 |
joint_measured_velocity | 关节速度 | array(float) | 关节测量速度,单位为角度/秒 |
joint_measured_kinetic | 关节力矩 | array(float) | 关节测量力矩,单位为牛顿米 |
joint_measured_current | 关节电流 | array(float) | 关节测量电流,单位为安培 |
joint_output_position | 关节位置 | array(float) | 关节指令位置,单位为角度 |
joint_output_velocity | 关节速度 | array(float) | 关节指令速度,单位为角度/秒 |
joint_output_kinetic | 关节力矩 | array(float) | 关节指令力矩,单位为牛顿米 |
joint_output_current | 关节电流 | array(float) | 关节指令电流,单位为安培 |
task/server 接口协议 (状态信息)
key 说明列表:
key | 说明 | 数据类型 | 具体描述 |
flag_task_in_process | 任务是否在进行中 | bool | 0: 任务未开始或已结束,1: 任务进行中 |
robot_task_state | 机器人任务状态 | int | 当前机器人任务状态,如果设置了 task/client 中的 flag_task_command_update 为 True,会更新此值,更新值为 robot_task_command |
robot_task_substate | 机器人任务子状态 | int | |
grx/server 接口协议 (状态信息)
key 说明列表:
key | 说明 | 数据类型 | 具体描述 |
fourier_core_version | 核心库版本 | string | 核心库版本号 |
fourier_grx_version | GRX库版本 | string | GRX库版本号 |
robot_error_codes | 机器人错误码 | int | 机器人错误码,0: 无错误,其他: 具体错误码 |
指令信息
comm/client 接口协议 (指令信息)
key 说明列表:
robot/client 接口协议 (指令信息)
key 说明列表:
task/client 接口协议 (指令信息)
任务指令发送接口如下,发送指令时要求按照以下流程执行:
- 任务指令发送:
- 发送 robot_task_command 和 robot_task_command_data,任务相关信息
- 发送 flag_task_command_update 指令更新标志位,确认更新任务指令
- 模块指令发送:
- 发送 robot_component_command 和 robot_component_command_data,模块相关信息
- 发送 flag_component_command_update 指令更新标志位,确认更新模块指令
key 说明列表:
key | 说明 | 数据类型 | 具体描述 |
flag_task_command_update | 任务指令请求更新标志 | bool | 0: 不更新,1: 更新 |
robot_task_command | 任务指令 | int | 机器人 任务值 (TID) |
robot_task_command_data | 任务指令数据 | dict | 机器人任务指令数据 |
flag_component_command_update | 模块指令请求更新标志 | bool | 0: 不更新,1: 更新 |
robot_component_command | 模块指令 | int | 机器人 模块值 (MID) |
robot_component_command_data | 模块指令数据 | dict | 机器人模块指令数据 |
grx/client 接口协议 (指令信息)
key 说明列表:
- 为规范用户的高层控制指令传入,对输入参数进行了封装和抽象。主要定义了“虚拟外设”的概念来进行机器人的控制。
- 虚拟摇杆 (virtual joystick)
- 虚拟键盘 (virtual keyboard)
- 虚拟鼠标 (virtual mouse)
- 虚拟遥操作手柄 (virtual teleoperation)
- 虚拟用户 (virtual user) 用于存储用户信息
- 虚拟面板 (virtual panel) 用于更通用的信息输入
- 在需要使用到对应虚拟设备时,需要在主程序启动时调用的
config_xxx.yaml
文件中,设置虚拟外设为 True
,如: peripheral/use_virtual_joystick
peripheral/use_virtual_keyboard
peripheral/use_virtual_mouse
peripheral/use_virtual_teleoperation
peripheral/use_virtual_user
peripheral/use_virtual_panel
- 一个任务可能允许使用多个虚拟外设进行控制,但是由于输入数据的唯一性,外设之间输入数据会互相覆盖,因此,建议用户参看具体任务中关于外设数据优先级的说明。
key | 说明 | 数据类型 | 具体描述 |
virtual_joystick_button_up | 虚拟手柄上按钮状态 | int | 0: 未按下,1: 按下 |
virtual_joystick_button_down | 虚拟手柄下按钮状态 | int | 0: 未按下,1: 按下 |
virtual_joystick_button_left | 虚拟手柄左按钮状态 | int | 0: 未按下,1: 按下 |
virtual_joystick_button_right | 虚拟手柄右按钮状态 | int | 0: 未按下,1: 按下 |
virtual_joystick_button_l1 | 虚拟手柄 L1 按钮状态 | int | 0: 未按下,1: 按下 |
virtual_joystick_button_l2 | 虚拟手柄 L2 按钮状态 | int | 0: 未按下,1: 按下 |
virtual_joystick_button_r1 | 虚拟手柄 R1 按钮状态 | int | 0: 未按下,1: 按下 |
virtual_joystick_button_r2 | 虚拟手柄 R2 按钮状态 | int | 0: 未按下,1: 按下 |
virtual_joystick_axis_left | 虚拟手柄左摇杆状态 | array(float, float) | 摇杆状态值范围为 [-1.0, 1.0] |
virtual_joystick_axis_right | 虚拟手柄右摇杆状态 | array(float, float) | 摇杆状态值范围为 [-1.0, 1.0] |
key | 说明 | 数据类型 | 具体描述 |
virtual_keyboard_key_up | 虚拟键盘上键状态 | int | 0: 未按下,1: 按下 |
virtual_keyboard_key_down | 虚拟键盘下键状态 | int | 0: 未按下,1: 按下 |
virtual_keyboard_key_left | 虚拟键盘左键状态 | int | 0: 未按下,1: 按下 |
virtual_keyboard_key_right | 虚拟键盘右键状态 | int | 0: 未按下,1: 按下 |
virtual_keyboard_key_enter | 虚拟键盘回车键状态 | int | 0: 未按下,1: 按下 |
virtual_keyboard_key_esc | 虚拟键盘 ESC 键状态 | int | 0: 未按下,1: 按下 |
virtual_keyboard_key_f1 | 虚拟键盘 F1 键状态 | int | 0: 未按下,1: 按下 |
virtual_keyboard_key_f2 | 虚拟键盘 F2 键状态 | int | 0: 未按下,1: 按下 |
virtual_keyboard_key_f3 | 虚拟键盘 F3 键状态 | int | 0: 未按下,1: 按下 |
virtual_keyboard_key_f4 | 虚拟键盘 F4 键状态 | int | 0: 未按下,1: 按下 |
virtual_keyboard_key_q | 虚拟键盘 Q 键状态 | int | 0: 未按下,1: 按下 |
virtual_keyboard_key_w | 虚拟键盘 W 键状态 | int | 0: 未按下,1: 按下 |
virtual_keyboard_key_e | 虚拟键盘 E 键状态 | int | 0: 未按下,1: 按下 |
virtual_keyboard_key_a | 虚拟键盘 A 键状态 | int | 0: 未按下,1: 按下 |
virtual_keyboard_key_s | 虚拟键盘 S 键状态 | int | 0: 未按下,1: 按下 |
virtual_keyboard_key_d | 虚拟键盘 D 键状态 | int | 0: 未按下,1: 按下 |
key | 说明 | 数据类型 | 具体描述 |
virtual_mouse_button_left | 虚拟鼠标左键状态 | int | 0: 未按下,1: 按下 |
virtual_mouse_button_right | 虚拟鼠标右键状态 | int | 0: 未按下,1: 按下 |
virtual_mouse_button_middle | 虚拟鼠标中键状态 | int | 0: 未按下,1: 按下 |
virtual_mouse_axis | 虚拟鼠标坐标状态 | array(int, int) | 鼠标坐标值,单位为像素,格式为 [x, y] |
key | 说明 | 数据类型 | 具体描述 |
virtual_teleoperation_left_handle_pose | 虚拟遥操作手柄左手柄姿态 | array(float, float, float,float,float,float,float) | |
virtual_teleoperation_right_handle_pose | 虚拟遥操作手柄右手柄姿态 | array(float, float, float,float,float,float,float) | |
virtual_teleoperation_button_left | 虚拟遥操作手柄左手柄按钮状态 | int | 0: 未按下,1: 按下 |
virtual_teleoperation_button_right | 虚拟遥操作手柄右手柄按钮状态 | int | 0: 未按下,1: 按下 |
key | 说明 | 数据类型 | 具体描述 |
virtual_user_upper_leg_length_left | 左上肢长度 | float | 单位为米,默认值为 0.5 |
virtual_user_upper_leg_length_right | 右上肢长度 | float | 单位为米,默认值为 0.5 |
virtual_user_lower_leg_length_left | 左下肢长度 | float | 单位为米,默认值为 0.5 |
virtual_user_lower_leg_length_right | 右下肢长度 | float | 单位为米,默认值为 0.5 |
virtual_user_upper_arm_length_left | 左上臂长度 | float | 单位为米,默认值为 0.5 |
virtual_user_upper_arm_length_right | 右上臂长度 | float | 单位为米,默认值为 0.5 |
virtual_user_lower_arm_length_left | 左下臂长度 | float | 单位为米,默认值为 0.5 |
virtual_user_lower_arm_length_right | 右下臂长度 | float | 单位为米,默认值为 0.5 |
key | 说明 | 数据类型 | 具体描述 |
virtual_panel_command_param_1 | 面板命令参数1 | float | 面板命令参数1,具体含义由任务决定 |
virtual_panel_command_param_2 | 面板命令参数2 | float | 面板命令参数2,具体含义由任务决定 |
virtual_panel_command_param_3 | 面板命令参数3 | float | 面板命令参数3,具体含义由任务决定 |
virtual_panel_command_param_4 | 面板命令参数4 | float | 面板命令参数4,具体含义由任务决定 |
virtual_panel_command_param_5 | 面板命令参数5 | float | 面板命令参数5,具体含义由任务决定 |
virtual_panel_command_switch_1 | 面板命令开关1 | bool | 0: 不开,1: 开,具体含义由任务决定 |
virtual_panel_command_switch_2 | 面板命令开关2 | bool | 0: 不开,1: 开,具体含义由任务决定 |
virtual_panel_command_switch_3 | 面板命令开关3 | bool | 0: 不开,1: 开,具体含义由任务决定 |
virtual_panel_command_switch_4 | 面板命令开关4 | bool | 0: 不开,1: 开,具体含义由任务决定 |
virtual_panel_command_switch_5 | 面板命令开关5 | bool | 0: 不开,1: 开,具体含义由任务决定 |
virtual_panel_command_picker_1 | 面板命令选择器1 | int | 面板命令选择器1,具体含义由任务决定 |
virtual_panel_command_picker_2 | 面板命令选择器2 | int | 面板命令选择器2,具体含义由任务决定 |
virtual_panel_command_picker_3 | 面板命令选择器3 | int | 面板命令选择器3,具体含义由任务决定 |
virtual_panel_command_start | 面板命令开始标志 | bool | 0: 不开始,1: 开始,具体含义由任务决定 |
virtual_panel_command_stop | 面板命令停止标志 | bool | 0: 不停止,1: 停止,具体含义由任务决定 |
virtual_panel_command_pause | 面板命令暂停标志 | bool | 0: 不暂停,1: 暂停,具体含义由任务决定 |