Skip to content

supcik/CircuitPython_SerialControlledServo

Repository files navigation

Introduction

Documentation Status Discord Build Status Code Style: Ruff

CircuitPython driver for Serial Controlled Servo and Motor Controllers (SCSCL) using UART.

Dependencies

This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle or individual libraries can be installed using circup.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install CircuitPython-sc_servo

To install system-wide (this may be required in some cases):

sudo pip3 install CircuitPython-serial-controlled-servo

To install in a virtual environment in your current project:

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:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install circuitpython_sc_servo

Or the following command to update an existing version:

circup update

Usage Example

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.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

About

CircuitPython driver for Serial Controlled Servo and Motor Controllers (SCSCL) using UART.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published