dandri/zigbee2mqtt
1
0
Fork 0
mirror of https://github.com/Koenkk/zigbee2mqtt.git synced 2026-08-28 13:34:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update docgen.

Browse Source
This commit is contained in:
Koen Kanters
2018-04-25 19:41:20 +02:00
parent 87fb513758
commit d20012e4d8
3 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+1 -1
View File
@@ -3,7 +3,7 @@
Allows you to use your Zigbee devices **without** the vendors (Xiaomi/TRADFRI/Hue) bridge/gateway.
It bridges the events sent from the sensors and switches to MQTT. In this way you can integrate your Zigbee devices with whatever smart home infrastructure you are using. Integrates especially well with [home-assistant.io](https://www.home-assistant.io/).
It bridges the events sent from the sensors and switches to MQTT. In this way you can integrate your Zigbee devices with whatever smart home infrastructure you are using. Integrates especially well with [Home Assistant](https://www.home-assistant.io/).
![Architecture](architecture.png)
lib/controller.js
+2 -2
View File
@@ -32,7 +32,7 @@ class Controller {
}
handleStarted() {
// Home assistant MQTT discovery on startup.
// Home Assistant MQTT discovery on startup.
if (settings.get().homeassistant) {
// MQTT discovery of all paired devices on startup.
const devices = this.zigbee.getAllClients();
@@ -111,7 +111,7 @@ class Controller {
return;
}
// Home assistant MQTT discovery
// Home Assistant MQTT discovery
if (settings.get().homeassistant && mappedModel.homeassistant &&
!this.hassDiscoveryCache[device.ieeeAddr]) {
this.homeassistantDiscover(mappedModel.homeassistant, device.ieeeAddr, friendlyName);
support/docgen.js
+5 -5
View File
@@ -54,10 +54,10 @@ vendors.forEach((vendor) => {
fs.writeFileSync(outputdir + '/' + file, text);
file = 'Integrating-with-home-assistant.io.md';
file = 'Integrating-with-Home-Assistant.md';
text = '*NOTE: Automatically generated by `npm run docgen`*\n\n';
text += 'The easiest way to integrate zigbee2mqtt with home assistant is by using [MQTT discovery](https://www.home-assistant.io/docs/mqtt/discovery/).'
text += ' To enable MQTT discovery set `homeassistant: true` in your zigbee2mqtt `configuration.yaml` and add the following to your home assistant `configuration.yaml`.\n'
text += 'The easiest way to integrate zigbee2mqtt with Home Assistant is by using [MQTT discovery](https://www.home-assistant.io/docs/mqtt/discovery/).'
text += ' To enable MQTT discovery set `homeassistant: true` in your zigbee2mqtt `configuration.yaml` and add the following to your Home Assistant `configuration.yaml`.\n'
text += '```yaml\n'
text += 'mqtt:\n'
text += ' discovery: true\n'
@@ -65,7 +65,7 @@ text += '```\n'
text += '\n\n'
text += 'To respond to button clicks you can use the following home assistant configuration:\n'
text += 'To respond to button clicks you can use the following Home Assistant configuration:\n'
text += '```yaml'
text += `
automation:
@@ -82,7 +82,7 @@ automation:
`
text += '```\n'
text += 'In case you **dont** want to use home assistants MQTT discovery you can use the configuration below.\n\n'
text += 'In case you **dont** want to use Home Assistant MQTT discovery you can use the configuration below.\n\n'
const homeassistantConfig = (device) => {
const payload = {