forked from OpenZWave/python-openzwave
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathoption.html
More file actions
463 lines (431 loc) · 21.2 KB
/
option.html
File metadata and controls
463 lines (431 loc) · 21.2 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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
<!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>Option 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="Node documentation" href="node.html" />
<link rel="prev" title="Controller documentation" href="controller.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="node.html" title="Node documentation"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="controller.html" title="Controller 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="option-documentation">
<h1>Option documentation<a class="headerlink" href="#option-documentation" title="Permalink to this headline">¶</a></h1>
<p>The options to start the manager. You can change the loglvel,...</p>
<div class="toctree-wrapper compound">
<ul class="simple">
</ul>
</div>
<span class="target" id="module-openzwave.option"></span><span class="target" id="module-openzwave.option"></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.option.ZWaveOption">
<em class="property">class </em><tt class="descclassname">openzwave.option.</tt><tt class="descname">ZWaveOption</tt><big>(</big><em>device=None</em>, <em>config_path=None</em>, <em>user_path='.'</em>, <em>cmd_line=''</em><big>)</big><a class="headerlink" href="#openzwave.option.ZWaveOption" title="Permalink to this definition">¶</a></dt>
<dd><p>Represents a Zwave option used to start the manager.</p>
<dl class="attribute">
<dt id="openzwave.option.ZWaveOption.config_path">
<tt class="descname">config_path</tt><a class="headerlink" href="#openzwave.option.ZWaveOption.config_path" title="Permalink to this definition">¶</a></dt>
<dd><p>The config path.</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">str</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="openzwave.option.ZWaveOption.device">
<tt class="descname">device</tt><a class="headerlink" href="#openzwave.option.ZWaveOption.device" title="Permalink to this definition">¶</a></dt>
<dd><p>The device used by the controller.</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">str</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="openzwave.option.ZWaveOption.set_append_log_file">
<tt class="descname">set_append_log_file</tt><big>(</big><em>status</em><big>)</big><a class="headerlink" href="#openzwave.option.ZWaveOption.set_append_log_file" title="Permalink to this definition">¶</a></dt>
<dd><p>Append new session logs to existing log file (false = overwrite).</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>status</strong> (<em>bool</em>) – </td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="openzwave.option.ZWaveOption.set_associate">
<tt class="descname">set_associate</tt><big>(</big><em>status</em><big>)</big><a class="headerlink" href="#openzwave.option.ZWaveOption.set_associate" title="Permalink to this definition">¶</a></dt>
<dd><p>Enable automatic association of the controller with group one of every 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">Parameters:</th><td class="field-body"><strong>status</strong> (<em>bool</em>) – True to enable logs, False to disable</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="openzwave.option.ZWaveOption.set_console_output">
<tt class="descname">set_console_output</tt><big>(</big><em>status</em><big>)</big><a class="headerlink" href="#openzwave.option.ZWaveOption.set_console_output" title="Permalink to this definition">¶</a></dt>
<dd><p>Display log information on console (as well as save to disk).</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>status</strong> (<em>bool</em>) – </td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="openzwave.option.ZWaveOption.set_custom_secured_cc">
<tt class="descname">set_custom_secured_cc</tt><big>(</big><em>custom_cc='0x62</em>, <em>0x4c</em>, <em>0x63'</em><big>)</big><a class="headerlink" href="#openzwave.option.ZWaveOption.set_custom_secured_cc" title="Permalink to this definition">¶</a></dt>
<dd><p>What List of Custom CC should we always encrypt if SecurityStrategy is CUSTOM.</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>custom_cc</strong> (<em>str</em>) – List of Custom CC</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="openzwave.option.ZWaveOption.set_driver_max_attempts">
<tt class="descname">set_driver_max_attempts</tt><big>(</big><em>attempts</em><big>)</big><a class="headerlink" href="#openzwave.option.ZWaveOption.set_driver_max_attempts" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the driver max attempts before raising an error.</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>attempts</strong> (<em>int</em>) – Number of attempts</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="openzwave.option.ZWaveOption.set_dump_trigger_level">
<tt class="descname">set_dump_trigger_level</tt><big>(</big><em>level</em><big>)</big><a class="headerlink" href="#openzwave.option.ZWaveOption.set_dump_trigger_level" title="Permalink to this definition">¶</a></dt>
<dd><p>Default is to never dump RAM-stored log messages.</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>level</strong> – </td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="openzwave.option.ZWaveOption.set_exclude">
<tt class="descname">set_exclude</tt><big>(</big><em>commandClass</em><big>)</big><a class="headerlink" href="#openzwave.option.ZWaveOption.set_exclude" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove support for the seted command classes.</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>commandClass</strong> (<em>str</em>) – The command class to exclude</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="openzwave.option.ZWaveOption.set_include">
<tt class="descname">set_include</tt><big>(</big><em>commandClass</em><big>)</big><a class="headerlink" href="#openzwave.option.ZWaveOption.set_include" title="Permalink to this definition">¶</a></dt>
<dd><p>Only handle the specified command classes. The Exclude option is ignored if anything is seted here.</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>commandClass</strong> (<em>str</em>) – The location of the log file</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="openzwave.option.ZWaveOption.set_interface">
<tt class="descname">set_interface</tt><big>(</big><em>port</em><big>)</big><a class="headerlink" href="#openzwave.option.ZWaveOption.set_interface" title="Permalink to this definition">¶</a></dt>
<dd><p>Identify the serial port to be accessed (TODO: change the code so more than one serial port can be specified and HID).</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>port</strong> (<em>str</em>) – The serial port</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="openzwave.option.ZWaveOption.set_interval_between_polls">
<tt class="descname">set_interval_between_polls</tt><big>(</big><em>status</em><big>)</big><a class="headerlink" href="#openzwave.option.ZWaveOption.set_interval_between_polls" title="Permalink to this definition">¶</a></dt>
<dd><p>Notifications when transaction complete is reported.</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>status</strong> (<em>bool</em>) – if false, try to execute the entire poll set within the PollInterval time frame. If true, wait for PollInterval milliseconds between polls</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="openzwave.option.ZWaveOption.set_log_file">
<tt class="descname">set_log_file</tt><big>(</big><em>logfile</em><big>)</big><a class="headerlink" href="#openzwave.option.ZWaveOption.set_log_file" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the log file location.</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>logfile</strong> (<em>str</em>) – The location of the log file</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="openzwave.option.ZWaveOption.set_logging">
<tt class="descname">set_logging</tt><big>(</big><em>status</em><big>)</big><a class="headerlink" href="#openzwave.option.ZWaveOption.set_logging" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the status of logging.</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>status</strong> (<em>bool</em>) – True to activate logs, False to disable</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="openzwave.option.ZWaveOption.set_notify_transactions">
<tt class="descname">set_notify_transactions</tt><big>(</big><em>status</em><big>)</big><a class="headerlink" href="#openzwave.option.ZWaveOption.set_notify_transactions" title="Permalink to this definition">¶</a></dt>
<dd><p>Notifications when transaction complete is reported.</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>status</strong> (<em>bool</em>) – True to enable, False to disable</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="openzwave.option.ZWaveOption.set_poll_interval">
<tt class="descname">set_poll_interval</tt><big>(</big><em>interval</em><big>)</big><a class="headerlink" href="#openzwave.option.ZWaveOption.set_poll_interval" title="Permalink to this definition">¶</a></dt>
<dd><p>30 seconds (can easily poll 30 values in this time; ~120 values is the effective limit for 30 seconds).</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>interval</strong> (<em>int</em>) – interval in seconds</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="openzwave.option.ZWaveOption.set_queue_log_level">
<tt class="descname">set_queue_log_level</tt><big>(</big><em>level</em><big>)</big><a class="headerlink" href="#openzwave.option.ZWaveOption.set_queue_log_level" title="Permalink to this definition">¶</a></dt>
<dd><p>Save (in RAM) log messages equal to or above LogLevel_Debug.</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>level</strong> – </td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="openzwave.option.ZWaveOption.set_save_configuration">
<tt class="descname">set_save_configuration</tt><big>(</big><em>status</em><big>)</big><a class="headerlink" href="#openzwave.option.ZWaveOption.set_save_configuration" title="Permalink to this definition">¶</a></dt>
<dd><p>Save the XML configuration upon driver close.</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>status</strong> (<em>bool</em>) – True to enable, False to disable</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="openzwave.option.ZWaveOption.set_save_log_level">
<tt class="descname">set_save_log_level</tt><big>(</big><em>level</em><big>)</big><a class="headerlink" href="#openzwave.option.ZWaveOption.set_save_log_level" title="Permalink to this definition">¶</a></dt>
<dd><p>Save (to file) log messages equal to or above LogLevel_Detail.</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>level</strong> – </td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="openzwave.option.ZWaveOption.set_security_strategy">
<tt class="descname">set_security_strategy</tt><big>(</big><em>strategy='SUPPORTED'</em><big>)</big><a class="headerlink" href="#openzwave.option.ZWaveOption.set_security_strategy" title="Permalink to this definition">¶</a></dt>
<dd><p>Should we encrypt CC’s that are available via both clear text and Security CC?</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>strategy</strong> (<em>str</em>) – The security strategy : SUPPORTED|ESSENTIAL|CUSTOM</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="openzwave.option.ZWaveOption.set_suppress_value_refresh">
<tt class="descname">set_suppress_value_refresh</tt><big>(</big><em>status</em><big>)</big><a class="headerlink" href="#openzwave.option.ZWaveOption.set_suppress_value_refresh" title="Permalink to this definition">¶</a></dt>
<dd><p>if true, notifications for refreshed (but unchanged) values will not be sent.</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>status</strong> (<em>bool</em>) – True to enable, False to disable</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="openzwave.option.ZWaveOption.user_path">
<tt class="descname">user_path</tt><a class="headerlink" href="#openzwave.option.ZWaveOption.user_path" title="Permalink to this definition">¶</a></dt>
<dd><p>The config path.</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">str</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="controller.html"
title="previous chapter">Controller documentation</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="node.html"
title="next chapter">Node documentation</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/option.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="node.html" title="Node documentation"
>next</a> |</li>
<li class="right" >
<a href="controller.html" title="Controller 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>