Skip to content
CircuitPython helper library for the DC & Stepper Motor FeatherWing, Shield and Pi Hat kits.
Python
Branch: master
Clone or download
ladyada Merge pull request #20 from adario7/master
Support Different Microsteps Intervals
Latest commit cc5598b Aug 13, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Initial setup. Dec 5, 2018
examples Update motorkit_dc_test.py Mar 13, 2019
.gitignore PyPI setup. Dec 5, 2018
.pylintrc Initial setup. Dec 5, 2018
.readthedocs.yml Initial setup. Dec 5, 2018
.travis.yml Encrypt travis for .com Dec 19, 2018
CODE_OF_CONDUCT.md Initial setup. Dec 5, 2018
LICENSE Initial setup. Dec 5, 2018
README.rst build badge update Dec 5, 2018
adafruit_motorkit.py Mark steppers_microsteps field as private Aug 9, 2019
requirements.txt Initial setup. Dec 5, 2018
setup.py Setup.py update Dec 5, 2018

README.rst

Introduction

Documentation Status Discord Build Status

CircuitPython helper library for the DC & Stepper Motor FeatherWing, Shield and Pi Hat 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-motorkit

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

sudo pip3 install adafruit-circuitpython-motorkit

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-motorkit

Usage Example

DC motor example:

import time
from adafruit_motorkit import MotorKit

kit = MotorKit()

kit.motor1.throttle = 1.0
time.sleep(0.5)
kit.motor1.throttle = 0

Stepper motor example:

import time
from adafruit_motorkit import MotorKit

kit = MotorKit()

for i in range(100):
    kit.stepper1.onestep()

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-motorkit --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.

You can’t perform that action at this time.