forked from OpenZWave/python-openzwave
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcontroller.html
More file actions
1305 lines (1236 loc) · 66.9 KB
/
controller.html
File metadata and controls
1305 lines (1236 loc) · 66.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
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>Controller documentation — python-openzwave 0.3.0b5 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.0b5',
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.0b5 documentation" href="index.html" />
<link rel="up" title="API documentation" href="openzwave.html" />
<link rel="next" title="Option documentation" href="option.html" />
<link rel="prev" title="Network documentation" href="network.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="option.html" title="Option documentation"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="network.html" title="Network documentation"
accesskey="P">previous</a> |</li>
<li><a href="index.html">python-openzwave 0.3.0b5 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="controller-documentation">
<h1>Controller documentation<a class="headerlink" href="#controller-documentation" title="Permalink to this headline">¶</a></h1>
<p>The controller is the node of your adaptater. You can use it to retrieve
informations on it : library, statistics, ...</p>
<div class="toctree-wrapper compound">
<ul class="simple">
</ul>
</div>
<span class="target" id="module-openzwave.controller"></span><span class="target" id="module-openzwave.controller"></span><dl class="docutils" id="openzwavecontroller">
<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.controller.ZWaveController">
<em class="property">class </em><tt class="descclassname">openzwave.controller.</tt><tt class="descname">ZWaveController</tt><big>(</big><em>controller_id</em>, <em>network</em>, <em>options=None</em><big>)</big><a class="headerlink" href="#openzwave.controller.ZWaveController" title="Permalink to this definition">¶</a></dt>
<dd><p>The controller manager.</p>
<p>Allows to retrieve informations about the library, statistics, ...
Also used to send commands to the controller</p>
<p>Commands :</p>
<blockquote>
<div><ul>
<li><p class="first">Driver::ControllerCommand_AddController : Add a new secondary controller to the Z-Wave network.</p>
</li>
<li><p class="first">Driver::ControllerCommand_AddDevice : Add a new device (but not a controller) to the Z-Wave network.</p>
</li>
<li><p class="first">Driver::ControllerCommand_CreateNewPrimary : (Not yet implemented)</p>
</li>
<li><p class="first">Driver::ControllerCommand_ReceiveConfiguration :</p>
</li>
<li><p class="first">Driver::ControllerCommand_RemoveController : remove a controller from the Z-Wave network.</p>
</li>
<li><p class="first">Driver::ControllerCommand_RemoveDevice : remove a device (but not a controller) from the Z-Wave network.</p>
</li>
<li><dl class="first docutils">
<dt>Driver::ControllerCommand_RemoveFailedNode <span class="classifier-delimiter">:</span> <span class="classifier">move a node to the controller’s list of failed nodes. The node must actually</span></dt>
<dd><p class="first last">have failed or have been disabled since the command will fail if it responds. A node must be in the controller’s failed nodes list
or ControllerCommand_ReplaceFailedNode to work.</p>
</dd>
</dl>
</li>
<li><p class="first">Driver::ControllerCommand_HasNodeFailed : Check whether a node is in the controller’s failed nodes list.</p>
</li>
<li><dl class="first docutils">
<dt>Driver::ControllerCommand_ReplaceFailedNode <span class="classifier-delimiter">:</span> <span class="classifier">replace a failed device with another. If the node is not in</span></dt>
<dd><p class="first last">the controller’s failed nodes list, or the node responds, this command will fail.</p>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>Driver:: ControllerCommand_TransferPrimaryRole <span class="classifier-delimiter">:</span> <span class="classifier">(Not yet implemented) - Add a new controller to the network and</span></dt>
<dd><p class="first last">make it the primary. The existing primary will become a secondary controller.</p>
</dd>
</dl>
</li>
<li><p class="first">Driver::ControllerCommand_RequestNetworkUpdate : Update the controller with network information from the SUC/SIS.</p>
</li>
<li><p class="first">Driver::ControllerCommand_RequestNodeNeighborUpdate : Get a node to rebuild its neighbour list. This method also does ControllerCommand_RequestNodeNeighbors afterwards.</p>
</li>
<li><p class="first">Driver::ControllerCommand_AssignReturnRoute : Assign a network return route to a device.</p>
</li>
<li><p class="first">Driver::ControllerCommand_DeleteAllReturnRoutes : Delete all network return routes from a device.</p>
</li>
<li><p class="first">Driver::ControllerCommand_CreateButton : Create a handheld button id.</p>
</li>
<li><p class="first">Driver::ControllerCommand_DeleteButton : Delete a handheld button id.</p>
</li>
</ul>
</div></blockquote>
<p>Callbacks :</p>
<blockquote>
<div><ul>
<li><dl class="first docutils">
<dt>Driver::ControllerState_Waiting <span class="classifier-delimiter">:</span> <span class="classifier">The controller is waiting for a user action. A notice should be displayed</span></dt>
<dd><p class="first last">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.</p>
</dd>
</dl>
</li>
<li><p class="first">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.</p>
</li>
<li><p class="first">Driver::ControllerState_Complete : the controller has finished adding or removing the node, and the command is complete.</p>
</li>
<li><p class="first">Driver::ControllerState_Failed : will be sent if the command fails for any reason.</p>
</li>
</ul>
</div></blockquote>
<dl class="method">
<dt id="openzwave.controller.ZWaveController.add_node">
<tt class="descname">add_node</tt><big>(</big><em>doSecurity=False</em><big>)</big><a class="headerlink" href="#openzwave.controller.ZWaveController.add_node" title="Permalink to this definition">¶</a></dt>
<dd><p>Start the Inclusion Process to add a Node to the Network.</p>
<p>The Status of the Node Inclusion is communicated via Notifications. Specifically, you should
monitor ControllerCommand Notifications.</p>
<p>Results of the AddNode Command will be send as a Notification with the Notification type as
Notification::Type_ControllerCommand</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>doSecurity</strong> (<em>bool</em>) – Whether to initialize the Network Key on the device if it supports the Security CC</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the request was sent successfully.</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="openzwave.controller.ZWaveController.assign_return_route">
<tt class="descname">assign_return_route</tt><big>(</big><em>nodeid</em><big>)</big><a class="headerlink" href="#openzwave.controller.ZWaveController.assign_return_route" title="Permalink to this definition">¶</a></dt>
<dd><p>Ask a Node to update its update its Return Route to the Controller</p>
<p>This command will ask a Node to update its Return Route to the Controller</p>
<p>Results of the AssignReturnRoute Command will be send as a Notification with the Notification type as
Notification::Type_ControllerCommand</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>nodeId</strong> (<em>int</em>) – The ID of the node to query.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the request was sent successfully.</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="openzwave.controller.ZWaveController.begin_command_add_device">
<tt class="descname">begin_command_add_device</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#openzwave.controller.ZWaveController.begin_command_add_device" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a new device to the Z-Wave network.</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>high_power</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.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the command was accepted and has started.</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="openzwave.controller.ZWaveController.begin_command_assign_return_route">
<tt class="descname">begin_command_assign_return_route</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#openzwave.controller.ZWaveController.begin_command_assign_return_route" title="Permalink to this definition">¶</a></dt>
<dd><p>Assign a network return route from a node to another one.</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>from_node_id</strong> (<em>int</em>) – The node that we will use the route.</li>
<li><strong>to_node_id</strong> (<em>int</em>) – The node that we will change the route</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 last">bool</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="openzwave.controller.ZWaveController.begin_command_create_button">
<tt class="descname">begin_command_create_button</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#openzwave.controller.ZWaveController.begin_command_create_button" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a handheld button id</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>node_id</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 last">bool</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="openzwave.controller.ZWaveController.begin_command_create_new_primary">
<tt class="descname">begin_command_create_new_primary</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#openzwave.controller.ZWaveController.begin_command_create_new_primary" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a new controller to the Z-Wave network. Used when old primary fails. Requires SUC.</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">True if the command was accepted and has started.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="openzwave.controller.ZWaveController.begin_command_delete_all_return_routes">
<tt class="descname">begin_command_delete_all_return_routes</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#openzwave.controller.ZWaveController.begin_command_delete_all_return_routes" title="Permalink to this definition">¶</a></dt>
<dd><p>Delete all network return routes from a 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>node_id</strong> (<em>int</em>) – Used only with the ReplaceFailedNode command, to specify the node that is going to be replaced.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the command was accepted and has started.</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="openzwave.controller.ZWaveController.begin_command_delete_button">
<tt class="descname">begin_command_delete_button</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#openzwave.controller.ZWaveController.begin_command_delete_button" title="Permalink to this definition">¶</a></dt>
<dd><p>Delete a handheld button id.</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>node_id</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 last">bool</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="openzwave.controller.ZWaveController.begin_command_has_node_failed">
<tt class="descname">begin_command_has_node_failed</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#openzwave.controller.ZWaveController.begin_command_has_node_failed" title="Permalink to this definition">¶</a></dt>
<dd><p>Check whether a node is in the controller’s failed nodes list.</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>node_id</strong> (<em>int</em>) – Used only with the ReplaceFailedNode command, to specify the node that is going to be replaced.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the command was accepted and has started.</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="openzwave.controller.ZWaveController.begin_command_receive_configuration">
<tt class="descname">begin_command_receive_configuration</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#openzwave.controller.ZWaveController.begin_command_receive_configuration" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li></li>
</ul>
<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">True if the command was accepted and has started.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="openzwave.controller.ZWaveController.begin_command_remove_device">
<tt class="descname">begin_command_remove_device</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#openzwave.controller.ZWaveController.begin_command_remove_device" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove a device from the Z-Wave network.</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>high_power</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.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the command was accepted and has started.</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="openzwave.controller.ZWaveController.begin_command_remove_failed_node">
<tt class="descname">begin_command_remove_failed_node</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#openzwave.controller.ZWaveController.begin_command_remove_failed_node" title="Permalink to this definition">¶</a></dt>
<dd><p>Move a node to the controller’s list of failed nodes. The node must
actually have failed or have been disabled since the command
will fail if it responds. A node must be in the controller’s
failed nodes list for ControllerCommand_ReplaceFailedNode to work.</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>node_id</strong> (<em>int</em>) – Used only with the ReplaceFailedNode command, to specify the node that is going to be replaced.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the command was accepted and has started.</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="openzwave.controller.ZWaveController.begin_command_replace_failed_node">
<tt class="descname">begin_command_replace_failed_node</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#openzwave.controller.ZWaveController.begin_command_replace_failed_node" title="Permalink to this definition">¶</a></dt>
<dd><p>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.</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>node_id</strong> (<em>int</em>) – Used only with the ReplaceFailedNode command, to specify the node that is going to be replaced.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the command was accepted and has started.</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="openzwave.controller.ZWaveController.begin_command_replication_send">
<tt class="descname">begin_command_replication_send</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#openzwave.controller.ZWaveController.begin_command_replication_send" title="Permalink to this definition">¶</a></dt>
<dd><p>Send information from primary to secondary.</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>high_power</strong> (<em>bool</em>) – 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.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the command was accepted and has started.</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="openzwave.controller.ZWaveController.begin_command_request_network_update">
<tt class="descname">begin_command_request_network_update</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#openzwave.controller.ZWaveController.begin_command_request_network_update" title="Permalink to this definition">¶</a></dt>
<dd><p>Update the controller with network information from the SUC/SIS.</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">True if the command was accepted and has started.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="openzwave.controller.ZWaveController.begin_command_request_node_neigbhor_update">
<tt class="descname">begin_command_request_node_neigbhor_update</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#openzwave.controller.ZWaveController.begin_command_request_node_neigbhor_update" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a node to rebuild its neighbors list.
This method also does ControllerCommand_RequestNodeNeighbors afterwards.</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>node_id</strong> (<em>int</em>) – Used only with the ReplaceFailedNode command, to specify the node that is going to be replaced.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the command was accepted and has started.</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="openzwave.controller.ZWaveController.begin_command_send_node_information">
<tt class="descname">begin_command_send_node_information</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#openzwave.controller.ZWaveController.begin_command_send_node_information" title="Permalink to this definition">¶</a></dt>
<dd><p>Send a node information frame.</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>node_id</strong> (<em>int</em>) – Used only with the ReplaceFailedNode command, to specify the node that is going to be replaced.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the command was accepted and has started.</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="openzwave.controller.ZWaveController.begin_command_transfer_primary_role">
<tt class="descname">begin_command_transfer_primary_role</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#openzwave.controller.ZWaveController.begin_command_transfer_primary_role" title="Permalink to this definition">¶</a></dt>
<dd><p>Make a different controller the primary.
The existing primary will become a secondary 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>high_power</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.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the command was accepted and has started.</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="openzwave.controller.ZWaveController.cancel_command">
<tt class="descname">cancel_command</tt><big>(</big><big>)</big><a class="headerlink" href="#openzwave.controller.ZWaveController.cancel_command" title="Permalink to this definition">¶</a></dt>
<dd><p>Cancels any in-progress command running on a controller.</p>
</dd></dl>
<dl class="attribute">
<dt id="openzwave.controller.ZWaveController.capabilities">
<tt class="descname">capabilities</tt><a class="headerlink" href="#openzwave.controller.ZWaveController.capabilities" title="Permalink to this definition">¶</a></dt>
<dd><p>The capabilities of 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">Returns:</th><td class="field-body">The capabilities of the controller</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">set</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="openzwave.controller.ZWaveController.create_button">
<tt class="descname">create_button</tt><big>(</big><em>nodeid</em>, <em>buttonid</em><big>)</big><a class="headerlink" href="#openzwave.controller.ZWaveController.create_button" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a handheld button id.</p>
<p>Only intended for Bridge Firmware Controllers.</p>
<p>Results of the CreateButton Command will be send as a Notification with the Notification type as
Notification::Type_ControllerCommand</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>nodeId</strong> (<em>int</em>) – The ID of the node to query.</li>
<li><strong>buttonid</strong> (<em>int</em>) – the ID of the Button to query.</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 request was sent successfully.</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="openzwave.controller.ZWaveController.create_new_primary">
<tt class="descname">create_new_primary</tt><big>(</big><big>)</big><a class="headerlink" href="#openzwave.controller.ZWaveController.create_new_primary" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new primary controller when old primary fails. Requires SUC.</p>
<p>This command creates a new Primary Controller when the Old Primary has Failed. Requires a SUC on the network to function.</p>
<p>Results of the CreateNewPrimary Command will be send as a Notification with the Notification type as
Notification::Type_ControllerCommand</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">True if the request was sent successfully.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="openzwave.controller.ZWaveController.delete_all_return_routes">
<tt class="descname">delete_all_return_routes</tt><big>(</big><em>nodeid</em><big>)</big><a class="headerlink" href="#openzwave.controller.ZWaveController.delete_all_return_routes" title="Permalink to this definition">¶</a></dt>
<dd><p>Ask a Node to delete all Return Route.</p>
<p>This command will ask a Node to delete all its return routes, and will rediscover when needed.</p>
<p>Results of the DeleteAllReturnRoutes Command will be send as a Notification with the Notification type as
Notification::Type_ControllerCommand</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>nodeId</strong> (<em>int</em>) – The ID of the node to query.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the request was sent successfully.</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="openzwave.controller.ZWaveController.delete_button">
<tt class="descname">delete_button</tt><big>(</big><em>nodeid</em>, <em>buttonid</em><big>)</big><a class="headerlink" href="#openzwave.controller.ZWaveController.delete_button" title="Permalink to this definition">¶</a></dt>
<dd><p>Delete a handheld button id.</p>
<p>Only intended for Bridge Firmware Controllers.</p>
<p>Results of the CreateButton Command will be send as a Notification with the Notification type as
Notification::Type_ControllerCommand</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>nodeId</strong> (<em>int</em>) – The ID of the node to query.</li>
<li><strong>buttonid</strong> (<em>int</em>) – the ID of the Button to query.</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 request was sent successfully.</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="attribute">
<dt id="openzwave.controller.ZWaveController.device">
<tt class="descname">device</tt><a class="headerlink" href="#openzwave.controller.ZWaveController.device" title="Permalink to this definition">¶</a></dt>
<dd><p>The device 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">Returns:</th><td class="field-body">The device (ie /dev/zwave)</td>
</tr>
<tr class="field-even 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.controller.ZWaveController.do_poll_statistics">
<tt class="descname">do_poll_statistics</tt><big>(</big><big>)</big><a class="headerlink" href="#openzwave.controller.ZWaveController.do_poll_statistics" title="Permalink to this definition">¶</a></dt>
<dd><p>Timer based polling system for statistics</p>
</dd></dl>
<dl class="method">
<dt id="openzwave.controller.ZWaveController.get_stats_label">
<tt class="descname">get_stats_label</tt><big>(</big><em>stat</em><big>)</big><a class="headerlink" href="#openzwave.controller.ZWaveController.get_stats_label" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieve label of the statistic from driver.</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>stat</strong> – The code of the stat label to retrieve.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The label or the stat.</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="openzwave.controller.ZWaveController.hard_reset">
<tt class="descname">hard_reset</tt><big>(</big><big>)</big><a class="headerlink" href="#openzwave.controller.ZWaveController.hard_reset" title="Permalink to this definition">¶</a></dt>
<dd><p>Hard Reset a PC Z-Wave Controller.
Resets a controller and erases its network configuration settings.
The controller becomes a primary controller ready to add devices to a new network.</p>
<p>This command fires a lot of louie signals.
Louie’s clients must disconnect from nodes and values signals</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">dispatcher</span><span class="o">.</span><span class="n">send</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_network</span><span class="o">.</span><span class="n">SIGNAL_NETWORK_RESETTED</span><span class="p">,</span> <span class="o">**</span><span class="p">{</span><span class="s">'network'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">_network</span><span class="p">})</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="openzwave.controller.ZWaveController.has_node_failed">
<tt class="descname">has_node_failed</tt><big>(</big><em>nodeid</em><big>)</big><a class="headerlink" href="#openzwave.controller.ZWaveController.has_node_failed" title="Permalink to this definition">¶</a></dt>
<dd><p>Check if the Controller Believes a Node has Failed.</p>
<blockquote>
<div><p>This is different from the IsNodeFailed call in that we test the Controllers Failed Node List, whereas the IsNodeFailed is testing
our list of Failed Nodes, which might be different.</p>
<p>The Results will be communicated via Notifications. Specifically, you should monitor the ControllerCommand notifications</p>
</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"><strong>nodeId</strong> (<em>int</em>) – The ID of the node to query.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the request was sent successfully.</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="attribute">
<dt id="openzwave.controller.ZWaveController.is_bridge_controller">
<tt class="descname">is_bridge_controller</tt><a class="headerlink" href="#openzwave.controller.ZWaveController.is_bridge_controller" title="Permalink to this definition">¶</a></dt>
<dd><p>Is this controller using the bridge controller library.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="openzwave.controller.ZWaveController.is_primary_controller">
<tt class="descname">is_primary_controller</tt><a class="headerlink" href="#openzwave.controller.ZWaveController.is_primary_controller" title="Permalink to this definition">¶</a></dt>
<dd><p>Is this node a primary controller of the network.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="openzwave.controller.ZWaveController.is_static_update_controller">
<tt class="descname">is_static_update_controller</tt><a class="headerlink" href="#openzwave.controller.ZWaveController.is_static_update_controller" title="Permalink to this definition">¶</a></dt>
<dd><p>Is this controller a static update controller (SUC).</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="openzwave.controller.ZWaveController.library_config_path">
<tt class="descname">library_config_path</tt><a class="headerlink" href="#openzwave.controller.ZWaveController.library_config_path" title="Permalink to this definition">¶</a></dt>
<dd><p>The library 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">Returns:</th><td class="field-body">The library config directory</td>
</tr>
<tr class="field-even 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.controller.ZWaveController.library_description">
<tt class="descname">library_description</tt><a class="headerlink" href="#openzwave.controller.ZWaveController.library_description" title="Permalink to this definition">¶</a></dt>
<dd><p>The description of the library.</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">The library description (name and version)</td>
</tr>
<tr class="field-even 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.controller.ZWaveController.library_type_name">
<tt class="descname">library_type_name</tt><a class="headerlink" href="#openzwave.controller.ZWaveController.library_type_name" title="Permalink to this definition">¶</a></dt>
<dd><p>The name of the library.</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">The cpp library name</td>
</tr>
<tr class="field-even 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.controller.ZWaveController.library_user_path">
<tt class="descname">library_user_path</tt><a class="headerlink" href="#openzwave.controller.ZWaveController.library_user_path" title="Permalink to this definition">¶</a></dt>
<dd><p>The library User 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">Returns:</th><td class="field-body">The user directory to store user configuration</td>
</tr>
<tr class="field-even 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.controller.ZWaveController.library_version">
<tt class="descname">library_version</tt><a class="headerlink" href="#openzwave.controller.ZWaveController.library_version" title="Permalink to this definition">¶</a></dt>
<dd><p>The version of the library.</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">The cpp library version</td>
</tr>
<tr class="field-even 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.controller.ZWaveController.name">
<tt class="descname">name</tt><a class="headerlink" href="#openzwave.controller.ZWaveController.name" title="Permalink to this definition">¶</a></dt>
<dd><p>The node name of the controller on the network.</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">The node’s name of the controller on the network</td>
</tr>
<tr class="field-even 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.controller.ZWaveController.node">
<tt class="descname">node</tt><a class="headerlink" href="#openzwave.controller.ZWaveController.node" title="Permalink to this definition">¶</a></dt>
<dd><p>The node controller on the network.</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">The node controller on the network</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">ZWaveNode</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="openzwave.controller.ZWaveController.node_id">
<tt class="descname">node_id</tt><a class="headerlink" href="#openzwave.controller.ZWaveController.node_id" title="Permalink to this definition">¶</a></dt>
<dd><p>The node Id of the controller on the network.</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">The node id of the controller on the network</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">int</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="openzwave.controller.ZWaveController.options">
<tt class="descname">options</tt><a class="headerlink" href="#openzwave.controller.ZWaveController.options" title="Permalink to this definition">¶</a></dt>
<dd><p>The starting options of the manager.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The options used to start the manager</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">ZWaveOption</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="openzwave.controller.ZWaveController.ozw_library_version">
<tt class="descname">ozw_library_version</tt><a class="headerlink" href="#openzwave.controller.ZWaveController.ozw_library_version" title="Permalink to this definition">¶</a></dt>
<dd><p>The version of the openzwave library.</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">The openzwave library version</td>
</tr>
<tr class="field-even 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.controller.ZWaveController.poll_stats">
<tt class="descname">poll_stats</tt><a class="headerlink" href="#openzwave.controller.ZWaveController.poll_stats" title="Permalink to this definition">¶</a></dt>
<dd><p>The interval for polling statistics</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">The interval in seconds</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">float</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="openzwave.controller.ZWaveController.python_library_version">
<tt class="descname">python_library_version</tt><a class="headerlink" href="#openzwave.controller.ZWaveController.python_library_version" title="Permalink to this definition">¶</a></dt>
<dd><p>The version of the python library.</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">The python library version</td>
</tr>
<tr class="field-even 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.controller.ZWaveController.receive_configuration">
<tt class="descname">receive_configuration</tt><big>(</big><big>)</big><a class="headerlink" href="#openzwave.controller.ZWaveController.receive_configuration" title="Permalink to this definition">¶</a></dt>
<dd><p>Receive network configuration information from primary controller. Requires secondary.</p>
<p>This command prepares the controller to recieve Network Configuration from a Secondary Controller.</p>
<p>Results of the ReceiveConfiguration Command will be send as a Notification with the Notification type as
Notification::Type_ControllerCommand</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">True if the request was sent successfully.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="openzwave.controller.ZWaveController.remove_failed_node">
<tt class="descname">remove_failed_node</tt><big>(</big><em>nodeid</em><big>)</big><a class="headerlink" href="#openzwave.controller.ZWaveController.remove_failed_node" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove a Failed Device from the Z-Wave Network</p>
<p>This Command will remove a failed node from the network. The Node should be on the Controllers Failed
Node List, otherwise this command will fail. You can use the HasNodeFailed function below to test if the Controller
believes the Node has Failed.</p>
<p>The Status of the Node Removal is communicated via Notifications. Specifically, you should
monitor ControllerCommand Notifications.</p>
<p>Results of the RemoveFailedNode Command will be send as a Notification with the Notification type as
Notification::Type_ControllerCommand</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>nodeId</strong> (<em>int</em>) – The ID of the node to query.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the request was sent successfully.</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="openzwave.controller.ZWaveController.remove_node">