From d8cfd9f810a101000404e6d082fa5c611e8456d6 Mon Sep 17 00:00:00 2001 From: Joseph Amalfitano <16958794+CanDoAnything@users.noreply.github.com> Date: Sun, 27 Sep 2020 00:27:50 -0400 Subject: [PATCH] Update README.md (#32) - minor MD format tweaks - numbered lists can all start w/ 1. in the raw markdown github will automatically number appropirately - indented the subs for 1 and 4 to make the list cleaner - added a link to a LQI definition - added a table @ the bottom for the colors --- README.md | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index d625904..4af216c 100644 --- a/README.md +++ b/README.md @@ -10,16 +10,24 @@ Zigbee network mapping with zha-map can help you identify weak points like bad l # Installation Instructions 1. Install the zha_map custom component -- https://github.com/zha-ng/zha-map -2. Add zha_map: to your configuration.yaml and restart Home Assistant -3. Wait for a scan to complete (logs to DEBUG, or use the new zha_map service to scan on demand) -4. Install one of the visualization cards: -- https://github.com/dmulcahey/zha-network-visualization-card -- https://github.com/Samantha-uk/zigzag -5. Add to your lovelace global config as type: module -6. Add custom card (works best in panel mode): - type: 'custom:zha-network-visualization-card' + - https://github.com/zha-ng/zha-map +1. Add zha_map: to your configuration.yaml and restart Home Assistant +1. Wait for a scan to complete (logs to DEBUG, or use the new zha_map service to scan on demand) +1. Install one of the visualization cards: + - https://github.com/dmulcahey/zha-network-visualization-card + - https://github.com/Samantha-uk/zigzag +1. Add to your lovelace global config as type: module +1. Add custom card (works best in panel mode): - type: 'custom:zha-network-visualization-card' # Usage + The Zigbee coordinator will be represented by a rectangle at the top. Any device that serves as Zigbee router (usually all devices running on Mains electricity / grid power) will represented as ovals, and Zigbee end-device (usually battery powered sensors) will be represented by as circles. -The lines between those representions show all the possible paths through Zigbee mesh. Any path with a LQI over 192 is shown as green, LQI 129-192 is shown as yellow, and anything 128 and lower is shown as red. +The lines between those representions show all the possible paths through Zigbee mesh. The numbers on the lines represent the ??LQI?? for the path. Sometimes lines may show two numbers seperated by a forward slash. The first number is ??????? and the second number is ??? + +|LQI [(about)](https://www.silabs.com/community/wireless/zigbee-and-thread/knowledge-base.entry.html/2012/06/28/how_do_i_obtain_lqi-pS4D)|Color| +|--|--| +| > 192 | Green | +| 129 - 192 | Yellow | +| < 129 | Red | +| ?not determined yet? | Grey |