Gumax LST103
Model | LST103 |
Vendor | Gumax |
Description | Gumax lighting system |
Exposes | light (state, brightness, color_temp, color_temp_startup, color_xy, color_hs), effect, power_on_behavior, linkquality |
Picture |
Notes
Pairing
- Power the device for at least 10 seconds.
- Cut the power for 1 second.
- Power on the device for 1 second.
- Repeat step 2-3 four times in total.
- The lighting system should flash all colours and then return to neutral white. The lighting system is now reset, and in pairing mode.
Note: It might help to put a routing device fairly close to the lighting system (within 2-3 meters) if pairing doesn't seem to work.
See this video for mouting instructions, including pairing and resetting.
Options
How to use device type specific configuration
transition
: Controls the transition time (in seconds) of on/off, brightness, color temperature (if applicable) and color (if applicable) changes. Defaults to0
(no transition). The value must be a number with a minimum value of0
color_sync
: When enabled colors will be synced, e.g. if the light supports both color x/y and color temperature a conversion from color x/y to color temperature will be done when setting the x/y color (default true). The value must betrue
orfalse
state_action
: State actions will also be published as 'action' when true (default false). The value must betrue
orfalse
Exposes
Light
This light supports the following features: state
, brightness
, color_temp
, color_temp_startup
, color_xy
, color_hs
.
state
: To control the state publish a message to topiczigbee2mqtt/FRIENDLY_NAME/set
with payload{"state": "ON"}
,{"state": "OFF"}
or{"state": "TOGGLE"}
. To read the state send a message tozigbee2mqtt/FRIENDLY_NAME/get
with payload{"state": ""}
.brightness
: To control the brightness publish a message to topiczigbee2mqtt/FRIENDLY_NAME/set
with payload{"brightness": VALUE}
whereVALUE
is a number between0
and254
. To read the brightness send a message tozigbee2mqtt/FRIENDLY_NAME/get
with payload{"brightness": ""}
.color_temp
: To control the color temperature (in reciprocal megakelvin a.k.a. mired scale) publish a message to topiczigbee2mqtt/FRIENDLY_NAME/set
with payload{"color_temp": VALUE}
whereVALUE
is a number between153
and370
, the higher the warmer the color. To read the color temperature send a message tozigbee2mqtt/FRIENDLY_NAME/get
with payload{"color_temp": ""}
. Besides the numeric values the following values are accepted:coolest
,cool
,neutral
,warmest
.color_temp_startup
: To set the startup color temperature (in reciprocal megakelvin a.k.a. mired scale) publish a message to topiczigbee2mqtt/FRIENDLY_NAME/set
with payload{"color_temp_startup": VALUE}
whereVALUE
is a number between153
and370
, the higher the warmer the color. To read the startup color temperature send a message tozigbee2mqtt/FRIENDLY_NAME/get
with payload{"color_temp_startup": ""}
. Besides the numeric values the following values are accepted:coolest
,cool
,neutral
,warmest
,previous
.color_xy
: To control the XY color (CIE 1931 color space) publish a message to topiczigbee2mqtt/FRIENDLY_NAME/set
with payload{"color": {"x": X_VALUE, "y": Y_VALUE}}
(e.g.{"color":{"x":0.123,"y":0.123}}
). To read the XY color send a message tozigbee2mqtt/FRIENDLY_NAME/get
with payload{"color":{"x":"","y":""}}
. Alternatively it is possible to set the XY color via RGB:{"color": {"r": R, "g": G, "b": B}}
e.g.{"color":{"r":46,"g":102,"b":150}}
{"color": {"rgb": "R,G,B"}}
e.g.{"color":{"rgb":"46,102,150"}}
{"color": {"hex": HEX}}
e.g.{"color":{"hex":"#547CFF"}}
color_hs
: To control the hue/saturation (color) publish a message to topiczigbee2mqtt/FRIENDLY_NAME/set
with payload{"color": {"hue": HUE, "saturation": SATURATION}}
(e.g.{"color":{"hue":360,"saturation":100}}
). To read the hue/saturation send a message tozigbee2mqtt/FRIENDLY_NAME/get
with payload{"color":{"hue":"","saturation":""}}
. Alternatively it is possible to set the hue/saturation via:- HSB space (hue, saturation, brightness):
{"color": {"h": H, "s": S, "b": B}}
e.g.{"color":{"h":360,"s":100,"b":100}}
or{"color": {"hsb": "H,S,B"}}
e.g.{"color":{"hsb":"360,100,100"}}
- HSV space (hue, saturation, value):
{"color": {"h": H, "s": S, "v": V}}
e.g.{"color":{"h":360,"s":100,"v":100}}
or{"color": {"hsv": "H,S,V"}}
e.g.{"color":{"hsv":"360,100,100"}}
- HSL space (hue, saturation, lightness)
{"color": {"h": H, "s": S, "l": L}}
e.g.{"color":{"h":360,"s":100,"l":100}}
or{"color": {"hsl": "H,S,L"}}
e.g.{"color":{"hsl":"360,100,100"}}
- HSB space (hue, saturation, brightness):
On with timed off
When setting the state to ON, it might be possible to specify an automatic shutoff after a certain amount of time. To do this add an additional property on_time
to the payload which is the time in seconds the state should remain on. Additionally an off_wait_time
property can be added to the payload to specify the cooldown time in seconds when the light will not answer to other on with timed off commands. Support depends on the light firmware. Some devices might require both on_time
and off_wait_time
to work Examples : {"state" : "ON", "on_time": 300}
, {"state" : "ON", "on_time": 300, "off_wait_time": 120}
.
Transition
For all of the above mentioned features it is possible to do a transition of the value over time. To do this add an additional property transition
to the payload which is the transition time in seconds. Examples: {"brightness":156,"transition":3}
, {"color_temp":241,"transition":1}
.
Moving/stepping
Instead of setting a value (e.g. brightness) directly it is also possible to:
- move: this will automatically move the value over time, to stop send value
stop
or0
. - step: this will increment/decrement the current value by the given one.
The direction of move and step can be either up or down, provide a negative value to move/step down, a positive value to move/step up. To do this send a payload like below to zigbee2mqtt/FRIENDLY_NAME/set
NOTE: brightness move/step will stop at the minimum brightness and won't turn on the light when it's off. In this case use brightness_move_onoff
/brightness_step_onoff
{
"brightness_move": -40, // Starts moving brightness down at 40 units per second
"brightness_move": 0, // Stop moving brightness
"brightness_step": 40 // Increases brightness by 40
"color_temp_move": 60, // Starts moving color temperature up at 60 units per second
"color_temp_move": "stop", // Stop moving color temperature
"color_temp_step": 99, // Increase color temperature by 99
"hue_move": 40, // Starts moving hue up at 40 units per second, will endlessly loop (allowed value range: -255 till 255)
"hue_step": -90, // Decrease hue by 90 (allowed value range: -255 till 255)
"saturation_move": -55, // Starts moving saturation down at -55 units per second (allowed value range: -255 till 255)
"saturation_step": 66, // Increase saturation by 66 (allowed value range: -255 till 255)
}
Effect (enum)
Triggers an effect on the light (e.g. make light blink for a few seconds). Value will not be published in the state. It's not possible to read (/get
) this value. To write (/set
) a value publish a message to topic zigbee2mqtt/FRIENDLY_NAME/set
with payload {"effect": NEW_VALUE}
. The possible values are: blink
, breathe
, okay
, channel_change
, finish_effect
, stop_effect
, colorloop
, stop_colorloop
.
Power-on behavior (enum)
Controls the behavior when the device is powered on after power loss. Value can be found in the published state on the power_on_behavior
property. To read (/get
) the value publish a message to topic zigbee2mqtt/FRIENDLY_NAME/get
with payload {"power_on_behavior": ""}
. To write (/set
) a value publish a message to topic zigbee2mqtt/FRIENDLY_NAME/set
with payload {"power_on_behavior": NEW_VALUE}
. The possible values are: off
, on
, toggle
, previous
.
Linkquality (numeric)
Link quality (signal strength). Value can be found in the published state on the linkquality
property. It's not possible to read (/get
) or write (/set
) this value. The minimal value is 0
and the maximum value is 255
. The unit of this value is lqi
.