From e520ce8cdf99e456f5e622d966097169faef1850 Mon Sep 17 00:00:00 2001 From: Marius Ciotlos Date: Sun, 1 Nov 2020 14:46:22 +0200 Subject: [PATCH] Documentation updates --- README.md | 2 +- zigbee2mqtt/DOCS.md | 24 ++++++++++++------------ 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index ae24ece9e..0cf667619 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Add the repository URL under **Supervisor → Add-on store → ⋮ → Manage add-on repositories**: - https://github.com/danielwelch/hassio-zigbee2mqtt + https://github.com/zigbee2mqtt/hassio-zigbee2mqtt The repository includes two add-ons: diff --git a/zigbee2mqtt/DOCS.md b/zigbee2mqtt/DOCS.md index f9ea86654..e681ef002 100644 --- a/zigbee2mqtt/DOCS.md +++ b/zigbee2mqtt/DOCS.md @@ -35,9 +35,18 @@ zigbee_herdsman_debug: true # Adding Support for New Devices -If you are interested in [adding support for new devices to zigbee2mqtt](https://www.zigbee2mqtt.io/how_tos/how_to_support_new_devices.html) you will need to use one of the methods below to allow you to change the required files. +If you are interested in [adding support for new devices to zigbee2mqtt](https://www.zigbee2mqtt.io/how_tos/how_to_support_new_devices.html) see methods below -### Using devices.js override in add-on +### Using external_converters + +Using `external_converters` option you will have more flexibility to add support but also allow you to maintain a DIY device support. Follow the [documentation](https://www.zigbee2mqtt.io/information/configuration.html#external-converters-configuration) to get started. + +If you are searching to edit specific files, please find the Line reference in the example converter where to make your changes: + +- `fromZigbee.js`: https://github.com/Koenkk/zigbee2mqtt.io/blob/master/docs/externalConvertersExample/dummy-converter.js#L15 +- `homeassistant.js`: https://github.com/Koenkk/zigbee2mqtt.io/blob/master/docs/externalConvertersExample/dummy-converter.js#L66 + +### [Not recommended] Using devices.js override in add-on Set the optional, top-level `zigbee_shepherd_devices` option to `true` in your configuration. @@ -57,19 +66,10 @@ When set, the add-on will scan your `data_path` for a `devices.js` file, and wil 6. Click on the commit hash (ex. `3a5abc7`) and then `browse files` button 7. Find `devices.js` file and download it (use `raw` version) -### Using external_converters - -Using `external_converters` option you will have more flexibility to add support but also allow you to maintain a DIY device support. Follow the [documentation](https://www.zigbee2mqtt.io/information/configuration.html#external-converters-configuration) to get started. - -If you are searching to edit specific files, please find the Line reference in the example converter where to make your changes: - -- `fromZigbee.js`: https://github.com/Koenkk/zigbee2mqtt.io/blob/master/docs/externalConvertersExample/dummy-converter.js#L15 -- `homeassistant.js`: https://github.com/Koenkk/zigbee2mqtt.io/blob/master/docs/externalConvertersExample/dummy-converter.js#L66 - # Notes - Depending on your configuration, the MQTT server config may need to include the port, typically `1883` or `8883` for SSL communications. For example, `mqtt://core-mosquitto:1883` for Home Assistant's Mosquitto add-on. - To find out which serial ports you have exposed go to **Supervisor → System → Host system → ⋮ → Hardware** -- Please see this add-on's [documentation on GitHub](https://github.com/danielwelch/hassio-zigbee2mqtt#socat) for further add-on-specific information (using Socat, how to add support for new devices etc.). +- Please see this add-on's [documentation on GitHub](https://github.com/zigbee2mqtt/hassio-zigbee2mqtt/blob/dev/zigbee2mqtt/DOCS.md#socat) for further add-on-specific information (using Socat, how to add support for new devices etc.). # Additional Configuration Options - `network_key_string`