Python:
通讯内容配置CommunicationConfig
机械臂控制器可通过网口、WIFI、RS232-USB 接口和 RS485 接口与用户通信,用户使用时无需切换,可使用上述任一接口, 控制器收到指令后,若指令格式正确,则会通过相同的接口反馈数据。下面是配置通讯内容CommunicationConfig
的详细成员函数说明,包含了方法原型、参数说明、返回值说明和使用示例。
配置 wifiAP 模式rm_set_wifi_ap()
- 方法原型:
python
rm_set_wifi_ap(self, wifi_name: str, password: str) -> int:
- 参数说明:
名称 | 类型 | 说明 |
---|---|---|
wifi_name | str | wifi名称 |
password | str | wifi密码 |
- 返回值: 函数执行的状态码:
参数 | 类型 | 说明 |
---|---|---|
0 | int | 成功 |
1 | int | 控制器返回false,参数错误或机械臂状态发生错误。 |
-1 | int | 数据发送失败,通信过程中出现问题。 |
-2 | int | 数据接收失败,通信过程中出现问题或者控制器长久没有返回。 |
-3 | int | 返回值解析失败,接收到的数据格式不正确或不完整。 |
- 使用示例
python
from Robotic_Arm.rm_robot_interface import *
# 实例化RoboticArm类
arm = RoboticArm(rm_thread_mode_e.RM_TRIPLE_MODE_E)
# 创建机械臂连接,打印连接id
handle = arm.rm_create_robot_arm("192.168.1.18", 8080)
print(handle.id)
print(arm.rm_set_wifi_ap("robot", "12345678"))
arm.rm_delete_robot_arm()
配置WiFi STA模式rm_set_wifi_sta()
- 方法原型:
python
rm_set_wifi_sta(self, router_name: str, password: str) -> int:
- 参数说明:
名称 | 类型 | 说明 |
---|---|---|
router_name | str | 路由器名称 |
password | str | 路由器wifi密码 |
- 返回值: 函数执行的状态码:
参数 | 类型 | 说明 |
---|---|---|
0 | int | 成功 |
1 | int | 控制器返回false,参数错误或机械臂状态发生错误。 |
-1 | int | 数据发送失败,通信过程中出现问题。 |
-2 | int | 数据接收失败,通信过程中出现问题或者控制器长久没有返回。 |
-3 | int | 返回值解析失败,接收到的数据格式不正确或不完整。 |
- 使用示例
python
from Robotic_Arm.rm_robot_interface import *
# 实例化RoboticArm类
arm = RoboticArm(rm_thread_mode_e.RM_TRIPLE_MODE_E)
# 创建机械臂连接,打印连接id
handle = arm.rm_create_robot_arm("192.168.1.18", 8080)
print(handle.id)
print(arm.rm_set_wifi_sta("robot", "12345678"))
arm.rm_delete_robot_arm()
控制器RS485波特率设置rm_set_RS485()
设置成功后蜂鸣器响。
- 方法原型:
python
rm_set_RS485(self, baudrate: int) -> int:
- 参数说明:
名称 | 类型 | 说明 |
---|---|---|
baudrate | int | 波特率:9600,19200,38400,115200和460800,若用户设置其他数据,控制器会默认按照460800处理。 |
- 返回值: 函数执行的状态码
参数 | 类型 | 说明 |
---|---|---|
0 | int | 成功 |
1 | int | 控制器返回false,参数错误或机械臂状态发生错误。 |
-1 | int | 数据发送失败,通信过程中出现问题。 |
-2 | int | 数据接收失败,通信过程中出现问题或者控制器长久没有返回。 |
-3 | int | 返回值解析失败,接收到的数据格式不正确或不完整。 |
- 使用示例
python
from Robotic_Arm.rm_robot_interface import *
# 实例化RoboticArm类
arm = RoboticArm(rm_thread_mode_e.RM_TRIPLE_MODE_E)
# 创建机械臂连接,打印连接id
handle = arm.rm_create_robot_arm("192.168.1.18", 8080)
print(handle.id)
print(arm.rm_set_RS485(115200))
arm.rm_delete_robot_arm()
获取有线网卡信息rm_get_wired_net()
未连接有线网卡则会返回无效数据。
- 方法原型:
python
rm_get_wired_net(self) -> dict[str, any]:
- 返回值:
dict[str,any]
: 包含以下键值的字典
- 'return_code' (int): 函数执行的状态码
参数 | 类型 | 说明 |
---|---|---|
0 | int | 成功。 |
1 | int | 控制器返回false,参数错误或机械臂状态发生错误。 |
-1 | int | 数据发送失败,通信过程中出现问题。 |
-2 | int | 数据接收失败,通信过程中出现问题或者控制器长久没有返回。 |
-3 | int | 返回值解析失败,接收到的数据格式不正确或不完整。 |
- 网络地址
参数 | 类型 | 说明 |
---|---|---|
ip | str | 网络地址 |
mask | str | 子网掩码 |
mac | str | MAC地址 |
- 使用示例
python
from Robotic_Arm.rm_robot_interface import *
# 实例化RoboticArm类
arm = RoboticArm(rm_thread_mode_e.RM_TRIPLE_MODE_E)
# 创建机械臂连接,打印连接id
handle = arm.rm_create_robot_arm("192.168.1.18", 8080)
print(handle.id)
print(arm.rm_get_wired_net())
arm.rm_delete_robot_arm()
查询无线网卡网络信息rm_get_wifi_net()
- 方法原型:
python
rm_get_wifi_net(self) -> tuple[int, dict[str, any]]:
- 返回值:
dict[str,any]
: 包含以下键值的字典
return_code
(int): 函数执行的状态码
参数 | 类型 | 说明 |
---|---|---|
0 | int | 成功 |
1 | int | 控制器返回false,参数错误或机械臂状态发生错误。 |
-1 | int | 数据发送失败,通信过程中出现问题。 |
-2 | int | 数据接收失败,通信过程中出现问题或者控制器长久没有返回。 |
-3 | int | 返回值解析失败,接收到的数据格式不正确或不完整。 |
- 无线网络信息
参数 | 类型 | 说明 |
---|---|---|
rm_wifi_net_t | dict[str,any] | 无线网络信息字典,键为rm_wifi_net_t结构体的字段 |
- 使用示例
python
from Robotic_Arm.rm_robot_interface import *
# 实例化RoboticArm类
arm = RoboticArm(rm_thread_mode_e.RM_TRIPLE_MODE_E)
# 创建机械臂连接,打印连接id
handle = arm.rm_create_robot_arm("192.168.1.18", 8080)
print(handle.id)
print(arm.rm_get_wifi_net())
arm.rm_delete_robot_arm()
恢复网络出厂设置rm_set_net_default()
- 方法原型:
python
rm_set_net_default(self) -> int:
- 返回值: 函数执行的状态码:
参数 | 类型 | 说明 |
---|---|---|
0 | int | 成功 |
1 | int | 控制器返回false,参数错误或机械臂状态发生错误。 |
-1 | int | 数据发送失败,通信过程中出现问题。 |
-2 | int | 数据接收失败,通信过程中出现问题或者控制器长久没有返回。 |
-3 | int | 返回值解析失败,接收到的数据格式不正确或不完整。 |
- 使用示例
python
from Robotic_Arm.rm_robot_interface import *
# 实例化RoboticArm类
arm = RoboticArm(rm_thread_mode_e.RM_TRIPLE_MODE_E)
# 创建机械臂连接,打印连接id
handle = arm.rm_create_robot_arm("192.168.1.18", 8080)
print(handle.id)
print(arm.rm_set_net_default())
arm.rm_delete_robot_arm()
配置关闭 wifi 功能rm_set_wifi_close()
需要重启后生效。
- 方法原型:
python
rm_set_wifi_close(self) -> int:
- 返回值: 函数执行的状态码
参数 | 类型 | 说明 |
---|---|---|
0 | int | 成功 |
1 | int | 控制器返回false,参数错误或机械臂状态发生错误。 |
-1 | int | 数据发送失败,通信过程中出现问题。 |
-2 | int | 数据接收失败,通信过程中出现问题或者控制器长久没有返回。 |
-3 | int | 返回值解析失败,接收到的数据格式不正确或不完整。 |
- 使用示例
python
from Robotic_Arm.rm_robot_interface import *
# 实例化RoboticArm类
arm = RoboticArm(rm_thread_mode_e.RM_TRIPLE_MODE_E)
# 创建机械臂连接,打印连接id
handle = arm.rm_create_robot_arm("192.168.1.18", 8080)
print(handle.id)
print(arm.rm_set_wifi_close())
arm.rm_delete_robot_arm()