serve-lights

This project provides a single interface to control multiple providers of smart lights. This enables you to easily write complex home automation with a single light control implementation. The list of currently supported lights can be found below.

Setup

This project should run on a machine on your local network. Run the serve-lights.jar executable after configuring each provider.

Configure

Set the VM option -Dconfig_dir with the path to a directory where your configuration files are stored. Global configurations should be in global.yaml (see Global Configurations). Individual provider configuration files are named <provider>.yaml. The provider is the lower-cased simple class name, i.e. Hue.java ->hue.lifx. Each provider has its own unique configurations, check each README-<provider>.md linked below under Provider Support. All configurations must also define the values in README-provider.md.

Running

Requires Java 11 or higher to start. Startup with:

java -Dconfig_dir="<configuration_files_path>" -jar serve-lights.jar

API

This project uses unauthenticated endpoints that clients on your local network can leverage to control lights. Do not expose the project on publicly accessible ports on your network! You've been warned. The endpoints and their documentation can be found on Postman.

Provider Support

feature-complete

• Hue
  • config

coming soon / in progress

• LIFX
• Nanoleaf

todo

+ abstract provider setup
+ web server to control lights
+ provider configuration
+ global configuration
- support as a source for Google Home (https://developers.google.com/assistant/sdk/device-actions-overview), etc. 
- logging
- cache list of lights
- tests
+ verify providers have guice @provides methods 
+ ci build to push tagged releases
- documentation for contributing
- bundle default properties in release
+ API endpoint documentation
+ refactor api into paths that make sense