Skip to main content

CircuitPython helper library for DC & Stepper Motor FeatherWing, Shield, and Pi Hat kits.

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

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 .venv
source .venv/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()

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

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

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

adafruit_circuitpython_motorkit-1.6.19.tar.gz (4.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file adafruit_circuitpython_motorkit-1.6.19.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_motorkit-1.6.19.tar.gz
Algorithm Hash digest
SHA256 db4ea02c63786e12ad74696f3e1dcabfea90e1f4fd5d2f5d2a88f95677d6892b
MD5 8e1ad664f4de9aee1fc812bb63c0a6e2
BLAKE2b-256 9f074743e6e1c33b6f12ea4944aa47a1bd405b9343f6b4c73c72a904cf96e2fa

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_motorkit-1.6.19-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_motorkit-1.6.19-py3-none-any.whl
Algorithm Hash digest
SHA256 aa0fd10bece6fd0f88446de438f24f7d85abfacdee2cd6d716e56b0d1d029ed3
MD5 9d4994767bbfa4c1d8e42924bf12705d
BLAKE2b-256 4bf289f9374ccd28e60644c6910ebe45502c45c3fcdaa3b6c831029fc0a2c3f2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page