Giter Club home page Giter Club logo

serve-lights's Introduction

serve-lights

build GitHub release (latest by date)

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

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

serve-lights's People

Contributors

lucaschilders avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.