API reference

User written automations will primarily interact with members of the pyziggy.parameters module. If you’re new to pyziggy, you should study this first, and refer to the rest later as necessary.

Modules

pyziggy.broadcasters

Used by pyziggy.parameters to implement the observer pattern.

pyziggy.devices_client

Classes for representing the devices in your Zigbee network.

pyziggy.device_bases

Autogenerated classes abstracting over parameters that are commonly occurring together.

pyziggy.message_loop

Classes synchronizing the various pyziggy tasks across threads.

pyziggy.parameters

Contains the parameter classes that your code can interact with in order to query and modify the device states observable through MQTT.

pyziggy.util

Utility classes and functions that may come handy for building automations.

pyziggy.workarounds

Contains somewhat generally applicable modifications to the autogenerated parameter data and behavior.

Modules for advanced or niche use-cases

pyziggy.cli

Used by the pyziggy command line program.

pyziggy.run

Provides the functionality for the pyziggy run and pyziggy check subcommands.