Introduction
============
.. image:: https://readthedocs.org/projects/circuitpython-serial-controlled-servo/badge/?version=latest
:target: https://circuitpython-serial-controlled-servo.readthedocs.io/
:alt: Documentation Status
.. image:: https://img.shields.io/discord/327254708534116352.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/supcik/Circuitpython_SerialControlledServo/workflows/Build%20CI/badge.svg
:target: https://github.com/supcik/Circuitpython_SerialControlledServo/actions
:alt: Build Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
:target: https://github.com/astral-sh/ruff
:alt: Code Style: Ruff
CircuitPython driver for Serial Controlled Servo and Motor Controllers (SCSCL) using UART.
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://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.
Installing from PyPI
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/circuitpython-serial-controlled-servo/>`_.
To install for current user:
.. code-block:: shell
pip3 install CircuitPython-sc_servo
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install CircuitPython-serial-controlled-servo
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install CircuitPython-serial-controlled-servo
Installing to a Connected CircuitPython Device with Circup
==========================================================
Make sure that you have ``circup`` installed in your Python environment.
Install it with the following command if necessary:
.. code-block:: shell
pip3 install circup
With ``circup`` installed and your CircuitPython device connected use the
following command to install:
.. code-block:: shell
circup install circuitpython_sc_servo
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
.. code-block:: python
import time
import board
from sc_servo import SerialControlledServo
POSITIONS = [0, 307, 614, 307]
SPEED = 1000
# Replace boards.IO02 and board.IO01 with the appropriate pins for your board
servo = SerialControlledServo(tx_pin=board.IO02, rx_pin=board.IO01)
index: int = 0
while True:
servo.set_position(servo_id=1, pos=POSITIONS[index], speed=SPEED)
index = (index + 1) % len(POSITIONS)
while servo.is_moving(servo_id=1):
time.sleep(0.1)
time.sleep(0.5) # Wait 1/2 second
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://circuitpython-serial-controlled-servo.readthedocs.io/>`_.
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/supcik/Circuitpython_SerialControlledServo/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "circuitpython-serial-controlled-servo",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, servo, motor, controller, serial, serial-controlled-servo, serial-motor, serial-controlled-servo-motor",
"author": null,
"author_email": "Jacques Supcik <jacques.supcik@hefr.ch>",
"download_url": "https://files.pythonhosted.org/packages/f1/7d/563ac8be443930990469631e862f701c5bde00e1ad3227f7db6152f609f1/circuitpython_serial_controlled_servo-0.1.2.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/circuitpython-serial-controlled-servo/badge/?version=latest\n :target: https://circuitpython-serial-controlled-servo.readthedocs.io/\n :alt: Documentation Status\n\n\n.. image:: https://img.shields.io/discord/327254708534116352.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n\n.. image:: https://github.com/supcik/Circuitpython_SerialControlledServo/workflows/Build%20CI/badge.svg\n :target: https://github.com/supcik/Circuitpython_SerialControlledServo/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\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n :target: https://github.com/astral-sh/ruff\n :alt: Code Style: Ruff\n\nCircuitPython driver for Serial Controlled Servo and Motor Controllers (SCSCL) using UART.\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://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\nInstalling from PyPI\n=====================\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/circuitpython-serial-controlled-servo/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install CircuitPython-sc_servo\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install CircuitPython-serial-controlled-servo\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 .env/bin/activate\n pip3 install CircuitPython-serial-controlled-servo\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n circup install circuitpython_sc_servo\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import time\n\n import board\n from sc_servo import SerialControlledServo\n\n POSITIONS = [0, 307, 614, 307]\n SPEED = 1000\n # Replace boards.IO02 and board.IO01 with the appropriate pins for your board\n servo = SerialControlledServo(tx_pin=board.IO02, rx_pin=board.IO01)\n index: int = 0\n while True:\n servo.set_position(servo_id=1, pos=POSITIONS[index], speed=SPEED)\n index = (index + 1) % len(POSITIONS)\n while servo.is_moving(servo_id=1):\n time.sleep(0.1)\n time.sleep(0.5) # Wait 1/2 second\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://circuitpython-serial-controlled-servo.readthedocs.io/>`_.\n\nFor information on building library documentation, please check out\n`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/supcik/Circuitpython_SerialControlledServo/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for Serial Servo Bus (UART)",
"version": "0.1.2",
"project_urls": {
"Homepage": "https://github.com/supcik/CircuitPython_SerialControlledServo"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" servo",
" motor",
" controller",
" serial",
" serial-controlled-servo",
" serial-motor",
" serial-controlled-servo-motor"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "94079ba0dd6f640149236c03502086bd4c5a3c916d5f127c8947ba2bfb282c37",
"md5": "e06bbd5a00516aa670650e3f8c3bc5f6",
"sha256": "d0737c2a5aaa11c88194319f178ef561c6328704b5ee935b64d27c338fd7e0cb"
},
"downloads": -1,
"filename": "circuitpython_serial_controlled_servo-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e06bbd5a00516aa670650e3f8c3bc5f6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7048,
"upload_time": "2025-08-03T21:41:42",
"upload_time_iso_8601": "2025-08-03T21:41:42.327181Z",
"url": "https://files.pythonhosted.org/packages/94/07/9ba0dd6f640149236c03502086bd4c5a3c916d5f127c8947ba2bfb282c37/circuitpython_serial_controlled_servo-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "f17d563ac8be443930990469631e862f701c5bde00e1ad3227f7db6152f609f1",
"md5": "f08a5109b55d252482b0e35689ab8791",
"sha256": "7285f4e36fd3ea6ee5318e8b856be177e0fc6c04f0aeb5ee6d7516ef36457ec4"
},
"downloads": -1,
"filename": "circuitpython_serial_controlled_servo-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "f08a5109b55d252482b0e35689ab8791",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 25502,
"upload_time": "2025-08-03T21:41:43",
"upload_time_iso_8601": "2025-08-03T21:41:43.237024Z",
"url": "https://files.pythonhosted.org/packages/f1/7d/563ac8be443930990469631e862f701c5bde00e1ad3227f7db6152f609f1/circuitpython_serial_controlled_servo-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-03 21:41:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "supcik",
"github_project": "CircuitPython_SerialControlledServo",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
}
],
"lcname": "circuitpython-serial-controlled-servo"
}
JSON
