A Python driver for driving the Rover Robotics OpenRover Basic robot
Project description
OpenRover Python Suite
This is the official Python driver for the Rover Robotics "Open Rover Basic" robot. Use this as a starting point to get up and running quickly.
Included in this package are:
- A Python library for programmatically interfacing with the Rover over USB
- A command line application "
pitstop
" for upgrading and configuring the Rover firmware - A test suite that confirms the Firmware and hardware are operating as expected.
Setup
To install official releases from PyPi:
python3 -m pip install -U pip setuptools
python3 -m pip install -U openrover --no-cache-dir
On Linux, you may not have permission to access USB devices. If this is the case, run the following then restart your computer:
sudo usermod -a -G dialout $(whoami)
pitstop
Pitstop is a helper program to bootload your rover and set options. After installing the openrover package, you can invoke it with pitstop
or python3 -m openrover.pitstop
.
> pitstop --help
usage: pitstop [-h] [-p port] action ...
OpenRover companion utility to upgrade firmware, configure settings, and test hardware health.
positional arguments:
action
flash write the given firmware hex file onto the rover
checkversion Check the version of firmware installed
test Run tests on the rover
config Update rover persistent settings
optional arguments:
-h, --help show this help message and exit
-p port, --port port Which device to use. If omitted, we will search for a possible rover device
tests
To run tests, first attach the rover via breakout cable then run pitstop test
.
By default, tests that involve running the motors will be skipped, since you may not want a rover ripping cables out of your computer. If you have made sure running the motors will not damage anything, these tests can be opted in with the flag --motorok
.
> pitstop test --motorok
Scanning for possible rover devices
Using device /dev/ttyUSB0
========================== test session starts ============================
platform linux -- Python 3.8.2, pytest-5.4.3, py-1.9.0, pluggy-0.13.1
rootdir: /home/dan/Documents/openrover-python/openrover
plugins: trio-0.6.0
collected 73 items
tests/test_bootloader.py .s [ 2%]
tests/test_find_device.py ..... [ 9%]
tests/test_openrover_protocol.py .... [ 15%]
tests/test_rover.py ..................x.x.........x................Xxxx.......... [ 98%]
tests/burnin/test_burnin.py s [100%]
===== 64 passed, 2 skipped, 6 xfailed, 1 xpassed in 83.94s (0:01:23) =====
Development setup
Manual Prerequisites:
- Python3 (recommended to install Python3.6, Python3.7, and Python3.8)
- Poetry
Instead, we recommend:
git clone https://github.com/RoverRobotics/openrover-python.git
cd openrover-python
poetry install
Useful commands
For development testing, it is recommended to use tox
, which can run tests on multiple Python interpreters.
pytest
- Test on current Python interpreter
tox
- Test on all supported Python minor versions
black .
- Reformat code to a uniform style
githooks setup
- Install git pre-commit hook to automatically run
black
Caveats
- When running in PyCharm in debug mode, you will get a warning like "RuntimeWarning: You seem to already have a custom sys.excepthook handler installed ..." https://github.com/python-trio/trio/issues/1553
- Note this is a pyproject (PEP-517) project so it will NOT work to
pip install --editable ...
for development. Instead usepoetry install
as above.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for openrover-1.0.0b2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bff4064436840f6109ea8fd8a8f2a7ca40a0482c075bcd9c524790b35da021e5 |
|
MD5 | 1618aecd384f86787f361d58ccb54728 |
|
BLAKE2b-256 | f6d0997c57586b31bae6338f0f55a31c119fd217df441dd5fab9dc3f07231b86 |