Skip to content

Commit

Permalink
Sync docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Koenkk committed Feb 28, 2021
1 parent 1f5cc19 commit c94511b
Show file tree
Hide file tree
Showing 1,284 changed files with 10,360 additions and 4,538 deletions.
96 changes: 96 additions & 0 deletions docgen/device_page_notes.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,36 @@ const notes = [
note: `
### Pairing
Press and hold the button on the device until the blue light starts blinking, release it and and the device will automatically join.
`,
},
{
model: ['AV2010/29A'],
deviceTypeSpecificConfiguration: true,
note: `
### Controlling
Trigger the siren sound and lights, duration can be indicated in seconds. The strobe parameter must always be false
\`\`\`json
topic: 'zigbee2mqtt/friendly name/set'
payload: '{"warning": {"duration": 3, "strobe": false}}'
\`\`\`
5 short beeps. If the alarm is on, it stops:
\`\`\`json
topic: 'zigbee2mqtt/friendly name/set'
payload: '{"warning": {"level": "medium"}}'
\`\`\`
5 long beeps. If the alarm is on, it stops:
\`\`\`json
topic: 'zigbee2mqtt/friendly name/set'
payload:
'{"warning": {"level": "high"}}'
\`\`\`
1 short beeps. If the alarm is on, it stops:
\`\`\`json
topic: 'zigbee2mqtt/friendly name/set'
payload: '{"warning": {"level": "very_high"}}'
\`\`\`
`,
},
{
Expand All @@ -18,6 +48,65 @@ The \`triple\`, \`quadruple\`, \`hold\` and \`release\` is not supported by all
note: `
### Firmware
This is a Texas Instruments CC1352P-2, CC2652RB or CC2652R flashed with the following firmware: https://github.com/Koenkk/Z-Stack-firmware/tree/master/router/Z-Stack_3.x.0/bin
`,
},
{
model: ['L122FF63H11A5.0W', 'L122CB63H11A9.0W', 'L122AA63H11A6.5W', 'C422AC14D41H140.0W', 'C422AC11D41H140.0W'],
note: `
### Pairing
Factory reset the light.
After resetting the light it will automatically connect.
The light should be turned off for at least 10 seconds. After that, the on- and off-phases should last around 2 to 5 seconds.
Start with light on, then off, and then 3 “on’s”, wait in the 3rd ON state.
`,
},
{
model: ['F122SB62H22A4.5W'],
note: `
### Pairing
Factory reset the light bulb.
After resetting the bulb will automatically connect.
The bulb should be turned off for at least 10 seconds. After that, the on- and off-phases should last around 2 to 5 seconds.
Start with bulb on, then off, and then 3 “on’s”, wait in the 3rd ON state.
`,
},
{
model: ['RL460WHZHA69'],
note: `
### Pairing
The bulb automatically pairs after coming out of the box.
To factory reset the bulb; turn on and off the power 6 times within a few seconds. After resetting the bulb will automatically connect.
`,
},
{
model: ['TI0001-switch', 'TI0001-switch-2gang', 'TI0001-socket', 'TI0001-dimmer'],
note: `
After pairing device will be shown as "TI0001" device. Need to manually trigger a re-configure of the device either using web-frontend
of Zigbee2MQTT or using [MQTT message](../information/mqtt_topics_and_message_structure.html#zigbee2mqttbridgerequestdeviceconfigure) right after pairing.
In case of problems it's recommended to remove device and than retry pairing and re-configuring device.
### Important
These devices can only be used on channel 26.
These devices are locked to the manufacturer's network key (ext_pan_id).
Your configuration file [data/configuration.yaml](../information/configuration) must contain the following:
\`\`\`yaml
advanced:
ext_pan_id: [33,117,141,25,0,75,18,0]
channel: 26
\`\`\`
Therefore these devices may not co-existence with other Zigbee devices.
Maybe, you need to add a dedicated coordinator and create a new network for Livolo.
If you decided to create a new network, you should specify another 'pan_id'.
\`\`\`yaml
advanced:
pan_id: 6756
\`\`\`
`,
},
{
Expand Down Expand Up @@ -1163,6 +1252,13 @@ The E1745 can be bound to groups using [binding](../information/binding).
## Detection cooldown (E1745 version)
This device will pause detection of presence for approximately 1 min 37 sec after detection. In other words; with continuous detection, every 1:37 a new publish (occupancy: true) will be done.
Cooldown of detection is 3 min. In other words; 3 min after last published detection (and trigger no longer present) occupancy will be published as false.
The cooldown detection timeout can be overriden by using the following device config option:
* \`occupancy_timeout\`: Timeout (in seconds) after which the \`occupancy: false\` message is sent.
Please note that setting \`occupancy_timeout\` lower than the device re-trigger time (around 1m30s) means \`occupancy: true\` will only be sent again when motion is detected after the re-trigger time.
This allows an external automation system to observe the detection cycles (detection -> idle -> detection -> idle) and implement more complex automation flows.
For simple automations, setting \`occupancy_timeout\` greater than the re-trigger time is probably desired.
`,
},
{
Expand Down
62 changes: 59 additions & 3 deletions docs/devices/014G2461.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ description: "Integrate your Danfoss 014G2461 via Zigbee2MQTT with whatever smar
| Model | 014G2461 |
| Vendor | Danfoss |
| Description | Ally thermostat |
| Exposes | battery, lock (state), climate (occupied_heating_setpoint, local_temperature, pi_heating_demand), linkquality |
| Exposes | battery, lock (state), mounted_mode, heat_required, window_open_internal, setpoint_change_source, climate (occupied_heating_setpoint, local_temperature, pi_heating_demand), linkquality |
| Picture | ![Danfoss 014G2461](../images/devices/014G2461.jpg) |

## Notes
Expand Down Expand Up @@ -52,6 +52,30 @@ The current state of this lock is in the published state under the `keypad_locko
To control this lock publish a message to topic `zigbee2mqtt/FRIENDLY_NAME/set` with payload `{"keypad_lockout": "1"}` or `{"keypad_lockout": "0"}`.
To read the current state of this lock publish a message to topic `zigbee2mqtt/FRIENDLY_NAME/get` with payload `{"keypad_lockout": ""}`.

### Mounted_mode (binary)
Mode in which the unit is mounted. This is set to `false` for normal mounting or `true` for vertical mounting.
Value can be found in the published state on the `mounted_mode` property.
It's not possible to read (`/get`) or write (`/set`) this value.
If value equals `true` mounted_mode is ON, if `false` OFF.

### Heat_required (binary)
Wether or not the unit needs warm water.
Value can be found in the published state on the `heat_required` property.
It's not possible to read (`/get`) or write (`/set`) this value.
If value equals `true` heat_required is ON, if `false` OFF.

### Window_open_internal (binary)
Most likely related to the option to set Window Detection mode.
Value can be found in the published state on the `window_open_internal` property.
It's not possible to read (`/get`) or write (`/set`) this value.
If value equals `1` window_open_internal is ON, if `0` OFF.

### Setpoint_change_source (binary)
Values observed are `0` (set locally) or `2` (set via Zigbee).
Value can be found in the published state on the `setpoint_change_source` property.
It's not possible to read (`/get`) or write (`/set`) this value.
If value equals `0` setpoint_change_source is ON, if `1` OFF.

### Climate
This climate device supports the following features: `occupied_heating_setpoint`, `local_temperature`, `pi_heating_demand`.
- `occupied_heating_setpoint`: Temperature setpoint. To control publish a message to topic `zigbee2mqtt/FRIENDLY_NAME/set` with payload `{"occupied_heating_setpoint": VALUE}` where `VALUE` is the °C between `6` and `28`. To read send a message to `zigbee2mqtt/FRIENDLY_NAME/get` with payload `{"occupied_heating_setpoint": ""}`.
Expand All @@ -75,8 +99,8 @@ sensor:
- platform: "mqtt"
state_topic: "zigbee2mqtt/<FRIENDLY_NAME>"
availability_topic: "zigbee2mqtt/bridge/state"
unit_of_measurement: "%"
value_template: "{{ value_json.battery }}"
unit_of_measurement: "%"
device_class: "battery"

lock:
Expand All @@ -89,6 +113,38 @@ lock:
payload_unlock: "0"
command_topic_postfix: "keypad_lockout"

binary_sensor:
- platform: "mqtt"
state_topic: "zigbee2mqtt/<FRIENDLY_NAME>"
availability_topic: "zigbee2mqtt/bridge/state"
value_template: "{{ value_json.mounted_mode }}"
payload_on: true
payload_off: false

binary_sensor:
- platform: "mqtt"
state_topic: "zigbee2mqtt/<FRIENDLY_NAME>"
availability_topic: "zigbee2mqtt/bridge/state"
value_template: "{{ value_json.heat_required }}"
payload_on: true
payload_off: false

binary_sensor:
- platform: "mqtt"
state_topic: "zigbee2mqtt/<FRIENDLY_NAME>"
availability_topic: "zigbee2mqtt/bridge/state"
value_template: "{{ value_json.window_open_internal }}"
payload_on: 1
payload_off: 0

binary_sensor:
- platform: "mqtt"
state_topic: "zigbee2mqtt/<FRIENDLY_NAME>"
availability_topic: "zigbee2mqtt/bridge/state"
value_template: "{{ value_json.setpoint_change_source }}"
payload_on: 0
payload_off: 1

climate:
- platform: "mqtt"
availability_topic: "zigbee2mqtt/bridge/state"
Expand All @@ -106,8 +162,8 @@ sensor:
- platform: "mqtt"
state_topic: "zigbee2mqtt/<FRIENDLY_NAME>"
availability_topic: "zigbee2mqtt/bridge/state"
unit_of_measurement: "lqi"
value_template: "{{ value_json.linkquality }}"
unit_of_measurement: "lqi"
icon: "mdi:signal"

sensor:
Expand Down
2 changes: 1 addition & 1 deletion docs/devices/046677476816.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,8 +158,8 @@ sensor:
- platform: "mqtt"
state_topic: "zigbee2mqtt/<FRIENDLY_NAME>"
availability_topic: "zigbee2mqtt/bridge/state"
unit_of_measurement: "lqi"
value_template: "{{ value_json.linkquality }}"
unit_of_measurement: "lqi"
icon: "mdi:signal"

sensor:
Expand Down
2 changes: 1 addition & 1 deletion docs/devices/046677551780.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,8 +158,8 @@ sensor:
- platform: "mqtt"
state_topic: "zigbee2mqtt/<FRIENDLY_NAME>"
availability_topic: "zigbee2mqtt/bridge/state"
unit_of_measurement: "lqi"
value_template: "{{ value_json.linkquality }}"
unit_of_measurement: "lqi"
icon: "mdi:signal"

sensor:
Expand Down
2 changes: 1 addition & 1 deletion docs/devices/046677552343.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,8 @@ sensor:
- platform: "mqtt"
state_topic: "zigbee2mqtt/<FRIENDLY_NAME>"
availability_topic: "zigbee2mqtt/bridge/state"
unit_of_measurement: "lqi"
value_template: "{{ value_json.linkquality }}"
unit_of_measurement: "lqi"
icon: "mdi:signal"

sensor:
Expand Down
4 changes: 2 additions & 2 deletions docs/devices/064873.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ sensor:
- platform: "mqtt"
state_topic: "zigbee2mqtt/<FRIENDLY_NAME>"
availability_topic: "zigbee2mqtt/bridge/state"
unit_of_measurement: "%"
value_template: "{{ value_json.battery }}"
unit_of_measurement: "%"
device_class: "battery"

sensor:
Expand All @@ -68,8 +68,8 @@ sensor:
- platform: "mqtt"
state_topic: "zigbee2mqtt/<FRIENDLY_NAME>"
availability_topic: "zigbee2mqtt/bridge/state"
unit_of_measurement: "lqi"
value_template: "{{ value_json.linkquality }}"
unit_of_measurement: "lqi"
icon: "mdi:signal"
```
{% endraw %}
Expand Down
2 changes: 1 addition & 1 deletion docs/devices/064888.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@ sensor:
- platform: "mqtt"
state_topic: "zigbee2mqtt/<FRIENDLY_NAME>"
availability_topic: "zigbee2mqtt/bridge/state"
unit_of_measurement: "lqi"
value_template: "{{ value_json.linkquality }}"
unit_of_measurement: "lqi"
icon: "mdi:signal"
```
{% endraw %}
Expand Down
4 changes: 2 additions & 2 deletions docs/devices/067646.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ sensor:
- platform: "mqtt"
state_topic: "zigbee2mqtt/<FRIENDLY_NAME>"
availability_topic: "zigbee2mqtt/bridge/state"
unit_of_measurement: "%"
value_template: "{{ value_json.battery }}"
unit_of_measurement: "%"
device_class: "battery"

sensor:
Expand All @@ -68,8 +68,8 @@ sensor:
- platform: "mqtt"
state_topic: "zigbee2mqtt/<FRIENDLY_NAME>"
availability_topic: "zigbee2mqtt/bridge/state"
unit_of_measurement: "lqi"
value_template: "{{ value_json.linkquality }}"
unit_of_measurement: "lqi"
icon: "mdi:signal"
```
{% endraw %}
Expand Down
4 changes: 2 additions & 2 deletions docs/devices/067694.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ sensor:
- platform: "mqtt"
state_topic: "zigbee2mqtt/<FRIENDLY_NAME>"
availability_topic: "zigbee2mqtt/bridge/state"
unit_of_measurement: "%"
value_template: "{{ value_json.battery }}"
unit_of_measurement: "%"
device_class: "battery"

sensor:
Expand All @@ -71,8 +71,8 @@ sensor:
- platform: "mqtt"
state_topic: "zigbee2mqtt/<FRIENDLY_NAME>"
availability_topic: "zigbee2mqtt/bridge/state"
unit_of_measurement: "lqi"
value_template: "{{ value_json.linkquality }}"
unit_of_measurement: "lqi"
icon: "mdi:signal"
```
{% endraw %}
Expand Down
2 changes: 1 addition & 1 deletion docs/devices/067771.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,8 +158,8 @@ sensor:
- platform: "mqtt"
state_topic: "zigbee2mqtt/<FRIENDLY_NAME>"
availability_topic: "zigbee2mqtt/bridge/state"
unit_of_measurement: "lqi"
value_template: "{{ value_json.linkquality }}"
unit_of_measurement: "lqi"
icon: "mdi:signal"
```
{% endraw %}
Expand Down
4 changes: 2 additions & 2 deletions docs/devices/067773.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@ sensor:
- platform: "mqtt"
state_topic: "zigbee2mqtt/<FRIENDLY_NAME>"
availability_topic: "zigbee2mqtt/bridge/state"
unit_of_measurement: "%"
value_template: "{{ value_json.battery }}"
unit_of_measurement: "%"
device_class: "battery"
sensor:
Expand All @@ -95,8 +95,8 @@ sensor:
- platform: "mqtt"
state_topic: "zigbee2mqtt/<FRIENDLY_NAME>"
availability_topic: "zigbee2mqtt/bridge/state"
unit_of_measurement: "lqi"
value_template: "{{ value_json.linkquality }}"
unit_of_measurement: "lqi"
icon: "mdi:signal"
```
{% endraw %}
Expand Down
4 changes: 2 additions & 2 deletions docs/devices/067774.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,8 @@ sensor:
- platform: "mqtt"
state_topic: "zigbee2mqtt/<FRIENDLY_NAME>"
availability_topic: "zigbee2mqtt/bridge/state"
unit_of_measurement: "%"
value_template: "{{ value_json.battery }}"
unit_of_measurement: "%"
device_class: "battery"
sensor:
Expand All @@ -89,8 +89,8 @@ sensor:
- platform: "mqtt"
state_topic: "zigbee2mqtt/<FRIENDLY_NAME>"
availability_topic: "zigbee2mqtt/bridge/state"
unit_of_measurement: "lqi"
value_template: "{{ value_json.linkquality }}"
unit_of_measurement: "lqi"
icon: "mdi:signal"
```
{% endraw %}
Expand Down
Loading

0 comments on commit c94511b

Please sign in to comment.