forked from project-chip/connectedhomeip
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathDoorLock.xml
2078 lines (2071 loc) · 82.5 KB
/
DoorLock.xml
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
<?xml version="1.0"?>
<!--
Copyright (C) Connectivity Standards Alliance (2021). All rights reserved.
The information within this document is the property of the Connectivity
Standards Alliance and its use and disclosure are restricted, except as
expressly set forth herein.
Connectivity Standards Alliance hereby grants you a fully-paid, non-exclusive,
nontransferable, worldwide, limited and revocable license (without the right to
sublicense), under Connectivity Standards Alliance's applicable copyright
rights, to view, download, save, reproduce and use the document solely for your
own internal purposes and in accordance with the terms of the license set forth
herein. This license does not authorize you to, and you expressly warrant that
you shall not: (a) permit others (outside your organization) to use this
document; (b) post or publish this document; (c) modify, adapt, translate, or
otherwise change this document in any manner or create any derivative work
based on this document; (d) remove or modify any notice or label on this
document, including this Copyright Notice, License and Disclaimer. The
Connectivity Standards Alliance does not grant you any license hereunder other
than as expressly stated herein.
Elements of this document may be subject to third party intellectual property
rights, including without limitation, patent, copyright or trademark rights,
and any such third party may or may not be a member of the Connectivity
Standards Alliance. Connectivity Standards Alliance members grant other
Connectivity Standards Alliance members certain intellectual property rights as
set forth in the Connectivity Standards Alliance IPR Policy. Connectivity
Standards Alliance members do not grant you any rights under this license. The
Connectivity Standards Alliance is not responsible for, and shall not be held
responsible in any manner for, identifying or failing to identify any or all
such third party intellectual property rights. Please visit www.csa-iot.org for
more information on how to become a member of the Connectivity Standards
Alliance.
This document and the information contained herein are provided on an “AS IS”
basis and the Connectivity Standards Alliance DISCLAIMS ALL WARRANTIES EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO (A) ANY WARRANTY THAT THE USE OF THE
INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OF THIRD PARTIES (INCLUDING
WITHOUT LIMITATION ANY INTELLECTUAL PROPERTY RIGHTS INCLUDING PATENT, COPYRIGHT
OR TRADEMARK RIGHTS); OR (B) ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE, TITLE OR NONINFRINGEMENT. IN NO EVENT WILL THE
CONNECTIVITY STANDARDS ALLIANCE BE LIABLE FOR ANY LOSS OF PROFITS, LOSS OF
BUSINESS, LOSS OF USE OF DATA, INTERRUPTION OF BUSINESS, OR FOR ANY OTHER
DIRECT, INDIRECT, SPECIAL OR EXEMPLARY, INCIDENTAL, PUNITIVE OR CONSEQUENTIAL
DAMAGES OF ANY KIND, IN CONTRACT OR IN TORT, IN CONNECTION WITH THIS DOCUMENT
OR THE INFORMATION CONTAINED HEREIN, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
LOSS OR DAMAGE.
All company, brand and product names in this document may be trademarks that
are the sole property of their respective owners.
This notice and disclaimer must be included on all copies of this document.
Connectivity Standards Alliance
508 Second Street, Suite 206
Davis, CA 95616, USA
:xrefstyle: basic
-->
<cluster xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="types types.xsd cluster cluster.xsd" id="0x0101" name="Door Lock Cluster" revision="7">
<revisionHistory>
<revision revision="1" summary="Mandatory global ClusterRevision attribute added; CCB 1811 1812 1821"/>
<revision revision="2" summary="CCB 2430"/>
<revision revision="3" summary="CCB 2629 2630"/>
<revision revision="4" summary="All Hubs changes and added feature map"/>
<revision revision="5"/>
<revision revision="6" summary="New data model format and notation. Added User features. General cleanup of functionality"/>
<revision revision="7" summary="Added support for European door locks (unbolt feature)"/>
</revisionHistory>
<clusterIds>
<clusterId id="0x0101" name="Door Lock"/>
</clusterIds>
<classification hierarchy="base" role="application" picsCode="DRLK" scope="Endpoint"/>
<features>
<feature bit="0" code="PIN" name="PINCredential" summary="Lock supports PIN credentials (via keypad, or over-the-air)">
<optionalConform/>
</feature>
<feature bit="1" code="RID" name="RFIDCredential" summary="Lock supports RFID credentials">
<optionalConform/>
</feature>
<feature bit="2" code="FGP" name="FingerCredentials" summary="Lock supports finger related credentials (fingerprint, finger vein)">
<otherwiseConform>
<provisionalConform/>
<optionalConform/>
</otherwiseConform>
</feature>
<feature bit="3" code="LOG" name="Logging" summary="Lock supports local/on-lock logging when Events are not supported">
<optionalConform/>
</feature>
<feature bit="4" code="WDSCH" name="WeekDayAccessSchedules" summary="Lock supports week day user access schedules">
<optionalConform/>
</feature>
<feature bit="5" code="DPS" name="DoorPositionSensor" summary="Lock supports a door position sensor that indicates door's state">
<optionalConform/>
</feature>
<feature bit="6" code="FACE" name="FaceCredentials" summary="Lock supports face related credentials (face, iris, retina)">
<otherwiseConform>
<provisionalConform/>
<optionalConform/>
</otherwiseConform>
</feature>
<feature bit="7" code="COTA" name="CredentialOverTheAirAccess" summary="PIN codes over-the-air supported for lock/unlock operations">
<optionalConform/>
</feature>
<feature bit="8" code="USR" name="User" summary="Lock supports the user commands and database">
<optionalConform>
<orTerm>
<feature name="PIN"/>
<feature name="RID"/>
<feature name="FGP"/>
<feature name="FACE"/>
</orTerm>
</optionalConform>
</feature>
<feature bit="9" code="NOT" name="Notification" summary="Operation and Programming Notifications">
<optionalConform/>
</feature>
<feature bit="10" code="YDSCH" name="YearDayAccessSchedules" summary="Lock supports year day user access schedules">
<optionalConform/>
</feature>
<feature bit="11" code="HDSCH" name="HolidaySchedules" summary="Lock supports holiday schedules">
<optionalConform/>
</feature>
<feature bit="12" code="UBOLT" name="Unbolting" summary="Lock supports unbolting">
<optionalConform/>
</feature>
</features>
<dataTypes>
<enum name="AlarmCodeEnum">
<item value="0" name="LockJammed" summary="Locking Mechanism Jammed">
<mandatoryConform/>
</item>
<item value="1" name="LockFactoryReset" summary="Lock Reset to Factory Defaults">
<optionalConform/>
</item>
<item value="3" name="LockRadioPowerCycled" summary="Lock Radio Power Cycled">
<optionalConform/>
</item>
<item value="4" name="WrongCodeEntryLimit" summary="Tamper Alarm - wrong code entry limit">
<optionalConform>
<feature name="USR"/>
</optionalConform>
</item>
<item value="5" name="FrontEsceutcheonRemoved" summary="Tamper Alarm - front escutcheon removed from main">
<optionalConform/>
</item>
<item value="6" name="DoorForcedOpen" summary="Forced Door Open under Door Locked Condition">
<optionalConform>
<feature name="DPS"/>
</optionalConform>
</item>
<item value="7" name="DoorAjar" summary="Door ajar">
<optionalConform>
<feature name="DPS"/>
</optionalConform>
</item>
<item value="8" name="ForcedUser" summary="Force User SOS alarm">
<optionalConform>
<feature name="USR"/>
</optionalConform>
</item>
</enum>
<enum name="CredentialRuleEnum">
<item value="0" name="Single" summary="Only one credential is required for lock operation">
<mandatoryConform>
<feature name="USR"/>
</mandatoryConform>
</item>
<item value="1" name="Dual" summary="Any two credentials are required for lock operation">
<optionalConform>
<feature name="USR"/>
</optionalConform>
</item>
<item value="2" name="Tri" summary="Any three credentials are required for lock operation">
<optionalConform>
<feature name="USR"/>
</optionalConform>
</item>
</enum>
<enum name="CredentialTypeEnum">
<item value="0" name="ProgrammingPIN" summary="Programming PIN code credential type">
<optionalConform/>
</item>
<item value="1" name="PIN" summary="PIN code credential type">
<mandatoryConform>
<feature name="PIN"/>
</mandatoryConform>
</item>
<item value="2" name="RFID" summary="RFID identifier credential type">
<mandatoryConform>
<feature name="RID"/>
</mandatoryConform>
</item>
<item value="3" name="Fingerprint" summary="Fingerprint identifier credential type">
<mandatoryConform>
<feature name="FGP"/>
</mandatoryConform>
</item>
<item value="4" name="FingerVein" summary="Finger vein identifier credential type">
<mandatoryConform>
<feature name="FGP"/>
</mandatoryConform>
</item>
<item value="5" name="Face" summary="Face identifier credential type">
<mandatoryConform>
<feature name="FACE"/>
</mandatoryConform>
</item>
</enum>
<enum name="DataOperationTypeEnum">
<item value="0" name="Add" summary="Data is being added or was added">
<mandatoryConform/>
</item>
<item value="1" name="Clear" summary="Data is being cleared or was cleared">
<mandatoryConform/>
</item>
<item value="2" name="Modify" summary="Data is being modified or was modified">
<mandatoryConform/>
</item>
</enum>
<enum name="DoorStateEnum">
<item value="0" name="DoorOpen" summary="Door state is open">
<mandatoryConform>
<feature name="DPS"/>
</mandatoryConform>
</item>
<item value="1" name="DoorClosed" summary="Door state is closed">
<mandatoryConform>
<feature name="DPS"/>
</mandatoryConform>
</item>
<item value="2" name="DoorJammed" summary="Door state is jammed">
<optionalConform>
<feature name="DPS"/>
</optionalConform>
</item>
<item value="3" name="DoorForcedOpen" summary="Door state is currently forced open">
<optionalConform>
<feature name="DPS"/>
</optionalConform>
</item>
<item value="4" name="DoorUnspecifiedError" summary="Door state is invalid for unspecified reason">
<optionalConform>
<feature name="DPS"/>
</optionalConform>
</item>
<item value="5" name="DoorAjar" summary="Door state is ajar">
<optionalConform>
<feature name="DPS"/>
</optionalConform>
</item>
</enum>
<enum name="EventSourceEnum">
<item value="0" name="Keypad" summary="Event source is keypad">
<mandatoryConform/>
</item>
<item value="1" name="Remote" summary="Event source is remote">
<mandatoryConform/>
</item>
<item value="2" name="Manual" summary="Event source is manual">
<mandatoryConform/>
</item>
<item value="3" name="RFID" summary="Event source is RFID">
<mandatoryConform/>
</item>
<item value="255" name="Indeterminate" summary="Event source is unknown">
<mandatoryConform/>
</item>
</enum>
<enum name="EventTypeEnum">
<item value="0" name="Operation" summary="Event type is operation">
<mandatoryConform/>
</item>
<item value="1" name="Programming" summary="Event type is programming">
<mandatoryConform/>
</item>
<item value="2" name="Alarm" summary="Event type is alarm">
<mandatoryConform/>
</item>
</enum>
<enum name="LEDSettingEnum">
<item value="0" name="NoLEDSignal" summary="Never use LED for signalization">
<mandatoryConform/>
</item>
<item value="1" name="NoLEDSignalAccessAllowed" summary="Use LED signalization except for access allowed events">
<mandatoryConform/>
</item>
<item value="2" name="LEDSignalAll" summary="Use LED signalization for all events">
<mandatoryConform/>
</item>
</enum>
<enum name="LockDataTypeEnum">
<item value="0" name="Unspecified" summary="Unspecified or manufacturer specific lock user data added, cleared, or modified.">
<optionalConform/>
</item>
<item value="1" name="ProgrammingCode" summary="Lock programming PIN code was added, cleared, or modified.">
<optionalConform/>
</item>
<item value="2" name="UserIndex" summary="Lock user index was added, cleared, or modified.">
<mandatoryConform/>
</item>
<item value="3" name="WeekDaySchedule" summary="Lock user week day schedule was added, cleared, or modified.">
<mandatoryConform>
<feature name="WDSCH"/>
</mandatoryConform>
</item>
<item value="4" name="YearDaySchedule" summary="Lock user year day schedule was added, cleared, or modified.">
<mandatoryConform>
<feature name="YDSCH"/>
</mandatoryConform>
</item>
<item value="5" name="HolidaySchedule" summary="Lock holiday schedule was added, cleared, or modified.">
<mandatoryConform>
<feature name="HDSCH"/>
</mandatoryConform>
</item>
<item value="6" name="PIN" summary="Lock user PIN code was added, cleared, or modified.">
<mandatoryConform>
<feature name="PIN"/>
</mandatoryConform>
</item>
<item value="7" name="RFID" summary="Lock user RFID code was added, cleared, or modified.">
<mandatoryConform>
<feature name="RID"/>
</mandatoryConform>
</item>
<item value="8" name="Fingerprint" summary="Lock user fingerprint was added, cleared, or modified.">
<mandatoryConform>
<feature name="FGP"/>
</mandatoryConform>
</item>
<item value="9" name="FingerVein" summary="Lock user finger-vein information was added, cleared, or modified.">
<mandatoryConform>
<feature name="FGP"/>
</mandatoryConform>
</item>
<item value="10" name="Face" summary="Lock user face information was added, cleared, or modified.">
<mandatoryConform>
<feature name="FACE"/>
</mandatoryConform>
</item>
</enum>
<enum name="LockOperationTypeEnum">
<item value="0" name="Lock" summary="Lock operation">
<mandatoryConform/>
</item>
<item value="1" name="Unlock" summary="Unlock operation">
<mandatoryConform/>
</item>
<item value="2" name="NonAccessUserEvent" summary="Triggered by keypad entry for user with User Type set to Non Access User">
<optionalConform/>
</item>
<item value="3" name="ForcedUserEvent" summary="Triggered by using a user with UserType set to Forced User">
<optionalConform/>
</item>
<item value="4" name="Unlatch" summary="Unlatch operation">
<mandatoryConform/>
</item>
</enum>
<enum name="LockStateEnum">
<item value="0" name="NotFullyLocked" summary="Lock state is not fully locked">
<mandatoryConform/>
</item>
<item value="1" name="Locked" summary="Lock state is fully locked">
<mandatoryConform/>
</item>
<item value="2" name="Unlocked" summary="Lock state is fully unlocked">
<mandatoryConform/>
</item>
<item value="3" name="Unlatched" summary="Lock state is fully unlocked and the latch is pulled">
<optionalConform/>
</item>
</enum>
<enum name="LockTypeEnum">
<item value="0" name="DeadBolt" summary="Physical lock type is dead bolt">
<mandatoryConform/>
</item>
<item value="1" name="Magnetic" summary="Physical lock type is magnetic">
<mandatoryConform/>
</item>
<item value="2" name="Other" summary="Physical lock type is other">
<mandatoryConform/>
</item>
<item value="3" name="Mortise" summary="Physical lock type is mortise">
<mandatoryConform/>
</item>
<item value="4" name="Rim" summary="Physical lock type is rim">
<mandatoryConform/>
</item>
<item value="5" name="LatchBolt" summary="Physical lock type is latch bolt">
<mandatoryConform/>
</item>
<item value="6" name="CylindricalLock" summary="Physical lock type is cylindrical lock">
<mandatoryConform/>
</item>
<item value="7" name="TubularLock" summary="Physical lock type is tubular lock">
<mandatoryConform/>
</item>
<item value="8" name="InterconnectedLock" summary="Physical lock type is interconnected lock">
<mandatoryConform/>
</item>
<item value="9" name="DeadLatch" summary="Physical lock type is dead latch">
<mandatoryConform/>
</item>
<item value="10" name="DoorFurniture" summary="Physical lock type is door furniture">
<mandatoryConform/>
</item>
<item value="11" name="Eurocylinder" summary="Physical lock type is euro cylinder">
<mandatoryConform/>
</item>
</enum>
<enum name="OperatingModeEnum">
<item value="0" name="Normal">
<mandatoryConform/>
</item>
<item value="1" name="Vacation">
<optionalConform/>
</item>
<item value="2" name="Privacy">
<optionalConform/>
</item>
<item value="3" name="NoRemoteLockUnlock">
<mandatoryConform/>
</item>
<item value="4" name="Passage">
<optionalConform/>
</item>
</enum>
<enum name="OperationErrorEnum">
<item value="0" name="Unspecified" summary="Lock/unlock error caused by unknown or unspecified source">
<optionalConform/>
</item>
<item value="1" name="InvalidCredential" summary="Lock/unlock error caused by invalid PIN, RFID, fingerprint or other credential">
<mandatoryConform>
<feature name="USR"/>
</mandatoryConform>
</item>
<item value="2" name="DisabledUserDenied" summary="Lock/unlock error caused by disabled USER or credential">
<mandatoryConform/>
</item>
<item value="3" name="Restricted" summary="Lock/unlock error caused by schedule restriction">
<mandatoryConform>
<orTerm>
<feature name="WDSCH"/>
<feature name="YDSCH"/>
</orTerm>
</mandatoryConform>
</item>
<item value="4" name="InsufficientBattery" summary="Lock/unlock error caused by insufficient battery power left to safely actuate the lock">
<optionalConform/>
</item>
</enum>
<enum name="OperationSourceEnum">
<item value="0" name="Unspecified" summary="Lock/unlock operation came from unspecified source">
<optionalConform/>
</item>
<item value="1" name="Manual" summary="Lock/unlock operation came from manual operation (key, thumbturn, handle, etc).">
<optionalConform/>
</item>
<item value="2" name="ProprietaryRemote" summary="Lock/unlock operation came from proprietary remote source (e.g. vendor app/cloud)">
<optionalConform/>
</item>
<item value="3" name="Keypad" summary="Lock/unlock operation came from keypad">
<optionalConform/>
</item>
<item value="4" name="Auto" summary="Lock/unlock operation came from lock automatically (e.g. relock timer)">
<optionalConform/>
</item>
<item value="5" name="Button" summary="Lock/unlock operation came from lock button (e.g. one touch or button)">
<optionalConform/>
</item>
<item value="6" name="Schedule" summary="Lock/unlock operation came from lock due to a schedule">
<mandatoryConform>
<feature name="HDSCH"/>
</mandatoryConform>
</item>
<item value="7" name="Remote" summary="Lock/unlock operation came from remote node">
<mandatoryConform/>
</item>
<item value="8" name="RFID" summary="Lock/unlock operation came from RFID card">
<mandatoryConform>
<feature name="RID"/>
</mandatoryConform>
</item>
<item value="9" name="Biometric" summary="Lock/unlock operation came from biometric source (e.g. face, fingerprint/fingervein)">
<optionalConform>
<feature name="USR"/>
</optionalConform>
</item>
</enum>
<enum name="SoundVolumeEnum">
<item value="0" name="Silent" summary="Silent Mode">
<mandatoryConform/>
</item>
<item value="1" name="Low" summary="Low Volume">
<mandatoryConform/>
</item>
<item value="2" name="High" summary="High Volume">
<mandatoryConform/>
</item>
<item value="3" name="Medium" summary="Medium Volume">
<mandatoryConform/>
</item>
</enum>
<enum name="Status Codes" type="status"/>
<enum name="UserStatusEnum">
<item value="0" name="Available" summary="The user ID is available">
<mandatoryConform/>
</item>
<item value="1" name="OccupiedEnabled" summary="The user ID is occupied and enabled">
<mandatoryConform/>
</item>
<item value="3" name="OccupiedDisabled" summary="The user ID is occupied and disabled">
<optionalConform/>
</item>
</enum>
<enum name="UserTypeEnum">
<item value="0" name="UnrestrictedUser" summary="The user ID type is unrestricted">
<mandatoryConform/>
</item>
<item value="1" name="YearDayScheduleUser" summary="The user ID type is schedule">
<optionalConform/>
</item>
<item value="2" name="WeekDayScheduleUser" summary="The user ID type is schedule">
<optionalConform/>
</item>
<item value="3" name="ProgrammingUser" summary="The user ID type is programming">
<optionalConform/>
</item>
<item value="4" name="NonAccessUser" summary="The user ID type is non access">
<optionalConform/>
</item>
<item value="5" name="ForcedUser" summary="The user ID type is forced">
<optionalConform>
<feature name="USR"/>
</optionalConform>
</item>
<item value="6" name="DisposableUser" summary="The user ID type is disposable">
<optionalConform>
<feature name="USR"/>
</optionalConform>
</item>
<item value="7" name="ExpiringUser" summary="The user ID type is expiring">
<optionalConform>
<feature name="USR"/>
</optionalConform>
</item>
<item value="8" name="ScheduleRestrictedUser" summary="The user ID type is schedule restricted">
<mandatoryConform>
<orTerm>
<feature name="WDSCH"/>
<feature name="YDSCH"/>
</orTerm>
</mandatoryConform>
</item>
<item value="9" name="RemoteOnlyUser" summary="The user ID type is remote only">
<mandatoryConform>
<andTerm>
<feature name="USR"/>
<feature name="COTA"/>
<feature name="PIN"/>
</andTerm>
</mandatoryConform>
</item>
</enum>
<bitmap name="AlarmMaskBitmap">
<bitfield name="LockJammed" bit="0" summary="Locking Mechanism Jammed">
<mandatoryConform/>
</bitfield>
<bitfield name="LockFactoryReset" bit="1" summary="Lock Reset to Factory Defaults">
<optionalConform/>
</bitfield>
<bitfield name="N" bit="2" summary="Reserved">
<optionalConform/>
</bitfield>
<bitfield name="LockRadioPowerCycled" bit="3" summary="RF Module Power Cycled">
<optionalConform/>
</bitfield>
<bitfield name="WrongCodeEntryLimit" bit="4" summary="Tamper Alarm - wrong code entry limit">
<mandatoryConform>
<orTerm>
<feature name="PIN"/>
<feature name="RID"/>
</orTerm>
</mandatoryConform>
</bitfield>
<bitfield name="FrontEscutcheonRemoved" bit="5" summary="Tamper Alarm - front escutcheon removed from main">
<optionalConform/>
</bitfield>
<bitfield name="DoorForcedOpen" bit="6" summary="Forced Door Open under Door Locked Condition">
<optionalConform/>
</bitfield>
</bitmap>
<bitmap name="ConfigurationRegisterBitmap">
<bitfield name="LocalProgramming" bit="0" summary="The state of local programming functionality">
<mandatoryConform/>
</bitfield>
<bitfield name="KeypadInterface" bit="1" summary="The state of the keypad interface">
<mandatoryConform/>
</bitfield>
<bitfield name="RemoteInterface" bit="2" summary="The state of the remote interface">
<mandatoryConform/>
</bitfield>
<bitfield name="SoundVolume" bit="5" summary="Sound volume is set to Silent value">
<mandatoryConform/>
</bitfield>
<bitfield name="AutoRelockTime" bit="6" summary="Auto relock time it set to 0">
<mandatoryConform/>
</bitfield>
<bitfield name="LEDSettings" bit="7" summary="LEDs is disabled">
<mandatoryConform/>
</bitfield>
</bitmap>
<bitmap name="CredentialRulesBitmap">
<bitfield name="Single" bit="0" summary="Only one credential is required for lock operation">
<mandatoryConform/>
</bitfield>
<bitfield name="Dual" bit="1" summary="Any two credentials are required for lock operation">
<mandatoryConform/>
</bitfield>
<bitfield name="Tri" bit="2" summary="Any three credentials are required for lock operation">
<mandatoryConform/>
</bitfield>
</bitmap>
<bitmap name="DaysMaskBitmap">
<bitfield name="Sunday" bit="0" summary="Schedule is applied on Sunday">
<mandatoryConform/>
</bitfield>
<bitfield name="Monday" bit="1" summary="Schedule is applied on Monday">
<mandatoryConform/>
</bitfield>
<bitfield name="Tuesday" bit="2" summary="Schedule is applied on Tuesday">
<mandatoryConform/>
</bitfield>
<bitfield name="Wednesday" bit="3" summary="Schedule is applied on Wednesday">
<mandatoryConform/>
</bitfield>
<bitfield name="Thursday" bit="4" summary="Schedule is applied on Thursday">
<mandatoryConform/>
</bitfield>
<bitfield name="Friday" bit="5" summary="Schedule is applied on Friday">
<mandatoryConform/>
</bitfield>
<bitfield name="Saturday" bit="6" summary="Schedule is applied on Saturday">
<mandatoryConform/>
</bitfield>
</bitmap>
<bitmap name="EventMaskBitmap">
<bitfield name="Bit0" bit="0" summary="State of bit 0">
<mandatoryConform/>
</bitfield>
<bitfield name="Bit1" bit="1" summary="State of bit 1">
<mandatoryConform/>
</bitfield>
<bitfield name="Bit2" bit="2" summary="State of bit 2">
<mandatoryConform/>
</bitfield>
<bitfield name="Bit3" bit="3" summary="State of bit 3">
<mandatoryConform/>
</bitfield>
<bitfield name="Bit4" bit="4" summary="State of bit 4">
<mandatoryConform/>
</bitfield>
<bitfield name="Bit5" bit="5" summary="State of bit 5">
<mandatoryConform/>
</bitfield>
<bitfield name="Bit6" bit="6" summary="State of bit 6">
<mandatoryConform/>
</bitfield>
<bitfield name="Bit7" bit="7" summary="State of bit 7">
<mandatoryConform/>
</bitfield>
<bitfield name="Bit8" bit="8" summary="State of bit 8">
<mandatoryConform/>
</bitfield>
<bitfield name="Bit9" bit="9" summary="State of bit 9">
<mandatoryConform/>
</bitfield>
<bitfield name="Bit10" bit="10" summary="State of bit 10">
<mandatoryConform/>
</bitfield>
<bitfield name="Bit11" bit="11" summary="State of bit 11">
<mandatoryConform/>
</bitfield>
<bitfield name="Bit12" bit="12" summary="State of bit 12">
<mandatoryConform/>
</bitfield>
<bitfield name="Bit13" bit="13" summary="State of bit 13">
<mandatoryConform/>
</bitfield>
<bitfield name="Bit14" bit="14" summary="State of bit 14">
<mandatoryConform/>
</bitfield>
<bitfield name="Bit15" bit="15" summary="State of bit 15">
<mandatoryConform/>
</bitfield>
</bitmap>
<bitmap name="LocalProgrammingFeaturesBitmap">
<bitfield name="AddUsersCredentialsSchedules" bit="0" summary="The state of the ability to add users, credentials or schedules on the device">
<mandatoryConform/>
</bitfield>
<bitfield name="ModifyUsersCredentialsSchedules" bit="1" summary="The state of the ability to modify users, credentials or schedules on the device">
<mandatoryConform/>
</bitfield>
<bitfield name="ClearUsersCredentialsSchedules" bit="2" summary="The state of the ability to clear users, credentials or schedules on the device">
<mandatoryConform/>
</bitfield>
<bitfield name="AdjustSettings" bit="3" summary="The state of the ability to adjust settings on the device">
<mandatoryConform/>
</bitfield>
</bitmap>
<bitmap name="OperatingModesBitmap">
<bitfield name="Normal" bit="0" summary="Normal operation mode">
<mandatoryConform/>
</bitfield>
<bitfield name="Vacation" bit="1" summary="Vacation operation mode">
<optionalConform/>
</bitfield>
<bitfield name="Privacy" bit="2" summary="Privacy operation mode">
<optionalConform/>
</bitfield>
<bitfield name="NoRemoteLockUnlock" bit="3" summary="No remote lock and unlock operation mode">
<mandatoryConform/>
</bitfield>
<bitfield name="Passage" bit="4" summary="Passage operation mode">
<optionalConform/>
</bitfield>
</bitmap>
<struct name="CredentialStruct">
<field id="0" name="CredentialType" type="CredentialTypeEnum">
<mandatoryConform/>
</field>
<field id="1" name="CredentialIndex" type="uint16" default="0">
<mandatoryConform/>
</field>
</struct>
</dataTypes>
<attributes>
<attribute id="0x0000" name="LockState" type="LockStateEnum">
<access read="true" readPrivilege="view"/>
<quality changeOmitted="false" nullable="true" scene="true" persistence="volatile" reportable="true"/>
<mandatoryConform/>
<constraint type="desc"/>
</attribute>
<attribute id="0x0001" name="LockType" type="LockTypeEnum">
<access read="true" readPrivilege="view"/>
<mandatoryConform/>
<constraint type="desc"/>
</attribute>
<attribute id="0x0002" name="ActuatorEnabled" type="bool">
<access read="true" readPrivilege="view"/>
<mandatoryConform/>
</attribute>
<attribute id="0x0003" name="DoorState" type="DoorStateEnum">
<access read="true" readPrivilege="view"/>
<quality changeOmitted="false" nullable="true" scene="false" persistence="volatile" reportable="true"/>
<mandatoryConform>
<feature name="DPS"/>
</mandatoryConform>
<constraint type="desc"/>
</attribute>
<attribute id="0x0004" name="DoorOpenEvents" type="uint32">
<access read="true" write="true" readPrivilege="view" writePrivilege="manage"/>
<optionalConform>
<feature name="DPS"/>
</optionalConform>
</attribute>
<attribute id="0x0005" name="DoorClosedEvents" type="uint32">
<access read="true" write="true" readPrivilege="view" writePrivilege="manage"/>
<optionalConform>
<feature name="DPS"/>
</optionalConform>
</attribute>
<attribute id="0x0006" name="OpenPeriod" type="uint16">
<access read="true" write="true" readPrivilege="view" writePrivilege="manage"/>
<optionalConform>
<feature name="DPS"/>
</optionalConform>
</attribute>
<attribute id="0x0010" name="NumberOfLogRecordsSupported" type="uint16" default="0">
<access read="true" readPrivilege="view"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="fixed" reportable="false"/>
<mandatoryConform>
<feature name="LOG"/>
</mandatoryConform>
</attribute>
<attribute id="0x0011" name="NumberOfTotalUsersSupported" type="uint16" default="0">
<access read="true" readPrivilege="view"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="fixed" reportable="false"/>
<mandatoryConform>
<feature name="USR"/>
</mandatoryConform>
</attribute>
<attribute id="0x0012" name="NumberOfPINUsersSupported" type="uint16" default="0">
<access read="true" readPrivilege="view"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="fixed" reportable="false"/>
<mandatoryConform>
<feature name="PIN"/>
</mandatoryConform>
</attribute>
<attribute id="0x0013" name="NumberOfRFIDUsersSupported" type="uint16" default="0">
<access read="true" readPrivilege="view"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="fixed" reportable="false"/>
<mandatoryConform>
<feature name="RID"/>
</mandatoryConform>
</attribute>
<attribute id="0x0014" name="NumberOfWeekDaySchedulesSupportedPerUser" type="uint8" default="0">
<access read="true" readPrivilege="view"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="fixed" reportable="false"/>
<mandatoryConform>
<feature name="WDSCH"/>
</mandatoryConform>
</attribute>
<attribute id="0x0015" name="NumberOfYearDaySchedulesSupportedPerUser" type="uint8" default="0">
<access read="true" readPrivilege="view"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="fixed" reportable="false"/>
<mandatoryConform>
<feature name="YDSCH"/>
</mandatoryConform>
</attribute>
<attribute id="0x0016" name="NumberOfHolidaySchedulesSupported" type="uint8" default="0">
<access read="true" readPrivilege="view"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="fixed" reportable="false"/>
<mandatoryConform>
<feature name="HDSCH"/>
</mandatoryConform>
</attribute>
<attribute id="0x0017" name="MaxPINCodeLength" type="uint8" default="MS">
<access read="true" readPrivilege="view"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="fixed" reportable="false"/>
<mandatoryConform>
<feature name="PIN"/>
</mandatoryConform>
</attribute>
<attribute id="0x0018" name="MinPINCodeLength" type="uint8" default="MS">
<access read="true" readPrivilege="view"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="fixed" reportable="false"/>
<mandatoryConform>
<feature name="PIN"/>
</mandatoryConform>
</attribute>
<attribute id="0x0019" name="MaxRFIDCodeLength" type="uint8" default="MS">
<access read="true" readPrivilege="view"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="fixed" reportable="false"/>
<mandatoryConform>
<feature name="RID"/>
</mandatoryConform>
</attribute>
<attribute id="0x001A" name="MinRFIDCodeLength" type="uint8" default="MS">
<access read="true" readPrivilege="view"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="fixed" reportable="false"/>
<mandatoryConform>
<feature name="RID"/>
</mandatoryConform>
</attribute>
<attribute id="0x001B" name="CredentialRulesSupport" type="CredentialRulesBitmap" default="1">
<access read="true" readPrivilege="view"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="fixed" reportable="false"/>
<mandatoryConform>
<feature name="USR"/>
</mandatoryConform>
</attribute>
<attribute id="0x001C" name="NumberOfCredentialsSupportedPerUser" type="uint8" default="0">
<access read="true" readPrivilege="view"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="fixed" reportable="false"/>
<mandatoryConform>
<feature name="USR"/>
</mandatoryConform>
</attribute>
<attribute id="0x0020" name="EnableLogging" type="bool" default="0">
<access read="true" write="optional" readPrivilege="view" writePrivilege="admin"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="volatile" reportable="true"/>
<mandatoryConform>
<feature name="LOG"/>
</mandatoryConform>
</attribute>
<attribute id="0x0021" name="Language" type="string" default="MS">
<access read="true" write="optional" readPrivilege="view" writePrivilege="manage"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="volatile" reportable="true"/>
<optionalConform/>
<constraint type="maxLength" value="3"/>
</attribute>
<attribute id="0x0022" name="LEDSettings" type="LEDSettingEnum" default="0">
<access read="true" write="optional" readPrivilege="view" writePrivilege="manage"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="volatile" reportable="true"/>
<optionalConform/>
</attribute>
<attribute id="0x0023" name="AutoRelockTime" type="uint32" default="MS">
<access read="true" write="optional" readPrivilege="view" writePrivilege="manage"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="volatile" reportable="true"/>
<optionalConform/>
</attribute>
<attribute id="0x0024" name="SoundVolume" type="SoundVolumeEnum" default="0">
<access read="true" write="optional" readPrivilege="view" writePrivilege="manage"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="volatile" reportable="true"/>
<optionalConform/>
</attribute>
<attribute id="0x0025" name="OperatingMode" type="OperatingModeEnum" default="0">
<access read="true" write="optional" readPrivilege="view" writePrivilege="manage"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="volatile" reportable="true"/>
<mandatoryConform/>
<constraint type="desc"/>
</attribute>
<attribute id="0x0026" name="SupportedOperatingModes" type="OperatingModesBitmap" default="0xFFF6">
<access read="true" readPrivilege="view"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="fixed" reportable="false"/>
<mandatoryConform/>
</attribute>
<attribute id="0x0027" name="DefaultConfigurationRegister" type="ConfigurationRegisterBitmap" default="0">
<access read="true" readPrivilege="view"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="volatile" reportable="true"/>
<optionalConform/>
</attribute>
<attribute id="0x0028" name="EnableLocalProgramming" type="bool" default="1">
<access read="true" write="optional" readPrivilege="view" writePrivilege="admin"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="volatile" reportable="true"/>
<optionalConform/>
</attribute>
<attribute id="0x0029" name="EnableOneTouchLocking" type="bool" default="0">
<access read="true" write="true" readPrivilege="view" writePrivilege="manage"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="volatile" reportable="true"/>
<optionalConform/>
</attribute>
<attribute id="0x002A" name="EnableInsideStatusLED" type="bool" default="0">
<access read="true" write="true" readPrivilege="view" writePrivilege="manage"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="volatile" reportable="true"/>
<optionalConform/>
</attribute>
<attribute id="0x002B" name="EnablePrivacyModeButton" type="bool" default="0">
<access read="true" write="true" readPrivilege="view" writePrivilege="manage"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="volatile" reportable="true"/>
<optionalConform/>
</attribute>
<attribute id="0x002C" name="LocalProgrammingFeatures" type="LocalProgrammingFeaturesBitmap" default="0">
<access read="true" write="optional" readPrivilege="view" writePrivilege="admin"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="volatile" reportable="true"/>
<optionalConform/>
</attribute>
<attribute id="0x0030" name="WrongCodeEntryLimit" type="uint8" default="MS">
<access read="true" write="optional" readPrivilege="view" writePrivilege="admin"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="volatile" reportable="true"/>
<mandatoryConform>
<orTerm>
<feature name="PIN"/>
<feature name="RID"/>
</orTerm>
</mandatoryConform>
<constraint type="between" from="1" to="255"/>
</attribute>
<attribute id="0x0031" name="UserCodeTemporaryDisableTime" type="uint8" default="MS">
<access read="true" write="optional" readPrivilege="view" writePrivilege="admin"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="volatile" reportable="true"/>
<mandatoryConform>
<orTerm>
<feature name="PIN"/>
<feature name="RID"/>
</orTerm>
</mandatoryConform>
<constraint type="between" from="1" to="255"/>
</attribute>
<attribute id="0x0032" name="SendPINOverTheAir" type="bool" default="0">
<access read="true" write="optional" readPrivilege="view" writePrivilege="admin"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="volatile" reportable="true"/>
<optionalConform>
<andTerm>
<notTerm>
<feature name="USR"/>
</notTerm>
<feature name="PIN"/>
</andTerm>
</optionalConform>
</attribute>
<attribute id="0x0033" name="RequirePINforRemoteOperation" type="bool" default="0">
<access read="true" write="optional" readPrivilege="view" writePrivilege="admin"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="volatile" reportable="true"/>
<mandatoryConform>
<andTerm>
<feature name="COTA"/>
<feature name="PIN"/>
</andTerm>
</mandatoryConform>
</attribute>
<attribute id="0x0034" name="SecurityLevel" default="0">
<deprecateConform/>
</attribute>
<attribute id="0x0035" name="ExpiringUserTimeout" type="uint16" default="MS">
<access read="true" write="optional" readPrivilege="view" writePrivilege="admin"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="volatile" reportable="true"/>
<optionalConform>
<feature name="USR"/>
</optionalConform>
<constraint type="between" from="1" to="2880"/>
</attribute>
<attribute id="0x0040" name="AlarmMask" type="AlarmMaskBitmap" default="0xFFFF">
<access read="true" write="true" readPrivilege="view" writePrivilege="admin"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="volatile" reportable="true"/>
<optionalConform/>
</attribute>
<attribute id="0x0041" name="KeypadOperationEventMask" type="EventMaskBitmap" default="0xFFFF">