Light — light
A controllable light load — switched, dimmed, tunable, or full color.
Capabilities
Declared in the driver manifest under [[proxy]] capabilities. Anything not declared takes the default below.
| Capability | Type | Default | Meaning |
|---|---|---|---|
cct_max | u32 | 6500 | |
cct_min | u32 | 2700 | |
dimmer | bool | false | Supports levels between off and on |
has_button_events | bool | false | Physical keypad on the load reports presses |
load_group_support | bool | false | Can join a synchronised group at the device level |
max_on_level | u8 | 100 | |
min_on_level | u8 | 1 | Lowest level the load will hold without flicker |
ramp_rate_max_ms | u32 | 0 | Longest fade the hardware accepts |
supports_cct | bool | false | Tunable correlated color temperature |
supports_color | bool | false | Full hue/saturation color |
supports_ramp | bool | false | Honours a ramp time on level changes |
supports_target | bool | false | Can be told to ramp toward a level over time and report progress |
Commands
off
No parameters.
on
No parameters.
ramp_start
Only present when
supports_rampis declared true.
Begin ramping in a direction until stopped — for held keypad buttons
| Parameter | Type | Notes |
|---|---|---|
direction | one of up · down |
ramp_stop
Only present when
supports_rampis declared true.
No parameters.
set_cct
Only present when
supports_cctis declared true.
| Parameter | Type | Notes |
|---|---|---|
kelvin | u32 1000–10000 | |
ramp_ms | u32 (optional) (needs supports_ramp) | Fade time |
set_color
Only present when
supports_coloris declared true.
| Parameter | Type | Notes |
|---|---|---|
hue | f32 0–360 | |
ramp_ms | u32 (optional) (needs supports_ramp) | Fade time |
sat | f32 0–100 |
set_level
Only present when
dimmeris declared true.
Set brightness. 0 is off.
| Parameter | Type | Notes |
|---|---|---|
level | u8 0–100 | |
ramp_ms | u32 (optional) (needs supports_ramp) | Fade time |
toggle
No parameters.
Notifications
button_action
Only present when
has_button_eventsis declared true.
| Parameter | Type | Notes |
|---|---|---|
action | one of press · release · click · double · hold | |
button | string |
cct_changed
Only present when
supports_cctis declared true.
| Parameter | Type | Notes |
|---|---|---|
kelvin | u32 |
color_changed
Only present when
supports_coloris declared true.
| Parameter | Type | Notes |
|---|---|---|
hue | f32 | |
sat | f32 |
level_changed
Settled at a level
| Parameter | Type | Notes |
|---|---|---|
level | u8 0–100 |
level_changing
Mid-ramp progress. Rate-limited by the driver; core does not persist these.
| Parameter | Type | Notes |
|---|---|---|
level | u8 0–100 |
online_changed
| Parameter | Type | Notes |
|---|---|---|
online | bool |
power_changed
| Parameter | Type | Notes |
|---|---|---|
on | bool |
State
Last-known values core keeps for a binding of this proxy.
| Key | Type | Meaning |
|---|---|---|
hue | f32 | |
kelvin | u32 | |
level | u8 | |
on | bool | |
online | bool | |
sat | f32 |