启动配置文件

启动配置文件是 Fourier-GRX SDK 中用于配置机器人的启动参数的文件。用户可以通过修改该文件来实现对机器人的个性化配置。

启动配置文件的路径

启动 fourier-grx 时,需要通过 --config 参数指定启动配置文件的路径。 在使用 fourier-grx start 启动机器人时,具体使用的配置文件信息可以在 ~/fourier-grx/run.sh 文件中找到。

默认情况下,fourier-grx 针对 FourierN1 机器人的启动配置文件位于 ~/fourier-grx/config/n1/ 目录下。

启动时使用哪个配置文件,取决于 run.sh 文件中的 robot_type, robot_versionrun_type 字段。 这些字段的值既可以通过 fourier-grx config 命令行工具进行修改,也可以直接在 run.sh 文件中修改。

比如,如果用户希望启动自定义的机器人配置文件 config_N1__custom.yaml,可以在 run.sh 文件中将 run_type 字段修改为 custom

robot_type="N1"
robot_version=""

run_type="custom"

# 此时,用 fourier-grx start 命令启动机器人时,将会使用 ~/fourier-grx/config/n1/config_N1__custom.yaml 作为配置文件。

启动配置文件的内容

启动配置文件是一个 YAML 格式的文件,包含了机器人的各种配置参数。以下是一些常见的配置项:

日志相关

配置项 说明 数据类型 默认值 可选项 用户可修改
log_config 是否打印启动配置信息 boolean false true, false
log_level 日志级别 string “none” “none”, “trace”, “debug”, “warning”, “error”
log_file 日志文件路径存储路径,仅针对日志中特定打印到日志文件中的内容 string ”” “filename”, null

控制系统相关

配置项 说明 数据类型 默认值 可选项 用户可修改
device_connected 是否连接设备 boolean true true, false
hardware_type 硬件类型 string “X64”  
system 系统类型 string “LINUX”  
mode 运行模式 string “debug” “debug”, “release”

调试相关

配置项 说明 数据类型 默认值 可选项 用户可修改
debug: print_imu_state 是否打印 IMU 原始状态信息 boolean false true, false
debug: print_joint_position_state 是否打印 关节 原始位置状态信息 boolean false true, false
debug: print_joint_velocity_state 是否打印 关节 原始速度状态信息 boolean false true, false
debug: print_joint_kinetic_state 是否打印 关节 原始力矩状态信息 boolean false true, false
debug: print_joint_current_state 是否打印 关节 原始电流状态信息 boolean false true, false
debug: print_imu_urdf_state 是否打印 IMU 对应 URDF 文件位姿状态信息 boolean false true, false
debug: print_joint_urdf_position_state 是否打印 关节 对应 URDF 文件位姿位置状态信息 boolean false true, false
debug: print_peripheral_virtual_joystick 是否打印 外设 虚拟摇杆状态信息 boolean false true, false
debug: print_peripheral_virtual_teleoperation 是否打印 外设 虚拟遥操作状态信息 boolean false true, false

子功能模块相关

配置项 说明 数据类型 默认值 可选项 用户可修改
dynalink: enable 是否启用 动态连接数据传输功能 boolean false true, false
sync: enable 是否启用 数据同步功能(需要 dynalink:enable=true) boolean false true, false 否 (暂未开放使用)
rerun: enable 是否启用 rerun 绘图功能(需要 dynalink:enable=true) boolean false true, false
streamlit: enable 是否启用 streamlit 绘图功能(需要 dynalink:enable=true) boolean false true, false 否 (暂未开放使用)
comm: enable 是否启用 旧版通信适配功能(需要 dynalink:enable=true) boolean false true, false 否 (暂未开放使用)
teleoperation: enable 是否启用 遥操作功能(需要 dynalink:enable=true) boolean false true, false 是 (请联系技术支持进行使用)
pubsub: enable 是否启用 发布订阅功能,用于将机器人程序作为服务器,远程启动控制器作为客户端使用 boolean false true, false

资源文件相关

配置项 说明 数据类型 默认值 可选项 用户可修改
resource: path 资源文件路径 string ”~/fourier-grx/resource/n1” “path/to/resource”
zenoh: path Zenoh 配置文件路径 string ”~/fourier-grx/resource/zenoh” “path/to/zenoh” 否 (暂未开放使用)
record: enable 是否启用 数据日志记录功能(记录关节位置、速度等信息,方便调试,需要 dynalink:enable=true ) boolean false true, false
record: path 数据日志记录文件路径 string ”~/fourier-grx/record/n1” “path/to/record_file”

外设相关

配置项 说明 数据类型 默认值 可选项 用户可修改
peripheral: use_joystick 是否使用手柄控制 boolean false true, false
peripheral: joystick_type 手柄类型 string “XBOX” “XBOX”, “PS4”, “PS5”
peripheral: use_keyboard 是否使用键盘控制 boolean false true, false
peripheral: keyboard_type 键盘类型 string “NORMAL” “NORMAL”
peripheral: use_virtual_joystick 是否使用虚拟手柄控制 boolean false true, false
peripheral: use_virtual_keyboard 是否使用虚拟键盘控制 boolean false true, false
peripheral: use_virtual_mouse 是否使用虚拟鼠标控制 boolean false true, false
peripheral: use_virtual_teleoperation 是否使用虚拟遥操作控制 boolean false true, false
peripheral: use_virtual_panel 是否使用虚拟面板控制 boolean false true, false

机器人相关

配置项 说明 数据类型 默认值 可选项 用户可修改
robot: name 机器人名称 string “N1” “N1”
robot: mechanism 机器人机械结构类型 string ”” ””
robot: control_period 控制周期 float 0.02 单位为秒
robot: communication_period 通信周期 float 0.02 单位为秒

传感器相关

配置项 说明 数据类型 默认值 可选项 用户可修改
sensor_usb_imu: usb IMU 传感器对应的 USB 设备路径 array(string) [“/dev/ttyUSB0”, …] “/path/to/USB” 是(谨慎修改)
sensor_usb_imu: comm_enable 是否启用 USB IMU 传感器通信 array(boolean) [true, …] true, false 是(谨慎修改)
sensor_usb_imu: comm_frequency USB IMU 传感器通信频率,单位为 Hz array(float) [500.0, …]   是(谨慎修改)

执行器相关

配置项 说明 数据类型 默认值 可选项 用户可修改
actuator: comm_enable 是否启用执行器通信 array(boolean) [true, …] true, false 是(谨慎修改)
配置项 说明 数据类型 默认值 可选项 用户可修改
fi_fsa: version FSA 库版本号 string “v2_async”