README

PHP client for the Philips Hue API V2 (the CLIP v2 REST API exposed by Hue bridges running recent firmware).

Phphue is a spiritual successor to Phue, which targets the now-deprecated Hue API v1 (/api/{username}/...). Phphue keeps the familiar Client / Command / Transport / Resource architecture but is built around the uniform, resource-oriented CLIP v2 API: https://{bridge}/clip/v2/resource/{type}, the hue-application-key header, the {data, errors} envelope, and the Server-Sent Events stream.

Scope: This release covers the full CLIP v2 REST API and the event stream. The real-time Entertainment streaming API (DTLS) is intentionally out of scope for now and planned as a follow-up — the architecture leaves room for it (Resource\Entertainment*, separated transport).

Requirements

PHP 8.5+
ext-curl (default transport adapter and event stream)

Installation

composer require neoteknic/phphue

Getting started

1. Create an application key

Press the link button on the bridge, then:

use Phphue\Client;

$client = new Client('192.168.1.10');                 // bridge IP or hostname
$key = $client->createApplicationKey('my-app', 'cli', true); // true => also a clientkey

echo $key->username;   // <- your application key, store it

2. Talk to the bridge

use Phphue\Client;
use Phphue\State\LightState;

$client = new Client('192.168.1.10', 'YOUR_APPLICATION_KEY');

// Typed accessors
foreach ($client->getLights() as $light) {
    echo $light->getName(), ' ', $light->isOn() ? 'on' : 'off', "\n";
}

// Fluent state, applied in a single PUT
$light = $client->getLights()[0];
$light->applyState(
    (new LightState())->on()->brightness(80)->colorRGB(255, 120, 0)->transition(400)
);

// Or the quick setters
$light->setColorTemperature(300);   // mired/mirek
$light->off();

Fast updates

Keep the same Client for successive commands in a process so it can reuse its TCP/TLS connection. When you already know the resource ID, use the write helpers: they send one PUT with no preliminary GET.

$state = (new LightState())->on()->brightness(80)->colorRGB(255, 120, 0);
$client->setLightState($lightId, $state);

// One command for an entire room/zone; use its grouped_light service ID.
$client->setGroupedLightState($groupedLightId, $state);

// A room/zone/home already loaded includes the service reference.
$room->applyState($state);  // no GET of grouped_light, one PUT for the group
$groupedLightId = $room->getGroupedLightId(); // local lookup, no request

// Activate an existing scene without first fetching it.
$client->recallScene($sceneId);

For an existing light or grouped light, applyState() also sends one PUT. The callback variant prepares the changes locally before sending:

$light->updateState(fn (LightState $state) => $state
    ->on()
    ->brightness(80)
    ->colorRGB(255, 120, 0)
);

An empty state sends nothing; a callback that throws sends nothing. In contrast, chaining the immediate resource setters still sends one PUT per setter. For common changes across lights, prefer a grouped light; for a stored multi-light appearance, recall a scene. These helpers do not create groups/scenes automatically.

No transition is forced: omit transition() to retain the bridge default, or use transition(0) when an immediate change is wanted. The REST request timeout defaults to 4 seconds and can still be configured through the Curl adapter constructor. There are no automatic retries: a timed-out write may already have reached the bridge.

Resource getters read the last fetched snapshot, not proof that a PUT has completed on the lamp. Writes do not trigger a refresh or mutate that snapshot. To minimize reads in a long-running application, load initial state once and merge SSE update fields into an application-owned cache, preserving absent fields and replacing explicit nulls/arrays. Keep requested state separate from bridge-reported state, and resynchronize after a stream reconnection. Event::getResources() wraps the event's partial data; a missing boolean field must not be interpreted as a newly reported false. getLight() and getGroupedLight() retain their explicit GET semantics; use the write helpers on the command path.

Dynamic effects

The Hue API V2 exposes built-in dynamic effects (candle, fire, sparkle, glisten, opal, prism) — there is no V1 equivalent beyond the old colour loop.

use Phphue\State\LightState;

// Which effects does this specific light support?
$light->getEffectValues();          // ['no_effect', 'candle', 'sparkle', ...]

// Start an effect
$light->setEffect(LightState::EFFECT_SPARKLE);

// The effects_v2 variant lets you tune the speed (0-1)
$light->setEffectV2(LightState::EFFECT_PRISM, speed: 0.6);

// Stop the running effect
$light->setEffect(LightState::EFFECT_NO_EFFECT);

// ...or combine it with other state in one PUT
$light->applyState(
    (new LightState())->on()->brightness(80)->effectV2(LightState::EFFECT_FIRE, 0.4)
);

Architecture

Layer	Classes	Role
Client	`Phphue\Client`	Holds the host + application key, exposes accessors, sends commands
Commands	`Phphue\Command\*`	Generic CRUD over any resource type (`GetResources`, `GetResourceById`, `CreateResource`, `UpdateResource`, `DeleteResource`, `GetAllResources`, `CreateApplicationKey`)
Transport	`Phphue\Transport\Http` + `Adapter\Curl`	HTTPS, `hue-application-key` header, `{data, errors}` parsing, status-code → exception mapping; the cURL handle is kept alive so successive requests reuse the same TCP/TLS connection
Resources	`Phphue\Resource\*`	Typed wrappers (`Light`, `Room`, `Zone`, `Scene`, `Device`, ...) built by `ResourceFactory`; unknown types fall back to `GenericResource`
State	`Phphue\State\LightState`, `Color`	PUT-body builder and RGB ⇄ xy / Kelvin ⇄ mirek conversions
Events	`Phphue\EventStream\EventStream`, `Event`	Consumes `GET /eventstream/clip/v2` (SSE)

Generic access (every resource type)

Because the CLIP v2 API is uniform, every route is reachable generically:

$client->getResources('motion');                 // AbstractResource[]
$client->getResourceById('device', $id);          // AbstractResource
$client->createResource('room', ['type' => 'room', 'metadata' => ['name' => 'Office']]);
$client->updateResource('light', $id, ['on' => ['on' => true]]);
$client->deleteResource('scene', $id);
$client->getAllResources();                        // GET /clip/v2/resource

Typed convenience accessors exist for the common types: getLights(), getGroupedLights(), getRooms(), getZones(), getScenes(), getSmartScenes(), getDevices(), getDevicePowers(), getBridge(), getBridgeHomes(), getMotionSensors(), getTemperatures(), getLightLevels(), getButtons(), getEntertainmentConfigurations().

Resource types with a dedicated wrapper: light, grouped_light, room, zone, bridge, bridge_home, scene, smart_scene, device, device_power, motion, temperature, light_level, button, relative_rotary, contact, tamper, zigbee_connectivity, entertainment, entertainment_configuration, behavior_script, behavior_instance, geofence_client, geolocation, homekit, matter. Any other type (service_group, zgp_connectivity, matter_fabric, public_image, ...) is returned as a GenericResource and remains fully usable through attr(), getRaw(), update() and delete().

Event stream

use Phphue\EventStream\Event;

$client->eventStream(/* maxSeconds */ 0)->listen(function (Event $event) {
    foreach ($event->getResources() as $resource) {
        echo $event->getType(), ' ', $resource->getType(), ' ', $resource->getId(), "\n";
    }
    // return false to stop listening
});

Warnings

The bridge answers with { "errors": [...], "data": [...] }. A non-2xx HTTP status is mapped to an exception (UnauthorizedException, NotFoundException, RateLimitException, BridgeBusyException, ...). A 2xx response can still carry errors. When data is non-empty, these are exposed as warnings describing a potentially partial success, e.g. a Zigbee light that "has communication issues, command may not have effect". Errors with empty data always throw HueException, even in non-strict mode. Invalid JSON or a malformed CLIP v2 envelope throws ConnectionException; invalid outgoing JSON throws JsonException before opening a connection. Network errors include cURL's error code and description. sendRaw() also checks HTTP/network/JSON errors, while retaining the legacy JSON response format.

By default warnings accompanying data do not throw. Read them, handle them, or restore the strict behaviour:

$transport = $client->getTransport();

// Push model: called on every warning
$transport->setWarningHandler(function (array $warnings): void {
    foreach ($warnings as $description) {
        error_log('[hue] ' . $description);
    }
});

// Pull model: inspect after a call
$light->setEffect(LightState::EFFECT_SPARKLE);
foreach ($transport->getLastWarnings() as $description) {
    // ...
}

// Opt back into "any error throws a HueException"
$transport->setThrowOnWarnings(true);

TLS

Hue bridges present a self-signed certificate, so certificate verification is off by default. To pin the official Hue CA, enable it and pass the bundle to the adapter:

$client = new Client('192.168.1.10', $key, sslVerify: true);
$client->getTransport()->setAdapter(new \Phphue\Transport\Adapter\Curl(true, 4, '/path/to/huebridge_cacert.pem'));

Changing Client::setSslVerify() updates an existing cURL adapter and disconnects its old connection, preserving its timeout and CA configuration. Custom adapters must be configured directly; the HTTP transport throws if this setter cannot update their TLS policy.

Examples

See the examples/ directory. Set HUE_BRIDGE and HUE_APP_KEY env vars:

HUE_BRIDGE=192.168.1.10 php examples/create-key.php       # press the link button first
HUE_BRIDGE=192.168.1.10 HUE_APP_KEY=xxxxx php examples/list-lights.php
HUE_BRIDGE=192.168.1.10 HUE_APP_KEY=xxxxx php examples/set-light-state.php
HUE_BRIDGE=192.168.1.10 HUE_APP_KEY=xxxxx php examples/event-stream.php

Development

composer install
composer phpunit     # unit tests
composer phpstan     # static analysis (level 6)

License

BSD-3-Clause. See LICENSE. Portions derived from the Phue project.

neoteknic / phphue

Package info

Security

Statistics