forked from project-chip/connectedhomeip
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsmoke-co-alarm-cluster.xml
212 lines (194 loc) · 9.18 KB
/
smoke-co-alarm-cluster.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
<?xml version="1.0"?>
<!--
Copyright (c) 2023 Project CHIP Authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<configurator>
<domain name="CHIP" />
<cluster>
<domain>Measurement & Sensing</domain>
<name>Smoke CO Alarm</name>
<code>0x005C</code>
<define>SMOKE_CO_ALARM_CLUSTER</define>
<description>This cluster provides an interface for observing and managing the state of smoke and CO alarms.</description>
<!-- Abbreviations used in descriptions -->
<tag name="SMOKE" description="Smoke Alarm" />
<tag name="CO" description="CO Alarm" />
<client tick="false" init="false">true</client>
<server tick="false" init="false">true</server>
<!-- Current cluster version -->
<globalAttribute side="either" code="0xFFFD" value="1" />
<!-- Cluster feature map -->
<globalAttribute side="server" code="0xFFFC" type="Feature" value="3" />
<features>
<feature bit="0" code="SMOKE" name="SmokeAlarm" summary="Supports Smoke alarm">
<optionalConform choice="a" more="true"/>
</feature>
<feature bit="1" code="CO" name="CO Alarm" summary="Supports CO alarm">
<optionalConform choice="a" more="true"/>
</feature>
</features>
<!-- Attributes -->
<attribute side="server" code="0x0000" name="ExpressedState" define="EXPRESSED_STATE" type="ExpressedStateEnum">
<mandatoryConform/>
</attribute>
<attribute side="server" code="0x0001" name="SmokeState" define="SMOKE_STATE" type="AlarmStateEnum" optional="true">
<mandatoryConform>
<feature name="SMOKE"/>
</mandatoryConform>
</attribute>
<attribute side="server" code="0x0002" name="COState" define="CO_STATE" type="AlarmStateEnum" optional="true">
<mandatoryConform>
<feature name="CO"/>
</mandatoryConform>
</attribute>
<attribute side="server" code="0x0003" name="BatteryAlert" define="BATTERY_ALERT" type="AlarmStateEnum">
<mandatoryConform/>
</attribute>
<attribute side="server" code="0x0004" name="DeviceMuted" define="DEVICE_MUTED" type="MuteStateEnum" optional="true">
<optionalConform/>
</attribute>
<attribute side="server" code="0x0005" name="TestInProgress" define="TEST_IN_PROGRESS" type="boolean">
<mandatoryConform/>
</attribute>
<attribute side="server" code="0x0006" name="HardwareFaultAlert" define="HARDWARE_FAULTALERT" type="boolean">
<mandatoryConform/>
</attribute>
<attribute side="server" code="0x0007" name="EndOfServiceAlert" define="END_OF_SERVICEALERT" type="EndOfServiceEnum">
<mandatoryConform/>
</attribute>
<attribute side="server" code="0x0008" name="InterconnectSmokeAlarm" define="INTERCONNECT_SMOKE_ALARM" type="AlarmStateEnum" optional="true">
<optionalConform/>
</attribute>
<attribute side="server" code="0x0009" name="InterconnectCOAlarm" define="INTERCONNECT_CO_ALARM" type="AlarmStateEnum" optional="true">
<optionalConform/>
</attribute>
<attribute side="server" code="0x000A" name="ContaminationState" define="CONTAMINATION_STATE" type="ContaminationStateEnum" optional="true">
<optionalConform>
<feature name="SMOKE"/>
</optionalConform>
</attribute>
<attribute side="server" code="0x000B" name="SmokeSensitivityLevel" define="SENSITIVITY_LEVEL" type="SensitivityEnum" min="0" max="2" writable="true" optional="true">
<access op="write" role="manage"/>
<optionalConform>
<feature name="SMOKE"/>
</optionalConform>
</attribute>
<attribute side="server" code="0x000C" name="ExpiryDate" define="EXPIRY_DATE" type="epoch_s" optional="true">
<optionalConform/>
</attribute>
<!-- Commands -->
<command source="client" code="0x00" name="SelfTestRequest" optional="true">
<description>This command SHALL initiate a device self-test.</description>
<optionalConform/>
</command>
<!-- Events -->
<event side="server" code="0x00" name="SmokeAlarm" priority="critical" optional="true">
<description>This event SHALL be generated when SmokeState attribute changes to either Warning or Critical state.</description>
<field id="0" name="AlarmSeverityLevel" type="AlarmStateEnum" />
<mandatoryConform>
<feature name="SMOKE"/>
</mandatoryConform>
</event>
<event side="server" code="0x01" name="COAlarm" priority="critical" optional="true">
<description>This event SHALL be generated when COState attribute changes to either Warning or Critical state.</description>
<field id="0" name="AlarmSeverityLevel" type="AlarmStateEnum" />
<mandatoryConform>
<feature name="CO"/>
</mandatoryConform>
</event>
<event side="server" code="0x02" name="LowBattery" priority="info" optional="false">
<description>This event SHALL be generated when BatteryAlert attribute changes to either Warning or Critical state.</description>
<field id="0" name="AlarmSeverityLevel" type="AlarmStateEnum" />
<mandatoryConform/>
</event>
<event side="server" code="0x03" name="HardwareFault" priority="info" optional="false">
<description>This event SHALL be generated when the device detects a hardware fault that leads to setting HardwareFaultAlert to True.</description>
<mandatoryConform/>
</event>
<event side="server" code="0x04" name="EndOfService" priority="info" optional="false">
<description>This event SHALL be generated when the EndOfServiceAlert is set to Expired.</description>
<mandatoryConform/>
</event>
<event side="server" code="0x05" name="SelfTestComplete" priority="info" optional="false">
<description>This event SHALL be generated when the SelfTest completes, and the attribute TestInProgress changes to False.</description>
<mandatoryConform/>
</event>
<event side="server" code="0x06" name="AlarmMuted" priority="info" optional="true">
<description>This event SHALL be generated when the DeviceMuted attribute changes to Muted.</description>
<optionalConform/>
</event>
<event side="server" code="0x07" name="MuteEnded" priority="info" optional="true">
<description>This event SHALL be generated when DeviceMuted attribute changes to NotMuted.</description>
<optionalConform/>
</event>
<event side="server" code="0x08" name="InterconnectSmokeAlarm" priority="critical" optional="true">
<description>This event SHALL be generated when the device hosting the server receives a smoke alarm from an interconnected sensor.</description>
<field id="0" name="AlarmSeverityLevel" type="AlarmStateEnum" />
<optionalConform>
<feature name="SMOKE"/>
</optionalConform>
</event>
<event side="server" code="0x09" name="InterconnectCOAlarm" priority="critical" optional="true">
<description>This event SHALL be generated when the device hosting the server receives a smoke alarm from an interconnected sensor.</description>
<field id="0" name="AlarmSeverityLevel" type="AlarmStateEnum" />
<optionalConform>
<feature name="CO"/>
</optionalConform>
</event>
<event side="server" code="0x0A" name="AllClear" priority="info" optional="false">
<description>This event SHALL be generated when ExpressedState attribute returns to Normal state.</description>
<mandatoryConform/>
</event>
</cluster>
<!-- Cluster data types -->
<enum name="AlarmStateEnum" type="enum8">
<cluster code="0x005C" />
<item value="0" name="Normal" />
<item value="1" name="Warning" />
<item value="2" name="Critical" />
</enum>
<enum name="SensitivityEnum" type="enum8">
<cluster code="0x005C" />
<item value="0" name="High" />
<item value="1" name="Standard" />
<item value="2" name="Low" />
</enum>
<enum name="ExpressedStateEnum" type="enum8">
<cluster code="0x005C" />
<item value="0" name="Normal" />
<item value="1" name="SmokeAlarm" />
<item value="2" name="COAlarm" />
<item value="3" name="BatteryAlert" />
<item value="4" name="Testing" />
<item value="5" name="HardwareFault" />
<item value="6" name="EndOfService" />
<item value="7" name="InterconnectSmoke" />
<item value="8" name="InterconnectCO" />
</enum>
<enum name="MuteStateEnum" type="enum8">
<cluster code="0x005C" />
<item value="0" name="NotMuted" />
<item value="1" name="Muted" />
</enum>
<enum name="EndOfServiceEnum" type="enum8">
<cluster code="0x005C" />
<item value="0" name="Normal" />
<item value="1" name="Expired" />
</enum>
<enum name="ContaminationStateEnum" type="enum8">
<cluster code="0x005C" />
<item value="0" name="Normal" />
<item value="1" name="Low" />
<item value="2" name="Warning" />
<item value="3" name="Critical" />
</enum>
</configurator>