pydobotlab

Python control for the Dobot Magician, with full coverage of the 28 Python API entries in the official DobotLab Magician manual. Use the documented function names and arguments for motion, I/O, sensors, end-effectors, the slideway, and the conveyor.

All ten ptp modes are supported. Extended control adds move_to with waiting, timeouts, and alarm handling, command batching, and live pose streaming. Run Python scripts and the optional desktop control panel separately or in parallel. A simulator supports working without hardware.

Communicates over serial using pyserial and the Dobot Communication Protocol V1.1.5; no vendor DLL or DobotStudio installation is required.

Documentation & homepage · API reference · GitHub · Report an issue

Installation

Requires Python 3.10 or newer. Install in a virtual environment:

python -m pip install pydobotlab

For the optional PySide6 desktop panel:

python -m pip install "pydobotlab[gui]"
pydobotlab-panel

The base library requires only pyserial; Qt is installed only with the gui extra. See the installation guide for virtual environments, Windows drivers, and Linux serial-port permissions. The project has been used on Ubuntu and Windows; macOS hardware has not been verified.

Quick start

With the arm connected and its workspace clear:

from pydobotlab import Magician, PTPMode

with Magician() as robot:  # auto-discover; or specify "/dev/ttyUSB0" / "COM3"
    robot.clear_alarm()
    robot.set_home()
    command_index = robot.ptp(mode=PTPMode.MOVJ_XYZ, x=220, y=0, z=50, r=0)
    robot.wait_for(command_index)
    pose = robot.get_pose()
    print(pose)

print(pose) displays x, y, z, r, and all four joint angles:

Pose(x=220.00, y=0.00, z=50.00, r=0.00, joints=[0.00, 30.00, 45.00, 0.00])

The values above illustrate the format; actual joint angles depend on the robot's pose. Access individual values with pose.x, pose.y, pose.z, pose.r, or pose.joints. Positions are in millimetres and angles are in degrees.

Dobot is also available as an alias for Magician. The documented DobotLab method names and parameters are preserved for existing scripts.

Queued commands such as ptp return a queue index; use wait_for to wait for completion. move_to combines motion and waiting in one call:

with Magician() as robot:
    robot.move_to(220, 0, 50, r=0, mode=PTPMode.MOVL_XYZ, timeout=30)

See DobotLab compatibility for the complete function list and return-value conventions.

Try it without hardware

pydobotlab-panel --simulator

Or use the simulator from Python:

from pydobotlab import Magician
from pydobotlab.simulator import install_simulator, stop_all

install_simulator(arms=1)
try:
    with Magician("/dev/sim0", via_broker=False) as robot:
        robot.move_to(220, 0, 50)
        print(robot.get_pose())
finally:
    stop_all()

The simulator supports offline examples and tests. It approximates motion and firmware behavior; it does not validate a real robot's trajectory.

Features and examples

• Cartesian and joint motion, jogging, homing, speed settings, and continuous paths.
• Suction cup, gripper, laser, digital I/O, sensors, and conveyor commands.
• Structured alarms, motion-failure exceptions, and live pose streaming.
• Firmware queue control and with robot.batch() for accumulating commands.
• Multiple robot connections and a local broker for sharing a port between the GUI and scripts.

Start with pick and place, smiley drawing, or two arms with live panels. The user guide covers the API, control panel, broker, and wire protocol.

License

MIT. Maintained by Tal Eylon, taleylon1@gmail.com.