Skip to content
/ RPiLC Public

Control RGB LED strip with a Raspberry Pi. RPiLC allows you to easily control multiple RGB LED strips using one or more Raspberry Pi.

Notifications You must be signed in to change notification settings

Winor/RPiLC

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

logo

GitHub package version GitHub (pre-)release Dependency Status

RPiLC allows you to control your RGB led strip from any device using a Raspberry Pi.

Imgur

Feature Description
🚦 Live Color Preview Watch the color change as you move the color picker
📲 Touch friendly The app was designed to be comfortable to use on any device
🕒 Recent Colors Choose a color from a list of recently used colors
Cycle Colors Select colors to cycle, choose transition effect
📱 iOS web app Add RPiLC to your home screen and use like a normal app
🌐 Web Client Use RPiLC from any browser
🔃 Flexible Connect to other RPiLC Servers through one web client
🔄 Updater Get updates for RPiLC through the web client (Experimental)
API Interact with RPiLC via API

Prerequisites

In order to use RPiLC you need:

  • A Raspberry Pi.
  • Node.js version 8.0.0 or newer installed (you can follow this to install the latest Node.js version on your Pi).
  • Pigpio C library (Version V41 or higher)
  • Python-setuptools & Python3-setuptools (required for Pigpio)
  • RGB led strip connected to the Pi's GPIO (you can follow this guide for wiring)

Install RPiLC on your Pi

1. Get the files

Get the latest release from here and extract it to a new folder, or do:

git clone https://github.com/Winor/RPiLC

2. Install dependencies

cd RPiLC
npm install

3. Run

Note that in order to run RPiLC, the app has to be ran with root privilags so it can have accsess to the Pi's GPIO.

sudo node index.js

4. Configure

Visit http://127.0.0.1 in your browser and configure the app to match your setup. You can also edit config.json manually after it is generated by the app.

Run RPiLC on startup using pm2

You can start RPiLC on startup by following these steps:

1. Install pm2

Note that in order to run RPiLC on startup, pm2 has to run the app as root so RPiLC can get accsess to the Pi's GPIO.

sudo npm install pm2@latest -g

2. Add RPiLC to pm2

cd [RPiLC location]
sudo pm2 start index.js --name RPiLC

3. Make pm2 run on startup

sudo pm2 startup

API

Status

http://RPiLC-Address/api/status

Will return status in JSON format

Toggle State

http://RPiLC-Address/api/togglestate

Will turn the LED strip on or off & return status in JSON format

Toggle Cycle

http://RPiLC-Address/api/togglecycle

Will turn the LED strip on or off & return status in JSON format

Set Color

http://RPiLC-Address/api/set/[color]

Accepts hex value, rgb(x, x, x) and color name. Will set the LED strip color & return status in JSON format

Apple Shortcuts

You can use this Siri shortcut to toggle your LED strip using your Apple device.

Resources

About

Control RGB LED strip with a Raspberry Pi. RPiLC allows you to easily control multiple RGB LED strips using one or more Raspberry Pi.

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published