cotugno/zigbee2mqtt
2
Fork 0
mirror of https://github.com/Koenkk/zigbee2mqtt.git synced 2024-11-17 10:58:31 -07:00
Code Issues Packages Projects Releases Wiki Activity

Finish groups documentation. #15

Browse Source
This commit is contained in:
Koen Kanters 2018-12-27 19:37:39 +01:00
parent 3bc2ec8c79
commit 03ff4e6e5a
4 changed files with 46 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docgen/integrating-with-homeassistant.js
View File

@ -18,6 +18,8 @@ use their documentation*
## MQTT discovery ## MQTT discovery
**At least Home Assistant >= 0.84 is required!** **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 The easiest way to integrate Zigbee2mqtt with Home Assistant is by
using [MQTT discovery](https://www.home-assistant.io/docs/mqtt/discovery/). using [MQTT discovery](https://www.home-assistant.io/docs/mqtt/discovery/).
This allows Zigbee2mqtt to automatically add devices to Home Assistant. This allows Zigbee2mqtt to automatically add devices to Home Assistant.
@ -80,6 +82,26 @@ automation:
\`\`\` \`\`\`
{% endraw %} {% 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 ## Controlling Zigbee2mqtt via Home Assistant
The following Home Assistant configuration allows you to control Zigbee2mqtt from Home Assistant. The following Home Assistant configuration allows you to control Zigbee2mqtt from Home Assistant.

1
docs/index.md
View File

@ -29,6 +29,7 @@ Welcome to the Zigbee2mqtt documentation!
### Information ### Information
* [Supported devices](information/supported_devices.md) * [Supported devices](information/supported_devices.md)
* [MQTT topics and message structure](information/mqtt_topics_and_message_structure.md) * [MQTT topics and message structure](information/mqtt_topics_and_message_structure.md)
* [Groups](information/groups.md)
* [Docker](information/docker.md) * [Docker](information/docker.md)
* [Zigbee network](information/zigbee_network.md) * [Zigbee network](information/zigbee_network.md)
* [3D cases](information/3d_cases.md) * [3D cases](information/3d_cases.md)

2
docs/information/groups.md
View File

@ -1,7 +1,7 @@
# Groups # Groups
Zigbee2mqtt has support for Zigbee groups. By using Zigbee groups you can control multiple devices simultaneously with one command. 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 ## Configuration
Add the following to your `configuration.yaml`. Add the following to your `configuration.yaml`.

22
docs/integration/home_assistant.md
View File

@ -9,6 +9,8 @@ use their documentation*
## MQTT discovery ## MQTT discovery
**At least Home Assistant >= 0.84 is required!** **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 The easiest way to integrate Zigbee2mqtt with Home Assistant is by
using [MQTT discovery](https://www.home-assistant.io/docs/mqtt/discovery/). using [MQTT discovery](https://www.home-assistant.io/docs/mqtt/discovery/).
This allows Zigbee2mqtt to automatically add devices to Home Assistant. This allows Zigbee2mqtt to automatically add devices to Home Assistant.
@ -71,6 +73,26 @@ automation:
``` ```
{% endraw %} {% 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 ## Controlling Zigbee2mqtt via Home Assistant
The following Home Assistant configuration allows you to control Zigbee2mqtt from Home Assistant. The following Home Assistant configuration allows you to control Zigbee2mqtt from Home Assistant.