This is a project to create a busy light from both the Pimoroni Unicorn Phat and Unicorn Mini.
The service itself has the following features:
- Installation script to simplify the process
- APIs for turning the Unicorn on/off
- APIs for changing the colors
- Rainbow effect
- Front-end to show the current status and manually set its status
In order to install this on your Raspberry Pi, you can follow the next steps:
Copy and paste the following in to a terminal. It will install all the required files, enable, and start the service. If you are running Raspbian or Ubuntu, you can use the following installation command:
curl -LSs https://raw.githubusercontent.com/estruyf/unicorn-busy-server/master/install.sh | sudo bash -If there might be a trust issue while running the command, you could try the following:
cd /tmp
curl -LSs https://raw.githubusercontent.com/estruyf/unicorn-busy-server/master/install.sh
cat install | more # So you can see the contents of the script a page at time
sudo bash ./install.sh -V -i /home/pi/unicorn-busy-serverImportant: Currently the script only runs on Raspbian/Ubuntu. Feel free to submit a pull request to extend the PR to support other distributions. Or you can make use of the old installation script:
install-fallback.sh.
If you want to clone/fork this repo and carry on development on a more sensible machine, you can install the required files without needing to install the service by doing the following:
curl -LSs https://raw.githubusercontent.com/estruyf/unicorn-busy-server/master/install.sh
bash ./install.sh -dThe scripts usage output is as follows:
Unicorn Busy Server installation script 0.5
(c) Jamie Maynard 2020
Usage:
-i --install-dir Specify where you want to install to
Default is: /home/pi/Development/unicorn-busy-server
-d --development Install for development only (no service installation)
-V --verbose Shows command output for debugging
-v --version Shows version details
-h --help Shows this usage message
If you've run the install script (without the -d option) check the Unicorn hat attache to your Pi. If all has gone according to plan the unicorn hat will be changing colours. Once its going through all 360 Hues within the HSV spectrum it'll go blank. As soon as the Uniron hat lights up the Busylight Server is ready to start receiving commands.
The front-end is available via http://<your-ip>:5000/.
The API is fairly simple though has been extend quite a bit from its orignal implementation. The Busy server has the following API endpoing:
| Method | Endpoint | Description |
|---|---|---|
| GET POST | /api/on |
Turn the Unicorn Hat on to a random colour |
| GET POST | /api/off |
Turn the Unicorn Hat off |
| GET | /api/status |
Get the status of the Unicorn Hat/Pi |
| POST | /api/rainbow |
Set the unicorn to cycle through all 360 hues in the HSV spectrum |
| POST | /api/switch |
Set the unicorn to a specific colour using RGB Integer values |
| GET POST | /api/available |
Set the unicorn to the available status color. This overwrites the status. Call /api/switch to turn off. |
| GET POST | /api/busy |
Set the unicorn to the busy status color. This overwrites the status. Call /api/switch to turn off. |
| GET POST | /api/away |
Set the unicorn to the away status color. This overwrites the status. Call /api/switch to turn off. |
| GET POST | /api/reset |
Resets the status overwrite setting. This way, the /api/switch can be called again. |
| Method | Endpoint |
|---|---|
| GET POST | /api/on |
The simpelest method there is. It turns the Unicorn Hat on to a random colour.
Returns 200 OK and an Empty JSON Object {}
| Method | Endpoint |
|---|---|
| GET POST | /api/off |
Another really simple method. This Turns the Unicorn Hat off.
Returns 200 OK and an Empty JSON Object {}
| Method | Endpoint |
|---|---|
| GET | /api/status |
Get the status of the pi
Returns 200 OK and the following JSON Object:
{
"blue": 110,
"brightness": 0.5,
"cpuTemp": 39.546,
"green": 60,
"height": 8,
"icon": "none",
"lastCalled": "Sun, 17 May 2020 18:00:33 GMT",
"lastCalledApi": "/api/on",
"red": 247,
"unicorn": "phat",
"width": 4
}| Method | Endpoint |
|---|---|
| POST | /api/rainbow |
This method was build off the back of an HSV method in the UnicornWrapper class. You can step horizontally across the HSV spectrum from 0 to 360 this allows you to cycle through all colours of a spectrum. It is similar to Razer Synpases "Spectrum" effect. It makes a nice Unicorn when you're not doing anything and can be helpful for making sure your Unicorn Phat/Mini is setup correctly.
All values are optional in this request so its possible to send a request like the one below and still have the rainbow effect activate.
{}However you can customise your rainbow first by specifying the starting hue. This is an integer between 0 and 360. The default is 0 which is Red.
You can specify your step through the hue range. This again can be any number between 1 and 90 The bigger the number the greater the change between between transitioning colours. Smaller numbers result in a much smooter transition. The default is 1.
You can specify the transition speed, that is the speed at which the colours change. This is any number in seconds the smaller the number the quicker the change the quicker you cycle through the hue spectrum. The default is 0.2
Finally you can specify the brightness this is any floating point number between 0 and 1. The default is 0.5.
Example request JSON:
{
"brightness": 0.5, // Optional
"speed": 1 // Optional
}Returns 200 OK and an Empty JSON Object {}
| Method | Endpoint |
|---|---|
| POST | /api/switch |
This is the original RGB method for setting the Unicorn to a single colour.
You have to specify the vaules for red, green and blue. These are integers between 0 and 255.
Optionally you can specify the brightness of the Unicorn. This is a float value between 0 and 1. The default is set to 0.5.
Optionally you can also specify the blink speed. This specifies the speed in seconds which the Unicorn turns on and off.
{
"red":0,
"green":255,
"blue":0,
"brightness": 0.5, // Optional
"speed": 1 // Optional
}Returns 200 OK and an Empty JSON Object {}
| Method | Endpoint |
|---|---|
| GET POST | /api/available |
Overrides the status to available. This way, any call coming in to the /api/switch endpoint will be ignored. You will have to call the /api/reset endpoint in order to remove the override.
Returns 200 OK and an Empty JSON Object {}
| Method | Endpoint |
|---|---|
| GET POST | /api/busy |
Overrides the status to busy. This way, any call coming in to the /api/switch endpoint will be ignored. You will have to call the /api/reset endpoint in order to remove the override.
Returns 200 OK and an Empty JSON Object {}
| Method | Endpoint |
|---|---|
| GET POST | /api/away |
Overrides the status to away. This way, any call coming in to the /api/switch endpoint will be ignored. You will have to call the /api/reset endpoint in order to remove the override.
Returns 200 OK and an Empty JSON Object {}
| Method | Endpoint |
|---|---|
| GET POST | /api/reset |
Resets the status override state so that the /api/switch endpoint will not ignore color/status changes.
Returns 200 OK and an Empty JSON Object {}
- Add support for the Unicorn Hat
- Add front-end
MIT License
Copyright (c) 2020 Elio Struyf Parts (c) 2020 Jamie Maynard
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.