adam-innes/alpha-hue

PHP SDK for interacting with the Phillips Hue Go Lighting System.

AlphaHue; Phillips Hue PHP SDK

Synopsis

This is a quick-to-implement library that connects your PHP project to the Phillips Hue lighting system. When I started writing an app for the Hue I found a need for an SDK that was complete and uncomplex with decent documentation. AlphaHue is an attempt to fill that need and speed up the process of getting started., _(*1)

AlphaHue uses the PhpRestClient to interact with the Hue APIs., _(*2)

Setup

Installation with Composer.

Clone the repository., _(*3)

$ git clone https://github.com/innesian/AlphaHue.git

Install Composer in your project using cURL (command below) or download the composer.phar directly., _(*4)

$ curl -sS http://getcomposer.org/installer | php

Let Composer install the project dependencies:, _(*5)

$ php composer.phar install

Once installed, include the autoloader in your script., _(*6)

<?php
include_once 'vendor/autoload.php'; // Path to autoload.php file.

// There are instructions on how to obtain Hostname and Username below.
$bridge_hostname = '192.168.1.1';
$bridge_username = 'xxxxxxxxxxx';

$hue = new \AlphaHue\AlphaHue($bridge_hostname, $bridge_username);

(or) add AlphaHue as a dependency to your Hue project using Composer.

Create a composer.json file in your project and add adam-innes/alpha-hue as a required dependency., _(*7)

{
    "require": {
        "adam-innes/alpha-hue": "1.0.*"
    }
}

Discovering Bridge Hostname and creating a Username

Phillips has a how-to on getting the internal IP address and creating a username * Make sure the Bridge is connected to the network and working. Check that your smartphone can connect. * Get the internal IP address from your router -or- use the broker service. * Follow the directions on obtaining a username from the documentation., _(*8)

Connecting from a remote server

If you're connecting to your bridge from an external server you may need to forward a port via your router. There are security risks associated with this that you should consider. If your project is not a personal one but an app or some software intended for use by other people with their light systems you should request the remote API access from Phillips directly. * Step 1: Determine the internal IP address of your Bridge. * Step 2: Forward an unused port to the internal IP address of the Bridge * After forwarding (for example, port 24055, to the Bridge) your Bridge Hostname would be yourIpAddress:24055, _(*9)

Lights API

Turn lights on/off., _(*10)

// Get all light IDs.
$light_ids = $hue->getLightIds();

// Turning lights on by ID.
foreach ($light_ids as $light_id) {
    $hue->togglePower($light_id, 'on');
}

// Turning lights off by ID.
foreach ($light_ids as $light_id) {
    $hue->togglePower($light_id, 'off');
}

Get the power status of a light by ID., _(*11)

$powered_on = $hue->getLightOnStatus($light_id); // True if on, false if off.

Delete a light from the Bridge., _(*12)

$hue->deleteLight($light_id);

Attempt to match a light to a color by hex (not all colors can be created by the light)., _(*13)

# Set the light to Red.
$hue->setLightToHex($light_id, '#ff0000');

Attempt to match a light to a color by RGB value (not all colors can be created by the light)., _(*14)

# Set the light to Blue.
$rgb = array(
  'r' => 0,
  'g' => 0,
  'b' => 255
);
$hue->setLightToRGB($light_id, $rgb);

Get or set the state of a light., _(*15)

# Get the state of light 1
$state = $hue->getLightState(1);

# Sets the light state to a Red, max brightness.
$red = $hue->getXYPointFromHex('#ff0000');
$lightAttributes = array(
  'on'  => true,
  'bri' => 254, // max brightness is 254
  'xy'  => $red
);
$hue->setLightState(1, $lightAttributes);

Groups API

Get group IDs associated to the Bridge., _(*16)

$group_ids = $hue->getGroups();

Create a group., _(*17)

# Create a group titled 'New Group'
$response = $hue->createGroup('New Group');

Set the attributes of a group., _(*18)

# Change group 1 name and set lights 1 and 2 to be the group members.
$attributes = array(
  'name'  => 'New Group Name',
  'lights' => array(1, 2),
);
$hue->setGroupAttributes(1, $attributes);

Delete a group., _(*19)

# Delete group 1.
$hue->deleteGroup(1);

Set the state of a group., _(*20)

$red = $hue->getXYPointFromHex('#ff0000');
$groupAttributes = array(
  'on'  => true,
  'bri' => 254, // max brightness is 254
  'xy'  => $red
);
$hue->setGroupState(1, $groupAttributes);

Rules API

Get rules., _(*21)

# Get list of rules stored in the bridge.
$rules = $hue->getRules();

# Get rule with a rule ID of 1.
$rule = $hue->getRule(1);

Delete a rule., _(*22)

# Delete a rule with ID 1.
$hue->deleteRule(1);

Sensors API

# Get an array of all sensor information.
$sensors = $hue->getSensors();

Schedule API

Get all schedules., _(*23)

# Get schedules.
$schedules = $hue->getSchedules();

Bridge Configuration Information

$hue->config['name']; // Bridge Name.
$hue->config['apiversion']; // Bridge API Version.
$hue->config['ipaddress']; // Bridge IP Address