How xarm-developer/xarm-python-sdk works
xArm-Python-SDK is a Python client for controlling UFACTORY xArm robots and related peripherals. The principal workflow is that an application calls the public API, which delegates robot operations to the xArm control layer; commands then pass through the Uxbus protocol and communication transports to the robot, with reports and feedback handled by the control layer. The SDK also exposes accessory controls, Studio/Blockly tools, G-code and Modbus TCP capabilities. Relationships are based on the README and SOURCE INDEX references; unsampled implementation details are not inferred.
Main entry points: xarm.py xArm interface · base.py Robot base · uxbus_cmd.py Uxbus commands · socket_port.py TCP transport
Components 23
Public interfaces
- Public API
xarm/wrapper/xarm_api.py - Studio API
xarm/wrapper/studio_api.py
Robot control
- xArm interface
xarm/x3/xarm.py - Robot base
xarm/x3/base.py - Motion control
xarm/x3/xarm.py - GPIO control
xarm/x3/gpio.py - Grippers
xarm/x3/gripper.py - Force sensor
xarm/x3/ft_sensor.py - Linear motor
xarm/x3/linear_motor.py - Servo control
xarm/x3/servo.py - Robot reports
xarm/x3/report.py - Status codes
xarm/x3/code.py
Protocol transport
- Uxbus commands
xarm/core/wrapper/uxbus_cmd.py - TCP transport
xarm/core/comm/socket_port.py - Serial transport
xarm/core/comm/serial_port.py - Robot config
xarm/core/config/x_config.py - Byte conversion
xarm/core/utils/bytes_data.py
Programs and peripherals
- Blockly conversion
xarm/tools/blockly/_blockly_handler.py - Blockly tools
xarm/tools/blockly/_blockly_tool.py - G-code client
xarm/tools/gcode.py - Modbus TCP client
xarm/tools/modbus_tcp.py - Studio support
xarm/x3/studio.py
Other components
- Application
Connections 22
- Application → Public API: calls
README.md - Public API → xArm interface: delegates
xarm/wrapper/xarm_api.py - Studio API → Public API: uses
xarm/wrapper/studio_api.py - Studio API → Studio support: uses
xarm/wrapper/studio_api.py - xArm interface → Robot base: inherits
xarm/x3/xarm.py - xArm interface → GPIO control: uses
xarm/x3/xarm.py - xArm interface → Grippers: uses
xarm/x3/xarm.py - xArm interface → Force sensor: uses
xarm/x3/xarm.py - xArm interface → Linear motor: uses
xarm/x3/xarm.py - xArm interface → Servo control: uses
xarm/x3/xarm.py - Robot base → Uxbus commands: uses
xarm/x3/base.py - Robot base → TCP transport: configures
xarm/x3/base.py - Robot base → Serial transport: configures
xarm/x3/base.py - Robot base → Robot config: uses
xarm/x3/base.py - Robot base → Robot reports: uses
xarm/x3/base.py - Uxbus commands → Byte conversion: encodes
xarm/core/wrapper/uxbus_cmd.py - Uxbus commands → Robot config: uses
xarm/core/wrapper/uxbus_cmd.py - TCP transport → Robot base: uses
xarm/core/comm/socket_port.py - TCP transport → Robot config: uses
xarm/core/comm/socket_port.py - Blockly tools → Blockly conversion: uses
xarm/tools/blockly/_blockly_tool.py - xArm interface → Blockly tools: uses
xarm/x3/xarm.py - Blockly conversion → Studio support: converts projects