Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-motorkit/badge/?version=latest
:target: https://docs.circuitpython.org/projects/motorkit/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_MotorKit/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_MotorKit/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
CircuitPython helper library for the DC & Stepper Motor FeatherWing, Shield and Pi Hat kits.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_
* `PCA9685 <https://github.com/adafruit/Adafruit_CircuitPython_PCA9685>`_
* `Motor <https://github.com/adafruit/Adafruit_CircuitPython_Motor>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
Installing from PyPI
--------------------
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-motorkit/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-motorkit
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-motorkit
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-motorkit
Usage Example
=============
DC motor example:
.. code-block:: python
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:
.. code-block:: python
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 <https://docs.circuitpython.org/projects/motorkit/en/latest/>`_.
For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_MotorKit/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-motorkit",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, motor, pca9685, featherwing, pi, shield, motorkit, kit, i2c, hardware, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/1f/d9/c7801437e27d9a542f9136d94292cb569eb6be11b448d55ac258677452ae/adafruit_circuitpython_motorkit-1.6.15.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-motorkit/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/motorkit/en/latest/\n :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_MotorKit/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_MotorKit/actions/\n :alt: Build Status\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nCircuitPython helper library for the DC & Stepper Motor FeatherWing, Shield and Pi Hat kits.\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\n* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_\n* `PCA9685 <https://github.com/adafruit/Adafruit_CircuitPython_PCA9685>`_\n* `Motor <https://github.com/adafruit/Adafruit_CircuitPython_Motor>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n--------------------\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-motorkit/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-motorkit\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-motorkit\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .venv/bin/activate\n pip3 install adafruit-circuitpython-motorkit\n\nUsage Example\n=============\n\nDC motor example:\n\n.. code-block:: python\n\n import time\n from adafruit_motorkit import MotorKit\n\n kit = MotorKit()\n\n kit.motor1.throttle = 1.0\n time.sleep(0.5)\n kit.motor1.throttle = 0\n\nStepper motor example:\n\n.. code-block:: python\n\n import time\n from adafruit_motorkit import MotorKit\n\n kit = MotorKit()\n\n for i in range(100):\n kit.stepper1.onestep()\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/motorkit/en/latest/>`_.\n\nFor information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_MotorKit/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython helper library for DC & Stepper Motor FeatherWing, Shield, and Pi Hat kits.",
"version": "1.6.15",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_MotorKit"
},
"split_keywords": [
"adafruit",
" motor",
" pca9685",
" featherwing",
" pi",
" shield",
" motorkit",
" kit",
" i2c",
" hardware",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "59e2b129fe006054779f9af6df43322da4961f8d9456bae889258f2db6d2ca1a",
"md5": "68cbd885371ad63bc2c74d24f0a18f82",
"sha256": "d884309c4d52dd5acc494fa10124703deebff4660160354b04345029dae42470"
},
"downloads": -1,
"filename": "adafruit_circuitpython_motorkit-1.6.15-py3-none-any.whl",
"has_sig": false,
"md5_digest": "68cbd885371ad63bc2c74d24f0a18f82",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6059,
"upload_time": "2024-10-07T22:31:51",
"upload_time_iso_8601": "2024-10-07T22:31:51.059147Z",
"url": "https://files.pythonhosted.org/packages/59/e2/b129fe006054779f9af6df43322da4961f8d9456bae889258f2db6d2ca1a/adafruit_circuitpython_motorkit-1.6.15-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1fd9c7801437e27d9a542f9136d94292cb569eb6be11b448d55ac258677452ae",
"md5": "ff31f7c1acc5028fce5174e1cbec0f0b",
"sha256": "04ea358463919eec4e279e2042bb72a6df89a389f7260c29db127ddbbab807f8"
},
"downloads": -1,
"filename": "adafruit_circuitpython_motorkit-1.6.15.tar.gz",
"has_sig": false,
"md5_digest": "ff31f7c1acc5028fce5174e1cbec0f0b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4044334,
"upload_time": "2024-10-07T22:31:52",
"upload_time_iso_8601": "2024-10-07T22:31:52.433119Z",
"url": "https://files.pythonhosted.org/packages/1f/d9/c7801437e27d9a542f9136d94292cb569eb6be11b448d55ac258677452ae/adafruit_circuitpython_motorkit-1.6.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 22:31:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_MotorKit",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-motorkit"
}
JSON
