Group documentation

The group is used in associations.

This file is part of python-openzwave project http://code.google.com/p/python-openzwave.
platform:Unix, Windows, MacOS X
sinopsis:openzwave API

License : GPL(v3)

python-openzwave is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

python-openzwave is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with python-openzwave. If not, see http://www.gnu.org/licenses.

class openzwave.group.ZWaveGroup(group_index, network=None, node_id=None)

The driver objet. Hold options of the manager Also used to retrieve informations about the library, ...

add_association(target_node_id)

Adds a node to an association group.

Due to the possibility of a device being asleep, the command is assumed to suceeed, and the association data held in this class is updated directly. This will be reverted by a future Association message from the device if the Z-Wave message actually failed to get through. Notification callbacks will be sent in both cases.

Parameters:target_node_id (int) – Identifier for the node that will be added to the association group.
associations

The members of associations.

Return type:set()
index

The index of the group.

Return type:int
label

The label of the group.

Return type:int
max_associations

The number of associations.

Return type:int
remove_association(target_node_id)

Removes a node from an association group.

Due to the possibility of a device being asleep, the command is assumed to succeed, and the association data held in this class is updated directly. This will be reverted by a future Association message from the device if the Z-Wave message actually failed to get through. Notification callbacks will be sent in both cases.

Parameters:target_node_id (int) – Identifier for the node that will be removed from the association group.