# Philips Hue Driver - Version 3.0

Introduction & Manufacturer Profile

The Philips Hue lighting system enables smart control of lights with features like switching, dimming, and full control for RGB colors and tunable lights. It integrates seamlessly with the Hue Bridge and mobile application for scalable lighting management.

The driver maintains two simultaneous HTTPS connections to the bridge: a command connection for sending API requests, and a Server-Sent Events (SSE) stream for receiving real-time state feedback. Both use port 443 with SSL/TLS. The driver automatically reconnects both channels on failure. This version makes use of the new Clip API v2, as v1 will be deprecated in the future.

---

Version History

• v3.0 (2/27/2025) - Initial Release

---

Driver Features

• Switching - Turn devices on/off seamlessly, with toggle support
• Dimming - Smooth, responsive brightness/level control (0-100%, 5% step)
• Color Control (RGB/CT) - Adjust individual color channels (RGB) and color temperature (50-1000 mirek)
• Color Presets - User-configurable RGB presets for quick color recall
• Scene Control - Recall Hue scenes configured on the bridge
• Scalable Control - Supports control of individual Lights, Rooms, Zones, and the bridge home itself
• Real-time Feedback - Live state updates via SSE event stream
• Auto Reconnect - 15-second keepalive with automatic reconnection on failure
• Auto API Key - Prompts link-button press on bridge if no API key is configured

---

System Requirements & Prerequisites

RTI System Requirements

• Integration Designer - 11.x or above
• XP Firmware - 25.x or above

Manufacturer Device Requirements

• Philips Hue Bridge - FW Version: 1.x
• Philips Hue Bridge Pro - FW Version: 1.x

---

Driver Configuration

Please refer to the Philips Driver Configuration Guide for initial driver configuration.

---

Device Configuration

1. Create a Hue account.
2. Connect to the Philips Hue Bridge.
3. Configure all lights.
4. Create required Rooms and Zones.
5. Create desired Scenes.

Note: Set a static IP through your router; otherwise, you may experience Hue Bridge connection issues.

---

Events

This driver supports the following events for each Light, Room, Zone, and Home.

• Light ON - Triggered when a light is turned ON from OFF
• Light OFF - Triggered when a light is turned OFF from ON
• Room ON - Triggered when a room is turned ON from OFF
• Room OFF - Triggered when a room is turned OFF from ON
• Zone ON - Triggered when a zone is turned ON from OFF
• Zone OFF - Triggered when a zone is turned OFF from ON
• Home ON - Triggered when Home is turned ON from OFF
• Home OFF - Triggered when Home is turned OFF from ON

---

Functions

This driver supports the following functions.

Slider-compatible: Functions marked with (slider) accept a numeric Value and can be mapped to a slider. Functions with an Action parameter are button-based.

• Switching Control
  • Load - Select Group or specific Light from the list.
  • Action - Select action: Off, On, or Toggle.
• Brightness Control (slider, 0-100%)
  • Load - Select Group or specific Light from the list.
  • Value - Enter Brightness value between 0 and 100 (%).
• Dimming Control
  • Load - Select Group or specific Light from the list.
  • Action - Select action: Increase or Decrease.
• Color Temperature (slider, mirek)
  • Load - Select Group or specific Light from the list.
  • Value - Enter Color Temperature value (mirek).
• Color Tuning
  • Load - Select Group or specific Light from the list.
  • Action - Select action: Warm or Cool.
• Set Red (slider, 0-255)
  • Load - Select Group or specific Light from the list.
  • Value - Enter Red channel intensity (0-255).
• Set Green (slider, 0-255)
  • Load - Select Group or specific Light from the list.
  • Value - Enter Green channel intensity (0-255).
• Set Blue (slider, 0-255)
  • Load - Select Group or specific Light from the list.
  • Value - Enter Blue channel intensity (0-255).
• Color Preset
  • Load - Select Group or specific Light from the list.
  • Color - Select Color Preset to be applied.
• Scene - No parameters.

---

Variables

This driver provides the following variables for each Light, Room, Zone, and Home configured in the Hue Bridge. Variable names are prefixed with the device name as configured on the bridge (e.g. Living Room On, Kitchen Brightness).

Light Variables

• On (Boolean) - Light is currently switched ON
• Off (Boolean) - Light is currently switched OFF
• Brightness (Integer) - Current brightness level (0-100%)
• Color Temperature (Integer) - Current color temperature (mirek)
• Color Mode (String) - Active color mode: Color Tunable or RGB Color
• Red (Integer) - Current red channel intensity (0-255)
• Green (Integer) - Current green channel intensity (0-255)
• Blue (Integer) - Current blue channel intensity (0-255)

Room Variables

• On (Boolean) - Room is currently switched ON
• Off (Boolean) - Room is currently switched OFF
• Brightness (Integer) - Current brightness level (0-100%)
• Color Temperature (Integer) - Current color temperature (mirek)
• Red (Integer) - Current red channel intensity (0-255)
• Green (Integer) - Current green channel intensity (0-255)
• Blue (Integer) - Current blue channel intensity (0-255)

Zone Variables

• On (Boolean) - Zone is currently switched ON
• Off (Boolean) - Zone is currently switched OFF
• Brightness (Integer) - Current brightness level (0-100%)
• Color Temperature (Integer) - Current color temperature (mirek)
• Red (Integer) - Current red channel intensity (0-255)
• Green (Integer) - Current green channel intensity (0-255)
• Blue (Integer) - Current blue channel intensity (0-255)

Home Variables

• On (Boolean) - Home is currently switched ON
• Off (Boolean) - Home is currently switched OFF
• Brightness (Integer) - Current brightness level (0-100%)
• Color Temperature (Integer) - Current color temperature (mirek)
• Red (Integer) - Current red channel intensity (0-255)
• Green (Integer) - Current green channel intensity (0-255)
• Blue (Integer) - Current blue channel intensity (0-255)

---

Limitations

Driver Limitations

This driver supports control of Lights, Rooms, Zones, and Scenes. RGB color and color temperature control is only available on fixtures that support those capabilities.

Hardware Limitations

• Hue Bridge - Up to 50 lights, up to 12 accessories
• Hue Bridge Pro - 150+ lights, 50+ accessories

Note: These hardware limitations are defined by Philips Hue Bridge specifications.

---

System Testing

• Integration Designer - 11
• XP Processor Model - XP-6
• XP Processor Firmware - 25.11
• Device Model - Hue Bridge Pro
• Device Firmware - 1.74

---

Support Contact

Miantic AV Distribution Pvt Ltd. licenses@miantic.com

Copyright Miantic AV Distribution 2021-2025