zigbee.mqtt
#
- class platypush.message.event.zigbee.mqtt.ZigbeeMqttDeviceBannedEvent(host: str, port: int, device=None, *args, **kwargs)[source]#
Bases:
ZigbeeMqttEvent
Triggered when a device is banned from the network.
- __init__(host: str, port: int, device=None, *args, **kwargs)[source]#
- Parameters:
target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default:
logging.INFO
)disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event
- class platypush.message.event.zigbee.mqtt.ZigbeeMqttDeviceBindEvent(host: str, port: int, device=None, *args, **kwargs)[source]#
Bases:
ZigbeeMqttEvent
Triggered when a device bind occurs on the network.
- __init__(host: str, port: int, device=None, *args, **kwargs)[source]#
- Parameters:
target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default:
logging.INFO
)disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event
- class platypush.message.event.zigbee.mqtt.ZigbeeMqttDeviceConnectedEvent(host: str, port: int, device=None, *args, **kwargs)[source]#
Bases:
ZigbeeMqttEvent
Triggered when a device connects to the network.
- __init__(host: str, port: int, device=None, *args, **kwargs)[source]#
- Parameters:
target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default:
logging.INFO
)disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event
- class platypush.message.event.zigbee.mqtt.ZigbeeMqttDevicePairingEvent(host: str, port: int, device=None, *args, **kwargs)[source]#
Bases:
ZigbeeMqttEvent
Triggered when a device is pairing to the network.
- __init__(host: str, port: int, device=None, *args, **kwargs)[source]#
- Parameters:
target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default:
logging.INFO
)disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event
- class platypush.message.event.zigbee.mqtt.ZigbeeMqttDevicePropertySetEvent(host: str, port: int, device: str, properties: Dict[str, Any], *args, **kwargs)[source]#
Bases:
ZigbeeMqttEvent
Triggered when a the properties of a Zigbee connected devices (state, brightness, alert etc.) change.
- __init__(host: str, port: int, device: str, properties: Dict[str, Any], *args, **kwargs)[source]#
- Parameters:
target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default:
logging.INFO
)disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event
- class platypush.message.event.zigbee.mqtt.ZigbeeMqttDeviceRemovedEvent(host: str, port: int, device=None, force=False, *args, **kwargs)[source]#
Bases:
ZigbeeMqttEvent
Triggered when a device is removed from the network.
- __init__(host: str, port: int, device=None, force=False, *args, **kwargs)[source]#
- Parameters:
target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default:
logging.INFO
)disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event
- class platypush.message.event.zigbee.mqtt.ZigbeeMqttDeviceRemovedFailedEvent(host: str, port: int, device=None, *args, **kwargs)[source]#
Bases:
ZigbeeMqttEvent
Triggered when the removal of a device from the network failed.
- __init__(host: str, port: int, device=None, *args, **kwargs)[source]#
- Parameters:
target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default:
logging.INFO
)disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event
- class platypush.message.event.zigbee.mqtt.ZigbeeMqttDeviceRenamedEvent(host: str, port: int, device=None, *args, **kwargs)[source]#
Bases:
ZigbeeMqttEvent
Triggered when a device is renamed on the network.
- __init__(host: str, port: int, device=None, *args, **kwargs)[source]#
- Parameters:
target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default:
logging.INFO
)disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event
- class platypush.message.event.zigbee.mqtt.ZigbeeMqttDeviceUnbindEvent(host: str, port: int, device=None, *args, **kwargs)[source]#
Bases:
ZigbeeMqttEvent
Triggered when a device bind occurs on the network.
- __init__(host: str, port: int, device=None, *args, **kwargs)[source]#
- Parameters:
target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default:
logging.INFO
)disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event
- class platypush.message.event.zigbee.mqtt.ZigbeeMqttDeviceWhitelistedEvent(host: str, port: int, device=None, *args, **kwargs)[source]#
Bases:
ZigbeeMqttEvent
Triggered when a device is whitelisted on the network.
- __init__(host: str, port: int, device=None, *args, **kwargs)[source]#
- Parameters:
target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default:
logging.INFO
)disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event
- class platypush.message.event.zigbee.mqtt.ZigbeeMqttErrorEvent(host: str, port: int, error=None, *args, **kwargs)[source]#
Bases:
ZigbeeMqttEvent
Triggered when an error happens on the zigbee2mqtt service.
- __init__(host: str, port: int, error=None, *args, **kwargs)[source]#
- Parameters:
target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default:
logging.INFO
)disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event
- class platypush.message.event.zigbee.mqtt.ZigbeeMqttEvent(target=None, origin=None, id=None, timestamp=None, logging_level=20, disable_web_clients_notification=False, **kwargs)[source]#
Bases:
Event
- class platypush.message.event.zigbee.mqtt.ZigbeeMqttGroupAddedEvent(host: str, port: int, group=None, *args, **kwargs)[source]#
Bases:
ZigbeeMqttEvent
Triggered when a group is added.
- __init__(host: str, port: int, group=None, *args, **kwargs)[source]#
- Parameters:
target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default:
logging.INFO
)disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event
- class platypush.message.event.zigbee.mqtt.ZigbeeMqttGroupAddedFailedEvent(host: str, port: int, group=None, *args, **kwargs)[source]#
Bases:
ZigbeeMqttEvent
Triggered when a request to add a group fails.
- __init__(host: str, port: int, group=None, *args, **kwargs)[source]#
- Parameters:
target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default:
logging.INFO
)disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event
- class platypush.message.event.zigbee.mqtt.ZigbeeMqttGroupRemoveAllEvent(host: str, port: int, group=None, *args, **kwargs)[source]#
Bases:
ZigbeeMqttEvent
Triggered when all the devices are removed from a group.
- __init__(host: str, port: int, group=None, *args, **kwargs)[source]#
- Parameters:
target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default:
logging.INFO
)disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event
- class platypush.message.event.zigbee.mqtt.ZigbeeMqttGroupRemoveAllFailedEvent(host: str, port: int, group=None, *args, **kwargs)[source]#
Bases:
ZigbeeMqttEvent
Triggered when a request to remove all the devices from a group fails.
- __init__(host: str, port: int, group=None, *args, **kwargs)[source]#
- Parameters:
target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default:
logging.INFO
)disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event
- class platypush.message.event.zigbee.mqtt.ZigbeeMqttGroupRemovedEvent(host: str, port: int, group=None, *args, **kwargs)[source]#
Bases:
ZigbeeMqttEvent
Triggered when a group is removed.
- __init__(host: str, port: int, group=None, *args, **kwargs)[source]#
- Parameters:
target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default:
logging.INFO
)disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event
- class platypush.message.event.zigbee.mqtt.ZigbeeMqttGroupRemovedFailedEvent(host: str, port: int, group=None, *args, **kwargs)[source]#
Bases:
ZigbeeMqttEvent
Triggered when a request to remove a group fails.
- __init__(host: str, port: int, group=None, *args, **kwargs)[source]#
- Parameters:
target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default:
logging.INFO
)disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event
- class platypush.message.event.zigbee.mqtt.ZigbeeMqttOfflineEvent(host: str, port: int, *args, **kwargs)[source]#
Bases:
ZigbeeMqttEvent
Triggered when a zigbee2mqtt service goes offline.
- __init__(host: str, port: int, *args, **kwargs)[source]#
- Parameters:
target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default:
logging.INFO
)disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event
- class platypush.message.event.zigbee.mqtt.ZigbeeMqttOnlineEvent(host: str, port: int, *args, **kwargs)[source]#
Bases:
ZigbeeMqttEvent
Triggered when a zigbee2mqtt service goes online.
- __init__(host: str, port: int, *args, **kwargs)[source]#
- Parameters:
target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default:
logging.INFO
)disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event