Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-servokit/badge/?version=latest
:target: https://docs.circuitpython.org/projects/servokit/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_ServoKit/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_ServoKit/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 PWM/Servo FeatherWing, Shield and Pi HAT and Bonnet 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>`_
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-servokit/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-servokit
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-servokit
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-servokit
Usage Example
=============
.. code-block:: python
import time
from adafruit_servokit import ServoKit
# Set channels to the number of servo channels on your kit.
# 8 for FeatherWing, 16 for Shield/HAT/Bonnet.
kit = ServoKit(channels=8)
kit.servo[0].angle = 180
kit.continuous_servo[1].throttle = 1
time.sleep(1)
kit.continuous_servo[1].throttle = -1
time.sleep(1)
kit.servo[0].angle = 0
kit.continuous_servo[1].throttle = 0
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/servokit/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_ServoKit/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-servokit",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,servo,motor,pwm,pca9685,featherwing,pi,shield,bonnet,servokit,kit,i2c,hardware,micropython,circuitpython",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/e6/f3/6e4e81d7159aadef92da863e68c24b57fc7babe66cf5c1f5ea847a1c769d/adafruit-circuitpython-servokit-1.3.17.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-servokit/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/servokit/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_ServoKit/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_ServoKit/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 PWM/Servo FeatherWing, Shield and Pi HAT and Bonnet 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\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-servokit/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-servokit\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-servokit\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-servokit\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import time\n from adafruit_servokit import ServoKit\n\n # Set channels to the number of servo channels on your kit.\n # 8 for FeatherWing, 16 for Shield/HAT/Bonnet.\n kit = ServoKit(channels=8)\n\n kit.servo[0].angle = 180\n kit.continuous_servo[1].throttle = 1\n time.sleep(1)\n kit.continuous_servo[1].throttle = -1\n time.sleep(1)\n kit.servo[0].angle = 0\n kit.continuous_servo[1].throttle = 0\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/servokit/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_ServoKit/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 PWM/Servo FeatherWing, Shield, and Pi HAT and Bonnet kits.",
"version": "1.3.17",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_ServoKit"
},
"split_keywords": [
"adafruit",
"servo",
"motor",
"pwm",
"pca9685",
"featherwing",
"pi",
"shield",
"bonnet",
"servokit",
"kit",
"i2c",
"hardware",
"micropython",
"circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ba0c3eba1775c6c22474feaee39efa804c719b0b0cc00b2d5524cd7874d92f2c",
"md5": "91d97d77e5b58a64991e6299eb20e490",
"sha256": "001450cae5617e83bfa00859e6f4948e33edd9b719c3097f3fa14d804eb1b3c1"
},
"downloads": -1,
"filename": "adafruit_circuitpython_servokit-1.3.17-py3-none-any.whl",
"has_sig": false,
"md5_digest": "91d97d77e5b58a64991e6299eb20e490",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5678,
"upload_time": "2023-12-09T17:53:52",
"upload_time_iso_8601": "2023-12-09T17:53:52.464676Z",
"url": "https://files.pythonhosted.org/packages/ba/0c/3eba1775c6c22474feaee39efa804c719b0b0cc00b2d5524cd7874d92f2c/adafruit_circuitpython_servokit-1.3.17-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e6f36e4e81d7159aadef92da863e68c24b57fc7babe66cf5c1f5ea847a1c769d",
"md5": "76cc0a6566ceab21f92fb7047882d039",
"sha256": "d5f7803ce4cceee844c0851382311e9daafb9e82da51663a03e05036cfa52b3c"
},
"downloads": -1,
"filename": "adafruit-circuitpython-servokit-1.3.17.tar.gz",
"has_sig": false,
"md5_digest": "76cc0a6566ceab21f92fb7047882d039",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 27060,
"upload_time": "2023-12-09T17:53:54",
"upload_time_iso_8601": "2023-12-09T17:53:54.175462Z",
"url": "https://files.pythonhosted.org/packages/e6/f3/6e4e81d7159aadef92da863e68c24b57fc7babe66cf5c1f5ea847a1c769d/adafruit-circuitpython-servokit-1.3.17.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-09 17:53:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_ServoKit",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": [
[
">=",
"7.0.0"
]
]
},
{
"name": "adafruit-circuitpython-busdevice",
"specs": []
},
{
"name": "adafruit-circuitpython-pca9685",
"specs": []
},
{
"name": "adafruit-circuitpython-motor",
"specs": []
},
{
"name": "adafruit-circuitpython-register",
"specs": []
}
],
"lcname": "adafruit-circuitpython-servokit"
}
JSON
