forked from balloob/python-openzwave
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathobject.html
More file actions
230 lines (209 loc) · 8.9 KB
/
Copy pathobject.html
File metadata and controls
230 lines (209 loc) · 8.9 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
<div class="section" id="object-documentation">
<h1>Object documentation</h1>
<p>The low level object. Implements cache mechanism.</p>
<div class="toctree-wrapper compound">
<ul class="simple">
</ul>
</div>
<span class="target" id="module-openzwave.object"></span><span class="target" id="module-openzwave.object"></span><dl class="docutils">
<dt>This file is part of <strong>python-openzwave</strong> project <a class="reference external" href="https://github.com/bibi21000/python-openzwave">https://github.com/bibi21000/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.object.ZWaveObject">
<em class="property">class </em><tt class="descclassname">openzwave.object.</tt><tt class="descname">ZWaveObject</tt><big>(</big><em>object_id</em>, <em>network=None</em>, <em>use_cache=True</em><big>)</big></dt>
<dd><p>Represents a Zwave object. Values, nodes, ... can be changer by
other managers on the network.</p>
<dl class="method">
<dt id="openzwave.object.ZWaveObject.cache_property">
<tt class="descname">cache_property</tt><big>(</big><em>prop</em><big>)</big></dt>
<dd><p>Add this property to the cache manager.</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>prop</strong> (<em>lambda</em>) – The property to cache</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="openzwave.object.ZWaveObject.home_id">
<tt class="descname">home_id</tt></dt>
<dd><p>The home_id of the node.</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.object.ZWaveObject.is_outdated">
<tt class="descname">is_outdated</tt><big>(</big><em>prop</em><big>)</big></dt>
<dd><p>Check if property information is outdated.</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>prop</strong> (<em>lambda</em>) – The property to check</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="openzwave.object.ZWaveObject.last_update">
<tt class="descname">last_update</tt></dt>
<dd><p>The last update date of the device.</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">time</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="openzwave.object.ZWaveObject.network">
<tt class="descname">network</tt></dt>
<dd><p>The network of the node.</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">ZWaveNetwork</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="openzwave.object.ZWaveObject.object_id">
<tt class="descname">object_id</tt></dt>
<dd><p>The id of the object.
object_id could be None, when creating a scene for example.</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.object.ZWaveObject.outdate">
<tt class="descname">outdate</tt><big>(</big><em>prop</em><big>)</big></dt>
<dd><p>Says that the property information is outdated.</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>prop</strong> (<em>lambda</em>) – The property to outdate</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="openzwave.object.ZWaveObject.outdated">
<tt class="descname">outdated</tt></dt>
<dd><p>Are the information of this object outdated.</p>
<p>How to manage the cache ?</p>
<p>2 ways of doing it :
- refresh information when setting the property
- refresh information when getting getting property.
Maybe whe could implement the 2 methods.</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.object.ZWaveObject.update">
<tt class="descname">update</tt><big>(</big><em>prop</em><big>)</big></dt>
<dd><p>Says that the property are updated.</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>prop</strong> (<em>lambda</em>) – The property to update</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="openzwave.object.ZWaveObject.use_cache">
<tt class="descname">use_cache</tt></dt>
<dd><p>Should this object use cache from property</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">bool</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="openzwave.object.ZWaveNodeInterface">
<em class="property">class </em><tt class="descclassname">openzwave.object.</tt><tt class="descname">ZWaveNodeInterface</tt></dt>
<dd><p>Represents an interface of a node. An interface can manage
specific commandClasses (ie a switch, a dimmer, a thermostat, ...).
Don’t know what to do with it now but sure it must exist</p>
</dd></dl>
<dl class="exception">
<dt id="openzwave.object.ZWaveException">
<em class="property">exception </em><tt class="descclassname">openzwave.object.</tt><tt class="descname">ZWaveException</tt><big>(</big><em>value</em><big>)</big></dt>
<dd><p>Exception class for OpenZWave</p>
</dd></dl>
<dl class="exception">
<dt id="openzwave.object.ZWaveTypeException">
<em class="property">exception </em><tt class="descclassname">openzwave.object.</tt><tt class="descname">ZWaveTypeException</tt><big>(</big><em>value</em><big>)</big></dt>
<dd><p>Exception class for OpenZWave</p>
</dd></dl>
<dl class="exception">
<dt id="openzwave.object.ZWaveCacheException">
<em class="property">exception </em><tt class="descclassname">openzwave.object.</tt><tt class="descname">ZWaveCacheException</tt><big>(</big><em>value</em><big>)</big></dt>
<dd><p>Exception class for OpenZWave</p>
</dd></dl>
<dl class="exception">
<dt id="openzwave.object.ZWaveCommandClassException">
<em class="property">exception </em><tt class="descclassname">openzwave.object.</tt><tt class="descname">ZWaveCommandClassException</tt><big>(</big><em>value</em><big>)</big></dt>
<dd><p>Exception class for OpenZWave</p>
</dd></dl>
<dl class="class">
<dt id="openzwave.object.NullLoggingHandler">
<em class="property">class </em><tt class="descclassname">openzwave.object.</tt><tt class="descname">NullLoggingHandler</tt><big>(</big><em>level=0</em><big>)</big></dt>
<dd><p>A Null Logging Handler</p>
</dd></dl>
</div>