ericparton / yetanotherhueapi

A Java 8 library for controlling Philips Hue lights.

Yet Another Hue API

This is a Java 8 API for the Philips Hue lights. It does not use the official Hue SDK but instead accesses the REST API of the Philips Hue Bridge directly. This library has been confirmed to work with the Philips Hue Bridge API version 1.28.0.

Usage

If you already have an API key for your Bridge:

final String bridgeIp = "192.168.1.99"; // Fill in the IP address of your Bridge
final String apiKey = "bn4z908...34jf03jokaf4"; // Fill in an API key to access your Bridge
final Hue hue = new Hue(bridgeIp, apiKey);

If you don't have an API key for your bridge:

final String bridgeIp = "192.168.1.99"; // Fill in the IP address of your Bridge
final String appName = "MyFirstHueApp"; // Fill in the name of your application
final java.util.concurrent.CompletableFuture<String> apiKey = Hue.hueBridgeConnectionBuilder(bridgeIp).initializeApiConnection(appName);
// Push the button on your Hue Bridge to resolve the apiKey future:
final Hue hue = new Hue(bridgeIp, apiKey.get());

Using the rooms and the lights:

// Get a room -- returns Optional.empty() if the room does not exist, but 
// let's assume we know for a fact it exists and can do the .get() right away:
final Room room = hue.getRoomByName("Basement").get();

// Turn the lights on, make them pink:
room.setState(new State(true, java.awt.Color.PINK));

// Turn off that single lamp in the corner:
room.getLightByName("Corner").get().turnOff();

Including the library with Maven

Add the following to your pom.xml file:

    <repositories>
        <repository>
            <id>ZeroOne3010-snapshots</id>
            <url>https://github.com/ZeroOne3010/mvn-repo/raw/master/snapshots</url>
        </repository>
    </repositories>

    <dependencies>
        <dependency>
            <groupId>com.github.zeroone3010</groupId>
            <artifactId>yetanotherhueapi</artifactId>
            <version>0.2.0-SNAPSHOT</version>
        </dependency>
    </dependencies>

Scope and philosophy

This library is not intended to have all the possible functionality of the SDK or the REST API. Instead it is focusing on the essentials: querying and setting the states of the rooms and the lights. And this library should do those essential functions well: in an intuitive and usable way for the programmer. The number of external dependencies should be kept to a minimum. Version numbering follows the Semantic Versioning.