forked from balloob/python-openzwave
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathlibopenzwave.html
More file actions
3667 lines (3506 loc) · 229 KB
/
Copy pathlibopenzwave.html
File metadata and controls
3667 lines (3506 loc) · 229 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
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!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>libopenzwave module — python-openzwave 0.3.0-alpha1 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-alpha1',
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-alpha1 documentation" href="index.html" />
<link rel="next" title="Data documentation" href="data.html" />
<link rel="prev" title="Welcome to python-openzwave’s documentation!" href="index.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="data.html" title="Data documentation"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="Welcome to python-openzwave’s documentation!"
accesskey="P">previous</a> |</li>
<li><a href="index.html">python-openzwave 0.3.0-alpha1 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="libopenzwave-module">
<h1>libopenzwave module<a class="headerlink" href="#libopenzwave-module" title="Permalink to this headline">¶</a></h1>
<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/bibi21000/python-openzwave">https://github.com/bibi21000/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="class">
<dt id="libopenzwave.EnumWithDoc">
<em class="property">class </em><tt class="descclassname">libopenzwave.</tt><tt class="descname">EnumWithDoc</tt><a class="headerlink" href="#libopenzwave.EnumWithDoc" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></p>
<p>Enum helper</p>
<dl class="method">
<dt id="libopenzwave.EnumWithDoc.setDoc">
<tt class="descname">setDoc</tt><big>(</big><big>)</big><a class="headerlink" href="#libopenzwave.EnumWithDoc.setDoc" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="libopenzwave.PyManager">
<em class="property">class </em><tt class="descclassname">libopenzwave.</tt><tt class="descname">PyManager</tt><a class="headerlink" href="#libopenzwave.PyManager" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
<p>The main public interface to OpenZWave.</p>
<p>A singleton class providing the main public interface to OpenZWave. The
Manager class exposes all the functionality required to add Z-Wave support to
an application. It handles the sending and receiving of Z-Wave messages as
well as the configuration of a Z-Wave network and its devices, freeing the
library user from the burden of learning the low-level details of the Z-Wave
protocol.</p>
<p>All Z-Wave functionality is accessed via the Manager class. While this does
not make for the most efficient code structure, it does enable the library to
handle potentially complex and hard-to-debug issues such as multi-threading and
object lifespans behind the scenes. Application development is therefore
simplified and less prone to bugs.</p>
<p>There can be only one instance of the Manager class, and all applications will
start by calling Manager::Create static method to create that instance. From
then on, a call to the Manager::Get static method will return the pointer to
the Manager object. On application exit, Manager::Destroy should be called to
allow OpenZWave to clean up and delete any other objects it has created.</p>
<p>Once the Manager has been created, a call should be made to Manager::AddWatcher
to install a notification callback handler. This handler will receive
notifications of Z-Wave network changes and updates to device values, and is an
essential element of OpenZWave.</p>
<p>Next, a call should be made to Manager::AddDriver for each Z-Wave controller
attached to the PC. Each Driver will handle the sending and receiving of
messages for all the devices in its controller’s Z-Wave network. The Driver
will read any previously saved configuration and then query the Z-Wave
controller for any missing information. Once that process is complete, a
DriverReady notification callback will be sent containing the Home ID of the
controller, which is required by most of the other Manager class methods.</p>
<p>After the DriverReady notification is sent, the Driver will poll each node on
the network to update information about each node. After all “awake” nodes
have been polled, an “AllAwakeNodesQueried” notification is sent. This is when
a client application can expect all of the node information (both static
information, like the physical device’s capabilities, session information (like
[associations and/or names] and dynamic information (like temperature or on/off
state) to be available. Finally, after all nodes (whether setening or
sleeping) have been polled, an “AllNodesQueried” notification is sent.</p>
<dl class="attribute">
<dt id="libopenzwave.PyManager.CALLBACK_DESC">
<tt class="descname">CALLBACK_DESC</tt><em class="property"> = ('value added', 'value removed', 'value changed', 'groups changed', 'new node', 'node added', 'node removed', 'node protocol info', 'node naming', 'node event', 'polling disabled', 'polling enabled', 'driver ready', 'driver reset', 'message complete', 'node queries complete', 'awake nodes queried', 'all nodes queried')</em><a class="headerlink" href="#libopenzwave.PyManager.CALLBACK_DESC" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="libopenzwave.PyManager.COMMAND_CLASS_DESC">
<tt class="descname">COMMAND_CLASS_DESC</tt><em class="property"> = {0: 'COMMAND_CLASS_NO_OPERATION', 32: 'COMMAND_CLASS_BASIC', 33: 'COMMAND_CLASS_CONTROLLER_REPLICATION', 34: 'COMMAND_CLASS_APPLICATION_STATUS', 35: 'COMMAND_CLASS_ZIP_SERVICES', 36: 'COMMAND_CLASS_ZIP_SERVER', 37: 'COMMAND_CLASS_SWITCH_BINARY', 38: 'COMMAND_CLASS_SWITCH_MULTILEVEL', 39: 'COMMAND_CLASS_SWITCH_ALL', 40: 'COMMAND_CLASS_SWITCH_TOGGLE_BINARY', 41: 'COMMAND_CLASS_SWITCH_TOGGLE_MULTILEVEL', 42: 'COMMAND_CLASS_CHIMNEY_FAN', 43: 'COMMAND_CLASS_SCENE_ACTIVATION', 44: 'COMMAND_CLASS_SCENE_ACTUATOR_CONF', 45: 'COMMAND_CLASS_SCENE_CONTROLLER_CONF', 46: 'COMMAND_CLASS_ZIP_CLIENT', 47: 'COMMAND_CLASS_ZIP_ADV_SERVICES', 48: 'COMMAND_CLASS_SENSOR_BINARY', 49: 'COMMAND_CLASS_SENSOR_MULTILEVEL', 50: 'COMMAND_CLASS_METER', 51: 'COMMAND_CLASS_ZIP_ADV_SERVER', 52: 'COMMAND_CLASS_ZIP_ADV_CLIENT', 53: 'COMMAND_CLASS_METER_PULSE', 56: 'COMMAND_CLASS_THERMOSTAT_HEATING', 60: 'COMMAND_CLASS_METER_TBL_CONFIG', 61: 'COMMAND_CLASS_METER_TBL_MONITOR', 62: 'COMMAND_CLASS_METER_TBL_PUSH', 64: 'COMMAND_CLASS_THERMOSTAT_MODE', 66: 'COMMAND_CLASS_THERMOSTAT_OPERATING_STATE', 67: 'COMMAND_CLASS_THERMOSTAT_SETPOINT', 68: 'COMMAND_CLASS_THERMOSTAT_FAN_MODE', 69: 'COMMAND_CLASS_THERMOSTAT_FAN_STATE', 70: 'COMMAND_CLASS_CLIMATE_CONTROL_SCHEDULE', 71: 'COMMAND_CLASS_THERMOSTAT_SETBACK', 76: 'COMMAND_CLASS_DOOR_LOCK_LOGGING', 78: 'COMMAND_CLASS_SCHEDULE_ENTRY_LOCK', 80: 'COMMAND_CLASS_BASIC_WINDOW_COVERING', 81: 'COMMAND_CLASS_MTP_WINDOW_COVERING', 96: 'COMMAND_CLASS_MULTI_CHANNEL_V2', 97: 'COMMAND_CLASS_DISPLAY', 98: 'COMMAND_CLASS_DOOR_LOCK', 99: 'COMMAND_CLASS_USER_CODE', 100: 'COMMAND_CLASS_GARAGE_DOOR', 112: 'COMMAND_CLASS_CONFIGURATION', 113: 'COMMAND_CLASS_ALARM', 114: 'COMMAND_CLASS_MANUFACTURER_SPECIFIC', 115: 'COMMAND_CLASS_POWERLEVEL', 117: 'COMMAND_CLASS_PROTECTION', 118: 'COMMAND_CLASS_LOCK', 119: 'COMMAND_CLASS_NODE_NAMING', 120: 'COMMAND_CLASS_ACTUATOR_MULTILEVEL', 121: 'COMMAND_CLASS_KICK', 122: 'COMMAND_CLASS_FIRMWARE_UPDATE_MD', 123: 'COMMAND_CLASS_GROUPING_NAME', 124: 'COMMAND_CLASS_REMOTE_ASSOCIATION_ACTIVATE', 125: 'COMMAND_CLASS_REMOTE_ASSOCIATION', 128: 'COMMAND_CLASS_BATTERY', 129: 'COMMAND_CLASS_CLOCK', 130: 'COMMAND_CLASS_HAIL', 131: 'COMMAND_CLASS_NETWORK_STAT', 132: 'COMMAND_CLASS_WAKE_UP', 133: 'COMMAND_CLASS_ASSOCIATION', 134: 'COMMAND_CLASS_VERSION', 135: 'COMMAND_CLASS_INDICATOR', 136: 'COMMAND_CLASS_PROPRIETARY', 137: 'COMMAND_CLASS_LANGUAGE', 138: 'COMMAND_CLASS_TIME', 139: 'COMMAND_CLASS_TIME_PARAMETERS', 140: 'COMMAND_CLASS_GEOGRAPHIC_LOCATION', 141: 'COMMAND_CLASS_COMPOSITE', 142: 'COMMAND_CLASS_MULTI_INSTANCE_ASSOCIATION', 143: 'COMMAND_CLASS_MULTI_CMD', 144: 'COMMAND_CLASS_ENERGY_PRODUCTION', 145: 'COMMAND_CLASS_MANUFACTURER_PROPRIETARY', 146: 'COMMAND_CLASS_SCREEN_MD', 147: 'COMMAND_CLASS_SCREEN_ATTRIBUTES', 148: 'COMMAND_CLASS_SIMPLE_AV_CONTROL', 149: 'COMMAND_CLASS_AV_CONTENT_DIRECTORY_MD', 150: 'COMMAND_CLASS_AV_RENDERER_STATUS', 151: 'COMMAND_CLASS_AV_CONTENT_SEARCH_MD', 152: 'COMMAND_CLASS_SECURITY', 153: 'COMMAND_CLASS_AV_TAGGING_MD', 154: 'COMMAND_CLASS_IP_CONFIGURATION', 155: 'COMMAND_CLASS_ASSOCIATION_COMMAND_CONFIGURATION', 156: 'COMMAND_CLASS_SENSOR_ALARM', 157: 'COMMAND_CLASS_SILENCE_ALARM', 158: 'COMMAND_CLASS_SENSOR_CONFIGURATION', 239: 'COMMAND_CLASS_MARK', 240: 'COMMAND_CLASS_NON_INTEROPERABLE'}</em><a class="headerlink" href="#libopenzwave.PyManager.COMMAND_CLASS_DESC" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="libopenzwave.PyManager.activateScene">
<tt class="descname">activateScene</tt><big>(</big><big>)</big><a class="headerlink" href="#libopenzwave.PyManager.activateScene" title="Permalink to this definition">¶</a></dt>
<dd><p id="activatescene">Activate given scene to perform all its actions.</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>sceneId</strong> (<em>int</em>) – The ID of the scene to activate.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if it is successful.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
</tr>
<tr class="field-even field"><th class="field-name">See:</th><td class="field-body"><a class="reference internal" href="#getnumscenes">getNumScenes</a>, <a class="reference internal" href="#getallscenes">getAllScenes</a>, <a class="reference internal" href="#sceneexists">sceneExists</a>, <a class="reference internal" href="#removeallscenes">removeAllScenes</a>, <a class="reference internal" href="#createscene">createScene</a>, <a class="reference internal" href="#removescene">removeScene</a>, <a class="reference internal" href="#getscenelabel">getSceneLabel</a>, <a class="reference internal" href="#setscenelabel">setSceneLabel</a>, <a class="reference internal" href="#removescenevalue">removeSceneValue</a>, <a class="reference internal" href="#addscenevalue">addSceneValue</a>, <a class="reference internal" href="#setscenevalue">setSceneValue</a>, <a class="reference internal" href="#scenegetvalues">sceneGetValues</a></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="libopenzwave.PyManager.addAssociation">
<tt class="descname">addAssociation</tt><big>(</big><big>)</big><a class="headerlink" href="#libopenzwave.PyManager.addAssociation" title="Permalink to this definition">¶</a></dt>
<dd><p id="addassociation">Adds a node to an association group.</p>
<p>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.</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 simple">
<li><strong>homeId</strong> (<em>int</em>) – The Home ID of the Z-Wave controller that manages the node.</li>
<li><strong>nodeId</strong> (<em>int</em>) – The ID of the node whose associations are to be changed.</li>
<li><strong>groupIdx</strong> (<em>int</em>) – One-based index of the group (because Z-Wave product manuals use one-based group numbering).</li>
<li><strong>targetNodeId</strong> (<em>int</em>) – Identifier for the node that will be added to the association group.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">See:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#getnumgroups">getNumGroups</a>, <a class="reference internal" href="#getassociations">getAssociations</a>, <a class="reference internal" href="#getmaxassociations">getMaxAssociations</a>, <a class="reference internal" href="#removeassociation">removeAssociation</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="libopenzwave.PyManager.addDriver">
<tt class="descname">addDriver</tt><big>(</big><big>)</big><a class="headerlink" href="#libopenzwave.PyManager.addDriver" title="Permalink to this definition">¶</a></dt>
<dd><p id="adddriver">Creates a new driver for a Z-Wave controller.</p>
<p>This method creates a Driver object for handling communications with a single
Z-Wave controller. In the background, the driver first tries to read
configuration data saved during a previous run. It then queries the controller
directly for any missing information, and a refresh of the set of nodes that
it controls. Once this information has been received, a DriverReady
notification callback is sent, containing the Home ID of the controller. This
Home ID is required by most of the OpenZWave Manager class 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">Parameters:</th><td class="field-body"><strong>serialport</strong> (<em>str</em>) – The string used to open the controller. On Windows this might be something like ”.COM3”, or on Linux “/dev/ttyUSB0”.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if a new driver was created</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
</tr>
<tr class="field-even field"><th class="field-name">See:</th><td class="field-body"><a class="reference internal" href="#removedriver">removeDriver</a></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="libopenzwave.PyManager.addSceneValue">
<tt class="descname">addSceneValue</tt><big>(</big><big>)</big><a class="headerlink" href="#libopenzwave.PyManager.addSceneValue" title="Permalink to this definition">¶</a></dt>
<dd><p id="addscenevalue">Add a ValueID of value to an existing scene.</p>
<p>Actually I don’t know how to use it :)</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 simple">
<li><strong>sceneid</strong> (<em>int</em>) – The ID of a scene.</li>
<li><strong>id</strong> (<em>int</em>) – The ID of a value.</li>
<li><strong>value</strong> (<em>bool, int, float, string</em>) – The value to set</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An integer representing the result of the operation
0 : The C method fails
1 : The C method succeed
2 : Can’t find id in the map</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">int</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">See:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#getnumscenes">getNumScenes</a>, <a class="reference internal" href="#getallscenes">getAllScenes</a>, <a class="reference internal" href="#sceneexists">sceneExists</a>, <a class="reference internal" href="#removeallscenes">removeAllScenes</a>, <a class="reference internal" href="#createscene">createScene</a>, <a class="reference internal" href="#removescene">removeScene</a>, <a class="reference internal" href="#activatescene">activateScene</a>, <a class="reference internal" href="#getscenelabel">getSceneLabel</a>, <a class="reference internal" href="#setscenelabel">setSceneLabel</a>, <a class="reference internal" href="#removescenevalue">removeSceneValue</a>, <a class="reference internal" href="#setscenevalue">setSceneValue</a>, <a class="reference internal" href="#scenegetvalues">sceneGetValues</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="libopenzwave.PyManager.addWatcher">
<tt class="descname">addWatcher</tt><big>(</big><big>)</big><a class="headerlink" href="#libopenzwave.PyManager.addWatcher" title="Permalink to this definition">¶</a></dt>
<dd><p id="addwatcher">Add a notification watcher.</p>
<p>In OpenZWave, all feedback from the Z-Wave network is sent to the application
via callbacks. This method allows the application to add a notification
callback handler, known as a “watcher” to OpenZWave. An application needs only
add a single watcher - all notifications will be reported to it.</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>pythonfunc</strong> (<em>callback</em>) – Watcher pointer to a function that will be called by the notification system.</td>
</tr>
<tr class="field-even field"><th class="field-name">See:</th><td class="field-body"><a class="reference internal" href="#removewatcher">removeWatcher</a></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="libopenzwave.PyManager.beginControllerCommand">
<tt class="descname">beginControllerCommand</tt><big>(</big><big>)</big><a class="headerlink" href="#libopenzwave.PyManager.beginControllerCommand" title="Permalink to this definition">¶</a></dt>
<dd><p id="begincontrollercommand">Start a controller command process.</p>
<p>Commands :</p>
<blockquote>
<div><ul class="simple">
<li>Driver::ControllerCommand_AddDevice - Add a new device or controller to the Z-Wave network.</li>
<li>Driver::ControllerCommand_CreateNewPrimary - Create a new primary controller when old primary fails. Requires SUC.</li>
<li>Driver::ControllerCommand_ReceiveConfiguration - Receive network configuration information from primary controller. Requires secondary.</li>
<li>Driver::ControllerCommand_RemoveDevice - Remove a device or controller from the Z-Wave network.</li>
<li>Driver::ControllerCommand_RemoveFailedNode - Remove a node from the network. The node must not be responding
and be on the controller’s failed node list.</li>
<li>Driver::ControllerCommand_HasNodeFailed - Check whether a node is in the controller’s failed nodes list.</li>
<li>Driver::ControllerCommand_ReplaceFailedNode - Replace a failed device with another. If the node is not in
the controller’s failed nodes list, or the node responds, this command will fail.</li>
<li>Driver:: ControllerCommand_TransferPrimaryRole - Add a new controller to the network and
make it the primary. The existing primary will become a secondary controller.</li>
<li>Driver::ControllerCommand_RequestNetworkUpdate - Update the controller with network information from the SUC/SIS.</li>
<li>Driver::ControllerCommand_RequestNodeNeighborUpdate - Get a node to rebuild its neighbour list. This method also does RequestNodeNeighbors afterwards.</li>
<li>Driver::ControllerCommand_AssignReturnRoute - Assign a network return route to a device.</li>
<li>Driver::ControllerCommand_DeleteAllReturnRoutes - Delete all network return routes from a device.</li>
<li>Driver::ControllerCommand_SendNodeInformation - Send a node information frame.</li>
<li>Driver::ControllerCommand_ReplicationSend - Send information from primary to secondary</li>
<li>Driver::ControllerCommand_CreateButton - Create a handheld button id.</li>
<li>Driver::ControllerCommand_DeleteButton - Delete a handheld button id.</li>
</ul>
</div></blockquote>
<p>Callbacks :</p>
<blockquote>
<div><ul class="simple">
<li>Driver::ControllerState_Waiting, the controller is waiting for a user action. A notice should be displayed to the user at this point, telling them what to do next. For the add, remove, replace and transfer primary role commands, the user needs to be told to press the inclusion button on the device that is going to be added or removed. For ControllerCommand_ReceiveConfiguration, they must set their other controller to send its data, and for ControllerCommand_CreateNewPrimary, set the other controller to learn new data.</li>
<li>Driver::ControllerState_InProgress - the controller is in the process of adding or removing the chosen node. It is now too late to cancel the command.</li>
<li>Driver::ControllerState_Complete - the controller has finished adding or removing the node, and the command is complete.</li>
<li>Driver::ControllerState_Failed - will be sent if the command fails for any reason.</li>
</ul>
</div></blockquote>
<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 simple">
<li><strong>homeId</strong> (<em>int</em>) – The Home ID of the Z-Wave controller.</li>
<li><strong>command</strong> (<em>ControllerCommand</em>) – The command to be sent to the controller.</li>
<li><strong>callback</strong> (<em>pfnControllerCallback_t</em>) – Pointer to a function that will be called at various stages during the command process to notify the user of progress or to request actions on the user’s part. Defaults to NULL.</li>
<li><strong>context</strong> – Pointer to user defined data that will be passed into to the callback function. Defaults to NULL.</li>
<li><strong>highPower</strong> (<em>bool</em>) – Used only with the AddDevice, AddController, RemoveDevice and RemoveController commands. Usually when adding or removing devices, the controller operates at low power so that the controller must be physically close to the device for security reasons. If _highPower is true, the controller will operate at normal power levels instead. Defaults to false.</li>
<li><strong>nodeId</strong> (<em>int</em>) – Used only with the ReplaceFailedNode command, to specify the node that is going to be replaced.</li>
<li><strong>arg</strong> (<em>int</em>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if the command was accepted and has started.</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">bool</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">See:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#cancelcontrollercommand">cancelControllerCommand</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="libopenzwave.PyManager.cancelControllerCommand">
<tt class="descname">cancelControllerCommand</tt><big>(</big><big>)</big><a class="headerlink" href="#libopenzwave.PyManager.cancelControllerCommand" title="Permalink to this definition">¶</a></dt>
<dd><p id="cancelcontrollercommand">Cancels any in-progress command running on a 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">Parameters:</th><td class="field-body"><strong>homeId</strong> (<em>int</em>) – The Home ID of the Z-Wave controller.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if a command was running and was cancelled.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
</tr>
<tr class="field-even field"><th class="field-name">See:</th><td class="field-body"><a class="reference internal" href="#begincontrollercommand">beginControllerCommand</a></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="libopenzwave.PyManager.clearSwitchPoints">
<tt class="descname">clearSwitchPoints</tt><big>(</big><big>)</big><a class="headerlink" href="#libopenzwave.PyManager.clearSwitchPoints" title="Permalink to this definition">¶</a></dt>
<dd><p id="clearswitchpoints">Clears all switch points from the schedule</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>id</strong> (<em>int</em>) – The unique identifier of the schedule value.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if all switch points are clear.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
</tr>
<tr class="field-even field"><th class="field-name">See:</th><td class="field-body"><a class="reference internal" href="#setswitchpoint">setSwitchPoint</a>, <a class="reference internal" href="#removeswitchpoint">removeSwitchPoint</a>, <a class="reference internal" href="#getswitchpoint">getSwitchPoint</a>, <a class="reference internal" href="#getnumswitchpoints">getNumSwitchPoints</a></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="libopenzwave.PyManager.create">
<tt class="descname">create</tt><big>(</big><big>)</big><a class="headerlink" href="#libopenzwave.PyManager.create" title="Permalink to this definition">¶</a></dt>
<dd><p id="create">Creates the Manager singleton object.</p>
<p>The Manager provides the public interface to OpenZWave, exposing all the
functionality required to add Z-Wave support to an application. There can be
only one Manager in an OpenZWave application. An Options object must be
created and Locked first, otherwise the call to Manager::Create will fail.
Once the Manager has been created, call AddWatcher to install a notification
callback handler, and then call the AddDriver method for each attached PC
Z-Wave controller in turn.</p>
</dd></dl>
<dl class="method">
<dt id="libopenzwave.PyManager.createScene">
<tt class="descname">createScene</tt><big>(</big><big>)</big><a class="headerlink" href="#libopenzwave.PyManager.createScene" title="Permalink to this definition">¶</a></dt>
<dd><p id="createscene">Create a Scene.</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">Returns:</th><td class="field-body">Scene ID used to reference the scene. 0 is failure result.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">id</td>
</tr>
<tr class="field-odd field"><th class="field-name">See:</th><td class="field-body"><a class="reference internal" href="#getnumscenes">getNumScenes</a>, <a class="reference internal" href="#getallscenes">getAllScenes</a>, <a class="reference internal" href="#sceneexists">sceneExists</a>, <a class="reference internal" href="#removescene">removeScene</a>, <a class="reference internal" href="#activatescene">activateScene</a>, <a class="reference internal" href="#getscenelabel">getSceneLabel</a>, <a class="reference internal" href="#setscenelabel">setSceneLabel</a>, <a class="reference internal" href="#removescenevalue">removeSceneValue</a>, <a class="reference internal" href="#addscenevalue">addSceneValue</a>, <a class="reference internal" href="#setscenevalue">setSceneValue</a>, <a class="reference internal" href="#scenegetvalues">sceneGetValues</a>, <a class="reference internal" href="#removeallscenes">removeAllScenes</a></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="libopenzwave.PyManager.disablePoll">
<tt class="descname">disablePoll</tt><big>(</big><big>)</big><a class="headerlink" href="#libopenzwave.PyManager.disablePoll" title="Permalink to this definition">¶</a></dt>
<dd><p id="disablepoll">Disable polling of a value.</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>id</strong> (<em>int</em>) – The ID of the value to disable polling.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if polling was disabled.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
</tr>
<tr class="field-even field"><th class="field-name">See:</th><td class="field-body"><a class="reference internal" href="#getpollinterval">getPollInterval</a>, <a class="reference internal" href="#setpollinterval">setPollInterval</a>, <a class="reference internal" href="#enablepoll">enablePoll</a>, <a class="reference internal" href="#ispolled">isPolled</a>, <a class="reference internal" href="#setpollintensity">setPollIntensity</a>, <a class="reference internal" href="#getpollintensity">getPollIntensity</a></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="libopenzwave.PyManager.enablePoll">
<tt class="descname">enablePoll</tt><big>(</big><big>)</big><a class="headerlink" href="#libopenzwave.PyManager.enablePoll" title="Permalink to this definition">¶</a></dt>
<dd><p id="enablepoll">Enable the polling of a device’s state.</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 simple">
<li><strong>id</strong> (<em>int</em>) – The ID of the value to start polling</li>
<li><strong>intensity</strong> (<em>int</em>) – The intensity of the poll</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if polling was enabled.</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">bool</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">See:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#getpollinterval">getPollInterval</a>, <a class="reference internal" href="#setpollinterval">setPollInterval</a>, <a class="reference internal" href="#ispolled">isPolled</a>, <a class="reference internal" href="#setpollintensity">setPollIntensity</a>, <a class="reference internal" href="#disablepoll">disablePoll</a>, <a class="reference internal" href="#getpollintensity">getPollIntensity</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="libopenzwave.PyManager.getAllScenes">
<tt class="descname">getAllScenes</tt><big>(</big><big>)</big><a class="headerlink" href="#libopenzwave.PyManager.getAllScenes" title="Permalink to this definition">¶</a></dt>
<dd><p id="getallscenes">Gets a set of all the SceneIds</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">Returns:</th><td class="field-body">A set() containing neighboring scene IDs</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">set()</td>
</tr>
<tr class="field-odd field"><th class="field-name">See:</th><td class="field-body"><a class="reference internal" href="#getnumscenes">getNumScenes</a>, <a class="reference internal" href="#sceneexists">sceneExists</a>, <a class="reference internal" href="#createscene">createScene</a>, <a class="reference internal" href="#removescene">removeScene</a>, <a class="reference internal" href="#activatescene">activateScene</a>, <a class="reference internal" href="#getscenelabel">getSceneLabel</a>, <a class="reference internal" href="#setscenelabel">setSceneLabel</a>, <a class="reference internal" href="#removescenevalue">removeSceneValue</a>, <a class="reference internal" href="#addscenevalue">addSceneValue</a>, <a class="reference internal" href="#setscenevalue">setSceneValue</a>, <a class="reference internal" href="#scenegetvalues">sceneGetValues</a>, <a class="reference internal" href="#removeallscenes">removeAllScenes</a></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="libopenzwave.PyManager.getAssociations">
<tt class="descname">getAssociations</tt><big>(</big><big>)</big><a class="headerlink" href="#libopenzwave.PyManager.getAssociations" title="Permalink to this definition">¶</a></dt>
<dd><p id="getassociations">Gets the associations for a 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"><ul class="first simple">
<li><strong>homeId</strong> (<em>int</em>) – The Home ID of the Z-Wave controller that manages the node.</li>
<li><strong>nodeId</strong> (<em>int</em>) – The ID of the node whose associations we are interested in.</li>
<li><strong>groupIdx</strong> (<em>int</em>) – one-based index of the group (because Z-Wave product manuals use one-based group numbering).</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A set containing IDs of members of the group</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">set()</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">See:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#getnumgroups">getNumGroups</a>, <a class="reference internal" href="#addassociation">addAssociation</a>, <a class="reference internal" href="#removeassociation">removeAssociation</a>, <a class="reference internal" href="#getmaxassociations">getMaxAssociations</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="libopenzwave.PyManager.getChangeVerified">
<tt class="descname">getChangeVerified</tt><big>(</big><big>)</big><a class="headerlink" href="#libopenzwave.PyManager.getChangeVerified" title="Permalink to this definition">¶</a></dt>
<dd><p>If so, the library will immediately refresh the value a second time whenever a change is observed.
This helps to filter out spurious data reported occasionally by some devices.</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>id</strong> (<em>int</em>) – The unique identifier of the value whose changes should or should not be verified.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if is verified.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="libopenzwave.PyManager.getControllerInterfaceType">
<tt class="descname">getControllerInterfaceType</tt><big>(</big><big>)</big><a class="headerlink" href="#libopenzwave.PyManager.getControllerInterfaceType" title="Permalink to this definition">¶</a></dt>
<dd><p>.._getControllerInterfaceType:
Retrieve controller interface type, Unknown, Serial, 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>homeId</strong> – The Home ID of the Z-Wave controller.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The controller interface type</td>
</tr>
<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="libopenzwave.PyManager.getControllerNodeId">
<tt class="descname">getControllerNodeId</tt><big>(</big><big>)</big><a class="headerlink" href="#libopenzwave.PyManager.getControllerNodeId" title="Permalink to this definition">¶</a></dt>
<dd><p id="getcontrollernodeid">Get the node ID of the Z-Wave 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">Parameters:</th><td class="field-body"><strong>homeId</strong> (<em>int</em>) – The Home ID of the Z-Wave controller.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The node ID of the Z-Wave controller</td>
</tr>
<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="libopenzwave.PyManager.getControllerPath">
<tt class="descname">getControllerPath</tt><big>(</big><big>)</big><a class="headerlink" href="#libopenzwave.PyManager.getControllerPath" title="Permalink to this definition">¶</a></dt>
<dd><p>.._getControllerPath:
Retrieve controller interface path, name or path used to open the controller hardware</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>homeId</strong> – The Home ID of the Z-Wave controller.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The controller interface type</td>
</tr>
<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="libopenzwave.PyManager.getDriverStatistics">
<tt class="descname">getDriverStatistics</tt><big>(</big><big>)</big><a class="headerlink" href="#libopenzwave.PyManager.getDriverStatistics" title="Permalink to this definition">¶</a></dt>
<dd><p id="getdriverstatistics">Retrieve statistics from driver.</p>
<p>Statistics:</p>
<blockquote>
<div><ul class="simple">
<li>SOFCnt : Number of SOF bytes received</li>
<li>ACKWaiting : Number of unsolicited messages while waiting for an ACK</li>
<li>readAborts : Number of times read were aborted due to timeouts</li>
<li>badChecksum : Number of bad checksums</li>
<li>readCnt : Number of messages successfully read</li>
<li>writeCnt : Number of messages successfully sent</li>
<li>CANCnt : Number of CAN bytes received</li>
<li>NAKCnt : Number of NAK bytes received</li>
<li>ACKCnt : Number of ACK bytes received</li>
<li>OOFCnt : Number of bytes out of framing</li>
<li>dropped : Number of messages dropped & not delivered</li>
<li>retries : Number of messages retransmitted</li>
<li>callbacks : Number of unexpected callbacks</li>
<li>badroutes : Number of failed messages due to bad route response</li>
<li>noack : Number of no ACK returned errors</li>
<li>netbusy : Number of network busy/failure messages</li>
<li>nondelivery : Number of messages not delivered to network</li>
<li>routedbusy : Number of messages received with routed busy status</li>
<li>broadcastReadCnt : Number of broadcasts read</li>
<li>broadcastWriteCnt : Number of broadcasts sent</li>
</ul>
</div></blockquote>
<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 simple">
<li><strong>homeId</strong> (<em>int</em>) – The Home ID of the Z-Wave controller.</li>
<li><strong>data</strong> (<em>int</em>) – Pointer to structure DriverData to return values</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A dict containing statistics of the driver.</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">dict()</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">See:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#getnodestatistics">getNodeStatistics</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="libopenzwave.PyManager.getGroupLabel">
<tt class="descname">getGroupLabel</tt><big>(</big><big>)</big><a class="headerlink" href="#libopenzwave.PyManager.getGroupLabel" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a label for the particular group of a node.</p>
<p id="getgrouplabel">This label is populated by the device specific configuration files.</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 simple">
<li><strong>homeid</strong> (<em>int</em>) – The Home ID of the Z-Wave controller that manages the node.</li>
<li><strong>nodeid</strong> (<em>int</em>) – The ID of the node whose associations are to be changed.</li>
<li><strong>groupidx</strong> (<em>int</em>) – One-based index of the group (because Z-Wave product manuals use one-based group numbering).</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The label for the particular group of a node.</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">str</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">See:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#getnumgroups">getNumGroups</a>, <a class="reference internal" href="#getassociations">getAssociations</a>, <a class="reference internal" href="#getmaxassociations">getMaxAssociations</a>, <a class="reference internal" href="#addassociation">addAssociation</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="libopenzwave.PyManager.getLibraryTypeName">
<tt class="descname">getLibraryTypeName</tt><big>(</big><big>)</big><a class="headerlink" href="#libopenzwave.PyManager.getLibraryTypeName" title="Permalink to this definition">¶</a></dt>
<dd><p id="getlibrarytypename">Get a string containing the Z-Wave API library type used by a controller.</p>
<p>The possible library types are:</p>
<blockquote>
<div><ul class="simple">
<li>Static Controller</li>
<li>Controller</li>
<li>Enhanced Slave</li>
<li>Slave</li>
<li>Installer</li>
<li>Routing Slave</li>
<li>Bridge Controller</li>
<li>Device Under Test</li>
</ul>
</div></blockquote>
<p>The controller should never return a slave library type. For a more efficient
test of whether a controller is a Bridge Controller, use the IsBridgeController
method.</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>homeId</strong> (<em>int</em>) – The Home ID of the Z-Wave controller.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A string containing the library type.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
</tr>
<tr class="field-even field"><th class="field-name">See:</th><td class="field-body"><a class="reference internal" href="#getlibraryversion">getLibraryVersion</a>, <a class="reference internal" href="#getpythonlibraryversion">getPythonLibraryVersion</a>, <a class="reference internal" href="#getozwlibraryversion">getOzwLibraryVersion</a></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="libopenzwave.PyManager.getLibraryVersion">
<tt class="descname">getLibraryVersion</tt><big>(</big><big>)</big><a class="headerlink" href="#libopenzwave.PyManager.getLibraryVersion" title="Permalink to this definition">¶</a></dt>
<dd><p id="getlibraryversion">Get the version of the Z-Wave API library used by a 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">Parameters:</th><td class="field-body"><strong>homeId</strong> (<em>int</em>) – The Home ID of the Z-Wave controller.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A string containing the library version. For example, “Z-Wave 2.48”.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
</tr>
<tr class="field-even field"><th class="field-name">See:</th><td class="field-body"><a class="reference internal" href="#getpythonlibraryversion">getPythonLibraryVersion</a>, <a class="reference internal" href="#getlibrarytypename">getLibraryTypeName</a>, <a class="reference internal" href="#getozwlibraryversion">getOzwLibraryVersion</a></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="libopenzwave.PyManager.getMaxAssociations">
<tt class="descname">getMaxAssociations</tt><big>(</big><big>)</big><a class="headerlink" href="#libopenzwave.PyManager.getMaxAssociations" title="Permalink to this definition">¶</a></dt>
<dd><p id="getmaxassociations">Gets the maximum number of associations for a 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"><ul class="first simple">
<li><strong>homeid</strong> (<em>int</em>) – The Home ID of the Z-Wave controller that manages the node.</li>
<li><strong>nodeid</strong> (<em>int</em>) – The ID of the node whose associations we are interested in.</li>
<li><strong>groupidx</strong> (<em>int</em>) – One-based index of the group (because Z-Wave product manuals use one-based group numbering).</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The maximum number of nodes that can be associated into the group.</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">int</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">See:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#getnumgroups">getNumGroups</a>, <a class="reference internal" href="#addassociation">addAssociation</a>, <a class="reference internal" href="#removeassociation">removeAssociation</a>, <a class="reference internal" href="#getassociations">getAssociations</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="libopenzwave.PyManager.getNodeBasic">
<tt class="descname">getNodeBasic</tt><big>(</big><big>)</big><a class="headerlink" href="#libopenzwave.PyManager.getNodeBasic" title="Permalink to this definition">¶</a></dt>
<dd><p id="getnodebasic">Get the basic type of a 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">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>homeId</strong> (<em>int</em>) – The Home ID of the Z-Wave controller that manages the node.</li>
<li><strong>nodeId</strong> (<em>int</em>) – The ID of the node to query.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The node basic type.</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">int</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">See:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#getnodetype">getNodeType</a>, <a class="reference internal" href="#getnodespecific">getNodeSpecific</a>, <a class="reference internal" href="#getnodegeneric">getNodeGeneric</a>, <a class="reference internal" href="#getnodesecurity">getNodeSecurity</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="libopenzwave.PyManager.getNodeClassInformation">
<tt class="descname">getNodeClassInformation</tt><big>(</big><big>)</big><a class="headerlink" href="#libopenzwave.PyManager.getNodeClassInformation" title="Permalink to this definition">¶</a></dt>
<dd><p id="getnodeclassinformation">Helper method to return whether a particular class is available in a 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">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>homeId</strong> (<em>int</em>) – The Home ID of the Z-Wave controller that manages the node.</li>
<li><strong>nodeId</strong> (<em>int</em>) – The ID of the node to query.</li>
<li><strong>commandClassId</strong> (<em>int</em>) – control class to query</li>
<li><strong>className</strong> (<em>str</em>) – (optional, default=None) specific name of class to query</li>
<li><strong>classVersion</strong> (<em>int</em>) – (optional, default=None) specific class version</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if the node does have the class instantiated, will return name & version</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">bool</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="libopenzwave.PyManager.getNodeGeneric">
<tt class="descname">getNodeGeneric</tt><big>(</big><big>)</big><a class="headerlink" href="#libopenzwave.PyManager.getNodeGeneric" title="Permalink to this definition">¶</a></dt>
<dd><p id="getnodegeneric">Get the generic type of a 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">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>homeId</strong> (<em>int</em>) – The Home ID of the Z-Wave controller that manages the node.</li>
<li><strong>nodeId</strong> (<em>int</em>) – The ID of the node to query.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The node generic type.</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">int</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">See:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#getnodetype">getNodeType</a>, <a class="reference internal" href="#getnodespecific">getNodeSpecific</a>, <a class="reference internal" href="#getnodebasic">getNodeBasic</a>, <a class="reference internal" href="#getnodesecurity">getNodeSecurity</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="libopenzwave.PyManager.getNodeLocation">
<tt class="descname">getNodeLocation</tt><big>(</big><big>)</big><a class="headerlink" href="#libopenzwave.PyManager.getNodeLocation" title="Permalink to this definition">¶</a></dt>
<dd><p id="getnodelocation">Get the location of a node</p>
<p>The node location is a user-editable string that would normally be handled by
the Node Naming commmand class, but many devices do not support it. So that a
node can always report its location, OpenZWave stores it with the node data,
and provides access through this method and SetNodeLocation, rather than
reporting it via a command class Value object.</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 simple">
<li><strong>homeId</strong> (<em>int</em>) – The Home ID of the Z-Wave controller that manages the node.</li>
<li><strong>nodeId</strong> (<em>int</em>) – The ID of the node to query.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">str – A string containing the nodes location.</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">See:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#setnodelocation">setNodeLocation</a>, <a class="reference internal" href="#getnodename">getNodeName</a>, <a class="reference internal" href="#setnodename">setNodeName</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="libopenzwave.PyManager.getNodeManufacturerId">
<tt class="descname">getNodeManufacturerId</tt><big>(</big><big>)</big><a class="headerlink" href="#libopenzwave.PyManager.getNodeManufacturerId" title="Permalink to this definition">¶</a></dt>
<dd><p id="getnodemanufacturerid">Get the manufacturer ID of a device</p>
<p>The manufacturer ID is a four digit hex code and would normally be handled by
the Manufacturer-Specific commmand class, but not all devices support it.
Although the value reported by this method will be an empty string if the
command class is not supported and cannot be set by the user, the manufacturer
ID is still stored with the node data (rather than being reported via a command
class Value object) to retain a consistent approach with the other manufacturer
specific data.</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 simple">
<li><strong>homeId</strong> (<em>int</em>) – The Home ID of the Z-Wave controller that manages the node.</li>
<li><strong>nodeId</strong> (<em>int</em>) – The ID of the node to query.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A string containing the nodes manufacturer ID, or an empty string if the manufactuer-specific command class is not supported by the device.</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">str</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">See:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#getnodeproducttype">getNodeProductType</a>, <a class="reference internal" href="#getnodeproductid">getNodeProductId</a>, <a class="reference internal" href="#getnodemanufacturername">getNodeManufacturerName</a>, <a class="reference internal" href="#setnodemanufacturername">setNodeManufacturerName</a>, <a class="reference internal" href="#getnodeproductname">getNodeProductName</a>, <a class="reference internal" href="#setnodeproductname">setNodeProductName</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="libopenzwave.PyManager.getNodeManufacturerName">
<tt class="descname">getNodeManufacturerName</tt><big>(</big><big>)</big><a class="headerlink" href="#libopenzwave.PyManager.getNodeManufacturerName" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div></div></blockquote>
<p id="getnodemanufacturername">Get the manufacturer name of a device</p>
<p>The manufacturer name would normally be handled by the Manufacturer Specific
commmand class, taking the manufacturer ID reported by the device and using it
to look up the name from the manufacturer_specific.xml file in the OpenZWave
config folder. However, there are some devices that do not support the command
class, so to enable the user to manually set the name, it is stored with the
node data and accessed via this method rather than being reported via a command
class Value object.</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 simple">
<li><strong>homeId</strong> (<em>int</em>) – The Home ID of the Z-Wave controller that manages the node.</li>
<li><strong>nodeId</strong> (<em>int</em>) – The ID of the node to query.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A string containing the nodes manufacturer name.</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">str</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">See:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#setnodemanufacturername">setNodeManufacturerName</a>, <a class="reference internal" href="#getnodeproductname">getNodeProductName</a>, <a class="reference internal" href="#setnodeproductname">setNodeProductName</a>, <a class="reference internal" href="#getnodemanufacturerid">getNodeManufacturerId</a>, <a class="reference internal" href="#getnodeproductid">getNodeProductId</a>, <a class="reference internal" href="#getnodeproducttype">getNodeProductType</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="libopenzwave.PyManager.getNodeMaxBaudRate">
<tt class="descname">getNodeMaxBaudRate</tt><big>(</big><big>)</big><a class="headerlink" href="#libopenzwave.PyManager.getNodeMaxBaudRate" title="Permalink to this definition">¶</a></dt>
<dd><p id="getnodemaxbaudrate">Get the maximum baud rate of a nodes communications</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 simple">
<li><strong>homeId</strong> (<em>int</em>) – The Home ID of the Z-Wave controller that manages the node.</li>
<li><strong>nodeId</strong> (<em>int</em>) – The ID of the node to query.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The baud rate in bits per second.</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">int</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="libopenzwave.PyManager.getNodeName">
<tt class="descname">getNodeName</tt><big>(</big><big>)</big><a class="headerlink" href="#libopenzwave.PyManager.getNodeName" title="Permalink to this definition">¶</a></dt>
<dd><p id="getnodename">Get the name of a node</p>
<p>The node name is a user-editable label for the node that would normally be
handled by the Node Naming commmand class, but many devices do not support it.
So that a node can always be named, OpenZWave stores it with the node data, and
provides access through this method and SetNodeName, rather than reporting it
via a command class Value object. The maximum length of a node name is 16
characters.</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 simple">
<li><strong>homeId</strong> (<em>int</em>) – The Home ID of the Z-Wave controller that manages the node.</li>
<li><strong>nodeId</strong> (<em>int</em>) – The ID of the node to query.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">str – A string containing the node name.</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">See:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#setnodename">setNodeName</a>, <a class="reference internal" href="#getnodelocation">getNodeLocation</a>, <a class="reference internal" href="#setnodelocation">setNodeLocation</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="libopenzwave.PyManager.getNodeNeighbors">
<tt class="descname">getNodeNeighbors</tt><big>(</big><big>)</big><a class="headerlink" href="#libopenzwave.PyManager.getNodeNeighbors" title="Permalink to this definition">¶</a></dt>
<dd><p id="getnodeneighbors">Get the bitmap of this node’s neighbors.</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 simple">
<li><strong>homeId</strong> (<em>int</em>) – The Home ID of the Z-Wave controller that manages the node.</li>
<li><strong>nodeId</strong> (<em>int</em>) – The ID of the node to query.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A set containing neighboring node IDs</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">set()</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="libopenzwave.PyManager.getNodeProductId">
<tt class="descname">getNodeProductId</tt><big>(</big><big>)</big><a class="headerlink" href="#libopenzwave.PyManager.getNodeProductId" title="Permalink to this definition">¶</a></dt>
<dd><p id="getnodeproductid">Get the product ID of a device</p>
<p>The product ID is a four digit hex code and would normally be handled by the
Manufacturer-Specific commmand class, but not all devices support it. Although