/src/connectedhomeip/zzz_generated/app-common/clusters/GeneralCommissioning/Commands.h
Line | Count | Source |
1 | | /* |
2 | | * |
3 | | * Copyright (c) 2022 Project CHIP Authors |
4 | | * |
5 | | * Licensed under the Apache License, Version 2.0 (the "License"); |
6 | | * you may not use this file except in compliance with the License. |
7 | | * You may obtain a copy of the License at |
8 | | * |
9 | | * http://www.apache.org/licenses/LICENSE-2.0 |
10 | | * |
11 | | * Unless required by applicable law or agreed to in writing, software |
12 | | * distributed under the License is distributed on an "AS IS" BASIS, |
13 | | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
14 | | * See the License for the specific language governing permissions and |
15 | | * limitations under the License. |
16 | | */ |
17 | | |
18 | | // THIS FILE IS GENERATED BY ZAP |
19 | | // This file is generated from clusters-Commands.h.zapt |
20 | | |
21 | | #pragma once |
22 | | |
23 | | #include <app/data-model/DecodableList.h> |
24 | | #include <app/data-model/Encode.h> |
25 | | #include <app/data-model/List.h> |
26 | | #include <app/data-model/NullObject.h> |
27 | | #include <app/data-model/Nullable.h> |
28 | | #include <lib/core/DataModelTypes.h> |
29 | | #include <lib/core/Optional.h> |
30 | | #include <lib/core/TLV.h> |
31 | | #include <lib/support/BitMask.h> |
32 | | |
33 | | #include <clusters/shared/Enums.h> |
34 | | #include <clusters/shared/Structs.h> |
35 | | |
36 | | #include <clusters/GeneralCommissioning/ClusterId.h> |
37 | | #include <clusters/GeneralCommissioning/CommandIds.h> |
38 | | #include <clusters/GeneralCommissioning/Enums.h> |
39 | | #include <clusters/GeneralCommissioning/Structs.h> |
40 | | |
41 | | #include <cstdint> |
42 | | |
43 | | namespace chip { |
44 | | namespace app { |
45 | | namespace Clusters { |
46 | | namespace GeneralCommissioning { |
47 | | namespace Commands { |
48 | | // Forward-declarations so we can reference these later. |
49 | | |
50 | | namespace ArmFailSafe { |
51 | | struct Type; |
52 | | struct DecodableType; |
53 | | } // namespace ArmFailSafe |
54 | | |
55 | | namespace ArmFailSafeResponse { |
56 | | struct Type; |
57 | | struct DecodableType; |
58 | | } // namespace ArmFailSafeResponse |
59 | | |
60 | | namespace SetRegulatoryConfig { |
61 | | struct Type; |
62 | | struct DecodableType; |
63 | | } // namespace SetRegulatoryConfig |
64 | | |
65 | | namespace SetRegulatoryConfigResponse { |
66 | | struct Type; |
67 | | struct DecodableType; |
68 | | } // namespace SetRegulatoryConfigResponse |
69 | | |
70 | | namespace CommissioningComplete { |
71 | | struct Type; |
72 | | struct DecodableType; |
73 | | } // namespace CommissioningComplete |
74 | | |
75 | | namespace CommissioningCompleteResponse { |
76 | | struct Type; |
77 | | struct DecodableType; |
78 | | } // namespace CommissioningCompleteResponse |
79 | | |
80 | | namespace SetTCAcknowledgements { |
81 | | struct Type; |
82 | | struct DecodableType; |
83 | | } // namespace SetTCAcknowledgements |
84 | | |
85 | | namespace SetTCAcknowledgementsResponse { |
86 | | struct Type; |
87 | | struct DecodableType; |
88 | | } // namespace SetTCAcknowledgementsResponse |
89 | | |
90 | | } // namespace Commands |
91 | | |
92 | | namespace Commands { |
93 | | namespace ArmFailSafe { |
94 | | enum class Fields : uint8_t |
95 | | { |
96 | | kExpiryLengthSeconds = 0, |
97 | | kBreadcrumb = 1, |
98 | | }; |
99 | | |
100 | | struct Type |
101 | | { |
102 | | public: |
103 | | // Use GetCommandId instead of commandId directly to avoid naming conflict with CommandIdentification in ExecutionOfACommand |
104 | 0 | static constexpr CommandId GetCommandId() { return Commands::ArmFailSafe::Id; } |
105 | 0 | static constexpr ClusterId GetClusterId() { return Clusters::GeneralCommissioning::Id; } |
106 | | |
107 | | uint16_t expiryLengthSeconds = static_cast<uint16_t>(0); |
108 | | uint64_t breadcrumb = static_cast<uint64_t>(0); |
109 | | |
110 | | CHIP_ERROR Encode(TLV::TLVWriter & aWriter, TLV::Tag aTag) const; |
111 | | |
112 | | using ResponseType = Clusters::GeneralCommissioning::Commands::ArmFailSafeResponse::DecodableType; |
113 | | |
114 | 0 | static constexpr bool MustUseTimedInvoke() { return false; } |
115 | | }; |
116 | | |
117 | | struct DecodableType |
118 | | { |
119 | | public: |
120 | 0 | static constexpr CommandId GetCommandId() { return Commands::ArmFailSafe::Id; } |
121 | 0 | static constexpr ClusterId GetClusterId() { return Clusters::GeneralCommissioning::Id; } |
122 | | static constexpr bool kIsFabricScoped = false; |
123 | | |
124 | | uint16_t expiryLengthSeconds = static_cast<uint16_t>(0); |
125 | | uint64_t breadcrumb = static_cast<uint64_t>(0); |
126 | | |
127 | | CHIP_ERROR Decode(TLV::TLVReader & reader); |
128 | | }; |
129 | | }; // namespace ArmFailSafe |
130 | | namespace ArmFailSafeResponse { |
131 | | enum class Fields : uint8_t |
132 | | { |
133 | | kErrorCode = 0, |
134 | | kDebugText = 1, |
135 | | }; |
136 | | |
137 | | struct Type |
138 | | { |
139 | | public: |
140 | | // Use GetCommandId instead of commandId directly to avoid naming conflict with CommandIdentification in ExecutionOfACommand |
141 | 0 | static constexpr CommandId GetCommandId() { return Commands::ArmFailSafeResponse::Id; } |
142 | 0 | static constexpr ClusterId GetClusterId() { return Clusters::GeneralCommissioning::Id; } |
143 | | |
144 | | CommissioningErrorEnum errorCode = static_cast<CommissioningErrorEnum>(0); |
145 | | chip::CharSpan debugText; |
146 | | |
147 | | CHIP_ERROR Encode(DataModel::FabricAwareTLVWriter & aWriter, TLV::Tag aTag) const; |
148 | | |
149 | | using ResponseType = DataModel::NullObjectType; |
150 | | |
151 | 0 | static constexpr bool MustUseTimedInvoke() { return false; } |
152 | | }; |
153 | | |
154 | | struct DecodableType |
155 | | { |
156 | | public: |
157 | 0 | static constexpr CommandId GetCommandId() { return Commands::ArmFailSafeResponse::Id; } |
158 | 0 | static constexpr ClusterId GetClusterId() { return Clusters::GeneralCommissioning::Id; } |
159 | | |
160 | | CommissioningErrorEnum errorCode = static_cast<CommissioningErrorEnum>(0); |
161 | | chip::CharSpan debugText; |
162 | | |
163 | | CHIP_ERROR Decode(TLV::TLVReader & reader); |
164 | | }; |
165 | | }; // namespace ArmFailSafeResponse |
166 | | namespace SetRegulatoryConfig { |
167 | | enum class Fields : uint8_t |
168 | | { |
169 | | kNewRegulatoryConfig = 0, |
170 | | kCountryCode = 1, |
171 | | kBreadcrumb = 2, |
172 | | }; |
173 | | |
174 | | struct Type |
175 | | { |
176 | | public: |
177 | | // Use GetCommandId instead of commandId directly to avoid naming conflict with CommandIdentification in ExecutionOfACommand |
178 | 0 | static constexpr CommandId GetCommandId() { return Commands::SetRegulatoryConfig::Id; } |
179 | 0 | static constexpr ClusterId GetClusterId() { return Clusters::GeneralCommissioning::Id; } |
180 | | |
181 | | RegulatoryLocationTypeEnum newRegulatoryConfig = static_cast<RegulatoryLocationTypeEnum>(0); |
182 | | chip::CharSpan countryCode; |
183 | | uint64_t breadcrumb = static_cast<uint64_t>(0); |
184 | | |
185 | | CHIP_ERROR Encode(TLV::TLVWriter & aWriter, TLV::Tag aTag) const; |
186 | | |
187 | | using ResponseType = Clusters::GeneralCommissioning::Commands::SetRegulatoryConfigResponse::DecodableType; |
188 | | |
189 | 0 | static constexpr bool MustUseTimedInvoke() { return false; } |
190 | | }; |
191 | | |
192 | | struct DecodableType |
193 | | { |
194 | | public: |
195 | 0 | static constexpr CommandId GetCommandId() { return Commands::SetRegulatoryConfig::Id; } |
196 | 0 | static constexpr ClusterId GetClusterId() { return Clusters::GeneralCommissioning::Id; } |
197 | | static constexpr bool kIsFabricScoped = false; |
198 | | |
199 | | RegulatoryLocationTypeEnum newRegulatoryConfig = static_cast<RegulatoryLocationTypeEnum>(0); |
200 | | chip::CharSpan countryCode; |
201 | | uint64_t breadcrumb = static_cast<uint64_t>(0); |
202 | | |
203 | | CHIP_ERROR Decode(TLV::TLVReader & reader); |
204 | | }; |
205 | | }; // namespace SetRegulatoryConfig |
206 | | namespace SetRegulatoryConfigResponse { |
207 | | enum class Fields : uint8_t |
208 | | { |
209 | | kErrorCode = 0, |
210 | | kDebugText = 1, |
211 | | }; |
212 | | |
213 | | struct Type |
214 | | { |
215 | | public: |
216 | | // Use GetCommandId instead of commandId directly to avoid naming conflict with CommandIdentification in ExecutionOfACommand |
217 | 0 | static constexpr CommandId GetCommandId() { return Commands::SetRegulatoryConfigResponse::Id; } |
218 | 0 | static constexpr ClusterId GetClusterId() { return Clusters::GeneralCommissioning::Id; } |
219 | | |
220 | | CommissioningErrorEnum errorCode = static_cast<CommissioningErrorEnum>(0); |
221 | | chip::CharSpan debugText; |
222 | | |
223 | | CHIP_ERROR Encode(DataModel::FabricAwareTLVWriter & aWriter, TLV::Tag aTag) const; |
224 | | |
225 | | using ResponseType = DataModel::NullObjectType; |
226 | | |
227 | 0 | static constexpr bool MustUseTimedInvoke() { return false; } |
228 | | }; |
229 | | |
230 | | struct DecodableType |
231 | | { |
232 | | public: |
233 | 0 | static constexpr CommandId GetCommandId() { return Commands::SetRegulatoryConfigResponse::Id; } |
234 | 0 | static constexpr ClusterId GetClusterId() { return Clusters::GeneralCommissioning::Id; } |
235 | | |
236 | | CommissioningErrorEnum errorCode = static_cast<CommissioningErrorEnum>(0); |
237 | | chip::CharSpan debugText; |
238 | | |
239 | | CHIP_ERROR Decode(TLV::TLVReader & reader); |
240 | | }; |
241 | | }; // namespace SetRegulatoryConfigResponse |
242 | | namespace CommissioningComplete { |
243 | | enum class Fields : uint8_t |
244 | | { |
245 | | }; |
246 | | |
247 | | struct Type |
248 | | { |
249 | | public: |
250 | | // Use GetCommandId instead of commandId directly to avoid naming conflict with CommandIdentification in ExecutionOfACommand |
251 | 0 | static constexpr CommandId GetCommandId() { return Commands::CommissioningComplete::Id; } |
252 | 0 | static constexpr ClusterId GetClusterId() { return Clusters::GeneralCommissioning::Id; } |
253 | | |
254 | | CHIP_ERROR Encode(TLV::TLVWriter & aWriter, TLV::Tag aTag) const; |
255 | | |
256 | | using ResponseType = Clusters::GeneralCommissioning::Commands::CommissioningCompleteResponse::DecodableType; |
257 | | |
258 | 0 | static constexpr bool MustUseTimedInvoke() { return false; } |
259 | | }; |
260 | | |
261 | | struct DecodableType |
262 | | { |
263 | | public: |
264 | 0 | static constexpr CommandId GetCommandId() { return Commands::CommissioningComplete::Id; } |
265 | 0 | static constexpr ClusterId GetClusterId() { return Clusters::GeneralCommissioning::Id; } |
266 | | static constexpr bool kIsFabricScoped = true; |
267 | | |
268 | | CHIP_ERROR Decode(TLV::TLVReader & reader, FabricIndex aAccessingFabricIndex); |
269 | | }; |
270 | | }; // namespace CommissioningComplete |
271 | | namespace CommissioningCompleteResponse { |
272 | | enum class Fields : uint8_t |
273 | | { |
274 | | kErrorCode = 0, |
275 | | kDebugText = 1, |
276 | | }; |
277 | | |
278 | | struct Type |
279 | | { |
280 | | public: |
281 | | // Use GetCommandId instead of commandId directly to avoid naming conflict with CommandIdentification in ExecutionOfACommand |
282 | 0 | static constexpr CommandId GetCommandId() { return Commands::CommissioningCompleteResponse::Id; } |
283 | 0 | static constexpr ClusterId GetClusterId() { return Clusters::GeneralCommissioning::Id; } |
284 | | |
285 | | CommissioningErrorEnum errorCode = static_cast<CommissioningErrorEnum>(0); |
286 | | chip::CharSpan debugText; |
287 | | |
288 | | CHIP_ERROR Encode(DataModel::FabricAwareTLVWriter & aWriter, TLV::Tag aTag) const; |
289 | | |
290 | | using ResponseType = DataModel::NullObjectType; |
291 | | |
292 | 0 | static constexpr bool MustUseTimedInvoke() { return false; } |
293 | | }; |
294 | | |
295 | | struct DecodableType |
296 | | { |
297 | | public: |
298 | 0 | static constexpr CommandId GetCommandId() { return Commands::CommissioningCompleteResponse::Id; } |
299 | 0 | static constexpr ClusterId GetClusterId() { return Clusters::GeneralCommissioning::Id; } |
300 | | |
301 | | CommissioningErrorEnum errorCode = static_cast<CommissioningErrorEnum>(0); |
302 | | chip::CharSpan debugText; |
303 | | |
304 | | CHIP_ERROR Decode(TLV::TLVReader & reader); |
305 | | }; |
306 | | }; // namespace CommissioningCompleteResponse |
307 | | namespace SetTCAcknowledgements { |
308 | | enum class Fields : uint8_t |
309 | | { |
310 | | kTCVersion = 0, |
311 | | kTCUserResponse = 1, |
312 | | }; |
313 | | |
314 | | struct Type |
315 | | { |
316 | | public: |
317 | | // Use GetCommandId instead of commandId directly to avoid naming conflict with CommandIdentification in ExecutionOfACommand |
318 | 0 | static constexpr CommandId GetCommandId() { return Commands::SetTCAcknowledgements::Id; } |
319 | 0 | static constexpr ClusterId GetClusterId() { return Clusters::GeneralCommissioning::Id; } |
320 | | |
321 | | uint16_t TCVersion = static_cast<uint16_t>(0); |
322 | | uint16_t TCUserResponse = static_cast<uint16_t>(0); |
323 | | |
324 | | CHIP_ERROR Encode(TLV::TLVWriter & aWriter, TLV::Tag aTag) const; |
325 | | |
326 | | using ResponseType = Clusters::GeneralCommissioning::Commands::SetTCAcknowledgementsResponse::DecodableType; |
327 | | |
328 | 0 | static constexpr bool MustUseTimedInvoke() { return false; } |
329 | | }; |
330 | | |
331 | | struct DecodableType |
332 | | { |
333 | | public: |
334 | 0 | static constexpr CommandId GetCommandId() { return Commands::SetTCAcknowledgements::Id; } |
335 | 0 | static constexpr ClusterId GetClusterId() { return Clusters::GeneralCommissioning::Id; } |
336 | | static constexpr bool kIsFabricScoped = false; |
337 | | |
338 | | uint16_t TCVersion = static_cast<uint16_t>(0); |
339 | | uint16_t TCUserResponse = static_cast<uint16_t>(0); |
340 | | |
341 | | CHIP_ERROR Decode(TLV::TLVReader & reader); |
342 | | }; |
343 | | }; // namespace SetTCAcknowledgements |
344 | | namespace SetTCAcknowledgementsResponse { |
345 | | enum class Fields : uint8_t |
346 | | { |
347 | | kErrorCode = 0, |
348 | | }; |
349 | | |
350 | | struct Type |
351 | | { |
352 | | public: |
353 | | // Use GetCommandId instead of commandId directly to avoid naming conflict with CommandIdentification in ExecutionOfACommand |
354 | 0 | static constexpr CommandId GetCommandId() { return Commands::SetTCAcknowledgementsResponse::Id; } |
355 | 0 | static constexpr ClusterId GetClusterId() { return Clusters::GeneralCommissioning::Id; } |
356 | | |
357 | | CommissioningErrorEnum errorCode = static_cast<CommissioningErrorEnum>(0); |
358 | | |
359 | | CHIP_ERROR Encode(DataModel::FabricAwareTLVWriter & aWriter, TLV::Tag aTag) const; |
360 | | |
361 | | using ResponseType = DataModel::NullObjectType; |
362 | | |
363 | 0 | static constexpr bool MustUseTimedInvoke() { return false; } |
364 | | }; |
365 | | |
366 | | struct DecodableType |
367 | | { |
368 | | public: |
369 | 0 | static constexpr CommandId GetCommandId() { return Commands::SetTCAcknowledgementsResponse::Id; } |
370 | 0 | static constexpr ClusterId GetClusterId() { return Clusters::GeneralCommissioning::Id; } |
371 | | |
372 | | CommissioningErrorEnum errorCode = static_cast<CommissioningErrorEnum>(0); |
373 | | |
374 | | CHIP_ERROR Decode(TLV::TLVReader & reader); |
375 | | }; |
376 | | }; // namespace SetTCAcknowledgementsResponse |
377 | | } // namespace Commands |
378 | | } // namespace GeneralCommissioning |
379 | | } // namespace Clusters |
380 | | } // namespace app |
381 | | } // namespace chip |