Welcome to the RoboMaster Developer Page

Quick Start

• 1. Introduction
  • 1.1. Introduction to the EP kit
  • 1.2. EP robot appearance
  • 1.3. Website content
  • 1.4. Contact us
• 2. Programming Environment Installation
  • 2.1. Introduction
  • 2.2. Install Python on Windows
  • 2.3. Install Python on Ubuntu
• 3. Third-party Platform Communication
  • 3.1. Introduction
  • 3.2. Third-party platform types
  • 3.3. Communication methods
    • 3.3.1. Wi-Fi connection
      • 3.3.1.1. The direct connection mode
      • 3.3.1.2. The router mode
    • 3.3.2. USB connection
    • 3.3.3. UART connection

RoboMaster SDK Description

• 1. Install RoboMaster SDK
  • 1.1. Install the SDK on the Windows platform
    • 1.1.1. Prepare the development environment
    • 1.1.2. Install the required VC library
    • 1.1.3. Install the RoboMaster Python SDK
    • 1.1.4. Upgrade the RoboMaster SDK
  • 1.2. Install the SDK on the Linux platform
  • 1.3. Install the SDK on the MacOS X platform
• 2. Download RoboMaster SDK Source Code
• 3. Connect the RoboMaster SDK with Robots
  • 3.1. EP connection method
  • 3.2. Connection methods of education-series devices
  • 3.3. Communication method
    • 3.3.1. Communication method for EP
    • 3.3.2. Communication methods of education-series robots
• 4. Getting Started with RoboMaster SDK - Basics
  • 4.1. What can the SDK do?
  • 4.2. Your first SDK program
• 5. Getting Started with the RoboMaster SDK - EP
  • 5.1. Initialize the robot
  • 5.2. Obtain module objects
  • 5.3. Release robot resources
  • 5.4. Use the query interface
    • 5.4.1. Example 1: Query the version number of the robot
    • 5.4.2. Example 2: Obtain the SN of the robot
  • 5.5. Use the setup interface
    • 5.5.1. Example 1: Configure the overall movement mode of the robot
    • 5.5.2. Example 2: Configure the armored light of the robot
  • 5.6. Use the action interface
    • 5.6.1. Instant action control
      • 5.6.1.1. Example 1: Control the firing of the blaster
      • 5.6.1.2. Example 2: Control the speed of the chassis
    • 5.6.2. Task action control
      • 5.6.2.1. Example 1: Control the chassis to move a specified distance
  • 5.7. Use the multimedia interface
    • 5.7.1. Example 1: Obtain video streams
    • 5.7.2. Example 2: Obtain the audio stream
• 6. Getting Started with the RoboMaster SDK - Education-series Drones
  • 6.1. Initialize the robot
  • 6.2. Obtain module objects
  • 6.3. Release robot resources
  • 6.4. Use the query interface
    • 6.4.1. Example 1: Query the firmware SDK version number of the robot
    • 6.4.2. Example 2: Obtain the SN of the robot
  • 6.5. Use the setup interface
    • 6.5.1. Example 1: Configure the extended LED module of the robot
  • 6.6. Use the action interface
    • 6.6.1. Task action control
      • 6.6.1.1. Example 1: Control the drone to take off and fly back and forth
    • 6.6.2. Instant action control
      • 6.6.2.1. Example 1: Control the remote control stick movement
  • 6.7. Use the multimedia interface
    • 6.7.1. Example 1: Obtain video streams
• 7. Getting Started with the RoboMaster SDK - Multi-device Control
  • 7.1. Introduction to multi-device control
  • 7.2. Multi-device control process
  • 7.3. Multi-device initialization
  • 7.4. Multi-device numbering
  • 7.5. Multi-device grouping and group control
    • 7.5.1. Generate a group object
    • 7.5.2. Operations related to group objects
      • 7.5.2.1. Update members
      • 7.5.2.2. Group control
      • 7.5.2.3. Standalone control
  • 7.6. Task control
• 8. Logging for the RoboMaster SDK
  • 8.1. Configure the log level
  • 8.2. Use log files
• 9. RoboMaster SDK APIs
• 10. Detailed Description of RoboMaster SDK APIs
  • 10.1. robomaster package
    • 10.1.1. robomaster.action
    • 10.1.2. robomaster.armor
    • 10.1.3. robomaster.battery
    • 10.1.4. robomaster.blaster
    • 10.1.5. robomaster.camera
    • 10.1.6. robomaster.chassis
    • 10.1.7. robomaster.exceptions
    • 10.1.8. robomaster.flight
    • 10.1.9. robomaster.gimbal
    • 10.1.10. robomaster.gripper
    • 10.1.11. robomaster.led
    • 10.1.12. robomaster.robot
    • 10.1.13. robomaster.robotic_arm
    • 10.1.14. robomaster.sensor
    • 10.1.15. robomaster.servo
    • 10.1.16. robomaster.uart
    • 10.1.17. robomaster.version
    • 10.1.18. robomaster.vision
    • 10.1.19. Module contents
• 11. Summary of RoboMaster SDK Multi-device APIs
  • 11.1. Summary of multi-device APIs
    • 11.1.1. For EP robots
    • 11.1.2. For education-series robots
• 12. Implement Multi-device Formation for TT by Using the RoboMaster SDK
  • 12.1. Initialize the drone
  • 12.2. Number and group drones
  • 12.3. Instruct drones to execute commands
  • 12.4. Release drone resources
  • 12.5. Use the query interface
    • 12.5.1. Example 1: Query the SN and battery level of the drone
  • 12.6. Use the setup interface
    • 12.6.1. Example 1: Configure the extended LED module of the drone
  • 12.7. Use the action interface
    • 12.7.1. Example 1: Control the drone to take off and fly back and forth
    • 12.7.2. Example 2: Control drones to move to the target coordinate point
• 13. Implement Multi-device Formation for EP by Using the RoboMaster SDK
  • 13.1. Demo environment requirements and materials checklist
  • 13.2. EP networking connection
  • 13.3. Run the sample code for multi-device formation
  • 13.4. Run the modified sample program

Extended Module/Interface Description

• 1. Mechanical Arm and Mechanical Gripper
  • 1.1. Introduction
  • 1.2. Instructions for use
    • 1.2.1. Description of the mechanical gripper’s PWM interface:
  • 1.3. Python API
• 2. Servo
  • 2.1. Introduction
  • 2.2. Pin description
  • 2.3. Control description
  • 2.4. Python API
• 3. Infrared Distance Sensor
  • 3.1. Introduction
  • 3.2. Product features
  • 3.3. Pin description
  • 3.4. Communication protocol and data format
  • 3.5. Python API
• 4. Sensor Adapter
  • 4.1. Introduction
  • 4.2. Pin description
  • 4.3. Python API
• 5. UART Interface
  • 5.1. Introduction
  • 5.2. Pin description
  • 5.3. Serial port configuration
  • 5.4. Third-party platform connection method
  • 5.5. Python programming example
  • 5.6. Cleartext SDK example
  • 5.7. Python API

Plaintext SDK Description

• 1. Introduction to the Plaintext SDK
  • 1.1. Development preparations
  • 1.2. Establish a connection
  • 1.3. Enable the SDK mode
  • 1.4. Send control commands
  • 1.5. Exit SDK mode.
  • 1.6. Summary
• 2. Access Methods
  • 2.1. Connection methods
  • 2.2. Connection parameters
  • 2.3. Connection examples
    • 2.3.1. Wi-Fi direct connection
    • 2.3.2. Wi-Fi router mode
    • 2.3.3. USB connection
    • 2.3.4. UART connection
• 3. Plaintext Protocol
  • 3.1. Protocol Format
    • 3.1.1. Control commands
    • 3.1.2. Message push
    • 3.1.3. Event reporting
    • 3.1.4. IP broadcasting
    • 3.1.5. The video stream
    • 3.1.6. The audio stream
  • 3.2. Protocol Content
    • 3.2.1. SDK mode control
      • 3.2.1.1. Enter SDK mode
      • 3.2.1.2. Exit SDK mode.
    • 3.2.2. Robot control
      • 3.2.2.1. Robot movement mode control
      • 3.2.2.2. Obtain the robot movement mode
      • 3.2.2.3. Obtain the remaining battery capacity of the robot
    • 3.2.3. Chassis control
      • 3.2.3.1. Chassis movement speed control
      • 3.2.3.2. Chassis wheel speed control
      • 3.2.3.3. Chassis relative position control
      • 3.2.3.4. Obtain the chassis speed
      • 3.2.3.5. Obtain the chassis position
      • 3.2.3.6. Obtain the chassis posture
      • 3.2.3.7. Obtain the chassis status
      • 3.2.3.8. Chassis information push control
      • 3.2.3.9. Chassis push information data
    • 3.2.4. Gimbal control
      • 3.2.4.1. Gimbal movement speed control
      • 3.2.4.2. Gimbal relative position control
      • 3.2.4.3. Gimbal absolute position control
      • 3.2.4.4. Gimbal sleep control
      • 3.2.4.5. Gimbal wakeup control
      • 3.2.4.6. Gimbal recenter control
      • 3.2.4.7. Obtain the gimbal posture
      • 3.2.4.8. Gimbal information push control
      • 3.2.4.9. Gimbal push information data
    • 3.2.5. Blaster control
      • 3.2.5.1. Single blaster shot amount
      • 3.2.5.2. Blaster firing control
      • 3.2.5.3. Obtain the amount of a single blaster shot
    • 3.2.6. Armored plate control
      • 3.2.6.1. Armored plate sensitivity control
      • 3.2.6.2. Obtain the armored plate sensitivity
      • 3.2.6.3. Armored-plate event reporting control
      • 3.2.6.4. Armored-plate event reporting data
    • 3.2.7. Voice recognition control
      • 3.2.7.1. Voice recognition event reporting control
      • 3.2.7.2. Voice recognition event reporting data
    • 3.2.8. PWM control
      • 3.2.8.1. Control the PWM output duty cycle
      • 3.2.8.2. PWM output frequency control
    • 3.2.9. LED control
      • 3.2.9.1. LED lighting effect control
    • 3.2.10. Sensor adapter control
      • 3.2.10.1. Obtain the ADC value of the sensor adapter
      • 3.2.10.2. Obtain the I/O value of the sensor adapter
      • 3.2.10.3. Obtain the I/O pin level transition time of the sensor adapter
      • 3.2.10.4. Sensor adapter event reporting control
      • 3.2.10.5. Sensor adapter event reporting data
    • 3.2.11. Infrared distance sensor control
      • 3.2.11.1. Switch control for the infrared distance sensor
      • 3.2.11.2. Obtain the distance measured by the infrared distance sensor
    • 3.2.12. Servo control
      • 3.2.12.1. Servo angle control
      • 3.2.12.2. Servo speed control
      • 3.2.12.3. Servo stop control
      • 3.2.12.4. Servo angle query
    • 3.2.13. Mechanical arm control
      • 3.2.13.1. Control the relative position of the mechanical arm
      • 3.2.13.2. Control the absolute position of the mechanical arm
      • 3.2.13.3. Mechanical arm recenter control
      • 3.2.13.4. Mechanical arm stop control
      • 3.2.13.5. Query the absolute position of the mechanical arm
    • 3.2.14. Mechanical gripper control
      • 3.2.14.1. Mechanical gripper opening control
      • 3.2.14.2. Mechanical gripper closing control
      • 3.2.14.3. Query the open/close status of the mechanical gripper
    • 3.2.15. Intelligent recognition function control
      • 3.2.15.1. Control intelligent recognition function attributes
      • 3.2.15.2. Control intelligent recognition function push
      • 3.2.15.3. Intelligent recognition function push data
    • 3.2.16. Camera control
      • 3.2.16.1. Camera exposure configuration
    • 3.2.17. Video stream control
      • 3.2.17.1. Video stream on control
      • 3.2.17.2. Video stream off control
    • 3.2.18. Audio stream control
      • 3.2.18.1. Audio stream on control
      • 3.2.18.2. Audio stream off control
    • 3.2.19. IP broadcasting
    • 3.2.20. Event data acquisition
      • 3.2.20.1. Turn on keyboard data push
      • 3.2.20.2. Turn off keyboard data push
      • 3.2.20.3. Keyboard data push data
  • 3.3. Data Description
• 4. Formation Control
  • 4.1. Introduction
  • 4.2. Environment
  • 4.3. Establish a multi-device connection
  • 4.4. Run the sample program

Python Programming Description

• 1. Introduction to Python Programming
  • 1.1. Introduction
  • 1.2. Interface
  • 1.3. Reference documents
• 2. Introduction to Python Functions
  • 2.1. Multi-device Communication System
  • 2.2. User-defined UI System
• 3. Python API
  • 3.1. Robot
  • 3.2. Multi-device Communication
  • 3.3. Custom UI System
    • 3.3.1. Common
    • 3.3.2. Stage
    • 3.3.3. Button
    • 3.3.4. Toggle
    • 3.3.5. Text
    • 3.3.6. InputField
    • 3.3.7. Dropdown
  • 3.4. Blaster
  • 3.5. Mechanical Gripper
  • 3.6. Mechanical Arm
  • 3.7. Servo
  • 3.8. Vision
  • 3.9. Armor Plate
  • 3.10. Infrared Distance Sensor
  • 3.11. Sensor Adapter
  • 3.12. UART

Version Description

• Version Description

Indices and tables

• 索引
• 模块索引
• 搜索页面