System Management
Capability overview
The system control module provides capabilities for managing robot operating modes and running status, and supports setting robot operating modes, entering or exiting SDK development mode, and performing an emergency stop of robot movement under abnormal conditions. It also supports obtaining device and system operating information such as robot model, device ID, software and hardware versions, power status, CPU and memory usage.
set_work_mode interface reference
| Field | Details |
|---|---|
| Function | set_work_mode() |
| Signature | def set_work_mode(robot_mode_param: RobotModeParam, timeout) -> ExecutionResult |
| Description | Set the robot work mode |
| Parameter | mode: RobotWorkMode - Work mode |
| Return Value | ExecutionResult |
| Notes | Work modes: IDLE: Idle mode; currently unsupported and returns an error when selected. INFERE: Inference mode; currently unsupported and returns an error when selected. COLLECT: Data collection mode; currently unsupported and returns an error when selected. SDK: SDK development mode; currently the only supported mode. Developers must set the robot to SDK mode before issuing control commands. If the client is disconnected for more than three seconds, the robot automatically exits SDK mode. |
Example:
mode_param = RobotModeParam(mode=RobotWorkMode.SDK)
result = robot.system.set_work_mode(mode_param)
print(result.is_success)get_static_info interface reference
| Field | Details |
|---|---|
| Function | get_static_info() |
| Signature | def get_static_info(timeout) -> RobotStaticInfo |
| Description | Get static robot information, including the model, device ID, software version, and hardware version |
| Parameter | None |
| Return Value | RobotStaticInfo |
| Notes | None |
Example:
result = robot.system.get_static_info()
print(result)get_dynamic_info interface reference
| Field | Details |
|---|---|
| Function | get_dynamic_info() |
| Signature | def get_dynamic_info(timeout) -> RobotDynamicInfo |
| Description | Get dynamic system information, including power status, CPU usage, and memory usage |
| Parameter | None |
| Return Value | RobotDynamicInfo |
| Notes | None |
Example:
result = robot.system.get_dynamic_info()
print(result)