CircuitPython helper library for the PWM/Servo FeatherWing, Shield and Pi HAT kits.
Branch: master
Clone or download
Latest commit 828a46c Jan 13, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Initial commit. Dec 13, 2018
examples Change range to all Jan 11, 2019
.gitignore PyPI setup. Dec 14, 2018
.pylintrc Initial commit. Dec 13, 2018
.readthedocs.yml Initial commit. Dec 13, 2018
.travis.yml travis-ci.com encryption Dec 19, 2018
CODE_OF_CONDUCT.md Initial commit. Dec 13, 2018
LICENSE Initial commit. Dec 13, 2018
README.rst Update build badge url. Dec 14, 2018
adafruit_servokit.py Initial commit. Dec 13, 2018
requirements.txt Initial commit. Dec 13, 2018
setup.py PyPI setup. Dec 14, 2018

README.rst

Introduction

Documentation Status Discord Build Status

CircuitPython helper library for the PWM/Servo FeatherWing, Shield and Pi HAT and Bonnet kits.

Dependencies

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

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-servokit

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-servokit

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install adafruit-circuitpython-servokit

Usage Example

import time
from adafruit_servokit import ServoKit

# Set channels to the number of servo channels on your kit.
# 8 for FeatherWing, 16 for Shield/HAT/Bonnet.
kit = ServoKit(channels=8)

kit.servo[0].angle = 180
kit.continuous_servo[1].throttle = 1
time.sleep(1)
kit.continuous_servo[1].throttle = -1
time.sleep(1)
kit.servo[0].angle = 0
kit.continuous_servo[1].throttle = 0

Contributing

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

Building locally

Zip release files

To build this library locally you'll need to install the circuitpython-build-tools package.

python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools

Once installed, make sure you are in the virtual environment:

source .env/bin/activate

Then run the build:

circuitpython-build-bundles --filename_prefix adafruit-circuitpython-servokit --library_location .

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.