forked from BrianODell/py-openzwave
-
Notifications
You must be signed in to change notification settings - Fork 1
/
openzwave.pyx
1524 lines (1321 loc) · 66.7 KB
/
openzwave.pyx
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
from cython.operator cimport dereference as deref
from libcpp.map cimport map, pair
cdef extern from "<string>" namespace "std":
cdef cppclass string:
string()
string(char *)
string (size_t n, char c)
char * c_str()
cdef extern from "stdlib.h":
void* malloc(size_t size)
void free(void* ptr)
ctypedef unsigned int uint32
ctypedef int int32
ctypedef int int16
ctypedef unsigned char uint8
cdef extern from "Options.h" namespace "OpenZWave":
cdef cppclass Options:
bint Lock()
cdef extern from "Python.h":
void PyEval_InitThreads()
cdef extern from "Options.h" namespace "OpenZWave::Options":
Options* Create(string a, string b, string c)
cdef extern from *:
ctypedef char* const_notification "OpenZWave::Notification const*"
cdef extern from *:
ctypedef char* const_char_ptr "const char*"
cdef extern from "Notification.h" namespace "OpenZWave::Notification":
cdef enum NotificationType:
Type_ValueAdded = 0
Type_ValueRemoved = 1
Type_ValueChanged = 2
Type_Group = 3
Type_NodeNew = 4
Type_NodeAdded = 5
Type_NodeRemoved = 6
Type_NodeProtocolInfo = 7
Type_NodeNaming = 8
Type_NodeEvent = 9
Type_PollingDisabled = 10
Type_PollingEnabled = 11
Type_DriverReady = 12
Type_DriverFailed = 13
Type_DriverReset = 14
Type_MsgComplete = 15
Type_EssentialNodeQueriesComplete = 16
Type_NodeQueriesComplete = 17
Type_AwakeNodesQueried = 18
Type_AllNodesQueried = 19
cdef extern from "ValueID.h" namespace "OpenZWave":
cdef enum ValueGenre:
ValueGenre_Basic = 0
ValueGenre_User = 1
ValueGenre_Config = 2
ValueGenre_System = 3
ValueGenre_Count = 4
cdef enum ValueType:
ValueType_Bool = 0
ValueType_Byte = 1
ValueType_Decimal = 2
ValueType_Int = 3
ValueType_List = 4
ValueType_Schedule = 5
ValueType_Short = 6
ValueType_String = 7
ValueType_Button = 8
ValueType_Max = ValueType_Button
cdef cppclass ValueID:
uint32 GetHomeId()
uint8 GetNodeId()
ValueGenre GetGenre()
uint8 GetCommandClassId()
uint8 GetInstance()
uint8 GetIndex()
ValueType GetType()
uint32 GetId()
cdef extern from "Notification.h" namespace "OpenZWave":
cdef cppclass Notification:
NotificationType GetType()
uint32 GetHomeId()
uint8 GetNodeId()
ValueID& GetValueID()
uint8 GetGroupIdx()
uint8 GetEvent()
uint8 GetByte()
ctypedef void (*pfnOnNotification_t)(const_notification _pNotification, void* _context )
cdef extern from "Log.h" namespace "OpenZWave":
cdef cppclass Log:
Log* Create()
void SetLoggingState(bint dologging)
bint GetLoggingState()
void Write(const_char_ptr _format)
cdef extern from "Manager.h" namespace "OpenZWave":
cdef cppclass Manager:
# // Configuration
void WriteConfig(uint32 homeid)
# Options* GetOptions()
# // Drivers
bint AddDriver(string serialport)
bint RemoveDriver(string controllerPath)
uint8 GetControllerNodeId(uint32 homeid)
bint IsPrimaryController(uint32 homeid)
bint IsStaticUpdateController(uint32 homeid)
bint IsBridgeController(uint32 homeid)
string GetLibraryVersion(uint32 homeid)
string GetLibraryTypeName(uint32 homeid)
# // Polling
uint32 GetPollInterval()
void SetPollInterval(uint8 seconds)
bint EnablePoll(ValueID& valueId)
bint DisablePoll(ValueID& valueId)
bint isPolled(ValueID& valueId)
# // Node Information
bint RefreshNodeInfo(uint32 homeid, uint8 nodeid)
void RequestNodeState(uint32 homeid, uint8 nodeid)
bint IsNodeListeningDevice(uint32 homeid, uint8 nodeid)
bint IsNodeRoutingDevice(uint32 homeid, uint8 nodeid)
uint32 GetNodeMaxBaudRate(uint32 homeid, uint8 nodeid)
uint8 GetNodeVersion(uint32 homeid, uint8 nodeid)
uint8 GetNodeSecurity(uint32 homeid, uint8 nodeid)
uint8 GetNodeBasic(uint32 homeid, uint8 nodeid)
uint8 GetNodeGeneric(uint32 homeid, uint8 nodeid)
uint8 GetNodeSpecific(uint32 homeid, uint8 nodeid)
string GetNodeType(uint32 homeid, uint8 nodeid)
uint32 GetNodeNeighbors(uint32 homeid, uint8 nodeid, uint8** nodeNeighbors)
string GetNodeManufacturerName(uint32 homeid, uint8 nodeid)
string GetNodeProductName(uint32 homeid, uint8 nodeid)
string GetNodeName(uint32 homeid, uint8 nodeid)
string GetNodeLocation(uint32 homeid, uint8 nodeid)
string GetNodeManufacturerId(uint32 homeid, uint8 nodeid)
string GetNodeProductType(uint32 homeid, uint8 nodeid)
string GetNodeProductId(uint32 homeid, uint8 nodeid)
void SetNodeManufacturerName(uint32 homeid, uint8 nodeid, string manufacturerName)
void SetNodeProductName(uint32 homeid, uint8 nodeid, string productName)
void SetNodeName(uint32 homeid, uint8 nodeid, string productName)
void SetNodeLocation(uint32 homeid, uint8 nodeid, string location)
void SetNodeOn(uint32 homeid, uint8 nodeid)
void SetNodeOff(uint32 homeid, uint8 nodeid)
void SetNodeLevel(uint32 homeid, uint8 nodeid, uint8 level)
bint IsNodeInfoReceived(uint32 homeid, uint8 nodeid)
bint GetNodeClassInformation(uint32 homeid, uint8 nodeid, uint8 commandClassId, string className = NULL, uint8 *classVersion = NULL)
# // Values
string GetValueLabel(ValueID& valueid)
void SetValueLabel(ValueID& valueid, string value)
string GetValueUnits(ValueID& valueid)
void SetValueUnits(ValueID& valueid, string value)
string GetValueHelp(ValueID& valueid)
void SetValueHelp(ValueID& valueid, string value)
uint32 GetValueMin(ValueID& valueid)
uint32 GetValueMax(ValueID& valueid)
bint IsValueReadOnly(ValueID& valueid)
bint IsValueSet(ValueID& valueid)
bint GetValueAsBool(ValueID& valueid, bint* o_value)
bint GetValueAsByte(ValueID& valueid, uint8* o_value)
bint GetValueAsFloat(ValueID& valueid, float* o_value)
bint GetValueAsInt(ValueID& valueid, uint32* o_value)
bint GetValueAsShort(ValueID& valueid, uint32* o_value)
bint GetValueAsString(ValueID& valueid, string* o_value)
bint GetValueListSelection(ValueID& valueid, string* o_value)
bint GetValueListSelection(ValueID& valueid, uint32* o_value)
#bint GetValueListItems(ValueID& valueid, vector<string>* o_value)
bint SetValue(ValueID& valueid, bint value)
bint SetValue(ValueID& valueid, uint8 value)
bint SetValue(ValueID& valueid, float value)
bint SetValue(ValueID& valueid, int32 value)
bint SetValue(ValueID& valueid, int16 value)
bint SetValue(ValueID& valueid, string value)
bint SetValueListSelection(ValueID& valueid, string selecteditem)
bint PressButton(ValueID& valueid)
bint ReleaseButton(ValueID& valueid)
uint8 GetNumSwitchPoints(ValueID& valueid)
# // Climate Control
bint SetSwitchPoint(ValueID& valueid, uint8 hours, uint8 minutes, uint8 setback)
bint RemoveSwitchPoint(ValueID& valueid, uint8 hours, uint8 minutes)
bint ClearSwitchPoints(ValueID& valueid)
bint GetSwitchPoint(ValueID& valueid, uint8 idx, uint8* o_hours, uint8* o_minutes, uint8* o_setback)
# // SwitchAll
void SwitchAllOn(uint32 homeid)
void SwitchAllOff(uint32 homeid)
# // Configuration Parameters
bint SetConfigParam(uint32 homeid, uint8 nodeid, uint8 param, uint32 value)
void RequestConfigParam(uint32 homeid, uint8 nodeid, uint8 aram)
void RequestAllConfigParams(uint32 homeid, uint8 nodeid)
# // Groups
uint8 GetNumGroups(uint32 homeid, uint8 nodeid)
uint32 GetAssociations(uint32 homeid, uint8 nodeid, uint8 groupidx, uint8** o_associations)
uint8 GetMaxAssociations(uint32 homeid, uint8 nodeid, uint8 groupidx)
string GetGroupLabel(uint32 homeid, uint8 nodeid, uint8 groupidx)
void AddAssociation(uint32 homeid, uint8 nodeid, uint8 groupidx, uint8 targetnodeid)
void RemoveAssociation(uint32 homeid, uint8 nodeid, uint8 groupidx, uint8 targetnodeid)
bint AddWatcher(pfnOnNotification_t notification, void* context)
bint RemoveWatcher(pfnOnNotification_t notification, void* context)
# // Controller Commands
void ResetController(uint32 homeid)
void SoftReset(uint32 homeid)
#bint BeginControllerCommand(uint32 homeid, Driver::ControllerCommand _command, Driver::pfnControllerCallback_t _callback = NULL, void* _context = NULL, bool _highPower = false, uint8 _nodeId = 0xff )
bint CancelControllerCommand(uint32 homeid)
cdef extern from "Manager.h" namespace "OpenZWave::Manager":
Manager* Create()
Manager* Get()
cdef class PyOptions:
cdef Options *options
def create(self, char *a, char *b, char *c):
self.options = Create(string(a), string(b), string(c))
def lock(self):
return self.options.Lock()
class EnumWithDoc(str):
def setDoc(self, doc):
self.__doc__ = doc
return self
PyNotifications = [
EnumWithDoc('ValueAdded').setDoc("A new node value has been added to OpenZWave's list. These notifications occur after a node has been discovered, and details of its command classes have been received. Each command class may generate one or more values depending on the complexity of the item being represented."),
EnumWithDoc('ValueRemoved').setDoc(
"A node value has been removed from OpenZWave's list. This only occurs when a node is removed."),
EnumWithDoc('ValueChanged').setDoc(
"A node value has been updated from the Z-Wave network."),
EnumWithDoc('Group').setDoc(
"The associations for the node have changed. The application should rebuild any group information it holds about the node."),
EnumWithDoc('NodeNew').setDoc(
"A new node has been found (not already stored in zwcfg*.xml file)"),
EnumWithDoc('NodeAdded').setDoc(
"A new node has been added to OpenZWave's list. This may be due to a device being added to the Z-Wave network, or because the application is initializing itself."),
EnumWithDoc('NodeRemoved').setDoc(
"A node has been removed from OpenZWave's list. This may be due to a device being removed from the Z-Wave network, or because the application is closing."),
EnumWithDoc('NodeProtocolInfo').setDoc(
"Basic node information has been receievd, such as whether the node is a listening device, a routing device and its baud rate and basic, generic and specific types. It is after this notification that you can call Manager::GetNodeType to obtain a label containing the device description."),
EnumWithDoc('NodeNaming').setDoc(
"One of the node names has changed (name, manufacturer, product)."),
EnumWithDoc('NodeEvent').setDoc(
"A node has triggered an event. This is commonly caused when a node sends a Basic_Set command to the controller. The event value is stored in the notification."),
EnumWithDoc('PollingDisabled').setDoc(
"Polling of a node has been successfully turned off by a call to Manager::DisablePoll"),
EnumWithDoc('PollingEnabled').setDoc(
"Polling of a node has been successfully turned on by a call to Manager::EnablePoll"),
EnumWithDoc('DriverReady').setDoc(
"A driver for a PC Z-Wave controller has been added and is ready to use. The notification will contain the controller's Home ID, which is needed to call most of the Manager methods."),
EnumWithDoc('DriverFailed').setDoc(
"Driver failed to load"),
EnumWithDoc('DriverReset').setDoc(
"All nodes and values for this driver have been removed. This is sent instead of potentially hundreds of individual node and value notifications."),
EnumWithDoc('MsgComplete').setDoc(
"The last message that was sent is now complete."),
EnumWithDoc('EssentialNodeQueriesComplete').setDoc(
"The queries on a node that are essential to its operation have been completed. The node can now handle incoming messages."),
EnumWithDoc('NodeQueriesComplete').setDoc(
"All the initialisation queries on a node have been completed."),
EnumWithDoc('AwakeNodesQueried').setDoc(
"All awake nodes have been queried, so client application can expected complete data for these nodes."),
EnumWithDoc('AllNodesQueried').setDoc(
"All nodes have been queried, so client application can expected complete data."),
]
PyGenres = [
EnumWithDoc('Basic').setDoc( "The 'level' as controlled by basic commands. Usually duplicated by another command class."),
EnumWithDoc('User').setDoc( "Basic values an ordinary user would be interested in."),
EnumWithDoc('Config').setDoc( "Device-specific configuration parameters. These cannot be automatically discovered via Z-Wave, and are usually described in the user manual instead."),
EnumWithDoc('System').setDoc( "Values of significance only to users who understand the Z-Wave protocol"),
]
PyValueTypes = [
EnumWithDoc('Bool').setDoc( "Boolean, true or false"),
EnumWithDoc('Byte').setDoc( "8-bit unsigned value"),
EnumWithDoc('Decimal').setDoc( "Represents a non-integer value as a string, to avoid floating point accuracy issues."),
EnumWithDoc('Int').setDoc( "32-bit signed value"),
EnumWithDoc('List').setDoc( "List from which one item can be selected"),
EnumWithDoc('Schedule').setDoc( "Complex type used with the Climate Control Schedule command class"),
EnumWithDoc('Short').setDoc( "16-bit signed value"),
EnumWithDoc('String').setDoc( "Text string"),
EnumWithDoc('Button').setDoc( "A write-only value that is the equivalent of pressing a button to send a command to a device"),
]
cdef map[uint32, ValueID] values_map
cdef addValueId(ValueID v, n):
cdef string value
cdef string label
cdef string units
cdef Manager *manager = Get()
if PyValueTypes[v.GetType()] == "List":
manager.GetValueListSelection(v, &value)
else:
manager.GetValueAsString(v, &value)
label = manager.GetValueLabel(v)
units = manager.GetValueUnits(v)
n['valueId'] = {'homeId' : v.GetHomeId(),
'nodeId' : v.GetNodeId(),
'commandClass' : PyManager.COMMAND_CLASS_DESC[v.GetCommandClassId()],
'instance' : v.GetInstance(),
'index' : v.GetIndex(),
'id' : v.GetId(),
'genre' : PyGenres[v.GetGenre()],
'type' : PyValueTypes[v.GetType()],
'value' : value.c_str(),
'label' : label.c_str(),
'units' : units.c_str(),
'readOnly': manager.IsValueReadOnly(v),
}
values_map.insert ( pair[uint32, ValueID] (v.GetId(), v))
cdef void callback(const_notification _notification, void* _context) with gil:
cdef Notification* notification = <Notification*>_notification
n = {'notificationType' : PyNotifications[notification.GetType()],
'homeId' : notification.GetHomeId(),
'nodeId' : notification.GetNodeId(),
}
if notification.GetType() == Type_Group:
n['groupIdx'] = notification.GetGroupIdx()
if notification.GetType() == Type_NodeEvent:
n['event'] = notification.GetEvent()
addValueId(notification.GetValueID(), n)
(<object>_context)(n)
cdef class PyLog:
'''
Cross-platform message and error logging
'''
cdef Log *log
def create(self):
'Static creation of the singleton, call this method first'
Create()
def SetLoggingState(self, s):
'Set flag to actually write to log or skip it'
self.log.SetLoggingState(s)
return
def GetLoggingState(self):
'Return a flag to indicate whether logging is enabled'
return self.log.GetLoggingState()
def Write(self, _format):
'Write to the log'
self.log.Write(_format)
cdef class PyManager:
'''
The main public interface to OpenZWave.
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.
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.
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.
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.
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.
[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 listening or
sleeping) have been polled, an "AllNodesQueried" notification is sent.]
'''
COMMAND_CLASS_DESC = {
0x00: 'COMMAND_CLASS_NO_OPERATION',
0x20: 'COMMAND_CLASS_BASIC',
0x21: 'COMMAND_CLASS_CONTROLLER_REPLICATION',
0x22: 'COMMAND_CLASS_APPLICATION_STATUS',
0x23: 'COMMAND_CLASS_ZIP_SERVICES',
0x24: 'COMMAND_CLASS_ZIP_SERVER',
0x25: 'COMMAND_CLASS_SWITCH_BINARY',
0x26: 'COMMAND_CLASS_SWITCH_MULTILEVEL',
0x27: 'COMMAND_CLASS_SWITCH_ALL',
0x28: 'COMMAND_CLASS_SWITCH_TOGGLE_BINARY',
0x29: 'COMMAND_CLASS_SWITCH_TOGGLE_MULTILEVEL',
0x2A: 'COMMAND_CLASS_CHIMNEY_FAN',
0x2B: 'COMMAND_CLASS_SCENE_ACTIVATION',
0x2C: 'COMMAND_CLASS_SCENE_ACTUATOR_CONF',
0x2D: 'COMMAND_CLASS_SCENE_CONTROLLER_CONF',
0x2E: 'COMMAND_CLASS_ZIP_CLIENT',
0x2F: 'COMMAND_CLASS_ZIP_ADV_SERVICES',
0x30: 'COMMAND_CLASS_SENSOR_BINARY',
0x31: 'COMMAND_CLASS_SENSOR_MULTILEVEL',
0x32: 'COMMAND_CLASS_METER',
0x33: 'COMMAND_CLASS_ZIP_ADV_SERVER',
0x34: 'COMMAND_CLASS_ZIP_ADV_CLIENT',
0x35: 'COMMAND_CLASS_METER_PULSE',
0x3C: 'COMMAND_CLASS_METER_TBL_CONFIG',
0x3D: 'COMMAND_CLASS_METER_TBL_MONITOR',
0x3E: 'COMMAND_CLASS_METER_TBL_PUSH',
0x38: 'COMMAND_CLASS_THERMOSTAT_HEATING',
0x40: 'COMMAND_CLASS_THERMOSTAT_MODE',
0x42: 'COMMAND_CLASS_THERMOSTAT_OPERATING_STATE',
0x43: 'COMMAND_CLASS_THERMOSTAT_SETPOINT',
0x44: 'COMMAND_CLASS_THERMOSTAT_FAN_MODE',
0x45: 'COMMAND_CLASS_THERMOSTAT_FAN_STATE',
0x46: 'COMMAND_CLASS_CLIMATE_CONTROL_SCHEDULE',
0x47: 'COMMAND_CLASS_THERMOSTAT_SETBACK',
0x4c: 'COMMAND_CLASS_DOOR_LOCK_LOGGING',
0x4E: 'COMMAND_CLASS_SCHEDULE_ENTRY_LOCK',
0x50: 'COMMAND_CLASS_BASIC_WINDOW_COVERING',
0x51: 'COMMAND_CLASS_MTP_WINDOW_COVERING',
0x60: 'COMMAND_CLASS_MULTI_CHANNEL_V2',
0x62: 'COMMAND_CLASS_DOOR_LOCK',
0x63: 'COMMAND_CLASS_USER_CODE',
0x70: 'COMMAND_CLASS_CONFIGURATION',
0x71: 'COMMAND_CLASS_ALARM',
0x72: 'COMMAND_CLASS_MANUFACTURER_SPECIFIC',
0x73: 'COMMAND_CLASS_POWERLEVEL',
0x75: 'COMMAND_CLASS_PROTECTION',
0x76: 'COMMAND_CLASS_LOCK',
0x77: 'COMMAND_CLASS_NODE_NAMING',
0x7A: 'COMMAND_CLASS_FIRMWARE_UPDATE_MD',
0x7B: 'COMMAND_CLASS_GROUPING_NAME',
0x7C: 'COMMAND_CLASS_REMOTE_ASSOCIATION_ACTIVATE',
0x7D: 'COMMAND_CLASS_REMOTE_ASSOCIATION',
0x80: 'COMMAND_CLASS_BATTERY',
0x81: 'COMMAND_CLASS_CLOCK',
0x82: 'COMMAND_CLASS_HAIL',
0x84: 'COMMAND_CLASS_WAKE_UP',
0x85: 'COMMAND_CLASS_ASSOCIATION',
0x86: 'COMMAND_CLASS_VERSION',
0x87: 'COMMAND_CLASS_INDICATOR',
0x88: 'COMMAND_CLASS_PROPRIETARY',
0x89: 'COMMAND_CLASS_LANGUAGE',
0x8A: 'COMMAND_CLASS_TIME',
0x8B: 'COMMAND_CLASS_TIME_PARAMETERS',
0x8C: 'COMMAND_CLASS_GEOGRAPHIC_LOCATION',
0x8D: 'COMMAND_CLASS_COMPOSITE',
0x8E: 'COMMAND_CLASS_MULTI_INSTANCE_ASSOCIATION',
0x8F: 'COMMAND_CLASS_MULTI_CMD',
0x90: 'COMMAND_CLASS_ENERGY_PRODUCTION',
0x91: 'COMMAND_CLASS_MANUFACTURER_PROPRIETARY',
0x92: 'COMMAND_CLASS_SCREEN_MD',
0x93: 'COMMAND_CLASS_SCREEN_ATTRIBUTES',
0x94: 'COMMAND_CLASS_SIMPLE_AV_CONTROL',
0x95: 'COMMAND_CLASS_AV_CONTENT_DIRECTORY_MD',
0x96: 'COMMAND_CLASS_AV_RENDERER_STATUS',
0x97: 'COMMAND_CLASS_AV_CONTENT_SEARCH_MD',
0x98: 'COMMAND_CLASS_SECURITY',
0x99: 'COMMAND_CLASS_AV_TAGGING_MD',
0x9A: 'COMMAND_CLASS_IP_CONFIGURATION',
0x9B: 'COMMAND_CLASS_ASSOCIATION_COMMAND_CONFIGURATION',
0x9C: 'COMMAND_CLASS_SENSOR_ALARM',
0x9D: 'COMMAND_CLASS_SILENCE_ALARM',
0x9E: 'COMMAND_CLASS_SENSOR_CONFIGURATION',
0xEF: 'COMMAND_CLASS_MARK',
0xF0: 'COMMAND_CLASS_NON_INTEROPERABLE'
}
CALLBACK_DESC = ('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')
cdef Manager *manager
cdef object _watcherCallback
def create(self):
'''
Creates the Manager singleton object.
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.
@param options a locked Options object containing all the application's
configurable option values.
@return a pointer to the newly created Manager object, or NULL if creation
failed.
@see options, get, addWatcher, addDriver
'''
self.manager = Create()
PyEval_InitThreads()
#
# -----------------------------------------------------------------------------
# Configuration
# -----------------------------------------------------------------------------
# For saving the Z-Wave network configuration so that the entire network does not need to be
# polled every time the application starts.
#
def writeConfig(self, homeid):
'''
Saves the configuration of a PC Controller's Z-Wave network to the
application's user data folder.
This method does not normally need to be called, since OpenZWave will save the
state automatically during the shutdown process. It is provided here only as
an aid to development. The configuration of each PC Controller's Z-Wave network
is stored in a separate file. The filename consists of the 8 digit hexadecimal
version of the controller's Home ID, prefixed with the string 'zwcfg_'. This
convention allows OpenZWave to find the correct configuration file for a
controller, even if it is attached to a different serial port, USB device path,
etc.
@param homeId The Home ID of the Z-Wave controller to save.
'''
self.manager.WriteConfig(homeid)
#
# -----------------------------------------------------------------------------
# Drivers
# -----------------------------------------------------------------------------
# Methods for adding and removing drivers and obtaining basic controller information.
#
def addDriver(self, char *serialport):
'''
Creates a new driver for a Z-Wave controller.
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 list 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.
@param controllerPath The string used to open the controller. On Windows this
might be something like "\\.\\COM3", or on Linux "/dev/ttyUSB0".
@return True if a new driver was created
@see RemoveDriver
'''
self.manager.AddDriver(string(serialport))
def removeDriver(self, char *serialport):
'''
Removes the driver for a Z-Wave controller, and closes the controller.
Drivers do not need to be explicitly removed before calling Destroy - this is
handled automatically.
@param controllerPath The same string as was passed in the original call to
AddDriver.
@return True if the driver was removed, False if it could not be found.
@see AddDriver
'''
self.manager.RemoveDriver(string(serialport))
def getControllerNodeId(self, homeid):
'''
Get the node ID of the Z-Wave controller.
@param homeId The Home ID of the Z-Wave controller.
@return the node ID of the Z-Wave controller
'''
return self.manager.GetControllerNodeId(homeid)
def isPrimaryController(self, homeid):
'''
Query if the controller is a primary controller.
The primary controller is the main device used to configure and control a
Z-Wave network. There can only be one primary controller - all other
controllers are secondary controllers.
The only difference between a primary and secondary controller is that the
primary is the only one that can be used to add or remove other devices. For
this reason, it is usually better for the promary controller to be portable,
since most devices must be added when installed in their final location.
Calls to BeginControllerCommand will fail if the controller is not the primary.
@param homeId The Home ID of the Z-Wave controller.
@return True if it is a primary controller, False if not.
'''
return self.manager.IsPrimaryController(homeid)
def isStaticUpdateController(self, homeid):
'''
Query if the controller is a static update controller (SUC).
A Static Update Controller (SUC) is a controller that must never be moved in
normal operation and which can be used by other nodes to receive information
about network changes.
@param homeId The Home ID of the Z-Wave controller.
@return True if it is a static update controller, False if not.
'''
return self.manager.IsStaticUpdateController(homeid)
def isBridgeController(self, homeid):
'''
Query if the controller is using the bridge controller library.
A bridge controller is able to create virtual nodes that can be associated
with other controllers to enable events to be passed on.
@param homeId The Home ID of the Z-Wave controller.
@return True if it is a bridge controller, False if not.
'''
return self.manager.IsBridgeController(homeid)
def getLibraryVersion(self, homeid):
'''
Get the version of the Z-Wave API library used by a controller.
@param _homeId The Home ID of the Z-Wave controller.
@return a string containing the library version. For example, "Z-Wave 2.48".
'''
cdef string c_string = self.manager.GetLibraryVersion(homeid)
return c_string.c_str()
def getLibraryTypeName(self, homeid):
'''
Get a string containing the Z-Wave API library type used by a controller.
The possible library types are:
- Static Controller
- Controller
- Enhanced Slave
- Slave
- Installer
- Routing Slave
- Bridge Controller
- Device Under Test
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.
@param homeId The Home ID of the Z-Wave controller.
@return a string containing the library type.
@see GetLibraryVersion, IsBridgeController
'''
cdef string c_string = self.manager.GetLibraryTypeName(homeid)
return c_string.c_str()
#
# -----------------------------------------------------------------------------
# Polling Z-Wave devices
# -----------------------------------------------------------------------------
# Methods for controlling the polling of Z-Wave devices. Modern devices will
# not require polling. Some old devices need to be polled as the only way to
# detect status changes.
#
def getPollInterval(self):
'''Get the time period between polls of a nodes state'''
return self.manager.GetPollInterval()
def setPollInterval(self, seconds):
'''
Set the time period between polls of a nodes state.
Due to patent concerns, some devices do not report state changes automatically
to the controller. These devices need to have their state polled at regular
intervals. The length of the interval is the same for all devices. To even
out the Z-Wave network traffic generated by polling, OpenZWave divides the
polling interval by the number of devices that have polling enabled, and polls
each in turn. It is recommended that if possible, the interval should not be
set shorter than the number of polled devices in seconds (so that the network
does not have to cope with more than one poll per second).
@param seconds The length of the polling interval in seconds.
'''
self.manager.SetPollInterval(seconds)
# bint EnablePoll(ValueID& valueId)
# bint DisablePoll(ValueID& valueId)
# bint isPolled(ValueID& valueId)
#
# -----------------------------------------------------------------------------
# Node information
# -----------------------------------------------------------------------------
# Methods for accessing information on indivdual nodes.
#
def refreshNodeInfo(self, homeid, nodeid):
'''
Trigger the fetching of fixed data about a node.
Causes the nodes data to be obtained from the Z-Wave network in the same way
as if it had just been added. This method would normally be called
automatically by OpenZWave, but if you know that a node has been changed,
calling this method will force a refresh of the data held by the library. This
can be especially useful for devices that were asleep when the application was
first run.
@param homeId The Home ID of the Z-Wave controller that manages the node.
@param nodeId The ID of the node to query.
@return True if the request was sent successfully.
'''
return self.manager.RefreshNodeInfo(homeid, nodeid)
def requestNodeState(self, homeid, nodeid):
'''
Trigger the fetching of dynamic value data for a node.
Causes the nodes values to be requested from the Z-Wave network.
@param homeId The Home ID of the Z-Wave controller that manages the node.
@param nodeId The ID of the node to query.
'''
self.manager.RequestNodeState(homeid, nodeid)
def isNodeListeningDevice(self, homeid, nodeid):
'''
Get whether the node is a listening device that does not go to sleep
@param homeId The Home ID of the Z-Wave controller that manages the node.
@param nodeId The ID of the node to query.
@return True if it is a listening node.
'''
return self.manager.IsNodeListeningDevice(homeid, nodeid)
def isNodeRoutingDevice(self, homeid, nodeid):
'''
Get whether the node is a routing device that passes messages to other nodes
@param homeId The Home ID of the Z-Wave controller that manages the node.
@param nodeId The ID of the node to query.
@return True if the node is a routing device
'''
return self.manager.IsNodeRoutingDevice(homeid, nodeid)
def getNodeMaxBaudRate(self, homeid, nodeid):
'''
Get the maximum baud rate of a nodes communications
@param homeId The Home ID of the Z-Wave controller that manages the node.
@param nodeId The ID of the node to query.
@return the baud rate in bits per second.
'''
return self.manager.GetNodeMaxBaudRate(homeid, nodeid)
def getNodeVersion(self, homeid, nodeid):
'''
Get the version number of a node
@param homeId The Home ID of the Z-Wave controller that manages the node.
@param nodeId The ID of the node to query.
@return the node version number
'''
return self.manager.GetNodeVersion(homeid, nodeid)
def getNodeSecurity(self, homeid, nodeid):
'''
Get the security byte for a node. Bit meanings are still to be determined.
@param homeId The Home ID of the Z-Wave controller that manages the node.
@param nodeId The ID of the node to query.
@return the node security byte
'''
return self.manager.GetNodeSecurity(homeid, nodeid)
def getNodeBasic(self, homeid, nodeid):
'''
Get the basic type of a node.
@param homeId The Home ID of the Z-Wave controller that manages the node.
@param nodeId The ID of the node to query.
@return the node basic type.
'''
return self.manager.GetNodeBasic(homeid, nodeid)
def getNodeGeneric(self, homeid, nodeid):
'''
Get the generic type of a node.
@param homeId The Home ID of the Z-Wave controller that manages the node.
@param nodeId The ID of the node to query.
@return the node generic type.
'''
return self.manager.GetNodeGeneric(homeid, nodeid)
def getNodeSpecific(self, homeid, nodeid):
'''
Get the specific type of a node.
@param homeId The Home ID of the Z-Wave controller that manages the node.
@param nodeId The ID of the node to query.
@return the node specific type.
'''
return self.manager.GetNodeSpecific(homeid, nodeid)
def getNodeType(self, homeid, nodeid):
'''
Get a human-readable label describing the node
The label is taken from the Z-Wave specific, generic or basic type, depending
on which of those values are specified by the node.
@param homeId The Home ID of the Z-Wave controller that manages the node.
@param nodeId The ID of the node to query.
@return A string containing the label text.
'''
cdef string c_string = self.manager.GetNodeType(homeid, nodeid)
return c_string.c_str()
def getNodeNeighbors(self, homeid, nodeid):
'''
Retrieve a list of neighbor node ids
@param homeId The Home ID of the Z-Wave controller that manages the node.
@param nodeId The ID of the node to query.
@return A tuple containing neighboring node IDs
'''
retval = None
# TODO: proper initialization of this pointer. Underlying code creates new uint8[] at this address, but segfaults if passed in value is null. Boy, is my C rusty.
cdef uint8** dbuf = <uint8**>malloc(sizeof(uint8))
# return value is pointer to uint8[]
cdef uint32 count = self.manager.GetNodeNeighbors(homeid, nodeid, dbuf)
cdef uint8* p
if count:
try:
data = set()
p = dbuf[0] # p is now pointing at first element of array
for i in range(0, count):
data.add(p[0])
p += 1
retval = tuple(data)
finally:
# TODO: caller is responsible for deleting returned array via call to delete()
pass
return retval
def getNodeManufacturerName(self, homeid, nodeid):
'''
Get the manufacturer name of a device
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.
@param homeId The Home ID of the Z-Wave controller that manages the node.
@param nodeId The ID of the node to query.
@return A string containing the nodes manufacturer name.
@see setNodeManufacturerName, getNodeProductName, setNodeProductName
'''
cdef string manufacturer_string = self.manager.GetNodeManufacturerName(homeid, nodeid)
return manufacturer_string.c_str()
def getNodeProductName(self, homeid, nodeid):
'''
Get the product name of a device
The product name would normally be handled by the Manufacturer Specific
commmand class, taking the product Type and 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.
@param homeId The Home ID of the Z-Wave controller that manages the node.
@param nodeId The ID of the node to query.
@return A string containing the nodes product name.
@see setNodeProductName, getNodeManufacturerName, setNodeManufacturerName
'''
cdef string productname_string = self.manager.GetNodeProductName(homeid, nodeid)
return productname_string.c_str()
def getNodeName(self, homeid, nodeid):
'''
Get the name of a node
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.
@param homeId The Home ID of the Z-Wave controller that manages the node.
@param nodeId The ID of the node to query.
@return A string containing the node name.
@see setNodeName, getNodeLocation, setNodeLocation
'''
cdef string c_string = self.manager.GetNodeName(homeid, nodeid)
return c_string.c_str()
def getNodeLocation(self, homeid, nodeid):
'''
Get the location of a node
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.
@param homeId The Home ID of the Z-Wave controller that manages the node.
@param nodeId The ID of the node to query.
@return A string containing the nodes location.
@see setNodeLocation, getNodeName, setNodeName
'''
cdef string c_string = self.manager.GetNodeLocation(homeid, nodeid)
return c_string.c_str()
def getNodeManufacturerId(self, homeid, nodeid):
'''
Get the manufacturer ID of a device
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.
@param homeId The Home ID of the Z-Wave controller that manages the node.
@param nodeId The ID of the node to query.
@return A string containing the nodes manufacturer ID, or an empty string if
the manufactuer-specific command class is not supported by the device.
@see getNodeProductType, getNodeProductId, getNodeManufacturerName,
getNodeProductName
'''
cdef string c_string = self.manager.GetNodeManufacturerId(homeid, nodeid)
return c_string.c_str()
def getNodeProductType(self, homeid, nodeid):
'''
Get the product type of a device
The product type 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 product type 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.
@param homeId The Home ID of the Z-Wave controller that manages the node.
@param nodeId The ID of the node to query.
@return A string containing the nodes product type, or an empty string if the
manufactuer-specific command class is not supported by the device.
@see getNodeManufacturerId, getNodeProductId, getNodeManufacturerName,
getNodeProductName
'''
cdef string c_string = self.manager.GetNodeProductType(homeid, nodeid)
return c_string.c_str()
def getNodeProductId(self, homeid, nodeid):
'''
Get the product ID of a device
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
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 product 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.