Skip to content
This repository has been archived by the owner on Mar 11, 2021. It is now read-only.

Commit

Permalink
Update README.md (#32)
Browse files Browse the repository at this point in the history
- 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
  • Loading branch information
CanDoAnything authored Sep 27, 2020
1 parent 6af95c9 commit d8cfd9f
Showing 1 changed file with 17 additions and 9 deletions.
26 changes: 17 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |

0 comments on commit d8cfd9f

Please sign in to comment.