From 03ff4e6e5a59318e13765970708cd70f9c7fd9e4 Mon Sep 17 00:00:00 2001 From: Koen Kanters Date: Thu, 27 Dec 2018 19:37:39 +0100 Subject: [PATCH] Finish groups documentation. #15 --- docgen/integrating-with-homeassistant.js | 22 ++++++++++++++++++++++ docs/index.md | 1 + docs/information/groups.md | 2 +- docs/integration/home_assistant.md | 22 ++++++++++++++++++++++ 4 files changed, 46 insertions(+), 1 deletion(-) diff --git a/docgen/integrating-with-homeassistant.js b/docgen/integrating-with-homeassistant.js index dd4fc300eb..57613e1843 100644 --- a/docgen/integrating-with-homeassistant.js +++ b/docgen/integrating-with-homeassistant.js @@ -18,6 +18,8 @@ use their documentation* ## MQTT discovery **At least Home Assistant >= 0.84 is required!** +**NOTE:** Groups are not auto-discovered, see configuration below. + The easiest way to integrate Zigbee2mqtt with Home Assistant is by using [MQTT discovery](https://www.home-assistant.io/docs/mqtt/discovery/). This allows Zigbee2mqtt to automatically add devices to Home Assistant. @@ -80,6 +82,26 @@ automation: \`\`\` {% endraw %} +## Groups +Groups are not auto-discovered. Use the following configuration: + +{% raw %} + +\`\`\`yaml +- platform: mqtt + schema: json + name: MY_GROUP + command_topic: "zigbee2mqtt/[GROUP_FRIENDLY_NAME]/set" + state_topic: "zigbee2mqtt/[GROUP_FRIENDLY_NAME]/set" + + // Modify according to features supported by all devices in group + color_temp: true + brightness: true + rgb: true +\`\`\` + +{% endraw %} + ## Controlling Zigbee2mqtt via Home Assistant The following Home Assistant configuration allows you to control Zigbee2mqtt from Home Assistant. diff --git a/docs/index.md b/docs/index.md index 0faa808a02..c9be725f41 100644 --- a/docs/index.md +++ b/docs/index.md @@ -29,6 +29,7 @@ Welcome to the Zigbee2mqtt documentation! ### Information * [Supported devices](information/supported_devices.md) * [MQTT topics and message structure](information/mqtt_topics_and_message_structure.md) +* [Groups](information/groups.md) * [Docker](information/docker.md) * [Zigbee network](information/zigbee_network.md) * [3D cases](information/3d_cases.md) diff --git a/docs/information/groups.md b/docs/information/groups.md index eaaccd9124..3fc12ff7f5 100644 --- a/docs/information/groups.md +++ b/docs/information/groups.md @@ -1,7 +1,7 @@ # Groups Zigbee2mqtt has support for Zigbee groups. By using Zigbee groups you can control multiple devices simultaneously with one command. -**NOTE:** to use groups, at least firmware version `20181224` is required! +**NOTE:** to use groups, at least firmware version `20181224` is required! (available [here](https://github.com/Koenkk/Z-Stack-firmware/tree/dev/coordinator)) ## Configuration Add the following to your `configuration.yaml`. diff --git a/docs/integration/home_assistant.md b/docs/integration/home_assistant.md index b86f5d86da..d456ec22d6 100644 --- a/docs/integration/home_assistant.md +++ b/docs/integration/home_assistant.md @@ -9,6 +9,8 @@ use their documentation* ## MQTT discovery **At least Home Assistant >= 0.84 is required!** +**NOTE:** Groups are not auto-discovered, see configuration below. + The easiest way to integrate Zigbee2mqtt with Home Assistant is by using [MQTT discovery](https://www.home-assistant.io/docs/mqtt/discovery/). This allows Zigbee2mqtt to automatically add devices to Home Assistant. @@ -71,6 +73,26 @@ automation: ``` {% endraw %} +## Groups +Groups are not auto-discovered. Use the following configuration: + +{% raw %} + +```yaml +- platform: mqtt + schema: json + name: MY_GROUP + command_topic: "zigbee2mqtt/[GROUP_FRIENDLY_NAME]/set" + state_topic: "zigbee2mqtt/[GROUP_FRIENDLY_NAME]/set" + + // Modify according to features supported by all devices in group + color_temp: true + brightness: true + rgb: true +``` + +{% endraw %} + ## Controlling Zigbee2mqtt via Home Assistant The following Home Assistant configuration allows you to control Zigbee2mqtt from Home Assistant.