Skip to main content

CircuitPython helper library for interfacing with Roomba Open Interface devices.

Project description


Coverage Report Documentation Status Build Status

CircuitRoomba is a CircuitPython library for interfacing with Roomba Open Interface devices.


This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Installing from PyPI for blinka boards

pip install circuitroomba

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip install circuitroomba

For CircuitPython boards that don’t support blinka copy /circuitroomba from /src to /lib on the CircuitPython board. make install has been setup as a helper, but you may need to update the /Volume path for your system and board name.

make install

Usage Example

import board
import digitalio
import time
from circuitroomba.series6 import roomba

__repo__ = ""

# initialize roomba
bot = roomba.Commands(board.TX, board.RX, digitalio.DigitalInOut(board.A1))

# wake roomba from sleep mode

# CircuitPython loop
while True:
    # send commands




More examples are available in /examples.


Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Sphinx documentation

Sphinx is used to build the documentation based on rST files and comments in the code. First, install dependencies (feel free to reuse the virtual environment from above):

python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme

Now, once you have the virtual environment activated:

cd docs
sphinx-build -E -W -b html . _build/html

This will output the documentation to docs/_build/html. Open the index.html in your browser to view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to locally verify it will pass.


circuit roomba high level circuit roomba running video roomba open interface connections circuit playground connections circuit playground connected to roomba

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

circuitroomba-0.1.0.tar.gz (2.3 MB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page