-
Notifications
You must be signed in to change notification settings - Fork 8.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'origin/dev' into feat/1.0.0
- Loading branch information
Showing
17 changed files
with
746 additions
and
434 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
<!-- Notes BEGIN: You can edit here. Add "## Notes" headline if not already present. --> | ||
Steps for resetting | ||
1. Open the casing of the device | ||
2. Press and hold the reset button for approximately 14-16 seconds. | ||
3. While holding down the button, the LED first flashes once, then two times in a row, and finally numerous times in a row. | ||
4. After a succesful reset, the yellow LED will start flashing which indicates network search. | ||
<!-- Notes END: Do not edit below this line --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,139 @@ | ||
--- | ||
title: "Sunricher HK-SL-DIM-AU-R-A control via MQTT" | ||
description: "Integrate your Sunricher HK-SL-DIM-AU-R-A via Zigbee2MQTT with whatever smart home infrastructure you are using without the vendor's bridge or gateway." | ||
addedAt: 2024-10-11T23:59:59Z | ||
pageClass: device-page | ||
--- | ||
|
||
<!-- !!!! --> | ||
<!-- ATTENTION: This file is auto-generated through docgen! --> | ||
<!-- You can only edit the "Notes"-Section between the two comment lines "Notes BEGIN" and "Notes END". --> | ||
<!-- Do not use h1 or h2 heading within "## Notes"-Section. --> | ||
<!-- !!!! --> | ||
|
||
# Sunricher ZG2835RAC | ||
|
||
| | | | ||
|-----|-----| | ||
| Model | HK-SL-DIM-AU-R-A | | ||
| Vendor | [Sunricher](/supported-devices/#v=Sunricher) | | ||
| Description | ZigBee knob smart dimmer | | ||
| Exposes | light (state, brightness), effect, power_on_behavior, power, voltage, current, energy, linkquality | | ||
| Picture | ![Sunricher HK-SL-DIM-AU-R-A](https://www.zigbee2mqtt.io/images/devices/HK-SL-DIM-AU-R-A.png) | | ||
| White-label | YPHIX 50208695, Samotech SM311 | | ||
|
||
|
||
<!-- Notes BEGIN: You can edit here. Add "## Notes" headline if not already present. --> | ||
|
||
|
||
<!-- Notes END: Do not edit below this line --> | ||
|
||
|
||
|
||
## Options | ||
*[How to use device type specific configuration](../guide/configuration/devices-groups.md#specific-device-options)* | ||
|
||
* `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 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 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 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 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`. | ||
- `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` | ||
````js | ||
{ | ||
"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 | ||
} | ||
```` | ||
|
||
### 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`. | ||
|
||
### Power-on behavior (enum) | ||
Controls the behavior when the device is powered on after power loss. If you get an `UNSUPPORTED_ATTRIBUTE` error, the device does not support it.. | ||
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`. | ||
|
||
### Power (numeric) | ||
Instantaneous measured power. | ||
Value can be found in the published state on the `power` property. | ||
To read (`/get`) the value publish a message to topic `zigbee2mqtt/FRIENDLY_NAME/get` with payload `{"power": ""}`. | ||
It's not possible to write (`/set`) this value. | ||
The unit of this value is `W`. | ||
|
||
### Voltage (numeric) | ||
Measured electrical potential value. | ||
Value can be found in the published state on the `voltage` property. | ||
To read (`/get`) the value publish a message to topic `zigbee2mqtt/FRIENDLY_NAME/get` with payload `{"voltage": ""}`. | ||
It's not possible to 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. | ||
To read (`/get`) the value publish a message to topic `zigbee2mqtt/FRIENDLY_NAME/get` with payload `{"current": ""}`. | ||
It's not possible to write (`/set`) this value. | ||
The unit of this value is `A`. | ||
|
||
### Energy (numeric) | ||
Sum of consumed energy. | ||
Value can be found in the published state on the `energy` property. | ||
To read (`/get`) the value publish a message to topic `zigbee2mqtt/FRIENDLY_NAME/get` with payload `{"energy": ""}`. | ||
It's not possible to write (`/set`) this value. | ||
The unit of this value is `kWh`. | ||
|
||
### 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`. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.