Aqara WS-K05E


Model	WS-K05E
Vendor	Aqara
Description	Dimmer Switch H2 US
Exposes	light (state, brightness, level_config), power_outage_count, device_temperature, power, energy, voltage, current, led_indicator, flip_indicator_light, mode_switch, operation_mode, power_on_behavior, multi_click, phase, min_brightness, max_brightness, action
Picture

Notes

Warning: Zigbee firmware flashing required

This device is shipped with Thread/Matter firmware. A smartphone, the Aqara Home app and an Aqara account is required for flashing the Zigbee firmware. The color of the indicator shows the wireless standard: green flashing means Thread/Matter pairing, while Zigbee pairing is shown by a yellow flashing indicator.

Resetting:

A double-click on any button immediately followed by a 5-second long-press will reset the device and put it back into pairing mode. Make sure the gap between the double click and the long press does not exceed 3 seconds. The indicator light will flash when the reset was successful.

OTA updates

This device supports OTA updates, for more information see OTA updates.

Options

How to use device type specific configuration

device_temperature_calibration: Calibrates the device_temperature value (absolute offset), takes into effect on next report of device. The value must be a number.
power_calibration: Calibrates the power value (percentual offset), takes into effect on next report of device. The value must be a number.
power_precision: Number of digits after decimal point for power, takes into effect on next report of device. This option can only decrease the precision, not increase it. The value must be a number with a minimum value of 0 and with a maximum value of 3
energy_calibration: Calibrates the energy value (percentual offset), takes into effect on next report of device. The value must be a number.
energy_precision: Number of digits after decimal point for energy, takes into effect on next report of device. This option can only decrease the precision, not increase it. The value must be a number with a minimum value of 0 and with a maximum value of 3
voltage_calibration: Calibrates the voltage value (percentual offset), takes into effect on next report of device. The value must be a number.
voltage_precision: Number of digits after decimal point for voltage, takes into effect on next report of device. This option can only decrease the precision, not increase it. The value must be a number with a minimum value of 0 and with a maximum value of 3
current_calibration: Calibrates the current value (percentual offset), takes into effect on next report of device. The value must be a number.
current_precision: Number of digits after decimal point for current, takes into effect on next report of device. This option can only decrease the precision, not increase it. The value must be a number with a minimum value of 0 and with a maximum value of 3
transition: Controls the transition time (in seconds) of on/off, brightness, color temperature (if applicable) and color (if applicable) changes. Defaults to 0 (no transition). The value must be a number with a minimum value of 0
state_action: State actions will also be published as 'action' when true (default false). The value must be true or false

Exposes

Light

This light supports the following features: state, brightness, level_config.

state: To control the state publish a message to topic zigbee2mqtt/FRIENDLY_NAME/set with payload {"state": "ON"}, {"state": "OFF"} or {"state": "TOGGLE"}. To read the state send a message to zigbee2mqtt/FRIENDLY_NAME/get with payload {"state": ""}.
brightness: To control the brightness publish a message to topic zigbee2mqtt/FRIENDLY_NAME/set with payload {"brightness": VALUE} where VALUE is a number between 0 and 254. To read the brightness send a message to zigbee2mqtt/FRIENDLY_NAME/get with payload {"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 or 0.
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
}

Power outage count (numeric)

Number of power outages (since last pairing). Value can be found in the published state on the power_outage_count property. It's not possible to read (/get) or write (/set) this value.

Device temperature (numeric)

Temperature of the device. Value can be found in the published state on the device_temperature property. It's not possible to read (/get) or write (/set) this value. The unit of this value is °C.

Power (numeric)

Instantaneous measured power. Value can be found in the published state on the power property. It's not possible to read (/get) or write (/set) this value. The unit of this value is W.

Energy (numeric)

Sum of consumed energy. Value can be found in the published state on the energy property. It's not possible to read (/get) or write (/set) this value. The unit of this value is kWh.

Voltage (numeric)

Measured electrical potential value. Value can be found in the published state on the voltage property. It's not possible to read (/get) or write (/set) this value. The unit of this value is V.

Current (numeric)

Instantaneous measured electrical current. Value can be found in the published state on the current property. It's not possible to read (/get) or write (/set) this value. The unit of this value is A.

Led indicator (binary)

LED indicator. Value can be found in the published state on the led_indicator property. To read (/get) the value publish a message to topic zigbee2mqtt/FRIENDLY_NAME/get with payload {"led_indicator": ""}. To write (/set) a value publish a message to topic zigbee2mqtt/FRIENDLY_NAME/set with payload {"led_indicator": NEW_VALUE}. If value equals ON led indicator is ON, if OFF OFF.

Flip indicator light (binary)

After turn on, the indicator light turns on while switch is off, and vice versa. Value can be found in the published state on the flip_indicator_light property. To read (/get) the value publish a message to topic zigbee2mqtt/FRIENDLY_NAME/get with payload {"flip_indicator_light": ""}. To write (/set) a value publish a message to topic zigbee2mqtt/FRIENDLY_NAME/set with payload {"flip_indicator_light": NEW_VALUE}. If value equals ON flip indicator light is ON, if OFF OFF.

Mode switch (enum)

Anti flicker mode can be used to solve blinking issues of some lights. Quick mode makes the device respond faster.. Value can be found in the published state on the mode_switch property. To read (/get) the value publish a message to topic zigbee2mqtt/FRIENDLY_NAME/get with payload {"mode_switch": ""}. To write (/set) a value publish a message to topic zigbee2mqtt/FRIENDLY_NAME/set with payload {"mode_switch": NEW_VALUE}. The possible values are: quick_mode, anti_flicker_mode.

Operation mode (enum, power endpoint)

Decoupled mode for the load relay (decoupling power disables bright/dim buttons). Value can be found in the published state on the operation_mode_power property. To read (/get) the value publish a message to topic zigbee2mqtt/FRIENDLY_NAME/get with payload {"operation_mode_power": ""}. To write (/set) a value publish a message to topic zigbee2mqtt/FRIENDLY_NAME/set with payload {"operation_mode_power": NEW_VALUE}. The possible values are: decoupled, control_relay.

Operation mode (enum, bright endpoint)

Decoupled mode for the brightness up button (disabled when power is decoupled). Value can be found in the published state on the operation_mode_bright property. To read (/get) the value publish a message to topic zigbee2mqtt/FRIENDLY_NAME/get with payload {"operation_mode_bright": ""}. To write (/set) a value publish a message to topic zigbee2mqtt/FRIENDLY_NAME/set with payload {"operation_mode_bright": NEW_VALUE}. The possible values are: decoupled, control_relay.

Operation mode (enum, dim endpoint)

Decoupled mode for the brightness down button (disabled when power is decoupled). Value can be found in the published state on the operation_mode_dim property. To read (/get) the value publish a message to topic zigbee2mqtt/FRIENDLY_NAME/get with payload {"operation_mode_dim": ""}. To write (/set) a value publish a message to topic zigbee2mqtt/FRIENDLY_NAME/set with payload {"operation_mode_dim": NEW_VALUE}. The possible values are: decoupled, control_relay.

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: on, previous, off, inverted.

Multi click (binary, power endpoint)

Multi-click mode for power button. Value can be found in the published state on the multi_click_power property. To read (/get) the value publish a message to topic zigbee2mqtt/FRIENDLY_NAME/get with payload {"multi_click_power": ""}. To write (/set) a value publish a message to topic zigbee2mqtt/FRIENDLY_NAME/set with payload {"multi_click_power": NEW_VALUE}. If value equals true multi click is ON, if false OFF.

Multi click (binary, bright endpoint)

Multi-click mode for brightness up button. Value can be found in the published state on the multi_click_bright property. To read (/get) the value publish a message to topic zigbee2mqtt/FRIENDLY_NAME/get with payload {"multi_click_bright": ""}. To write (/set) a value publish a message to topic zigbee2mqtt/FRIENDLY_NAME/set with payload {"multi_click_bright": NEW_VALUE}. If value equals true multi click is ON, if false OFF.

Multi click (binary, dim endpoint)

Multi-click mode for brightness down button. Value can be found in the published state on the multi_click_dim property. To read (/get) the value publish a message to topic zigbee2mqtt/FRIENDLY_NAME/get with payload {"multi_click_dim": ""}. To write (/set) a value publish a message to topic zigbee2mqtt/FRIENDLY_NAME/set with payload {"multi_click_dim": NEW_VALUE}. If value equals true multi click is ON, if false OFF.

Phase (enum)

Dimming phase. Value can be found in the published state on the phase property. To read (/get) the value publish a message to topic zigbee2mqtt/FRIENDLY_NAME/get with payload {"phase": ""}. To write (/set) a value publish a message to topic zigbee2mqtt/FRIENDLY_NAME/set with payload {"phase": NEW_VALUE}. The possible values are: forward, reverse.

Min brightness (numeric)

Minimum brightness level. Value can be found in the published state on the min_brightness property. 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 {"min_brightness": NEW_VALUE}. The minimal value is 0 and the maximum value is 99. The unit of this value is %.

Max brightness (numeric)

Maximum brightness level. Value can be found in the published state on the max_brightness property. 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 {"max_brightness": NEW_VALUE}. The minimal value is 1 and the maximum value is 100. The unit of this value is %.

Action (enum)

Triggered action (e.g. a button click). Value can be found in the published state on the action property. It's not possible to read (/get) or write (/set) this value. The possible values are: hold_power, hold_bright, hold_dim, single_power, single_bright, single_dim, double_power, double_bright, double_dim, release_power, release_bright, release_dim.