Skip to main content

A lightweight library for controlling RC servos on the Raspberry Pi Zero 2 W using hardware PWM via the Linux kernel.

Project description

Tests Coverage Python versions PyPI version License: MIT PyPI downloads Code style: black

Raspberry Pi Zero 2 W Servo PWM

A lightweight Python library for controlling RC servos on the Raspberry Pi Zero 2 W using hardware PWM via the Linux kernel.

This library is specifically designed for servo PWM control. The PWM frequency is fixed to 50 Hz by default, and you specify the pulse length in microseconds.

Typical RC servos expect a pulse width between 1000 µs and 2000 µs, where 1500 µs is the center position. Some servo models support a wider range, e.g., 900–2100 µs, but you must verify this in your servo's datasheet or test cautiously. Increase or decrease values gradually; if the servo starts making crackling or buzzing noises, reduce the range. Extended pulse width ranges are usually symmetrical – for example, if you can safely reduce the pulse width by 100 µs, you can usually increase it by a similar amount.

Why this library?

I wanted a deterministic library for one specific use case: Servo PWM. Existing solutions were often too bloated, included unused features or relied on software-based PWM, which is not timing-accurate.

This library ensures:

  • Hardware-only PWM (no bit-banging fallback)
  • Predictable timing, as PWM generation is handled by the Raspberry Pi's PWM hardware module
  • A minimal, low-overhead interface tailored for servos (frequency fixed at 50Hz, only pulse width adjustable)

Supported platforms

All Raspberry Pi platforms with kernel hardware PWM support should work.

It has been tested on the following platforms:

  • Raspberry Pi Zero 2 W (with Raspberry Pi OS Bullseye, Bookworm)

Setup

This library uses the kernel PWM driver provided by Raspberry Pi OS. To enable it, configure the Device Tree Overlay and reboot.

Make sure you are not running any other PWM-related software like pigpiod for example.

Enable PWM in /boot/config.txt

Add the following line:

dtoverlay=pwm-2chan

Reboot:

sudo reboot

Verify PWM availability

After reboot, check that the PWM interface is present:

ls /sys/class/pwm/pwmchip0
# Expected output: device  export  npwm  power  subsystem  uevent  unexport

Verify that there are two available channels:

cat /sys/class/pwm/pwmchip0/npwm
# Expected output: 2

Verify Group membership

Make sure that the invoking user is part of the gpio group, if not add them:

sudo usermod -aG gpio $USER

Default GPIO mapping

With the default overlay configuration, channels are mapped as follows:

Channel GPIO Pin
0 GPIO 18
1 GPIO 19

Optional: remapping PWM pins

You can remap PWM channels to other supported GPIO pins using overlay parameters. For example, to map channel 1 to GPIO 13:

dtoverlay=pwm-2chan,pin=18,func=2,pin2=13,func2=4

Resulting mapping:

Channel GPIO Pin
0 GPIO 18
1 GPIO 13

Verify the mapping:

raspi-gpio get 18
# GPIO 18: level=0 fsel=2 alt=5 func=PWM0

raspi-gpio get 13
# GPIO 13: level=0 fsel=4 alt=0 func=PWM1

Installation

Install via pip:

pip install rpi-servo-pwm

Usage

Example using manual resource management:

from rpi_servo_pwm import HardwarePWM

# Initialize PWM on channel 0 (GPIO 18), using 50 Hz
pwm = HardwarePWM(channel=0, frequency_hz=50)

# Start PWM with initial pulse width
pwm.setup(1500)

# Move servo to a new position
pwm.set_pulse_width(2000)

# Disable and close
pwm.disable()
pwm.close()

Example using a context manager:

from rpi_servo_pwm import HardwarePWM

with HardwarePWM(channel=0) as pwm:
    pwm.setup(1500)
    pwm.set_pulse_width(2000)
    pwm.disable()

Once you call setup, the PWM signal starts outputting on the pin. Calling disable stops the PWM output.

Testing

Run unit tests with:

python -m pytest tests

Tests are fully mocked and safe to run without hardware access.

Contributing

Pull requests and issue reports are welcome.

Before contributing:

python -m venv ./venv
source ./venv/bin/activate
pip install -r requirements.txt

Before submitting a PR, ensure code is formatted with Black:

# Check formatting
black --check src/ tests/ main.py

# Apply formatting
black src/ tests/ main.py

Distribution

To build and upload to PyPI:

  1. Update the version in both src/__init__.py and pyproject.toml
  2. Build and publish:
rm -rf dist/*
python -m build
python -m twine upload --repository testpypi dist/*
python -m twine upload dist/*

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rpi_servo_pwm-1.0.0.tar.gz (8.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rpi_servo_pwm-1.0.0-py3-none-any.whl (6.8 kB view details)

Uploaded Python 3

File details

Details for the file rpi_servo_pwm-1.0.0.tar.gz.

File metadata

  • Download URL: rpi_servo_pwm-1.0.0.tar.gz
  • Upload date:
  • Size: 8.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.2

File hashes

Hashes for rpi_servo_pwm-1.0.0.tar.gz
Algorithm Hash digest
SHA256 00a7637d002b03679905fe41783a8f9edfa6dffc27fba8b5d397b6e04df4ccd5
MD5 adb7f57441e495435c6de49a2b46e734
BLAKE2b-256 ba5c22ff394ce2aabdd4668d26e7ac29af45fcd14fb83dd50b4486f2ddca886f

See more details on using hashes here.

File details

Details for the file rpi_servo_pwm-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: rpi_servo_pwm-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 6.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.2

File hashes

Hashes for rpi_servo_pwm-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 23c3ccb1687309fd7ba25e3edbd27b62542adf51c29b68b9004f47f7f3c42838
MD5 58f5a99b5cee7b52def99d115d44ec3f
BLAKE2b-256 535ed43c3d14d8b07c8ba26ba4b75c40af19037f9a2d9e141a7dec366e72b67d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page