Skip to content

Installation

pydobotlab requires Python 3.11 or newer. Its only required dependency is pyserial. The control panel also requires PySide6.

Create a virtual environment

macOS and Linux:

python3 -m venv .venv
source .venv/bin/activate

Windows (PowerShell):

python -m venv .venv
.\.venv\Scripts\Activate.ps1

Install

python -m pip install "pydobotlab[gui]"

The gui extra installs the control panel, pydobotlab-panel, and is recommended: scripts connect through the control panel by default. Without the panel, install the base package; scripts then open the serial port directly:

python -m pip install pydobotlab

To install from a source checkout, run python -m pip install -e . in the directory that contains pyproject.toml.

Verify

python -c "import pydobotlab; print(pydobotlab.__version__)"

The command prints the installed version.

Check that the arm is visible

  • macOS and Linux: run ls /dev/tty.usbserial-* /dev/ttyUSB* /dev/ttyACM*. The arm appears as /dev/ttyUSB0 or /dev/ttyACM0. See Linux setup for the required permissions.
  • Windows: open Device Manager, then Ports (COM & LPT), and note the COM number, for example COM3.

Without an arm, use the simulator.

Next