-
Notifications
You must be signed in to change notification settings - Fork 8.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[New manufacturer : Yokis] Add documentation for several Yokis devices (
- Loading branch information
1 parent
28d85d6
commit 9b9618c
Showing
30 changed files
with
2,310 additions
and
0 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,66 @@ | ||
| --- | ||
| title: "YOKIS E2BP-UP control via MQTT" | ||
| description: "Integrate your YOKIS E2BP-UP via Zigbee2MQTT with whatever smart home infrastructure you are using without the vendor's bridge or gateway." | ||
| addedAt: 2024-12-29T16:26:41 | ||
| 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. --> | ||
| <!-- !!!! --> | ||
|
|
||
| # YOKIS E2BP-UP | ||
|
|
||
| | | | | ||
| |-----|-----| | ||
| | Model | E2BP-UP | | ||
| | Vendor | [YOKIS](/supported-devices/#v=YOKIS) | | ||
| | Description | Flush-mounted independent 2-channel transmitter | | ||
| | Exposes | identify, action, linkquality | | ||
| | Picture |  | | ||
|
|
||
|
|
||
| <!-- 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)* | ||
|
|
||
| * `identify_timeout`: Sets the duration of the identification procedure in seconds (i.e., how long the device would flash).The value ranges from 1 to 30 seconds (default: 3). The value must be a number with a minimum value of `1` and with a with a maximum value of `30` | ||
|
|
||
| * `simulated_brightness`: Simulate a brightness value. If this device provides a brightness_move_up or brightness_move_down action it is possible to specify the update interval and delta. The action_brightness_delta indicates the delta for each interval. Example: | ||
| ```yaml | ||
| simulated_brightness: | ||
| delta: 20 # delta per interval, default = 20 | ||
| interval: 200 # interval in milliseconds, default = 200 | ||
| ``` | ||
| ## Exposes | ||
| ### Identify (enum) | ||
| Initiate device identification. | ||
| 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 `{"identify": NEW_VALUE}`. | ||
| The possible values are: `identify`. | ||
|
|
||
| ### 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: `on`, `off`, `toggle`, `brightness_move_to_level`, `brightness_move_up`, `brightness_move_down`, `brightness_step_up`, `brightness_step_down`, `brightness_stop`, `open`, `close`, `stop`. | ||
|
|
||
| ### 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| --- | ||
| title: "YOKIS E4BP-UP control via MQTT" | ||
| description: "Integrate your YOKIS E4BP-UP via Zigbee2MQTT with whatever smart home infrastructure you are using without the vendor's bridge or gateway." | ||
| addedAt: 2024-12-29T16:26:41 | ||
| 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. --> | ||
| <!-- !!!! --> | ||
|
|
||
| # YOKIS E4BP-UP | ||
|
|
||
| | | | | ||
| |-----|-----| | ||
| | Model | E4BP-UP | | ||
| | Vendor | [YOKIS](/supported-devices/#v=YOKIS) | | ||
| | Description | Flush-mounted independent 4-channel transmitter | | ||
| | Exposes | identify, action, linkquality | | ||
| | Picture |  | | ||
|
|
||
|
|
||
| <!-- 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)* | ||
|
|
||
| * `identify_timeout`: Sets the duration of the identification procedure in seconds (i.e., how long the device would flash).The value ranges from 1 to 30 seconds (default: 3). The value must be a number with a minimum value of `1` and with a with a maximum value of `30` | ||
|
|
||
| * `simulated_brightness`: Simulate a brightness value. If this device provides a brightness_move_up or brightness_move_down action it is possible to specify the update interval and delta. The action_brightness_delta indicates the delta for each interval. Example: | ||
| ```yaml | ||
| simulated_brightness: | ||
| delta: 20 # delta per interval, default = 20 | ||
| interval: 200 # interval in milliseconds, default = 200 | ||
| ``` | ||
| ## Exposes | ||
| ### Identify (enum) | ||
| Initiate device identification. | ||
| 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 `{"identify": NEW_VALUE}`. | ||
| The possible values are: `identify`. | ||
|
|
||
| ### 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: `on`, `off`, `toggle`, `brightness_move_to_level`, `brightness_move_up`, `brightness_move_down`, `brightness_step_up`, `brightness_step_down`, `brightness_stop`, `open`, `close`, `stop`. | ||
|
|
||
| ### 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| --- | ||
| title: "YOKIS GALET4-UP control via MQTT" | ||
| description: "Integrate your YOKIS GALET4-UP via Zigbee2MQTT with whatever smart home infrastructure you are using without the vendor's bridge or gateway." | ||
| addedAt: | ||
| 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. --> | ||
| <!-- !!!! --> | ||
|
|
||
| # YOKIS GALET4-UP | ||
|
|
||
| | | | | ||
| |-----|-----| | ||
| | Model | GALET4-UP | | ||
| | Vendor | [YOKIS](/supported-devices/#v=YOKIS) | | ||
| | Description | 4-button remote control | | ||
| | Exposes | identify, action, linkquality | | ||
| | Picture |  | | ||
|
|
||
|
|
||
| <!-- 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)* | ||
|
|
||
| * `identify_timeout`: Sets the duration of the identification procedure in seconds (i.e., how long the device would flash).The value ranges from 1 to 30 seconds (default: 3). The value must be a number with a minimum value of `1` and with a with a maximum value of `30` | ||
|
|
||
| * `simulated_brightness`: Simulate a brightness value. If this device provides a brightness_move_up or brightness_move_down action it is possible to specify the update interval and delta. The action_brightness_delta indicates the delta for each interval. Example: | ||
| ```yaml | ||
| simulated_brightness: | ||
| delta: 20 # delta per interval, default = 20 | ||
| interval: 200 # interval in milliseconds, default = 200 | ||
| ``` | ||
| ## Exposes | ||
| ### Identify (enum) | ||
| Initiate device identification. | ||
| 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 `{"identify": NEW_VALUE}`. | ||
| The possible values are: `identify`. | ||
|
|
||
| ### 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: `on`, `off`, `toggle`, `brightness_move_to_level`, `brightness_move_up`, `brightness_move_down`, `brightness_step_up`, `brightness_step_down`, `brightness_stop`, `open`, `close`, `stop`. | ||
|
|
||
| ### 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`. | ||
|
|
Oops, something went wrong.