pyzwave.zipconnection module

class pyzwave.zipconnection.ZIPConnection(address, psk)

Bases: pyzwave.adapter.Adapter

Class for connecting to a zipgateway or zipnode

async addNode(txOptions: pyzwave.adapter.TxOptions) → bool

Start inclusion mode in the controller

async addNodeDSKSet(accept: bool, inputDSKLength: int, dsk: pyzwave.types.dsk_t) → bool

This command is used to indicate the S2 bootstrapping controller if the DSK is accepted and report the user input when needed.

async addNodeKeysSet(grantCSA: bool, accept: bool, grantedKeys: pyzwave.commandclass.NetworkManagementInclusion.Keys) → bool

This command is used to inform an S2 bootstrapping controller which keys must be granted to the node being bootstrapped.

async addNodeStop() → bool

Stop inclusion mode in the controller

async connect()

Connect the adapter. Must be implemented by subclass

async getFailedNodeList() → list

Return a list of failing nodes

async getMultiChannelCapability(nodeId: int, endpoint: int) → pyzwave.commandclass.NetworkManagementProxy.MultiChannelCapabilityReport

Return the multi channel capabilities for an endpoint in a node

async getMultiChannelEndPoints(nodeId: int) → int

Return the number of multi channel end points implemented by a node

async getNodeInfo(nodeId: int) → pyzwave.commandclass.NetworkManagementProxy.NodeInfoCachedReport

Return the node info from this node. Possibly cached

async getNodeList() → set

Return a list of nodes included in the network

keepAlive()

Send a keepalive message

onPacket(pkt)

Called when a packed has recevied from the connection

property psk

The psk used for the connection

async removeFailedNode(nodeId: int) → pyzwave.commandclass.NetworkManagementInclusion.FailedNodeRemoveStatus.Status

Remove a non-responding node

async removeNode() → bool

Start exclusion mode in the controller

async removeNodeStop() → bool

Stop exclusion mode in the controller

resetKeepAlive()

Reset the keepalive timeout

async send(cmd, sourceEP=0, destEP=0, timeout=3) → bool

Send message to Z-Wave chip. Must be implemented in subclass.

Warning

This command will block until the message has been ACKed by the node.

When talking to battery operated (sleeping) nodes this command will block until the nodes wakes up or is considered dead. This can be a long time (week or even months). Please make sure the code can handle this.

async setNodeInfo(generic, specific, cmdClasses)

Set the application NIF (Node Information Frame). This method should not be called directly. Use the corresponding function in Application instead.