https://github.com/jc21/mmm-pilights
MagicMirror Module to control a led strip attached to a Raspberry Pi
https://github.com/jc21/mmm-pilights
Last synced: 6 months ago
JSON representation
MagicMirror Module to control a led strip attached to a Raspberry Pi
- Host: GitHub
- URL: https://github.com/jc21/mmm-pilights
- Owner: jc21
- License: mit
- Created: 2016-09-19T03:40:18.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-06T19:36:26.000Z (over 2 years ago)
- Last Synced: 2024-04-15T18:13:46.169Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://magicmirror.builders/
- Size: 136 KB
- Stars: 12
- Watchers: 5
- Forks: 10
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MMM-PiLights
MagicMirror Module to control a led strip attached to a Raspberry Pi
## Requirements
This module is specifically meant for the Raspberry Pi system, using SPI and a LPD8806 or WS2801
LED strip. It may be compatible with other LED strips, but this has not been tested.
[Buy the LPD8806 LED Strip here](https://www.adafruit.com/products/306) and [learn how to connect it here](https://learn.adafruit.com/light-painting-with-raspberry-pi/hardware)
If using Raspbian, you will need to enable SPI:
```bash
sudo raspi-config
```
then navigate to `Advanced` options and enable `SPI`
## Module installation
Clone the module and npm install:
```bash
cd ~/MagicMirror/modules
git clone https://github.com/jc21/MMM-PiLights.git
cd MMM-PiLights
npm install
```
Add the module config to `~/MagicMirror/config/config.js`
```javascript
modules: [
{
module: 'MMM-PiLights',
config: {
ledCount: 64,
type: 'ws2801', // 'ws2801' or 'lpd8806'
bus: 0,
device: 0,
brightness: 1.0 // between 0.0 and 1.0
}
}
]
```
## Module Configuration Options
Option
Type
Default
Description
ledCount
Integer
64
Number LEDs on your strip
type
String
ws2801
The LED strip type, either 'ws2801' or 'lpd8806'
bus
Integer
0
The SPI bus number for your LED strip
device
Integer
0
The SPI device number for your LED strip
brightness
Float
0.0
The LED strip brightness (between 0.0 and 1.0)
## Trigger from another module
If you're developing a module and want to trigger a light sequence, here's an example of
what you'd use in your module:
```javascript
this.sendNotification('PILIGHTS_SEQUENCE', 'blue_pulse');
```
My other MagicMirror module is able to trigger light sequences with notifications:
[MMM-IFTTT](https://github.com/jc21/MMM-IFTTT)
## Trigger from a endpoint
The GET endpoint is pretty simple:
`http://yourmagicmirror/PiLights?sequence=blue_pulse`
From the command line:
```bash
curl -X GET "http://yourmagicmirror/PiLights?sequence=blue_pulse"
```
## Available Sequences
- white_pulse
- blue_pulse
- lightblue_pulse
- red_pulse
- green_pulse
- orange_pulse
- pink_pulse
More to come later.