Skip to content

Latest commit

 

History

History
47 lines (33 loc) · 2.75 KB

README.md

File metadata and controls

47 lines (33 loc) · 2.75 KB
Raw

PiBorg's TroPi

Getting Started: https://www.piborg.org/blog/tropi-getting-started

Shop: https://www.piborg.org/tropi

The TroPi adds a row of 5 programmable LEDs to your Raspberry Pi projects and you can also build you very own light up Trophy display using the additional Trophy kit.

Here you'll find the driver code, and a handful of examples to get you started.

Installation

Follow the Getting Started Guide for physical installation of the board, then use git clone https://github.com/piborg/tropi to clone the TroPi repository locally and use the class within your projects. This will also give you this README and the example scripts showing how to use the TroPi class.

Examples

There are three examples available in this repository:

  • cheerlights.py - Runs Cheerlights on the TroPi. Try running this script using python cheerlights.py then Tweet using the #Cheerlights hash tag and a colour eg. Tweeting "#Cheerlights Red" will change the TroPi lights to Red.
  • colourwave.py - Smoothly changes colours of the TroPi LEDs through the rainbow of colours in a wave from the first LED to the last.
  • fuzz.py - Flashing lights as if you've been caught by the Fuzz.
  • whichlight.py - Asks the user "which light would you like to turn on?". Give a number from 0 to 4 and watch the light come on.

API

There are a few useful callable functions inside the TroPi class:

  • SetEachColour(colours) - Provide a list of colours to set each light, see fuzz.py for an example of usage.
  • SetAllColours(red, green, blue) - Set all LEDs to the given RGB value eg. SetAllColours(1.0, 0.0, 0.0) would set all the lights to red.
  • SetSingleColour(ledNumber, red, green, blue) - Set a given LED to a colour eg. SetSingleColour(2, 1.0, 0.0, 0.0) would set the middle LED to red.

Raspberry Pi 5

The RPi.GPIO library used in tropi.py is not compatible with the Raspberry Pi 5, but there is a drop-in replacement library available.

You can install the replacement using these commands:

sudo apt-get update
sudo apt remove python3-rpi.gpio
sudo apt install python3-rpi-lgpio

If the last command fails with E: Unable to locate package python3-rpi-lgpio you can install the module using this alternative:

pip3 install rpi-lgpio

For more details see rpi-lgpio - Installation.

Further Help

Head over to the PiBorg Forum and ask for questions if you need further help.