Lightkey Home Assistant Integration (HACS)

Custom Home Assistant integration for controlling Lightkey via OSC (Open Sound Control).

This integration is service-based (no automatic entity discovery) because Lightkey's OSC interface is command-oriented and does not expose a simple API for enumerating cues/pages.

Features

• UI-based config flow (Settings -> Devices & Services)
• Sends OSC commands to Lightkey over UDP (default port 21600)
• Built-in Home Assistant services for common Lightkey actions:
  • lightkey.activate_cue
  • lightkey.deactivate_cue
  • lightkey.toggle_cue
  • lightkey.set_cue_intensity
  • lightkey.select_page
  • lightkey.live_action
  • lightkey.send_osc (escape hatch for any OSC path)

Installation (HACS)

1. Add this repository as a custom repository in HACS (Integration type).
2. Install Lightkey.
3. Restart Home Assistant.
4. Go to Settings -> Devices & Services -> Add Integration, search for Lightkey.

Lightkey Setup

In Lightkey:

1. Enable OSC input.
2. Confirm the OSC port (default is 21600).
3. Ensure Home Assistant can reach the machine running Lightkey over the network.

Example Service Calls

Activate a cue

service: lightkey.activate_cue
data:
  page: "Main"
  cue: "House"

Set cue intensity

service: lightkey.set_cue_intensity
data:
  page: "Main"
  cue: "Wash"
  intensity: 0.5

intensity is normalized (0.0 to 1.0) and is converted to Lightkey's OSC cue value percent (0 to 100).

Trigger any OSC command directly

service: lightkey.send_osc
data:
  address: "/lightkey/live/page/Main/cue/House/toggle"
  arguments: []

Notes

• This integration currently sends OSC commands only (UDP). It does not read back Lightkey state.
• If you configure multiple Lightkey instances, include entry_id in service calls to target a specific one.