Docs generated based on zigbee-herdsman-converters v20.58.0

itavero · Dec 1, 2024 · 7788b82 · 7788b82
1 parent b566041
commit 7788b82
Show file tree

Hide file tree

Showing 228 changed files with 6,107 additions and 348 deletions.
diff --git a/docs/devices/adeo/zb-doorsensor-d0007.md b/docs/devices/adeo/zb-doorsensor-d0007.md
@@ -0,0 +1,29 @@
+---
+title: "ADEO ZB-DoorSensor-D0007 Homebridge/HomeKit integration"
+description: "Add HomeKit support to your ADEO ZB-DoorSensor-D0007, using Homebridge, Zigbee2MQTT and homebridge-z2m."
+---
+<!---
+This file has been GENERATED using src/docgen/docgen.ts
+DO NOT EDIT THIS FILE MANUALLY!
+-->
+# ADEO ZB-DoorSensor-D0007
+> ENKI LEXMAN wireless smart door window sensor
+
+
+# Services and characteristics
+The following HomeKit Services and Characteristics are exposed by
+the ADEO ZB-DoorSensor-D0007
+
+* [Battery](../../battery.md)
+  * Battery Level
+  * Charging State
+  * Status Low Battery
+* [Contact Sensor](../../sensors.md)
+  * Contact Sensor State
+  * Status Low Battery
+  * Status Tampered
+
+
+# Related
+* [Other devices from ADEO](../index.md#adeo)
+* [Zigbee2MQTT documentation for this device](https://www.zigbee2mqtt.io/devices/ZB-DoorSensor-D0007.html)
diff --git a/docs/devices/adeo/zbek-32.md b/docs/devices/adeo/zbek-32.md
@@ -0,0 +1,29 @@
+---
+title: "ADEO ZBEK-32 Homebridge/HomeKit integration"
+description: "Add HomeKit support to your ADEO ZBEK-32, using Homebridge, Zigbee2MQTT and homebridge-z2m."
+---
+<!---
+This file has been GENERATED using src/docgen/docgen.ts
+DO NOT EDIT THIS FILE MANUALLY!
+-->
+# ADEO ZBEK-32
+> ENKI Inspire Extraflat D12
+
+
+# Services and characteristics
+The following HomeKit Services and Characteristics are exposed by
+the ADEO ZBEK-32
+
+* [Lightbulb](../../light.md)
+  * Brightness
+  * Color Temperature
+  * Hue
+  * On
+  * Saturation
+
+## Other features
+* [Adaptive Lighting](../../light.md)
+
+# Related
+* [Other devices from ADEO](../index.md#adeo)
+* [Zigbee2MQTT documentation for this device](https://www.zigbee2mqtt.io/devices/ZBEK-32.html)
diff --git a/docs/devices/adurosmart/81868.md b/docs/devices/adurosmart/81868.md
@@ -0,0 +1,156 @@
+---
+title: "AduroSmart 81868 Homebridge/HomeKit integration"
+description: "Add HomeKit support to your AduroSmart 81868, using Homebridge, Zigbee2MQTT and homebridge-z2m."
+---
+<!---
+This file has been GENERATED using src/docgen/docgen.ts
+DO NOT EDIT THIS FILE MANUALLY!
+-->
+# AduroSmart 81868
+> Siren
+
+
+# Unsupported
+
+This device is currently *UNSUPPORTED*.
+Want to have this device supported? Please check the [GitHub issue section](https://github.com/itavero/homebridge-z2m/issues?q=81868) to see if a request already exists for this device.
+If it doesn't exist yet, you can [open a new request](https://github.com/itavero/homebridge-z2m/issues/new?assignees=&labels=enhancement&template=device_support.yml&title=%5BDevice%5D+AduroSmart%2081868&model=AduroSmart%2081868&exposes=%5B%0A%20%20%7B%0A%20%20%20%20%22name%22%3A%20%22tamper%22%2C%0A%20%20%20%20%22label%22%3A%20%22Tamper%22%2C%0A%20%20%20%20%22access%22%3A%201%2C%0A%20%20%20%20%22type%22%3A%20%22binary%22%2C%0A%20%20%20%20%22property%22%3A%20%22tamper%22%2C%0A%20%20%20%20%22description%22%3A%20%22Indicates%20whether%20the%20device%20is%20tampered%22%2C%0A%20%20%20%20%22value_on%22%3A%20true%2C%0A%20%20%20%20%22value_off%22%3A%20false%0A%20%20%7D%2C%0A%20%20%7B%0A%20%20%20%20%22name%22%3A%20%22warning%22%2C%0A%20%20%20%20%22label%22%3A%20%22Warning%22%2C%0A%20%20%20%20%22access%22%3A%202%2C%0A%20%20%20%20%22type%22%3A%20%22composite%22%2C%0A%20%20%20%20%22property%22%3A%20%22warning%22%2C%0A%20%20%20%20%22features%22%3A%20%5B%0A%20%20%20%20%20%20%7B%0A%20%20%20%20%20%20%20%20%22name%22%3A%20%22mode%22%2C%0A%20%20%20%20%20%20%20%20%22label%22%3A%20%22Mode%22%2C%0A%20%20%20%20%20%20%20%20%22access%22%3A%202%2C%0A%20%20%20%20%20%20%20%20%22type%22%3A%20%22enum%22%2C%0A%20%20%20%20%20%20%20%20%22property%22%3A%20%22mode%22%2C%0A%20%20%20%20%20%20%20%20%22description%22%3A%20%22Mode%20of%20the%20warning%20(sound%20effect)%22%2C%0A%20%20%20%20%20%20%20%20%22values%22%3A%20%5B%0A%20%20%20%20%20%20%20%20%20%20%22stop%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22burglar%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22fire%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22emergency%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22police_panic%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22fire_panic%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22emergency_panic%22%0A%20%20%20%20%20%20%20%20%5D%0A%20%20%20%20%20%20%7D%2C%0A%20%20%20%20%20%20%7B%0A%20%20%20%20%20%20%20%20%22name%22%3A%20%22level%22%2C%0A%20%20%20%20%20%20%20%20%22label%22%3A%20%22Level%22%2C%0A%20%20%20%20%20%20%20%20%22access%22%3A%202%2C%0A%20%20%20%20%20%20%20%20%22type%22%3A%20%22enum%22%2C%0A%20%20%20%20%20%20%20%20%22property%22%3A%20%22level%22%2C%0A%20%20%20%20%20%20%20%20%22description%22%3A%20%22Sound%20level%22%2C%0A%20%20%20%20%20%20%20%20%22values%22%3A%20%5B%0A%20%20%20%20%20%20%20%20%20%20%22low%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22medium%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22high%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22very_high%22%0A%20%20%20%20%20%20%20%20%5D%0A%20%20%20%20%20%20%7D%2C%0A%20%20%20%20%20%20%7B%0A%20%20%20%20%20%20%20%20%22name%22%3A%20%22strobe_level%22%2C%0A%20%20%20%20%20%20%20%20%22label%22%3A%20%22Strobe%20level%22%2C%0A%20%20%20%20%20%20%20%20%22access%22%3A%202%2C%0A%20%20%20%20%20%20%20%20%22type%22%3A%20%22enum%22%2C%0A%20%20%20%20%20%20%20%20%22property%22%3A%20%22strobe_level%22%2C%0A%20%20%20%20%20%20%20%20%22description%22%3A%20%22Intensity%20of%20the%20strobe%22%2C%0A%20%20%20%20%20%20%20%20%22values%22%3A%20%5B%0A%20%20%20%20%20%20%20%20%20%20%22low%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22medium%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22high%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22very_high%22%0A%20%20%20%20%20%20%20%20%5D%0A%20%20%20%20%20%20%7D%2C%0A%20%20%20%20%20%20%7B%0A%20%20%20%20%20%20%20%20%22name%22%3A%20%22strobe%22%2C%0A%20%20%20%20%20%20%20%20%22label%22%3A%20%22Strobe%22%2C%0A%20%20%20%20%20%20%20%20%22access%22%3A%202%2C%0A%20%20%20%20%20%20%20%20%22type%22%3A%20%22binary%22%2C%0A%20%20%20%20%20%20%20%20%22property%22%3A%20%22strobe%22%2C%0A%20%20%20%20%20%20%20%20%22description%22%3A%20%22Turn%20on%2Foff%20the%20strobe%20(light)%20during%20warning%22%2C%0A%20%20%20%20%20%20%20%20%22value_on%22%3A%20true%2C%0A%20%20%20%20%20%20%20%20%22value_off%22%3A%20false%0A%20%20%20%20%20%20%7D%2C%0A%20%20%20%20%20%20%7B%0A%20%20%20%20%20%20%20%20%22name%22%3A%20%22strobe_duty_cycle%22%2C%0A%20%20%20%20%20%20%20%20%22label%22%3A%20%22Strobe%20duty%20cycle%22%2C%0A%20%20%20%20%20%20%20%20%22access%22%3A%202%2C%0A%20%20%20%20%20%20%20%20%22type%22%3A%20%22numeric%22%2C%0A%20%20%20%20%20%20%20%20%22property%22%3A%20%22strobe_duty_cycle%22%2C%0A%20%20%20%20%20%20%20%20%22description%22%3A%20%22Length%20of%20the%20flash%20cycle%22%2C%0A%20%20%20%20%20%20%20%20%22value_max%22%3A%2010%2C%0A%20%20%20%20%20%20%20%20%22value_min%22%3A%200%0A%20%20%20%20%20%20%7D%2C%0A%20%20%20%20%20%20%7B%0A%20%20%20%20%20%20%20%20%22name%22%3A%20%22duration%22%2C%0A%20%20%20%20%20%20%20%20%22label%22%3A%20%22Duration%22%2C%0A%20%20%20%20%20%20%20%20%22access%22%3A%202%2C%0A%20%20%20%20%20%20%20%20%22type%22%3A%20%22numeric%22%2C%0A%20%20%20%20%20%20%20%20%22property%22%3A%20%22duration%22%2C%0A%20%20%20%20%20%20%20%20%22description%22%3A%20%22Duration%20in%20seconds%20of%20the%20alarm%22%2C%0A%20%20%20%20%20%20%20%20%22unit%22%3A%20%22s%22%0A%20%20%20%20%20%20%7D%0A%20%20%20%20%5D%0A%20%20%7D%2C%0A%20%20%7B%0A%20%20%20%20%22name%22%3A%20%22max_duration%22%2C%0A%20%20%20%20%22label%22%3A%20%22Max%20duration%22%2C%0A%20%20%20%20%22access%22%3A%207%2C%0A%20%20%20%20%22type%22%3A%20%22numeric%22%2C%0A%20%20%20%20%22property%22%3A%20%22max_duration%22%2C%0A%20%20%20%20%22description%22%3A%20%22Duration%20of%20Siren%22%2C%0A%20%20%20%20%22unit%22%3A%20%22s%22%2C%0A%20%20%20%20%22value_max%22%3A%20600%2C%0A%20%20%20%20%22value_min%22%3A%200%0A%20%20%7D%2C%0A%20%20%7B%0A%20%20%20%20%22name%22%3A%20%22alarm%22%2C%0A%20%20%20%20%22label%22%3A%20%22Alarm%22%2C%0A%20%20%20%20%22access%22%3A%202%2C%0A%20%20%20%20%22type%22%3A%20%22binary%22%2C%0A%20%20%20%20%22property%22%3A%20%22alarm%22%2C%0A%20%20%20%20%22description%22%3A%20%22Manual%20start%20of%20siren%22%2C%0A%20%20%20%20%22value_on%22%3A%20%22ON%22%2C%0A%20%20%20%20%22value_off%22%3A%20%22OFF%22%0A%20%20%7D%2C%0A%20%20%7B%0A%20%20%20%20%22name%22%3A%20%22linkquality%22%2C%0A%20%20%20%20%22label%22%3A%20%22Linkquality%22%2C%0A%20%20%20%20%22access%22%3A%201%2C%0A%20%20%20%20%22type%22%3A%20%22numeric%22%2C%0A%20%20%20%20%22property%22%3A%20%22linkquality%22%2C%0A%20%20%20%20%22description%22%3A%20%22Link%20quality%20(signal%20strength)%22%2C%0A%20%20%20%20%22category%22%3A%20%22diagnostic%22%2C%0A%20%20%20%20%22unit%22%3A%20%22lqi%22%2C%0A%20%20%20%20%22value_max%22%3A%20255%2C%0A%20%20%20%20%22value_min%22%3A%200%0A%20%20%7D%0A%5D) by filling in the _Device support_ issue template.
+
+## Exposes
+
+This is the information provided by Zigbee2MQTT for this device:
+
+```json
+[
+  {
+    "name": "tamper",
+    "label": "Tamper",
+    "access": 1,
+    "type": "binary",
+    "property": "tamper",
+    "description": "Indicates whether the device is tampered",
+    "value_on": true,
+    "value_off": false
+  },
+  {
+    "name": "warning",
+    "label": "Warning",
+    "access": 2,
+    "type": "composite",
+    "property": "warning",
+    "features": [
+      {
+        "name": "mode",
+        "label": "Mode",
+        "access": 2,
+        "type": "enum",
+        "property": "mode",
+        "description": "Mode of the warning (sound effect)",
+        "values": [
+          "stop",
+          "burglar",
+          "fire",
+          "emergency",
+          "police_panic",
+          "fire_panic",
+          "emergency_panic"
+        ]
+      },
+      {
+        "name": "level",
+        "label": "Level",
+        "access": 2,
+        "type": "enum",
+        "property": "level",
+        "description": "Sound level",
+        "values": [
+          "low",
+          "medium",
+          "high",
+          "very_high"
+        ]
+      },
+      {
+        "name": "strobe_level",
+        "label": "Strobe level",
+        "access": 2,
+        "type": "enum",
+        "property": "strobe_level",
+        "description": "Intensity of the strobe",
+        "values": [
+          "low",
+          "medium",
+          "high",
+          "very_high"
+        ]
+      },
+      {
+        "name": "strobe",
+        "label": "Strobe",
+        "access": 2,
+        "type": "binary",
+        "property": "strobe",
+        "description": "Turn on/off the strobe (light) during warning",
+        "value_on": true,
+        "value_off": false
+      },
+      {
+        "name": "strobe_duty_cycle",
+        "label": "Strobe duty cycle",
+        "access": 2,
+        "type": "numeric",
+        "property": "strobe_duty_cycle",
+        "description": "Length of the flash cycle",
+        "value_max": 10,
+        "value_min": 0
+      },
+      {
+        "name": "duration",
+        "label": "Duration",
+        "access": 2,
+        "type": "numeric",
+        "property": "duration",
+        "description": "Duration in seconds of the alarm",
+        "unit": "s"
+      }
+    ]
+  },
+  {
+    "name": "max_duration",
+    "label": "Max duration",
+    "access": 7,
+    "type": "numeric",
+    "property": "max_duration",
+    "description": "Duration of Siren",
+    "unit": "s",
+    "value_max": 600,
+    "value_min": 0
+  },
+  {
+    "name": "alarm",
+    "label": "Alarm",
+    "access": 2,
+    "type": "binary",
+    "property": "alarm",
+    "description": "Manual start of siren",
+    "value_on": "ON",
+    "value_off": "OFF"
+  },
+  {
+    "name": "linkquality",
+    "label": "Linkquality",
+    "access": 1,
+    "type": "numeric",
+    "property": "linkquality",
+    "description": "Link quality (signal strength)",
+    "category": "diagnostic",
+    "unit": "lqi",
+    "value_max": 255,
+    "value_min": 0
+  }
+]
+```
+
+# Related
+* [Other devices from AduroSmart](../index.md#adurosmart)
+* [Zigbee2MQTT documentation for this device](https://www.zigbee2mqtt.io/devices/81868.html)
diff --git a/docs/devices/aeotec/zga002.md b/docs/devices/aeotec/zga002.md
@@ -1,18 +1,18 @@
 ---
-title: "AEOTEC ZGA002 Homebridge/HomeKit integration"
-description: "Add HomeKit support to your AEOTEC ZGA002, using Homebridge, Zigbee2MQTT and homebridge-z2m."
+title: "Aeotec ZGA002 Homebridge/HomeKit integration"
+description: "Add HomeKit support to your Aeotec ZGA002, using Homebridge, Zigbee2MQTT and homebridge-z2m."
 ---
 <!---
 This file has been GENERATED using src/docgen/docgen.ts
 DO NOT EDIT THIS FILE MANUALLY!
 -->
-# AEOTEC ZGA002
+# Aeotec ZGA002
 > Pico switch with power meter
 
 
 # Services and characteristics
 The following HomeKit Services and Characteristics are exposed by
-the AEOTEC ZGA002
+the Aeotec ZGA002
 
 * [Stateless Programmable Switch](../../action.md)
   * Programmable Switch Event
@@ -24,5 +24,5 @@ the AEOTEC ZGA002
 
 
 # Related
-* [Other devices from AEOTEC](../index.md#aeotec)
+* [Other devices from Aeotec](../index.md#aeotec)
 * [Zigbee2MQTT documentation for this device](https://www.zigbee2mqtt.io/devices/ZGA002.html)
diff --git a/docs/devices/aeotec/zga003.md b/docs/devices/aeotec/zga003.md
@@ -1,18 +1,18 @@
 ---
-title: "AEOTEC ZGA003 Homebridge/HomeKit integration"
-description: "Add HomeKit support to your AEOTEC ZGA003, using Homebridge, Zigbee2MQTT and homebridge-z2m."
+title: "Aeotec ZGA003 Homebridge/HomeKit integration"
+description: "Add HomeKit support to your Aeotec ZGA003, using Homebridge, Zigbee2MQTT and homebridge-z2m."
 ---
 <!---
 This file has been GENERATED using src/docgen/docgen.ts
 DO NOT EDIT THIS FILE MANUALLY!
 -->
-# AEOTEC ZGA003
+# Aeotec ZGA003
 > Pico switch duo with power meter
 
 
 # Services and characteristics
 The following HomeKit Services and Characteristics are exposed by
-the AEOTEC ZGA003
+the Aeotec ZGA003
 
 * [Stateless Programmable Switch](../../action.md)
   * Programmable Switch Event
@@ -24,5 +24,5 @@ the AEOTEC ZGA003
 
 
 # Related
-* [Other devices from AEOTEC](../index.md#aeotec)
+* [Other devices from Aeotec](../index.md#aeotec)
 * [Zigbee2MQTT documentation for this device](https://www.zigbee2mqtt.io/devices/ZGA003.html)
diff --git a/docs/devices/aeotec/zga004.md b/docs/devices/aeotec/zga004.md
@@ -1,18 +1,18 @@
 ---
-title: "AEOTEC ZGA004 Homebridge/HomeKit integration"
-description: "Add HomeKit support to your AEOTEC ZGA004, using Homebridge, Zigbee2MQTT and homebridge-z2m."
+title: "Aeotec ZGA004 Homebridge/HomeKit integration"
+description: "Add HomeKit support to your Aeotec ZGA004, using Homebridge, Zigbee2MQTT and homebridge-z2m."
 ---
 <!---
 This file has been GENERATED using src/docgen/docgen.ts
 DO NOT EDIT THIS FILE MANUALLY!
 -->
-# AEOTEC ZGA004
+# Aeotec ZGA004
 > Pico shutter
 
 
 # Services and characteristics
 The following HomeKit Services and Characteristics are exposed by
-the AEOTEC ZGA004
+the Aeotec ZGA004
 
 * [Stateless Programmable Switch](../../action.md)
   * Programmable Switch Event
@@ -29,5 +29,5 @@ the AEOTEC ZGA004
 
 
 # Related
-* [Other devices from AEOTEC](../index.md#aeotec)
+* [Other devices from Aeotec](../index.md#aeotec)
 * [Zigbee2MQTT documentation for this device](https://www.zigbee2mqtt.io/devices/ZGA004.html)
diff --git a/docs/devices/amina_distribution_as/amina_s.md b/docs/devices/amina_distribution_as/amina_s.md
@@ -0,0 +1,23 @@
+---
+title: "Amina Distribution AS amina S Homebridge/HomeKit integration"
+description: "Add HomeKit support to your Amina Distribution AS amina S, using Homebridge, Zigbee2MQTT and homebridge-z2m."
+---
+<!---
+This file has been GENERATED using src/docgen/docgen.ts
+DO NOT EDIT THIS FILE MANUALLY!
+-->
+# Amina Distribution AS amina S
+> Amina S EV Charger
+
+
+# Services and characteristics
+The following HomeKit Services and Characteristics are exposed by
+the Amina Distribution AS amina S
+
+* [Switch](../../switch.md)
+  * On
+
+
+# Related
+* [Other devices from Amina Distribution AS](../index.md#amina_distribution_as)
+* [Zigbee2MQTT documentation for this device](https://www.zigbee2mqtt.io/devices/amina_S.html)
diff --git a/docs/devices/aqara/fp1e.md b/docs/devices/aqara/fp1e.md
@@ -0,0 +1,25 @@
+---
+title: "Aqara FP1E Homebridge/HomeKit integration"
+description: "Add HomeKit support to your Aqara FP1E, using Homebridge, Zigbee2MQTT and homebridge-z2m."
+---
+<!---
+This file has been GENERATED using src/docgen/docgen.ts
+DO NOT EDIT THIS FILE MANUALLY!
+-->
+# Aqara FP1E
+> Presence sensor
+
+
+# Services and characteristics
+The following HomeKit Services and Characteristics are exposed by
+the Aqara FP1E
+
+* [Occupancy Sensor](../../sensors.md)
+  * Occupancy Detected
+* [Temperature Sensor](../../sensors.md)
+  * Current Temperature
+
+
+# Related
+* [Other devices from Aqara](../index.md#aqara)
+* [Zigbee2MQTT documentation for this device](https://www.zigbee2mqtt.io/devices/FP1E.html)