zwave
Platypush documentation
zwave
- class platypush.message.event.zwave.ZwaveButtonCreatedEvent(node: Dict[str, Any], *args, **kwargs)[source]
Bases:
ZwaveNodeEvent
Triggered when a button is added to the network.
- class platypush.message.event.zwave.ZwaveButtonOffEvent(node: Dict[str, Any], *args, **kwargs)[source]
Bases:
ZwaveNodeEvent
Triggered when a button is released.
- class platypush.message.event.zwave.ZwaveButtonOnEvent(node: Dict[str, Any], *args, **kwargs)[source]
Bases:
ZwaveNodeEvent
Triggered when a button is pressed.
- class platypush.message.event.zwave.ZwaveButtonRemovedEvent(node: Dict[str, Any], *args, **kwargs)[source]
Bases:
ZwaveNodeEvent
Triggered when a button is removed from the network.
- class platypush.message.event.zwave.ZwaveCommandEvent(state: str, state_description: str, error: Optional[str] = None, error_description: Optional[str] = None, node: Optional[Dict[str, Any]] = None, *args, **kwargs)[source]
Bases:
ZwaveEvent
Triggered when a command is received on the network.
- __init__(state: str, state_description: str, error: Optional[str] = None, error_description: Optional[str] = None, node: Optional[Dict[str, Any]] = None, *args, **kwargs)[source]
- Params:
target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict] logging_level – Logging level that should be applied to these
events (default: INFO).
- class platypush.message.event.zwave.ZwaveCommandWaitingEvent(state: str, state_description: str, error: Optional[str] = None, error_description: Optional[str] = None, node: Optional[Dict[str, Any]] = None, *args, **kwargs)[source]
Bases:
ZwaveCommandEvent
Triggered when a command is waiting for a message to proceed.
- class platypush.message.event.zwave.ZwaveEvent(device: Optional[str] = None, *args, **kwargs)[source]
Bases:
Event
- __init__(device: Optional[str] = None, *args, **kwargs)[source]
- Params:
target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict] logging_level – Logging level that should be applied to these
events (default: INFO).
- class platypush.message.event.zwave.ZwaveNetworkErrorEvent(device: Optional[str] = None, *args, **kwargs)[source]
Bases:
ZwaveEvent
Triggered when an error occurs on the Z-Wave network.
- class platypush.message.event.zwave.ZwaveNetworkReadyEvent(ozw_library_version: str, python_library_version: str, zwave_library: str, node_id: int, node_version: str, home_id: int, nodes_count: int, device: Optional[str] = None, *args, **kwargs)[source]
Bases:
ZwaveEvent
Triggered when the network started on a Z-Wave adapter becomes ready.
- __init__(ozw_library_version: str, python_library_version: str, zwave_library: str, node_id: int, node_version: str, home_id: int, nodes_count: int, device: Optional[str] = None, *args, **kwargs)[source]
- Params:
target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict] logging_level – Logging level that should be applied to these
events (default: INFO).
- class platypush.message.event.zwave.ZwaveNetworkResetEvent(device: Optional[str] = None, *args, **kwargs)[source]
Bases:
ZwaveEvent
Triggered when a Z-Wave network is reset.
- class platypush.message.event.zwave.ZwaveNetworkStoppedEvent(device: Optional[str] = None, *args, **kwargs)[source]
Bases:
ZwaveEvent
Triggered when a Z-Wave network is stopped.
- class platypush.message.event.zwave.ZwaveNodeAddedEvent(node: Dict[str, Any], *args, **kwargs)[source]
Bases:
ZwaveNodeEvent
Triggered when a node is added to the network.
- class platypush.message.event.zwave.ZwaveNodeAsleepEvent(node: Dict[str, Any], *args, **kwargs)[source]
Bases:
ZwaveNodeEvent
Triggered when a node goes in sleep mode.
- class platypush.message.event.zwave.ZwaveNodeAwakeEvent(node: Dict[str, Any], *args, **kwargs)[source]
Bases:
ZwaveNodeEvent
Triggered when a node goes back into awake mode.
- class platypush.message.event.zwave.ZwaveNodeEvent(node: Dict[str, Any], *args, **kwargs)[source]
Bases:
ZwaveEvent
Generic Z-Wave node event class.
- __init__(node: Dict[str, Any], *args, **kwargs)[source]
- Params:
target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict] logging_level – Logging level that should be applied to these
events (default: INFO).
- class platypush.message.event.zwave.ZwaveNodeGroupEvent(group_index: Optional[int] = None, *args, **kwargs)[source]
Bases:
ZwaveNodeEvent
Triggered when a node is associated/de-associated to a group.
- __init__(group_index: Optional[int] = None, *args, **kwargs)[source]
- Params:
target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict] logging_level – Logging level that should be applied to these
events (default: INFO).
- class platypush.message.event.zwave.ZwaveNodePollingDisabledEvent(node: Dict[str, Any], *args, **kwargs)[source]
Bases:
ZwaveNodeEvent
Triggered when the polling of a node is successfully turned off.
- class platypush.message.event.zwave.ZwaveNodePollingEnabledEvent(node: Dict[str, Any], *args, **kwargs)[source]
Bases:
ZwaveNodeEvent
Triggered when the polling of a node is successfully turned on.
- class platypush.message.event.zwave.ZwaveNodeQueryCompletedEvent(device: Optional[str] = None, *args, **kwargs)[source]
Bases:
ZwaveEvent
Triggered when all the nodes on the network have been queried.
- class platypush.message.event.zwave.ZwaveNodeReadyEvent(node: Dict[str, Any], *args, **kwargs)[source]
Bases:
ZwaveNodeEvent
Triggered when a node is ready.
- class platypush.message.event.zwave.ZwaveNodeRemovedEvent(node: Dict[str, Any], *args, **kwargs)[source]
Bases:
ZwaveNodeEvent
Triggered when a node is removed from the network.
- class platypush.message.event.zwave.ZwaveNodeRenamedEvent(node: Dict[str, Any], *args, **kwargs)[source]
Bases:
ZwaveNodeEvent
Triggered when a node is renamed.
- class platypush.message.event.zwave.ZwaveNodeSceneEvent(scene_id: int, *args, **kwargs)[source]
Bases:
ZwaveNodeEvent
Triggered when a scene is activated on a node.
- __init__(scene_id: int, *args, **kwargs)[source]
- Params:
target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict] logging_level – Logging level that should be applied to these
events (default: INFO).
- class platypush.message.event.zwave.ZwaveValueAddedEvent(node: Dict[str, Any], value: Dict[str, Any], *args, **kwargs)[source]
Bases:
ZwaveValueEvent
Triggered when a value is added to a node on the network.
- class platypush.message.event.zwave.ZwaveValueChangedEvent(node: Dict[str, Any], value: Dict[str, Any], *args, **kwargs)[source]
Bases:
ZwaveValueEvent
Triggered when a value of a node on the network changes.
- class platypush.message.event.zwave.ZwaveValueEvent(node: Dict[str, Any], value: Dict[str, Any], *args, **kwargs)[source]
Bases:
ZwaveEvent
Abstract class for Z-Wave value events.
- __init__(node: Dict[str, Any], value: Dict[str, Any], *args, **kwargs)[source]
- Params:
target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict] logging_level – Logging level that should be applied to these
events (default: INFO).