Skip to main content

Python library for driving Pimoroni Plasma!

Project description

Build Status Coverage Status PyPi Package Python Versions

Eight super-bright RGB LED indicators, ideal for adding visual notifications to your Raspberry Pi on their own or on a pHAT stacking header.


Manual install:

Library install for Python 3:

on Raspbian:

sudo apt-get install python3-plasmalights

other environments:

sudo pip3 install plasmalights

Library install for Python 2:

on Raspbian:

sudo apt-get install python-plasmalights

other environments:

sudo pip2 install plasmalights

Using Plasma

Plasma installs two programs onto your Raspberry Pi. plasma itself and a tool called plasmactl you can use to install and switch lighting effects. Plasma runs as a service on your system.

plasmactl commands:

  • plasmactl 255 0 0 - Set Plasma lights to R, G, B colour. Red in this case.
  • plasmactl <pattern> - Set Plasma lights to pattern image
  • plasmactl fps <fps> - Change plasma effect framerate (default is 30, lower FPS = less CPU)
  • plasmactl --list - List all available patterns
  • sudo plasmactl --install <pattern> - Install a new pattern, where <pattern> is the filename of a 24bit PNG image file


If you want to contribute, or like living on the edge of your seat by having the latest code, you should clone this repository, cd to the library directory, and run:

sudo python3 install

(or sudo python install whichever your primary Python environment may be)

Documentation & Support


  • API refactor, use plasma.legacy for old API
  • USB support for Picade Player X


  • Initial Release

Project details

Download files

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

Files for plasmalights, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size plasmalights-1.0.0-py2-none-any.whl (8.0 kB) File type Wheel Python version py2 Upload date Hashes View
Filename, size plasmalights-1.0.0-py3-none-any.whl (8.0 kB) File type Wheel Python version py3 Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page