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 <https://github.com/adafruit/circuitpython>`_
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-motor/>`_. 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 <https://docs.circuitpython.org/projects/motor/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_motor/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-motor",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, servo, stepper, motor, hardware, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/2b/a9/86324401d6faafafec2717732a4470a4602c017bdfab780140cc739ba51d/adafruit_circuitpython_motor-3.4.14.tar.gz",
"platform": null,
"description": "\nIntroduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-motor/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/motor/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_Motor/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_Motor/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\nThis helper library provides higher level objects to control motors and servos based on one or more\nPWM outputs.\n\nThe PWM outputs can be any object that have a 16-bit ``duty_cycle`` attribute. Its assumed that the\nfrequency has already been configured appropriately. (Typically 50hz for servos and 1600hz for\nmotors.)\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\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-motor/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-motor\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-motor\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-motor\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/motor/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_motor/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython helper library provides higher level objects to control motors and servos.",
"version": "3.4.14",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_Motor"
},
"split_keywords": [
"adafruit",
" servo",
" stepper",
" motor",
" hardware",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a5026ce49e5fda9093dca2d047f7c7fd9878428e6a39169b88f83fde1d93aa8a",
"md5": "43066e4d7b3ca95ff112987f1f30095a",
"sha256": "60d6031ecea7013cf5d434baa375b3351947306d96959bb72aa978b4eadbd74e"
},
"downloads": -1,
"filename": "adafruit_circuitpython_motor-3.4.14-py3-none-any.whl",
"has_sig": false,
"md5_digest": "43066e4d7b3ca95ff112987f1f30095a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 10962,
"upload_time": "2024-10-07T22:31:46",
"upload_time_iso_8601": "2024-10-07T22:31:46.293763Z",
"url": "https://files.pythonhosted.org/packages/a5/02/6ce49e5fda9093dca2d047f7c7fd9878428e6a39169b88f83fde1d93aa8a/adafruit_circuitpython_motor-3.4.14-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2ba986324401d6faafafec2717732a4470a4602c017bdfab780140cc739ba51d",
"md5": "12140f2c23ad145141f12c4eea389ff8",
"sha256": "8a2047eacf17238761878a623718f3aca13ef842a0d33bc85904898fbe6a6412"
},
"downloads": -1,
"filename": "adafruit_circuitpython_motor-3.4.14.tar.gz",
"has_sig": false,
"md5_digest": "12140f2c23ad145141f12c4eea389ff8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 34330,
"upload_time": "2024-10-07T22:31:47",
"upload_time_iso_8601": "2024-10-07T22:31:47.196932Z",
"url": "https://files.pythonhosted.org/packages/2b/a9/86324401d6faafafec2717732a4470a4602c017bdfab780140cc739ba51d/adafruit_circuitpython_motor-3.4.14.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 22:31:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_Motor",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-motor"
}
JSON
