Unicorn Remote is a web based remote control for the Unicorn HAT LED matrix. It allows you to control light grid programs from a desktop or mobile browser, or REST API.

Supports both the new Unicorn HAT HD 16x16 and original Unicorn HAT 8x8. It comes with a built-in set of programs for both, and allows you add your own.

The Unicorn HATs are available from Pimoroni:
https://shop.pimoroni.com/products/unicorn-hat-hd
https://shop.pimoroni.com/products/unicorn-hat

Setup

1. Do first time setup for Unicorn HAT or Unicorn HAT HD
2. Clone or download this git repository:

git clone https://github.com/njbbaer/unicorn-remote.git && cd unicorn-remote

3. Install dependencies:

sudo apt install python3-pip python3-numpy

sudo pip3 install -r requirements.txt

4. Start the Unicorn Remote:

sudo python3 run.py

Note: Must be run as root

Optional Arguments

-o --original use original 8x8 unicorn hat
-d --debug enable Flask debugging mode
-p --port <port> set port number (default 5000)

Web Interface

Visit the web interface by directing a browser to the server's address.

http://127.0.0.1:5000

• Choose a program from the dropdown list.
• Select the desired brightness and display rotation.
• Press Run to start the program, and Stop to end it.

REST API

Start a program by placing a PUT request:

PUT /api/program/<program_name>

• All programs use the optional query parameters brightness and rotatation. Some take additional parameters (ex. ascii_text requires a value for text)

Stop the currently running program:

DELETE /api/program

Testing

Run the test suite.

sudo python3 -m unittest

Contribute

• Star this repository to show your interest in this project.
• Give feedback, report bugs, and request features as GitHub issues.
• Improve the repository and submit a pull request.