From ce2455510b30224a00ecb8c21458fcaf79cb6bf9 Mon Sep 17 00:00:00 2001 From: Russell Joyce Date: Sun, 10 Feb 2019 18:29:02 +0000 Subject: [PATCH] Fixed link (and minor text edits) in 'How to support new devices' (#1054) --- docs/how_tos/how_to_support_new_devices.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/how_tos/how_to_support_new_devices.md b/docs/how_tos/how_to_support_new_devices.md index 3b8ae4892..860882a21 100644 --- a/docs/how_tos/how_to_support_new_devices.md +++ b/docs/how_tos/how_to_support_new_devices.md @@ -7,7 +7,7 @@ This page will guide you through the process of adding support for new devices t In case you require any help feel free to create an [issue](https://github.com/Koenkk/zigbee2mqtt/issues). ## 1. Pairing the device with Zigbee2mqtt -The first step is to pair the device with zigbee2mqtt. It should be possible to pair your unsupported device out of the box because zigbee2mqtt can pair with any zigbee device. You need to find out how to bring your device into pairing mode, most of the times via a factory reset. For some vendors this is already documented [here](https://koenkk.github.io/zigbee2mqtt/getting_started/pairing_devices.html). +The first step is to pair the device with zigbee2mqtt. It should be possible to pair your unsupported device out of the box because zigbee2mqtt can pair with any zigbee device. You need to find out how to bring your device into pairing mode, most of the time via a factory reset. For some vendors this is already documented [here](https://koenkk.github.io/zigbee2mqtt/getting_started/pairing_devices.html). Once you successfully paired the device you will see something like: ``` @@ -38,7 +38,7 @@ Once finished, restart Zigbee2mqtt and trigger some actions on the device. You w 2018-5-1 18:19:41 WARN Please create an issue on https://github.com/Koenkk/zigbee2mqtt/issues with this message. ``` -In case your device is not reporting anything, it could be that this device requires additional configure. This can be done by adding a `configure:` section, [examples]([https://github.com/Koenkk/zigbee-shepherd-converters/blob/master/devices.js). In case your device is a contact or motion sensor, it could be that this is an [IAS device](https://stackoverflow.com/questions/31241211/zigbee-ias-device-enroll-and-response). Example of an IAS `configure:` section can be found [here](https://github.com/Koenkk/zigbee-shepherd-converters/blob/master/devices.js#L1495). +In case your device is not reporting anything, it could be that this device requires additional configuration. This can be done by adding a `configure:` section ([examples here](https://github.com/Koenkk/zigbee-shepherd-converters/blob/master/devices.js)). In case your device is a contact or motion sensor, it could be that this is an [IAS device](https://stackoverflow.com/questions/31241211/zigbee-ias-device-enroll-and-response). Example of an IAS `configure:` section can be found [here](https://github.com/Koenkk/zigbee-shepherd-converters/blob/master/devices.js#L1495). ## 3. Adding converter(s) for your device In order to parse the messages of your zigbee device we need to add converter(s) to `node_modules/zigbee-shepherd-converters/converters/fromZigbee.js`.