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": "",
"name": "adafruit-circuitpython-motor",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,servo,stepper,motor,hardware,micropython,circuitpython",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/ca/b9/8493a632bb9253445b41a72ebddbc9a14305097db3bbfd662f5b6f68c44c/adafruit-circuitpython-motor-3.4.13.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.13",
"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": "073c6d30e111390b1a0d4b7ea8af44c35bad7efa01411f2003a128bd0774ed6a",
"md5": "33721c360b6d990e6c0d646eaec08921",
"sha256": "a85ce312087a9a7107d520f2183acaa2cdb2d55b196c13a07c946f064ccde2ec"
},
"downloads": -1,
"filename": "adafruit_circuitpython_motor-3.4.13-py3-none-any.whl",
"has_sig": false,
"md5_digest": "33721c360b6d990e6c0d646eaec08921",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 10964,
"upload_time": "2023-12-09T17:45:49",
"upload_time_iso_8601": "2023-12-09T17:45:49.776863Z",
"url": "https://files.pythonhosted.org/packages/07/3c/6d30e111390b1a0d4b7ea8af44c35bad7efa01411f2003a128bd0774ed6a/adafruit_circuitpython_motor-3.4.13-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cab98493a632bb9253445b41a72ebddbc9a14305097db3bbfd662f5b6f68c44c",
"md5": "9790bafdbbdaf07747f2f5c34ed0a236",
"sha256": "51d9f14f9ba69720f0ffea0e6efcd8797422e397496a424312458f6df3ad5388"
},
"downloads": -1,
"filename": "adafruit-circuitpython-motor-3.4.13.tar.gz",
"has_sig": false,
"md5_digest": "9790bafdbbdaf07747f2f5c34ed0a236",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 34336,
"upload_time": "2023-12-09T17:45:51",
"upload_time_iso_8601": "2023-12-09T17:45:51.893237Z",
"url": "https://files.pythonhosted.org/packages/ca/b9/8493a632bb9253445b41a72ebddbc9a14305097db3bbfd662f5b6f68c44c/adafruit-circuitpython-motor-3.4.13.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-09 17:45:51",
"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
