pyziggy.devices_client

Classes for representing the devices in your Zigbee network.

Classes

Device(property_name)	Base class for the devices under DevicesClient.
DevicesClient([impl])	Base class for the AvailableDevices class.

class pyziggy.devices_client.Device(property_name: str)

Bases: MqttSubscriber, AsyncUpdater

Base class for the devices under DevicesClient. These are the public members of the AvailableDevices autogenerated class.

final get_parameters() → List[ParameterBase]

Returns:

a list of all parameters under this device.

class pyziggy.devices_client.DevicesClient(impl: MqttClientImpl | None = None)

Bases: MqttClient

Base class for the AvailableDevices class. Contains the mechanisms to aggregate all devices, receive and dispatch MQTT messages and translate them into parameter state changes.

final get_devices() → List[Device]

A useful function for iterating over all devices.

Returns:

all known Device members.

on_connect: Broadcaster

Call pyziggy.broadcasters.Broadcaster.add_listener() on this member to receive a callback upon successful connection to the MQTT broker.