forked from OpenZWave/python-openzwave
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdata.html
More file actions
252 lines (236 loc) · 19.6 KB
/
Copy pathdata.html
File metadata and controls
252 lines (236 loc) · 19.6 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
<!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="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Data documentation — python-openzwave 0.4.9 documentation</title>
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Changelog" href="CHANGELOG.html" />
<link rel="prev" title="Object documentation" href="object.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<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="CHANGELOG.html" title="Changelog"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="object.html" title="Object documentation"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">python-openzwave 0.4.9 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="openzwave.html" accesskey="U">API documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="data-documentation">
<h1>Data documentation<a class="headerlink" href="#data-documentation" title="Permalink to this headline">¶</a></h1>
<p>The common data structures and defitions.</p>
<div class="toctree-wrapper compound">
</div>
<span class="target" id="module-libopenzwave"></span><span class="target" id="module-libopenzwave"></span><p>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>.</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">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 C++</td>
</tr>
</tbody>
</table>
<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="data">
<dt id="libopenzwave.PyNotifications">
<code class="descclassname">libopenzwave.</code><code class="descname">PyNotifications</code><em class="property"> = ['ValueAdded', 'ValueRemoved', 'ValueChanged', 'ValueRefreshed', 'Group', 'NodeNew', 'NodeAdded', 'NodeRemoved', 'NodeProtocolInfo', 'NodeNaming', 'NodeEvent', 'PollingDisabled', 'PollingEnabled', 'SceneEvent', 'CreateButton', 'DeleteButton', 'ButtonOn', 'ButtonOff', 'DriverReady', 'DriverFailed', 'DriverReset', 'EssentialNodeQueriesComplete', 'NodeQueriesComplete', 'AwakeNodesQueried', 'AllNodesQueriedSomeDead', 'AllNodesQueried', 'Notification', 'DriverRemoved', 'ControllerCommand', 'NodeReset']</em><a class="headerlink" href="#libopenzwave.PyNotifications" title="Permalink to this definition">¶</a></dt>
<dd><p>list() -> new empty list
list(iterable) -> new list initialized from iterable’s items</p>
</dd></dl>
<dl class="data">
<dt id="libopenzwave.PyGenres">
<code class="descclassname">libopenzwave.</code><code class="descname">PyGenres</code><em class="property"> = ['Basic', 'User', 'Config', 'System']</em><a class="headerlink" href="#libopenzwave.PyGenres" title="Permalink to this definition">¶</a></dt>
<dd><p>list() -> new empty list
list(iterable) -> new list initialized from iterable’s items</p>
</dd></dl>
<dl class="data">
<dt id="libopenzwave.PyValueTypes">
<code class="descclassname">libopenzwave.</code><code class="descname">PyValueTypes</code><em class="property"> = ['Bool', 'Byte', 'Decimal', 'Int', 'List', 'Schedule', 'Short', 'String', 'Button', 'Raw']</em><a class="headerlink" href="#libopenzwave.PyValueTypes" title="Permalink to this definition">¶</a></dt>
<dd><p>list() -> new empty list
list(iterable) -> new list initialized from iterable’s items</p>
</dd></dl>
<dl class="data">
<dt id="libopenzwave.PyLogLevels">
<code class="descclassname">libopenzwave.</code><code class="descname">PyLogLevels</code><em class="property"> = {'Alert': {'doc': 'Something unexpected by the library about which the controlling application should be aware', 'value': 6}, 'Always': {'doc': 'These messages should always be shown', 'value': 2}, 'Debug': {'doc': 'Very detailed information on progress that will create a huge log file quickly but this level (as others) can be queued and sent to the log only on an error or warning', 'value': 9}, 'Detail': {'doc': 'Detailed information on the progress of each message', 'value': 8}, 'Error': {'doc': 'A serious issue with the library or the network', 'value': 4}, 'Fatal': {'doc': 'A likely fatal issue in the library', 'value': 3}, 'Info': {'doc': "Everything's working fine...these messages provide streamlined feedback on each message", 'value': 7}, 'Internal': {'doc': 'Used only within the log class (uses existing timestamp, etc', 'value': 11}, 'Invalid': {'doc': 'Invalid Log Status', 'value': 0}, 'None': {'doc': 'Disable all logging', 'value': 1}, 'StreamDetail': {'doc': 'Will include low-level byte transfers from controller to buffer to application and back', 'value': 10}, 'Warning': {'doc': 'A minor issue from which the library should be able to recover', 'value': 5}}</em><a class="headerlink" href="#libopenzwave.PyLogLevels" title="Permalink to this definition">¶</a></dt>
<dd><p>dict() -> new empty dictionary
dict(mapping) -> new dictionary initialized from a mapping object’s</p>
<blockquote>
<div>(key, value) pairs</div></blockquote>
<dl class="docutils">
<dt>dict(iterable) -> new dictionary initialized as if via:</dt>
<dd><p class="first">d = {}
for k, v in iterable:</p>
<blockquote class="last">
<div>d[k] = v</div></blockquote>
</dd>
<dt>dict(<a href="#id1"><span class="problematic" id="id2">**</span></a>kwargs) -> new dictionary initialized with the name=value pairs</dt>
<dd>in the keyword argument list. For example: dict(one=1, two=2)</dd>
</dl>
</dd></dl>
<dl class="data">
<dt id="libopenzwave.PyControllerCommand">
<code class="descclassname">libopenzwave.</code><code class="descname">PyControllerCommand</code><em class="property"> = ['None', 'AddDevice', 'CreateNewPrimary', 'ReceiveConfiguration', 'RemoveDevice', 'RemoveFailedNode', 'HasNodeFailed', 'ReplaceFailedNode', 'TransferPrimaryRole', 'RequestNetworkUpdate', 'RequestNodeNeighborUpdate', 'AssignReturnRoute', 'DeleteAllReturnRoutes', 'SendNodeInformation', 'ReplicationSend', 'CreateButton', 'DeleteButton']</em><a class="headerlink" href="#libopenzwave.PyControllerCommand" title="Permalink to this definition">¶</a></dt>
<dd><p>list() -> new empty list
list(iterable) -> new list initialized from iterable’s items</p>
</dd></dl>
<dl class="data">
<dt id="libopenzwave.PyControllerError">
<code class="descclassname">libopenzwave.</code><code class="descname">PyControllerError</code><em class="property"> = ['None', 'ButtonNotFound', 'NodeNotFound', 'NotBridge', 'NotSUC', 'NotSecondary', 'NotPrimary', 'IsPrimary', 'NotFound', 'Busy', 'Failed', 'Disabled', 'Overflow']</em><a class="headerlink" href="#libopenzwave.PyControllerError" title="Permalink to this definition">¶</a></dt>
<dd><p>list() -> new empty list
list(iterable) -> new list initialized from iterable’s items</p>
</dd></dl>
<dl class="data">
<dt id="libopenzwave.PyControllerState">
<code class="descclassname">libopenzwave.</code><code class="descname">PyControllerState</code><em class="property"> = ['Normal', 'Starting', 'Cancel', 'Error', 'Waiting', 'Sleeping', 'InProgress', 'Completed', 'Failed', 'NodeOK', 'NodeFailed']</em><a class="headerlink" href="#libopenzwave.PyControllerState" title="Permalink to this definition">¶</a></dt>
<dd><p>list() -> new empty list
list(iterable) -> new list initialized from iterable’s items</p>
</dd></dl>
<dl class="data">
<dt id="libopenzwave.PyOptionList">
<code class="descclassname">libopenzwave.</code><code class="descname">PyOptionList</code><em class="property"> = {'AppendLogFile': {'type': 'Bool', 'doc': 'Append new session logs to existing log file (false = overwrite).'}, 'Associate': {'type': 'Bool', 'doc': 'Enable automatic association of the controller with group one of every device.'}, 'AssumeAwake': {'type': 'Bool', 'doc': 'Assume Devices that Support the Wakeup CC are awake when we first query them ...'}, 'ConfigPath': {'type': 'String', 'doc': 'Path to the OpenZWave config folder.'}, 'ConsoleOutput': {'type': 'Bool', 'doc': 'Display log information on console (as well as save to disk).'}, 'CustomSecuredCC': {'type': 'String', 'doc': 'What List of Custom CC should we always encrypt if SecurityStrategy is CUSTOM.', 'value': '0x62,0x4c,0x63'}, 'DriverMaxAttempts': {'type': 'Int', 'doc': '.'}, 'DumpTriggerLevel': {'type': 'Int', 'doc': 'Default is to never dump RAM-stored log messages.'}, 'EnableSIS': {'type': 'Bool', 'doc': 'Automatically become a SUC if there is no SUC on the network.'}, 'EnforceSecureReception': {'type': 'Bool', 'doc': 'If we recieve a clear text message for a CC that is Secured, should we drop the message'}, 'Exclude': {'type': 'String', 'doc': 'Remove support for the listed command classes.'}, 'Include': {'type': 'String', 'doc': 'Only handle the specified command classes. The Exclude option is ignored if anything is listed here.'}, 'Interface': {'type': 'String', 'doc': 'Identify the serial port to be accessed (TODO: change the code so more than one serial port can be specified and HID).'}, 'IntervalBetweenPolls': {'type': 'Bool', 'doc': 'If false, try to execute the entire poll list within the PollInterval time frame. If true, wait for PollInterval milliseconds between polls.'}, 'LogFileName': {'type': 'String', 'doc': 'Name of the log file (can be changed via Log::SetLogFileName).'}, 'Logging': {'type': 'Bool', 'doc': 'Enable logging of library activity.'}, 'NetworkKey': {'type': 'String', 'doc': 'Key used to negotiate and communicate with devices that support Security Command Class'}, 'NotifyOnDriverUnload': {'type': 'Bool', 'doc': 'Should we send the Node/Value Notifications on Driver Unloading - Read comments in Driver::~Driver() method about possible race conditions.'}, 'NotifyTransactions': {'type': 'Bool', 'doc': 'Notifications when transaction complete is reported.'}, 'PerformReturnRoutes': {'type': 'Bool', 'doc': 'If true, return routes will be updated.'}, 'PollInterval': {'type': 'Int', 'doc': '30 seconds (can easily poll 30 values in this time; ~120 values is the effective limit for 30 seconds).'}, 'QueueLogLevel': {'type': 'Int', 'doc': 'Save (in RAM) log messages equal to or above LogLevel_Debug.'}, 'RefreshAllUserCodes': {'type': 'Bool', 'doc': "If true, during startup, we refresh all the UserCodes the device reports it supports. If False, we stop after we get the first 'Available' slot (Some devices have 250+ usercode slots! - That makes our Session Stage Very Long )."}, 'RetryTimeout': {'type': 'Int', 'doc': 'How long do we wait to timeout messages sent.'}, 'SaveConfiguration': {'type': 'Bool', 'doc': 'Save the XML configuration upon driver close.'}, 'SaveLogLevel': {'type': 'Int', 'doc': 'Save (to file) log messages equal to or above LogLevel_Detail.'}, 'SecurityStrategy': {'type': 'String', 'doc': "Should we encrypt CC's that are available via both clear text and Security CC?.", 'value': 'SUPPORTED'}, 'SuppressValueRefresh': {'type': 'Bool', 'doc': 'If true, notifications for refreshed (but unchanged) values will not be sent.'}, 'UserPath': {'type': 'String', 'doc': "Path to the user's data folder."}}</em><a class="headerlink" href="#libopenzwave.PyOptionList" title="Permalink to this definition">¶</a></dt>
<dd><p>dict() -> new empty dictionary
dict(mapping) -> new dictionary initialized from a mapping object’s</p>
<blockquote>
<div>(key, value) pairs</div></blockquote>
<dl class="docutils">
<dt>dict(iterable) -> new dictionary initialized as if via:</dt>
<dd><p class="first">d = {}
for k, v in iterable:</p>
<blockquote class="last">
<div>d[k] = v</div></blockquote>
</dd>
<dt>dict(<a href="#id3"><span class="problematic" id="id4">**</span></a>kwargs) -> new dictionary initialized with the name=value pairs</dt>
<dd>in the keyword argument list. For example: dict(one=1, two=2)</dd>
</dl>
</dd></dl>
<dl class="data">
<dt id="libopenzwave.PyStatDriver">
<code class="descclassname">libopenzwave.</code><code class="descname">PyStatDriver</code><em class="property"> = {'ACKCnt': 'Number of ACK bytes received', 'ACKWaiting': 'Number of unsolicited messages while waiting for an ACK', 'CANCnt': 'Number of CAN bytes received', 'NAKCnt': 'Number of NAK bytes received', 'OOFCnt': 'Number of bytes out of framing', 'SOFCnt': 'Number of SOF bytes received', 'badChecksum': 'Number of bad checksums', 'badroutes': 'Number of failed messages due to bad route response', 'broadcastReadCnt': 'Number of broadcasts read', 'broadcastWriteCnt': 'Number of broadcasts sent', 'callbacks': 'Number of unexpected callbacks', 'dropped': 'Number of messages dropped & not delivered', 'netbusy': 'Number of network busy/failure messages', 'noack': 'Number of no ACK returned errors', 'nondelivery': 'Number of messages not delivered to network', 'readAborts': 'Number of times read were aborted due to timeouts', 'readCnt': 'Number of messages successfully read', 'retries': 'Number of messages retransmitted', 'routedbusy': 'Number of messages received with routed busy status', 'writeCnt': 'Number of messages successfully sent'}</em><a class="headerlink" href="#libopenzwave.PyStatDriver" title="Permalink to this definition">¶</a></dt>
<dd><p>dict() -> new empty dictionary
dict(mapping) -> new dictionary initialized from a mapping object’s</p>
<blockquote>
<div>(key, value) pairs</div></blockquote>
<dl class="docutils">
<dt>dict(iterable) -> new dictionary initialized as if via:</dt>
<dd><p class="first">d = {}
for k, v in iterable:</p>
<blockquote class="last">
<div>d[k] = v</div></blockquote>
</dd>
<dt>dict(<a href="#id5"><span class="problematic" id="id6">**</span></a>kwargs) -> new dictionary initialized with the name=value pairs</dt>
<dd>in the keyword argument list. For example: dict(one=1, two=2)</dd>
</dl>
</dd></dl>
<dl class="data">
<dt id="libopenzwave.PyStatNode">
<code class="descclassname">libopenzwave.</code><code class="descname">PyStatNode</code><em class="property"> = {'averageRequestRTT': 'Average Request round trip time', 'averageResponseRTT': 'Average Response round trip time', 'errors': 'Count errors for dead node detection', 'lastReceivedMessage': 'Place to hold last received message', 'lastRequestRTT': 'Last message request RTT', 'lastResponseRTT': 'Last message response RTT', 'quality': 'Node quality measure', 'receivedCnt': 'Number of messages received from this node', 'receivedDups': 'Number of duplicated messages received', 'receivedTS': 'Last message received time', 'receivedUnsolicited': 'Number of messages received unsolicited', 'retries': 'Number of message retries', 'sentCnt': 'Number of messages sent from this node', 'sentFailed': 'Number of sent messages failed', 'sentTS': 'Last message sent time'}</em><a class="headerlink" href="#libopenzwave.PyStatNode" title="Permalink to this definition">¶</a></dt>
<dd><p>dict() -> new empty dictionary
dict(mapping) -> new dictionary initialized from a mapping object’s</p>
<blockquote>
<div>(key, value) pairs</div></blockquote>
<dl class="docutils">
<dt>dict(iterable) -> new dictionary initialized as if via:</dt>
<dd><p class="first">d = {}
for k, v in iterable:</p>
<blockquote class="last">
<div>d[k] = v</div></blockquote>
</dd>
<dt>dict(<a href="#id7"><span class="problematic" id="id8">**</span></a>kwargs) -> new dictionary initialized with the name=value pairs</dt>
<dd>in the keyword argument list. For example: dict(one=1, two=2)</dd>
</dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="object.html"
title="previous chapter">Object documentation</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="CHANGELOG.html"
title="next chapter">Changelog</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/data.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<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>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<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="CHANGELOG.html" title="Changelog"
>next</a> |</li>
<li class="right" >
<a href="object.html" title="Object documentation"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">python-openzwave 0.4.9 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="openzwave.html" >API documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2012,2013,2014,2015, bibi21000.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.7.7.
</div>
</body>
</html>