Zigzag v0.2.0 is available

It can be found in the one repo

Zigzag-v1 is archived and will receive no updates or support.

Edited: 3-Jan-2021

Zigzag v0.1.0 (Alpha Release)

Zigzag is a custom card/panel for Home Assistant that displays a graphical layout of Zigbee devices and the connections between them.

In Zigzag, Zigbee devices are known as Zigs and the connections between them as Zags.

Zigzag can be installed as a panel or a custom card.

Prerequisites

• Home Assistant
• ZHA (A Home Assistant Zigbee Integration)
• ZHA-MAP A custom component that collects the Zag information.

It is possible to use Zigzag without ZHA-MAP, however it is of limited value as no Zags will be displayed.

Installation

At present the installation of Zigzag is not automated.

You will need to:

• Create a zigzag directory inside your Home Assistant www directory.
• Copy zigzag-panel.js and/or zigzag-card.js from the dist directory of this repo into your zigzag folder.

Zigzag as a panel

• Copy the contents of the static/config.yaml file in this repo to your caonfiguration.yaml file.
• Restart Home Assistant. Zigzag should appear as an entry on the left of the display.

Zigzag as a Custom Card

• Using the Lovelace Resources section (Configuration->Lovelace Dashboards -> Resources) add a new resource.
• Url: /local/zigzag/zigzag-card.js
• Resource Type: JavaScript Module

You can now add a Zigzag custom card as described here.

Zigzag as a card works best when put in a view that has panel mode active.

Know Issues/Limitations

• Icon paths are hardcoded into the source.
• Icon size is currently set at 48px (Once the hardcoded icons are resolved, this can be addressed.)
• Text orientation on zag labels is fixed.
• Card Config editor is unfinished. (I could not get the hui-elements to load and I ran out of steam trying ...)
• Does not check for existence of zha or zha-map.
• Error handling needs to be … hardened.
• Only tested on a small Zigbee network.

Related projects

zha-map

zha-map integration commponent for Home Assistant allow you to make a ZHA (Zigbee Home Automation) network topology map. zha-network-visualization-card relies on this data to visualize that map in Lovelace of Zigbee devices and the connections between them.

zha-network-visualization-card

zha-network-visualization-card is an alternative custom lovelace element for Home Assistant that visualizing your ZHA Zigbee network. Zigbee network mapping with zha-map can help you identify weak points like bad links between your devices. Like Zigzag, zha-network-visualization-card relies on the data provided by the zha-map integration commponent.

ZHA Network Card

zha-network-card is a another alternative custom Lovelace card for Home Assistant that displays ZHA component Zigbee network and device information in Home Assistant. This implementation leverages the ZHA websocket API to get ZHA device information instead.

ZHA Device Exporter

zha-device-exporter is a custom component for Home Assistant to allow the ZHA component to export lists of Zigbee devices.

Zigpy

zigpy is Zigbee protocol stack integration project to implement the Zigbee Home Automation standard as a Python library. Zigbee Home Automation integration with zigpy allows you to connect one of many off-the-shelf Zigbee adapters using one of the available Zigbee radio library modules compatible with zigpy to control Zigbee devices. There is currently support for controlling Zigbee device types such as binary sensors (e.g. motion and door sensors), analog sensors (e.g. temperature sensors), lightbulbs, switches, and fans. Zigpy is tightly integrated with Home Assistant's ZHA component and provides a user-friendly interface for working with a Zigbee network.