/zha-network-visualization-card

Lovelace custom element for visualizing the ZHA Zigbee network

Primary LanguageJavaScript

zha-network-visualization-card

Lovelace custom element for visualizing the ZHA Zigbee network

zha-map integration commponent for Home Assistant allow you to make a ZHA (Zigbee Home Automation) network topology map and zha-network-visualization-card allows you to visualize that map in Lovelace.

Requires that you are already using the ZHA integration commponent in Home Assistant.

Zigbee network mapping with zha-map can help you identify weak points like bad links between your devices.

Installation Instructions

  1. Install the zha_map custom component
  1. Add zha_map: to your configuration.yaml and restart Home Assistant
  2. Wait for a scan to complete (logs to DEBUG, or use the new zha_map service to scan on demand)
  3. Put the zha-network-visualization-card.js lovelace card into the \[config\]/www/zha-network-vizualization-card directory ether by copying it there or by using the file editor to create it with a cut and paste of the content.
  4. Add the lovelace resource with Configuration ¦ Lovelace Dashboards ¦ Resources ¦ ⊕ ¦ URL:/local/zha-network-visualization-card.js & Resource Type JavaScript Module ¦ Update.
  5. Add custom card (works best in panel mode) through Overview ¦ ⋮ ¦ Configure UI ¦ New Tab + ¦ Give it a Title and any other options & select Panel Mode. Open this new view which will be empty, at the bottom right click the + for cards window. Choose the manual card type and a card configuration window will open, this is where you will add type: custom:zha-network-visualization-card. Save and exit UI configurator
  6. Optional: Restart Home Assistant. Once its back go to Developer Tools then open the Services tab and choose the zha_map.scan_now service and click call service button. Check logs for details.

New map card should be there.

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.