Studio API
Studio接口概述:
Studio通信协议:
websoket:ws://{ip}:18333/ws
http/1.1:http://{ip}:18333
通信流程图:
front_end:前端(用户操作界面)
Background:后端(封装xArm-Python-SDK)
Controller:控制器
Robot:机械臂
uxbus:UFACTORY自定义协议(控制器与电机通信)
u_modbus_tcp:UFACTORY自定义协议(PC与控制器通信)
Externals:外接设备,例如BIO机械爪、xArm真空吸头、xArm机械爪等
Studio_API 说明
Studio接口概述:
Studio通信协议:
websoket:ws://{ip}:18333/ws
http/1.1:http://{ip}:18333
通信流程图:
front_end:前端(用户操作界面)
Background:后端(封装xArm-Python-SDK)
Controller:控制器
Robot:机械臂
uxbus:UFACTORY自定义协议(控制器与电机通信)
u_modbus_tcp:UFACTORY自定义协议(PC与控制器通信)
Externals:外接设备,例如BIO机械爪、xArm真空吸头、xArm机械爪等
上报数据说明:
建立websocket连接后,后端会持续上报机械臂实时状态,以下是上报参数解析
Websoket协议
实时控制_API:
xarm_move_step
xarm_move_step_over
xarm_move_joint
switch_mode_lite6
xarm_urgent_stop
xarm_set_simulation_robot
xarm_set_lite6_gripper
xarm_set_speed
xarm_switch_mode
Blockly_API:
xarm_set_blockly_init
run_blockly
xarm_move_arc_line
xarm_move_circle
app_create_file
app_save_info
get_app_info
get_app_xml_data
Python IDE:
ide_list_projects
ide_get_project
ide_create_project
ide_delete_project
ide_rename_project
ide_save_project
ide_create_file
ide_to_python_allow
ide_blockly_to_python
ide_write_file
ide_get_file
ide_delete_file
ide_rename_file
ide_create_folder
ide_delete_folder
ide_rename_folder
run_python_program
stop_python_program
设置_API:
xarm_set_cgpio_digital
xarm_set_cgpio_analog
xarm_set_gpio_digital
xarm_set_suction_cup
xarm_set_motion_config
xarm_set_effector_modbus_rtu_cmd
get_tcp_offset_load_config
set_tcp_load_offset_configs
remove_tcp_load_offset_configs
associate_tcp_offset_load
xarm_start_identification
xarm_stop_identification
xarm_get_reduced_states
xarm_get_approx_motion(获取规避奇异点是否开启)
xarm_config_gpio_reset_when_stop(当机械臂停止的时候重置控制器和末端io状态接口)
xarm_set_collision_rebound(设置碰撞回弹参数接口)
xarm_set_self_collision_detection(设置自碰撞检测开关)
xarm_set_jerk(设置关节加加速度和Tcp加加速度接口)
xarm_get_joint_pi(获取关节PID参数)
xarm_factory_reset(恢复出厂设置)
xarm_start_report_gpio_digital(获取末端数字、模拟量IO)
xarm_stop_report_gpio_digital(停止获取末端数字、模拟量IO)
get_gpio_config(获取控制器数字IO触发的相应操作)
set_gpio_config(设置控制器数字IO触发的相应操作)
xarm_set_stop_loop(停止modabus循环发送)
xarm_set_modbus_baud_rate(设置modbus波特率)
xarm_get_end_io_info(获取modbus配置信息)
xarm_set_user_config(设置辅助功能信息)
xarm_save_config(保存设置)
xarm_get_ft_sensor_mode(查询力矩传感器手动模式)
xarm_get_ft_sensor_info(获取力矩传感器信息)
get_world_offset_config(获取坐标系数据)
set_world_offset_configs(设置坐标系数据)
xarm_set_mount_direction(设置安装方向)
xarm_set_reduced_max_joint_speed(设置缩减模式的最大关节速度)
xarm_set_reduced_max_tcp_speed(设置缩减模式的最大tcp速度)
xarm_set_reduced_joint_range(设置缩减模式的关节运动范围)
xarm_set_reduced_mode(开启/关闭缩减模式)
xarm_set_reduced_tcp_boundary(设置缩减模式的安全边界)
xarm_set_fense_mode(设置缩减模式安全边界开启)
通用:
xarm_clear_error_warn
\
HTTP协议:
下载上传_API:
下载blockly文件
导入blockly文件
导出机械臂参数文件
通用:
加载机械臂参数文件
Last updated