forked from OpenZWave/python-openzwave
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathgroup.html
More file actions
292 lines (274 loc) · 12.5 KB
/
group.html
File metadata and controls
292 lines (274 loc) · 12.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Group documentation — python-openzwave 0.3.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.3.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="python-openzwave 0.3.0 documentation" href="index.html" />
<link rel="up" title="API documentation" href="openzwave.html" />
<link rel="next" title="Value documentation" href="value.html" />
<link rel="prev" title="Command documentation" href="command.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="value.html" title="Value documentation"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="command.html" title="Command documentation"
accesskey="P">previous</a> |</li>
<li><a href="index.html">python-openzwave 0.3.0 documentation</a> »</li>
<li><a href="openzwave.html" accesskey="U">API documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="group-documentation">
<h1>Group documentation<a class="headerlink" href="#group-documentation" title="Permalink to this headline">¶</a></h1>
<p>The group is used in associations.</p>
<div class="toctree-wrapper compound">
<ul class="simple">
</ul>
</div>
<span class="target" id="module-openzwave.group"></span><span class="target" id="module-openzwave.group"></span><dl class="docutils">
<dt>This file is part of <strong>python-openzwave</strong> project <a class="reference external" href="https://github.com/OpenZWave/python-openzwave">https://github.com/OpenZWave/python-openzwave</a>.</dt>
<dd><table class="first last docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">platform:</th><td class="field-body">Unix, Windows, MacOS X</td>
</tr>
<tr class="field-even field"><th class="field-name">sinopsis:</th><td class="field-body">openzwave API</td>
</tr>
</tbody>
</table>
</dd>
</dl>
<p>License : GPL(v3)</p>
<p><strong>python-openzwave</strong> 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.</p>
<p><strong>python-openzwave</strong> 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 <a class="reference external" href="http://www.gnu.org/licenses">http://www.gnu.org/licenses</a>.</p>
<dl class="class">
<dt id="openzwave.group.ZWaveGroup">
<em class="property">class </em><tt class="descclassname">openzwave.group.</tt><tt class="descname">ZWaveGroup</tt><big>(</big><em>group_index</em>, <em>network=None</em>, <em>node_id=None</em><big>)</big><a class="headerlink" href="#openzwave.group.ZWaveGroup" title="Permalink to this definition">¶</a></dt>
<dd><p>The driver object.
Hold options of the manager
Also used to retrieve information about the library, ...</p>
<dl class="method">
<dt id="openzwave.group.ZWaveGroup.add_association">
<tt class="descname">add_association</tt><big>(</big><em>target_node_id</em>, <em>instance=0</em><big>)</big><a class="headerlink" href="#openzwave.group.ZWaveGroup.add_association" title="Permalink to this definition">¶</a></dt>
<dd><p>Adds a node to an association group.</p>
<p>Due to the possibility of a device being asleep, the command is assumed to
complete with success, 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.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>target_node_id</strong> (<em>int</em>) – Identifier for the node that will be added to the association group.</li>
<li><strong>instance</strong> (<em>int</em>) – The instance that will be added to the association group.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="openzwave.group.ZWaveGroup.associations">
<tt class="descname">associations</tt><a class="headerlink" href="#openzwave.group.ZWaveGroup.associations" title="Permalink to this definition">¶</a></dt>
<dd><p>The members of associations.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">set()</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="openzwave.group.ZWaveGroup.associations_instances">
<tt class="descname">associations_instances</tt><a class="headerlink" href="#openzwave.group.ZWaveGroup.associations_instances" title="Permalink to this definition">¶</a></dt>
<dd><p>The members of associations with theirs instances.
Nodes that does not support multi-instances have an instanceid equal to 0.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">set() of tuples (nodeid,instanceid)</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="openzwave.group.ZWaveGroup.index">
<tt class="descname">index</tt><a class="headerlink" href="#openzwave.group.ZWaveGroup.index" title="Permalink to this definition">¶</a></dt>
<dd><p>The index of the group.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">int</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="openzwave.group.ZWaveGroup.label">
<tt class="descname">label</tt><a class="headerlink" href="#openzwave.group.ZWaveGroup.label" title="Permalink to this definition">¶</a></dt>
<dd><p>The label of the group.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">int</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="openzwave.group.ZWaveGroup.max_associations">
<tt class="descname">max_associations</tt><a class="headerlink" href="#openzwave.group.ZWaveGroup.max_associations" title="Permalink to this definition">¶</a></dt>
<dd><p>The number of associations.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">int</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="openzwave.group.ZWaveGroup.remove_association">
<tt class="descname">remove_association</tt><big>(</big><em>target_node_id</em>, <em>instance=0</em><big>)</big><a class="headerlink" href="#openzwave.group.ZWaveGroup.remove_association" title="Permalink to this definition">¶</a></dt>
<dd><p>Removes a node from an association group.</p>
<p>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.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>target_node_id</strong> (<em>int</em>) – Identifier for the node that will be removed from the association group.</li>
<li><strong>instance</strong> (<em>int</em>) – The instance that will be added to the association group.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="openzwave.group.ZWaveGroup.to_dict">
<tt class="descname">to_dict</tt><big>(</big><em>extras=['all']</em><big>)</big><a class="headerlink" href="#openzwave.group.ZWaveGroup.to_dict" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a dict representation of the group.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>extras</strong> (<em>[]</em>) – The extra inforamtions to add</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A dict</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">dict()</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="command.html"
title="previous chapter">Command documentation</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="value.html"
title="next chapter">Value documentation</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/group.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="value.html" title="Value documentation"
>next</a> |</li>
<li class="right" >
<a href="command.html" title="Command documentation"
>previous</a> |</li>
<li><a href="index.html">python-openzwave 0.3.0 documentation</a> »</li>
<li><a href="openzwave.html" >API documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2012,2013,2014,2015, bibi21000.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div>
</body>
</html>