Lighthouse

Control your Philips Hue lights with this API wrapper!

NOTE: This wrapper is under active redevelopment, see the older commits in order to get the previous iterations of the API. Also this is not a complete API wrapper for the HUE API as I do not have the time to expand the wrapper. If you would like to contribute please consider making a PR.

Usage

Adding the dependency:

[dependencies]
lighthouse = "0.2.1"

And then in your application:

use std::net::{IpAddr, Ipv4Addr};
use lighthouse::bridge::Bridge;
// Acquire your IP address and substitute here
let ip_addr = IpAddr::V4(Ipv4Addr::new(192, 168, 1, 10));
// Get an API token from your bridge, requires proof of physical access
let bridge_token = String::from("my-example-token");
let mut bridge = Bridge::new(ip_addr, bridge_token).unwrap();
let lights = bridge.get_lights();

If you haven't set up a user token or discovered your bridge yet, you can do so with the interactive try_register function:

use lighthouse::*;
// Discovers the bridge's IP and registers a user token
// This requires physical access to the Bridge!
let bridge = bridge::Bridge::try_register(true).unwrap();

See the ./examples/ directory for more examples.

NOTE: The features for color conversion and serialisation to and from files are now behind feature flags. Available flags are:

• color - adds the color conversion module
• persist - adds the ability to serialise to and from files and also to create bridges from environment variables

Command line tool

The previous releases of this library came with a binary that allowed users to control their lights from the command line. The crate has been refactored and simplified. The binary will have to be refactored as well. However the priority is to finished a more sensible API wrapper before moving onto the binary.

Also see:

lighthouse.el - an Emacs package wrapping the functionality of lighthouse (uses older version of the library)

lightshow - A simple scripting language allowing you to script your lights into lightshows (uses older version of the library)

Contributions

I don't have the time to wrap absolutely all the endpoints and the data structures required for the API.

I would really love people to chip in over time and keep adding new functionality through extra endpoints wrapped.