https://github.com/ruuda/christmas-tree
An API for lighting up my Christmas tree
https://github.com/ruuda/christmas-tree
Last synced: 8 months ago
JSON representation
An API for lighting up my Christmas tree
- Host: GitHub
- URL: https://github.com/ruuda/christmas-tree
- Owner: ruuda
- License: gpl-3.0
- Created: 2016-12-06T05:57:54.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-11-12T16:32:07.000Z (over 8 years ago)
- Last Synced: 2025-02-05T12:23:04.603Z (over 1 year ago)
- Language: Haskell
- Homepage:
- Size: 36.1 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# Christmas Tree
An API for lighting up my Christmas tree.
[![Build Status][ci-img]][ci]
## Hardware
I am using the components of the [Adalight][adalight]: a 25 pixel RGB LED
strand driven by an Arduino Uno. The standard Adalight driver program runs on
the Arduino and accepts color data over USB. The Arduino presents itself as a
serial device to the computer, and the `christmas-tree` program writes color
data to the serial port.
## Software
There are two programs:
* `server`, the API server that runs on a publicly accessible server. It
exposes a simple API over https on one port (protected by basic auth). On a
different port it listens for connecting clients. When a client connects, it
the server sends it mode changes via the socket.
* `cristmas-tree`, the program that runs in a local network and writes color
data to the serial port. Colors are determined by the current mode, and the
current mode is retrieved by connecting to the server and listening for mode
changes.
## Running
To run the client on Ubuntu 16.04:
# Build the client program.
stack setup
stack build
# Give yourself permission to access /dev/ttyACM0
sudo usermod --append --groups dialout $USER
# Run the client, assuming the Arduino is at /dev/ttyACM0.
# Replace example.com:444 with your server domain and socket port.
stack exec christmas-tree /dev/ttyACM0 example.com:444
## Modes
A mode is a function `Float -> Integer -> Color`, that takes the current time
(the amount of seconds since midnight) and the LED index, and produces a color
for the LED.
## License
Christmas Tree is free software. It is licensed under the
[GNU General Public License][gplv3], version 3.
[gplv3]: https://www.gnu.org/licenses/gpl-3.0.html
[adalight]: https://learn.adafruit.com/adalight-diy-ambient-tv-lighting
[ci]: https://travis-ci.org/ruuda/christmas-tree
[ci-img]: https://travis-ci.org/ruuda/christmas-tree.svg?branch=master