https://github.com/adafruit/adafruit_circuitpython_motor

Helpers for controlling PWM based motors and servos
https://github.com/adafruit/adafruit_circuitpython_motor

circuitpython continuous-servo dc-motor hacktoberfest servo servo-motor stepper-motor

Last synced: 6 days ago
JSON representation

Helpers for controlling PWM based motors and servos

• Host: GitHub
• URL: https://github.com/adafruit/adafruit_circuitpython_motor
• Owner: adafruit
• License: mit
• Created: 2017-12-20T00:40:55.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2025-01-16T19:56:48.000Z (16 days ago)
• Last Synced: 2025-01-20T10:06:39.132Z (13 days ago)
• Topics: circuitpython, continuous-servo, dc-motor, hacktoberfest, servo, servo-motor, stepper-motor
• Language: Python
• Homepage:
• Size: 210 KB
• Stars: 64
• Watchers: 22
• Forks: 42
• Open Issues: 3
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        

Introduction

============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-motor/badge/?version=latest

    :target: https://docs.circuitpython.org/projects/motor/en/latest/

    :alt: Documentation Status

.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg

    :target: https://adafru.it/discord

    :alt: Discord

.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Motor/workflows/Build%20CI/badge.svg

    :target: https://github.com/adafruit/Adafruit_CircuitPython_Motor/actions/

    :alt: Build Status

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg

    :target: https://github.com/psf/black

    :alt: Code Style: Black

This helper library provides higher level objects to control motors and servos based on one or more

PWM outputs.

The PWM outputs can be any object that have a 16-bit ``duty_cycle`` attribute. Its assumed that the

frequency has already been configured appropriately. (Typically 50hz for servos and 1600hz for

motors.)

Dependencies

=============

This driver depends on:

* `Adafruit CircuitPython `_

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:

.. code-block:: shell

    pip3 install adafruit-circuitpython-motor

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-motor

To install in a virtual environment in your current project:

.. code-block:: shell

    mkdir project-name && cd project-name

    python3 -m venv .venv

    source .venv/bin/activate

    pip3 install adafruit-circuitpython-motor

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.