RoboMasterPy

English | 中文

RoboMasterPy is a Python SDK and framework for RoboMaster EP.

The SDK(client) is straightforward to use:

>>> import robomasterpy as rm

# IP of RoboMaster is detected under router mode
>>> cmd = rm.Commander()

# check RoboMaster's API version
>>> cmd.version()
'version 00.00.00.60'

>>> cmd.get_robot_mode()
'chassis_lead'

# ensure your Robomaster has enough room to move
>>> cmd.chassis_move(x=-1, z=30)
'ok'

# activate video streaming,
# which can be handled by the framework.
>>> cmd.stream(rm.SWITCH_ON)
'ok'

# activate gimbal attitude push at 5Hz,
# which can be handled by the framework.
>>> cmd.gimbal_push_on(attitude_freq=5)
'ok'

# Watch out!
>>> cmd.blaster_fire()
'ok'

The framework deals with video streaming, push and event, provides a high-level interface for controlling and communication. You can build your controlling logic basing on it.

Fun Examples

• Drive your robomaster using keyboard;
• Make your robomaster a goalkeeper;
• More examples

Installation

RoboMasterPy requires Python 3.6 and above.

pip install robomasterpy

If you are using Python 3.6.x, you need to install dataclasses:

pip install dataclasses

User Guide

https://robomasterpy.nanmu.me/

Documentation is generously hosted by Read the Docs.

Health and Safety Notice

• Your Robomaster may hurt people or pet, break stuffs or itself;
• Make sure your RoboMaster has enough room to move; make sure the ground is clear;
• Start slowly, avoid using high speed for debugging;
• Use cushion;
• Stay safe and have fun!

Paperwork

RoboMasterPy is a fan work, and it has no concern with DJI.

DJI, RoboMaster are trademarks of SZ DJI Technology Co., Ltd.

Acknowledgement

RoboMasterPy was incubated during a RoboMaster EP developing contest. The author would like to thank DJI for hardware and technical support.

License

RoboMasterPy is released under MIT license.