1
+ <?xml version =" 1.0" ?>
2
+ <!--
3
+ Copyright (C) Connectivity Standards Alliance (2021). All rights reserved.
4
+ The information within this document is the property of the Connectivity
5
+ Standards Alliance and its use and disclosure are restricted, except as
6
+ expressly set forth herein.
7
+
8
+ Connectivity Standards Alliance hereby grants you a fully-paid, non-exclusive,
9
+ nontransferable, worldwide, limited and revocable license (without the right to
10
+ sublicense), under Connectivity Standards Alliance's applicable copyright
11
+ rights, to view, download, save, reproduce and use the document solely for your
12
+ own internal purposes and in accordance with the terms of the license set forth
13
+ herein. This license does not authorize you to, and you expressly warrant that
14
+ you shall not: (a) permit others (outside your organization) to use this
15
+ document; (b) post or publish this document; (c) modify, adapt, translate, or
16
+ otherwise change this document in any manner or create any derivative work
17
+ based on this document; (d) remove or modify any notice or label on this
18
+ document, including this Copyright Notice, License and Disclaimer. The
19
+ Connectivity Standards Alliance does not grant you any license hereunder other
20
+ than as expressly stated herein.
21
+
22
+ Elements of this document may be subject to third party intellectual property
23
+ rights, including without limitation, patent, copyright or trademark rights,
24
+ and any such third party may or may not be a member of the Connectivity
25
+ Standards Alliance. Connectivity Standards Alliance members grant other
26
+ Connectivity Standards Alliance members certain intellectual property rights as
27
+ set forth in the Connectivity Standards Alliance IPR Policy. Connectivity
28
+ Standards Alliance members do not grant you any rights under this license. The
29
+ Connectivity Standards Alliance is not responsible for, and shall not be held
30
+ responsible in any manner for, identifying or failing to identify any or all
31
+ such third party intellectual property rights. Please visit www.csa-iot.org for
32
+ more information on how to become a member of the Connectivity Standards
33
+ Alliance.
34
+
35
+ This document and the information contained herein are provided on an “AS IS”
36
+ basis and the Connectivity Standards Alliance DISCLAIMS ALL WARRANTIES EXPRESS
37
+ OR IMPLIED, INCLUDING BUT NOT LIMITED TO (A) ANY WARRANTY THAT THE USE OF THE
38
+ INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OF THIRD PARTIES (INCLUDING
39
+ WITHOUT LIMITATION ANY INTELLECTUAL PROPERTY RIGHTS INCLUDING PATENT, COPYRIGHT
40
+ OR TRADEMARK RIGHTS); OR (B) ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS
41
+ FOR A PARTICULAR PURPOSE, TITLE OR NONINFRINGEMENT. IN NO EVENT WILL THE
42
+ CONNECTIVITY STANDARDS ALLIANCE BE LIABLE FOR ANY LOSS OF PROFITS, LOSS OF
43
+ BUSINESS, LOSS OF USE OF DATA, INTERRUPTION OF BUSINESS, OR FOR ANY OTHER
44
+ DIRECT, INDIRECT, SPECIAL OR EXEMPLARY, INCIDENTAL, PUNITIVE OR CONSEQUENTIAL
45
+ DAMAGES OF ANY KIND, IN CONTRACT OR IN TORT, IN CONNECTION WITH THIS DOCUMENT
46
+ OR THE INFORMATION CONTAINED HEREIN, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
47
+ LOSS OR DAMAGE.
48
+
49
+ All company, brand and product names in this document may be trademarks that
50
+ are the sole property of their respective owners.
51
+
52
+ This notice and disclaimer must be included on all copies of this document.
53
+
54
+ Connectivity Standards Alliance
55
+ 508 Second Street, Suite 206
56
+ Davis, CA 95616, USA
57
+ -->
58
+ <cluster xmlns : xsi =" http://www.w3.org/2001/XMLSchema-instance" xsi : schemaLocation =" types types.xsd cluster cluster.xsd" id =" 0x0081" name =" Valve Configuration and Control" revision =" 1" >
59
+ <revisionHistory >
60
+ <revision revision =" 1" summary =" Initial Release" />
61
+ </revisionHistory >
62
+ <classification hierarchy =" base" role =" application" picsCode =" VALCC" scope =" Endpoint" />
63
+ <features >
64
+ <feature bit =" 0" code =" TS" name =" TimeSync" summary =" UTC time is used for time indications" />
65
+ <feature bit =" 1" code =" LVL" name =" Level" summary =" Device supports setting the specific position of the valve" >
66
+ <optionalConform />
67
+ </feature >
68
+ </features >
69
+ <dataTypes >
70
+ <enum name =" Status Codes" type =" status" />
71
+ <enum name =" ValveStateEnum" >
72
+ <item value =" 0" name =" Closed" summary =" Valve is in closed position" >
73
+ <mandatoryConform />
74
+ </item >
75
+ <item value =" 1" name =" Open" summary =" Valve is in open position" >
76
+ <mandatoryConform />
77
+ </item >
78
+ <item value =" 2" name =" Transitioning" summary =" Valve is transitioning between closed and open positions or between levels" >
79
+ <mandatoryConform />
80
+ </item >
81
+ </enum >
82
+ <bitmap name =" ValveFaultBitmap" >
83
+ <bitfield name =" GeneralFault" bit =" 0" summary =" Unspecified fault detected" >
84
+ <mandatoryConform />
85
+ </bitfield >
86
+ <bitfield name =" Blocked" bit =" 1" summary =" Valve is blocked" >
87
+ <mandatoryConform />
88
+ </bitfield >
89
+ <bitfield name =" Leaking" bit =" 2" summary =" Valve has detected a leak" >
90
+ <mandatoryConform />
91
+ </bitfield >
92
+ <bitfield name =" NotConnected" bit =" 3" summary =" No valve is connected to controller" >
93
+ <mandatoryConform />
94
+ </bitfield >
95
+ <bitfield name =" ShortCircuit" bit =" 4" summary =" Short circuit is detected" >
96
+ <mandatoryConform />
97
+ </bitfield >
98
+ <bitfield name =" CurrentExceeded" bit =" 5" summary =" The available current has been exceeded" >
99
+ <mandatoryConform />
100
+ </bitfield >
101
+ </bitmap >
102
+ </dataTypes >
103
+ <attributes >
104
+ <attribute id =" 0x0000" name =" OpenDuration" type =" elapsed-s" default =" null" >
105
+ <access read =" true" readPrivilege =" view" />
106
+ <quality changeOmitted =" false" nullable =" true" scene =" false" persistence =" volatile" reportable =" false" />
107
+ <mandatoryConform />
108
+ <constraint type =" min" value =" 1" />
109
+ </attribute >
110
+ <attribute id =" 0x0001" name =" DefaultOpenDuration" type =" elapsed-s" default =" null" >
111
+ <access read =" true" write =" true" readPrivilege =" view" writePrivilege =" operate" />
112
+ <quality changeOmitted =" false" nullable =" true" scene =" false" persistence =" nonVolatile" reportable =" false" />
113
+ <mandatoryConform />
114
+ <constraint type =" min" value =" 1" />
115
+ </attribute >
116
+ <attribute id =" 0x0002" name =" AutoCloseTime" type =" epoch-us" default =" null" >
117
+ <access read =" true" readPrivilege =" view" />
118
+ <quality changeOmitted =" false" nullable =" true" scene =" false" persistence =" volatile" reportable =" false" />
119
+ <mandatoryConform >
120
+ <feature name =" TS" />
121
+ </mandatoryConform >
122
+ </attribute >
123
+ <attribute id =" 0x0003" name =" RemainingDuration" type =" elapsed-s" default =" null" >
124
+ <access read =" true" readPrivilege =" view" />
125
+ <quality changeOmitted =" false" nullable =" true" scene =" false" persistence =" volatile" reportable =" false" />
126
+ <mandatoryConform />
127
+ </attribute >
128
+ <attribute id =" 0x0004" name =" CurrentState" type =" ValveStateEnum" default =" null" >
129
+ <access read =" true" readPrivilege =" view" />
130
+ <quality changeOmitted =" false" nullable =" true" scene =" false" persistence =" volatile" reportable =" false" />
131
+ <mandatoryConform />
132
+ </attribute >
133
+ <attribute id =" 0x0005" name =" TargetState" type =" ValveStateEnum" default =" null" >
134
+ <access read =" true" readPrivilege =" view" />
135
+ <quality changeOmitted =" false" nullable =" true" scene =" false" persistence =" volatile" reportable =" false" />
136
+ <mandatoryConform />
137
+ </attribute >
138
+ <attribute id =" 0x0006" name =" CurrentLevel" type =" percent" default =" null" >
139
+ <access read =" true" readPrivilege =" view" />
140
+ <quality changeOmitted =" false" nullable =" true" scene =" false" persistence =" volatile" reportable =" false" />
141
+ <mandatoryConform >
142
+ <feature name =" LVL" />
143
+ </mandatoryConform >
144
+ </attribute >
145
+ <attribute id =" 0x0007" name =" TargetLevel" type =" percent" default =" null" >
146
+ <access read =" true" readPrivilege =" view" />
147
+ <quality changeOmitted =" false" nullable =" true" scene =" false" persistence =" volatile" reportable =" false" />
148
+ <mandatoryConform >
149
+ <feature name =" LVL" />
150
+ </mandatoryConform >
151
+ </attribute >
152
+ <attribute id =" 0x0008" name =" DefaultOpenLevel" type =" percent" default =" 100" >
153
+ <access read =" true" write =" true" readPrivilege =" view" writePrivilege =" operate" />
154
+ <quality changeOmitted =" false" nullable =" false" scene =" false" persistence =" nonVolatile" reportable =" false" />
155
+ <optionalConform >
156
+ <feature name =" LVL" />
157
+ </optionalConform >
158
+ <constraint type =" between" from =" 1" to =" 100" />
159
+ </attribute >
160
+ <attribute id =" 0x0009" name =" ValveFault" type =" ValveFaultBitmap" default =" 0" >
161
+ <access read =" true" readPrivilege =" view" />
162
+ <optionalConform />
163
+ </attribute >
164
+ </attributes >
165
+ <commands >
166
+ <command id =" 0x00" name =" Open" response =" Y" >
167
+ <access invokePrivilege =" operate" />
168
+ <mandatoryConform />
169
+ <field id =" 0" name =" OpenDuration" type =" elapsed-s" >
170
+ <quality nullable =" true" />
171
+ <optionalConform />
172
+ <constraint type =" min" value =" 1" />
173
+ </field >
174
+ <field id =" 1" name =" TargetLevel" type =" percent" >
175
+ <optionalConform >
176
+ <feature name =" LVL" />
177
+ </optionalConform >
178
+ <constraint type =" min" value =" 1" />
179
+ </field >
180
+ </command >
181
+ <command id =" 0x01" name =" Close" response =" Y" >
182
+ <access invokePrivilege =" operate" />
183
+ <mandatoryConform />
184
+ </command >
185
+ </commands >
186
+ <events >
187
+ <event id =" 0x00" name =" ValveStateChanged" priority =" info" >
188
+ <access readPrivilege =" view" />
189
+ <optionalConform />
190
+ <field id =" 0" name =" ValveState" type =" ValveStateEnum" >
191
+ <mandatoryConform />
192
+ </field >
193
+ <field id =" 1" name =" ValveLevel" type =" percent" >
194
+ <mandatoryConform >
195
+ <feature name =" LVL" />
196
+ </mandatoryConform >
197
+ </field >
198
+ </event >
199
+ <event id =" 0x01" name =" ValveFault" priority =" info" >
200
+ <access readPrivilege =" view" />
201
+ <optionalConform />
202
+ <field id =" 0" name =" ValveFault" type =" ValveFaultBitmap" >
203
+ <mandatoryConform />
204
+ </field >
205
+ </event >
206
+ </events >
207
+ </cluster >
0 commit comments