Typed, asyncio-friendly Python SDK for the Wokwi Simulation API
TL;DR: Run and control your Wokwi simulations from Python with first-class type hints and zero boilerplate.
Wokwi is a platform for creating and running simulations of electronic circuits and embedded systems. It supports a wide range of hardware platforms, including ESP32 family, Arduino, Raspberry Pi, STM32 and more.In addition, it supports a wide range of peripherals, including sensors, displays, motors, and debugging tools.
Wokwi Python Client is a Python SDK for the Wokwi Simulation API. It allows you to run and control your Wokwi simulations from Python in a typed, asyncio-friendly way. You can use it to automate your embedded testing and development workflows.
- Python ≥ 3.9
- An API token from https://wokwi.com/dashboard/ci.
Install the library with:
pip install wokwi-clientThe basic example is in the examples/hello_esp32/main.py file. It shows how to:
- Connect to the Wokwi Simulator
- Upload a diagram and firmware files
- Start a simulation
- Monitor the serial output
You can run the example with:
pip install -e .[dev]
python -m examples.hello_esp32.mainFor more examples, see the examples directory.
The API documentation is available at https://wokwi.github.io/wokwi-python-client/.
This project is licensed under the MIT License. See the LICENSE file for details.