Skip to main content

Python library for driving Pimoroni Plasma!

Project description

Build Status Coverage Status PyPi Package Python Versions

https://shop.pimoroni.com/products/plasma

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

Installing

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

Development:

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 setup.py install

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

Documentation & Support

1.0.0

  • API refactor, use plasma.legacy for old API

  • USB support for Picade Player X

0.0.1

  • 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.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

plasmalights-1.0.0-py3-none-any.whl (8.0 kB view details)

Uploaded Python 3

plasmalights-1.0.0-py2-none-any.whl (8.0 kB view details)

Uploaded Python 2

File details

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

File metadata

  • Download URL: plasmalights-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 8.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/43.0.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.3

File hashes

Hashes for plasmalights-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1cdbc08c5254c1556fd027fca939814b63c920fade2455611afd44efa5d1dbb8
MD5 9f6e239aade70ee488ed4991e693e9c3
BLAKE2b-256 9c4bbe7e78ad34f6a2b2e07463ef18f8c4a7d0c6120086ad8f1fb604839582c1

See more details on using hashes here.

File details

Details for the file plasmalights-1.0.0-py2-none-any.whl.

File metadata

  • Download URL: plasmalights-1.0.0-py2-none-any.whl
  • Upload date:
  • Size: 8.0 kB
  • Tags: Python 2
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/43.0.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.3

File hashes

Hashes for plasmalights-1.0.0-py2-none-any.whl
Algorithm Hash digest
SHA256 1450229ca5dd44bb81bd464a31574307a04bb01c890054ec38e05871f39ed6cd
MD5 5de44f8c51fc9306bfd180fb96b60b68
BLAKE2b-256 3eaa4568bd9641190131d129912a127e5a9678614f84da922e7138250efae668

See more details on using hashes here.

Supported by

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