3 * Copyright (c) 2021 Project CHIP Authors
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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 // THIS FILE IS GENERATED BY ZAP
20 // Prevent multiple inclusion
23 #include "af-structs.h"
25 #include "basic-types.h"
27 /** @brief Cluster Init
29 * This function is called when a specific cluster is initialized. It gives the
30 * application an opportunity to take care of cluster initialization procedures.
31 * It is called exactly once for each endpoint where cluster is present.
33 * @param endpoint Ver.: always
34 * @param clusterId Ver.: always
36 void emberAfClusterInitCallback(chip::EndpointId endpoint, chip::ClusterId clusterId);
38 // Cluster Init Functions
40 /** @brief Application Basic Cluster Init
44 * @param endpoint Endpoint that is being initialized
46 void emberAfApplicationBasicClusterInitCallback(chip::EndpointId endpoint);
48 /** @brief Barrier Control Cluster Init
52 * @param endpoint Endpoint that is being initialized
54 void emberAfBarrierControlClusterInitCallback(chip::EndpointId endpoint);
56 /** @brief Basic Cluster Init
60 * @param endpoint Endpoint that is being initialized
62 void emberAfBasicClusterInitCallback(chip::EndpointId endpoint);
64 /** @brief Binding Cluster Init
68 * @param endpoint Endpoint that is being initialized
70 void emberAfBindingClusterInitCallback(chip::EndpointId endpoint);
72 /** @brief Color Control Cluster Init
76 * @param endpoint Endpoint that is being initialized
78 void emberAfColorControlClusterInitCallback(chip::EndpointId endpoint);
80 /** @brief Content Launch Cluster Init
84 * @param endpoint Endpoint that is being initialized
86 void emberAfContentLaunchClusterInitCallback(chip::EndpointId endpoint);
88 /** @brief Door Lock Cluster Init
92 * @param endpoint Endpoint that is being initialized
94 void emberAfDoorLockClusterInitCallback(chip::EndpointId endpoint);
96 /** @brief General Commissioning Cluster Init
100 * @param endpoint Endpoint that is being initialized
102 void emberAfGeneralCommissioningClusterInitCallback(chip::EndpointId endpoint);
104 /** @brief Groups Cluster Init
108 * @param endpoint Endpoint that is being initialized
110 void emberAfGroupsClusterInitCallback(chip::EndpointId endpoint);
112 /** @brief Identify Cluster Init
116 * @param endpoint Endpoint that is being initialized
118 void emberAfIdentifyClusterInitCallback(chip::EndpointId endpoint);
120 /** @brief Level Control Cluster Init
124 * @param endpoint Endpoint that is being initialized
126 void emberAfLevelControlClusterInitCallback(chip::EndpointId endpoint);
128 /** @brief Low Power Cluster Init
132 * @param endpoint Endpoint that is being initialized
134 void emberAfLowPowerClusterInitCallback(chip::EndpointId endpoint);
136 /** @brief Media Playback Cluster Init
140 * @param endpoint Endpoint that is being initialized
142 void emberAfMediaPlaybackClusterInitCallback(chip::EndpointId endpoint);
144 /** @brief On/off Cluster Init
148 * @param endpoint Endpoint that is being initialized
150 void emberAfOnOffClusterInitCallback(chip::EndpointId endpoint);
152 /** @brief Scenes Cluster Init
156 * @param endpoint Endpoint that is being initialized
158 void emberAfScenesClusterInitCallback(chip::EndpointId endpoint);
160 /** @brief Temperature Measurement Cluster Init
164 * @param endpoint Endpoint that is being initialized
166 void emberAfTemperatureMeasurementClusterInitCallback(chip::EndpointId endpoint);
168 // Cluster Server/Client Init Functions
171 // Application Basic Cluster client
174 /** @brief Application Basic Cluster Client Init
178 * @param endpoint Endpoint that is being initialized
180 void emberAfApplicationBasicClusterClientInitCallback(chip::EndpointId endpoint);
182 /** @brief Application Basic Cluster Client Attribute Changed
184 * Client Attribute Changed
186 * @param endpoint Endpoint that is being initialized
187 * @param attributeId Attribute that changed
189 void emberAfApplicationBasicClusterClientAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId);
191 /** @brief Application Basic Cluster Client Manufacturer Specific Attribute Changed
193 * Client Manufacturer Specific Attribute Changed
195 * @param endpoint Endpoint that is being initialized
196 * @param attributeId Attribute that changed
197 * @param manufacturerCode Manufacturer Code of the attribute that changed
199 void emberAfApplicationBasicClusterClientManufacturerSpecificAttributeChangedCallback(chip::EndpointId endpoint,
200 chip::AttributeId attributeId,
201 uint16_t manufacturerCode);
203 /** @brief Application Basic Cluster Client Message Sent
205 * Client Message Sent
207 * @param type The type of message sent
208 * @param indexOrDestination The destination or address to which the message was sent
209 * @param apsFrame The APS frame for the message
210 * @param msgLen The length of the message
211 * @param message The message that was sent
212 * @param status The status of the sent message
214 void emberAfApplicationBasicClusterClientMessageSentCallback(EmberOutgoingMessageType type, uint64_t indexOrDestination,
215 EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message,
218 /** @brief Application Basic Cluster Client Pre Attribute Changed
220 * client Pre Attribute Changed
222 * @param endpoint Endpoint that is being initialized
223 * @param attributeId Attribute to be changed
224 * @param attributeType Attribute type
225 * @param size Attribute size
226 * @param value Attribute value
228 EmberAfStatus emberAfApplicationBasicClusterClientPreAttributeChangedCallback(chip::EndpointId endpoint,
229 chip::AttributeId attributeId,
230 EmberAfAttributeType attributeType, uint8_t size,
233 /** @brief Application Basic Cluster Client Tick
237 * @param endpoint Endpoint that is being served
239 void emberAfApplicationBasicClusterClientTickCallback(chip::EndpointId endpoint);
242 // Barrier Control Cluster client
245 /** @brief Barrier Control Cluster Client Init
249 * @param endpoint Endpoint that is being initialized
251 void emberAfBarrierControlClusterClientInitCallback(chip::EndpointId endpoint);
253 /** @brief Barrier Control Cluster Client Attribute Changed
255 * Client Attribute Changed
257 * @param endpoint Endpoint that is being initialized
258 * @param attributeId Attribute that changed
260 void emberAfBarrierControlClusterClientAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId);
262 /** @brief Barrier Control Cluster Client Manufacturer Specific Attribute Changed
264 * Client Manufacturer Specific Attribute Changed
266 * @param endpoint Endpoint that is being initialized
267 * @param attributeId Attribute that changed
268 * @param manufacturerCode Manufacturer Code of the attribute that changed
270 void emberAfBarrierControlClusterClientManufacturerSpecificAttributeChangedCallback(chip::EndpointId endpoint,
271 chip::AttributeId attributeId,
272 uint16_t manufacturerCode);
274 /** @brief Barrier Control Cluster Client Message Sent
276 * Client Message Sent
278 * @param type The type of message sent
279 * @param indexOrDestination The destination or address to which the message was sent
280 * @param apsFrame The APS frame for the message
281 * @param msgLen The length of the message
282 * @param message The message that was sent
283 * @param status The status of the sent message
285 void emberAfBarrierControlClusterClientMessageSentCallback(EmberOutgoingMessageType type, uint64_t indexOrDestination,
286 EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message,
289 /** @brief Barrier Control Cluster Client Pre Attribute Changed
291 * client Pre Attribute Changed
293 * @param endpoint Endpoint that is being initialized
294 * @param attributeId Attribute to be changed
295 * @param attributeType Attribute type
296 * @param size Attribute size
297 * @param value Attribute value
299 EmberAfStatus emberAfBarrierControlClusterClientPreAttributeChangedCallback(chip::EndpointId endpoint,
300 chip::AttributeId attributeId,
301 EmberAfAttributeType attributeType, uint8_t size,
304 /** @brief Barrier Control Cluster Client Tick
308 * @param endpoint Endpoint that is being served
310 void emberAfBarrierControlClusterClientTickCallback(chip::EndpointId endpoint);
313 // Basic Cluster client
316 /** @brief Basic Cluster Client Init
320 * @param endpoint Endpoint that is being initialized
322 void emberAfBasicClusterClientInitCallback(chip::EndpointId endpoint);
324 /** @brief Basic Cluster Client Attribute Changed
326 * Client Attribute Changed
328 * @param endpoint Endpoint that is being initialized
329 * @param attributeId Attribute that changed
331 void emberAfBasicClusterClientAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId);
333 /** @brief Basic Cluster Client Manufacturer Specific Attribute Changed
335 * Client Manufacturer Specific Attribute Changed
337 * @param endpoint Endpoint that is being initialized
338 * @param attributeId Attribute that changed
339 * @param manufacturerCode Manufacturer Code of the attribute that changed
341 void emberAfBasicClusterClientManufacturerSpecificAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId,
342 uint16_t manufacturerCode);
344 /** @brief Basic Cluster Client Message Sent
346 * Client Message Sent
348 * @param type The type of message sent
349 * @param indexOrDestination The destination or address to which the message was sent
350 * @param apsFrame The APS frame for the message
351 * @param msgLen The length of the message
352 * @param message The message that was sent
353 * @param status The status of the sent message
355 void emberAfBasicClusterClientMessageSentCallback(EmberOutgoingMessageType type, uint64_t indexOrDestination,
356 EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message, EmberStatus status);
358 /** @brief Basic Cluster Client Pre Attribute Changed
360 * client Pre Attribute Changed
362 * @param endpoint Endpoint that is being initialized
363 * @param attributeId Attribute to be changed
364 * @param attributeType Attribute type
365 * @param size Attribute size
366 * @param value Attribute value
368 EmberAfStatus emberAfBasicClusterClientPreAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId,
369 EmberAfAttributeType attributeType, uint8_t size,
372 /** @brief Basic Cluster Client Tick
376 * @param endpoint Endpoint that is being served
378 void emberAfBasicClusterClientTickCallback(chip::EndpointId endpoint);
381 // Binding Cluster client
384 /** @brief Binding Cluster Client Init
388 * @param endpoint Endpoint that is being initialized
390 void emberAfBindingClusterClientInitCallback(chip::EndpointId endpoint);
392 /** @brief Binding Cluster Client Attribute Changed
394 * Client Attribute Changed
396 * @param endpoint Endpoint that is being initialized
397 * @param attributeId Attribute that changed
399 void emberAfBindingClusterClientAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId);
401 /** @brief Binding Cluster Client Manufacturer Specific Attribute Changed
403 * Client Manufacturer Specific Attribute Changed
405 * @param endpoint Endpoint that is being initialized
406 * @param attributeId Attribute that changed
407 * @param manufacturerCode Manufacturer Code of the attribute that changed
409 void emberAfBindingClusterClientManufacturerSpecificAttributeChangedCallback(chip::EndpointId endpoint,
410 chip::AttributeId attributeId,
411 uint16_t manufacturerCode);
413 /** @brief Binding Cluster Client Message Sent
415 * Client Message Sent
417 * @param type The type of message sent
418 * @param indexOrDestination The destination or address to which the message was sent
419 * @param apsFrame The APS frame for the message
420 * @param msgLen The length of the message
421 * @param message The message that was sent
422 * @param status The status of the sent message
424 void emberAfBindingClusterClientMessageSentCallback(EmberOutgoingMessageType type, uint64_t indexOrDestination,
425 EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message,
428 /** @brief Binding Cluster Client Pre Attribute Changed
430 * client Pre Attribute Changed
432 * @param endpoint Endpoint that is being initialized
433 * @param attributeId Attribute to be changed
434 * @param attributeType Attribute type
435 * @param size Attribute size
436 * @param value Attribute value
438 EmberAfStatus emberAfBindingClusterClientPreAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId,
439 EmberAfAttributeType attributeType, uint8_t size,
442 /** @brief Binding Cluster Client Tick
446 * @param endpoint Endpoint that is being served
448 void emberAfBindingClusterClientTickCallback(chip::EndpointId endpoint);
451 // Color Control Cluster client
454 /** @brief Color Control Cluster Client Init
458 * @param endpoint Endpoint that is being initialized
460 void emberAfColorControlClusterClientInitCallback(chip::EndpointId endpoint);
462 /** @brief Color Control Cluster Client Attribute Changed
464 * Client Attribute Changed
466 * @param endpoint Endpoint that is being initialized
467 * @param attributeId Attribute that changed
469 void emberAfColorControlClusterClientAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId);
471 /** @brief Color Control Cluster Client Manufacturer Specific Attribute Changed
473 * Client Manufacturer Specific Attribute Changed
475 * @param endpoint Endpoint that is being initialized
476 * @param attributeId Attribute that changed
477 * @param manufacturerCode Manufacturer Code of the attribute that changed
479 void emberAfColorControlClusterClientManufacturerSpecificAttributeChangedCallback(chip::EndpointId endpoint,
480 chip::AttributeId attributeId,
481 uint16_t manufacturerCode);
483 /** @brief Color Control Cluster Client Message Sent
485 * Client Message Sent
487 * @param type The type of message sent
488 * @param indexOrDestination The destination or address to which the message was sent
489 * @param apsFrame The APS frame for the message
490 * @param msgLen The length of the message
491 * @param message The message that was sent
492 * @param status The status of the sent message
494 void emberAfColorControlClusterClientMessageSentCallback(EmberOutgoingMessageType type, uint64_t indexOrDestination,
495 EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message,
498 /** @brief Color Control Cluster Client Pre Attribute Changed
500 * client Pre Attribute Changed
502 * @param endpoint Endpoint that is being initialized
503 * @param attributeId Attribute to be changed
504 * @param attributeType Attribute type
505 * @param size Attribute size
506 * @param value Attribute value
508 EmberAfStatus emberAfColorControlClusterClientPreAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId,
509 EmberAfAttributeType attributeType, uint8_t size,
512 /** @brief Color Control Cluster Client Tick
516 * @param endpoint Endpoint that is being served
518 void emberAfColorControlClusterClientTickCallback(chip::EndpointId endpoint);
521 // Content Launch Cluster client
524 /** @brief Content Launch Cluster Client Init
528 * @param endpoint Endpoint that is being initialized
530 void emberAfContentLaunchClusterClientInitCallback(chip::EndpointId endpoint);
532 /** @brief Content Launch Cluster Client Attribute Changed
534 * Client Attribute Changed
536 * @param endpoint Endpoint that is being initialized
537 * @param attributeId Attribute that changed
539 void emberAfContentLaunchClusterClientAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId);
541 /** @brief Content Launch Cluster Client Manufacturer Specific Attribute Changed
543 * Client Manufacturer Specific Attribute Changed
545 * @param endpoint Endpoint that is being initialized
546 * @param attributeId Attribute that changed
547 * @param manufacturerCode Manufacturer Code of the attribute that changed
549 void emberAfContentLaunchClusterClientManufacturerSpecificAttributeChangedCallback(chip::EndpointId endpoint,
550 chip::AttributeId attributeId,
551 uint16_t manufacturerCode);
553 /** @brief Content Launch Cluster Client Message Sent
555 * Client Message Sent
557 * @param type The type of message sent
558 * @param indexOrDestination The destination or address to which the message was sent
559 * @param apsFrame The APS frame for the message
560 * @param msgLen The length of the message
561 * @param message The message that was sent
562 * @param status The status of the sent message
564 void emberAfContentLaunchClusterClientMessageSentCallback(EmberOutgoingMessageType type, uint64_t indexOrDestination,
565 EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message,
568 /** @brief Content Launch Cluster Client Pre Attribute Changed
570 * client Pre Attribute Changed
572 * @param endpoint Endpoint that is being initialized
573 * @param attributeId Attribute to be changed
574 * @param attributeType Attribute type
575 * @param size Attribute size
576 * @param value Attribute value
578 EmberAfStatus emberAfContentLaunchClusterClientPreAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId,
579 EmberAfAttributeType attributeType, uint8_t size,
582 /** @brief Content Launch Cluster Client Tick
586 * @param endpoint Endpoint that is being served
588 void emberAfContentLaunchClusterClientTickCallback(chip::EndpointId endpoint);
591 // Door Lock Cluster client
594 /** @brief Door Lock Cluster Client Init
598 * @param endpoint Endpoint that is being initialized
600 void emberAfDoorLockClusterClientInitCallback(chip::EndpointId endpoint);
602 /** @brief Door Lock Cluster Client Attribute Changed
604 * Client Attribute Changed
606 * @param endpoint Endpoint that is being initialized
607 * @param attributeId Attribute that changed
609 void emberAfDoorLockClusterClientAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId);
611 /** @brief Door Lock Cluster Client Manufacturer Specific Attribute Changed
613 * Client Manufacturer Specific Attribute Changed
615 * @param endpoint Endpoint that is being initialized
616 * @param attributeId Attribute that changed
617 * @param manufacturerCode Manufacturer Code of the attribute that changed
619 void emberAfDoorLockClusterClientManufacturerSpecificAttributeChangedCallback(chip::EndpointId endpoint,
620 chip::AttributeId attributeId,
621 uint16_t manufacturerCode);
623 /** @brief Door Lock Cluster Client Message Sent
625 * Client Message Sent
627 * @param type The type of message sent
628 * @param indexOrDestination The destination or address to which the message was sent
629 * @param apsFrame The APS frame for the message
630 * @param msgLen The length of the message
631 * @param message The message that was sent
632 * @param status The status of the sent message
634 void emberAfDoorLockClusterClientMessageSentCallback(EmberOutgoingMessageType type, uint64_t indexOrDestination,
635 EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message,
638 /** @brief Door Lock Cluster Client Pre Attribute Changed
640 * client Pre Attribute Changed
642 * @param endpoint Endpoint that is being initialized
643 * @param attributeId Attribute to be changed
644 * @param attributeType Attribute type
645 * @param size Attribute size
646 * @param value Attribute value
648 EmberAfStatus emberAfDoorLockClusterClientPreAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId,
649 EmberAfAttributeType attributeType, uint8_t size,
652 /** @brief Door Lock Cluster Client Tick
656 * @param endpoint Endpoint that is being served
658 void emberAfDoorLockClusterClientTickCallback(chip::EndpointId endpoint);
661 // General Commissioning Cluster client
664 /** @brief General Commissioning Cluster Client Init
668 * @param endpoint Endpoint that is being initialized
670 void emberAfGeneralCommissioningClusterClientInitCallback(chip::EndpointId endpoint);
672 /** @brief General Commissioning Cluster Client Attribute Changed
674 * Client Attribute Changed
676 * @param endpoint Endpoint that is being initialized
677 * @param attributeId Attribute that changed
679 void emberAfGeneralCommissioningClusterClientAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId);
681 /** @brief General Commissioning Cluster Client Manufacturer Specific Attribute Changed
683 * Client Manufacturer Specific Attribute Changed
685 * @param endpoint Endpoint that is being initialized
686 * @param attributeId Attribute that changed
687 * @param manufacturerCode Manufacturer Code of the attribute that changed
689 void emberAfGeneralCommissioningClusterClientManufacturerSpecificAttributeChangedCallback(chip::EndpointId endpoint,
690 chip::AttributeId attributeId,
691 uint16_t manufacturerCode);
693 /** @brief General Commissioning Cluster Client Message Sent
695 * Client Message Sent
697 * @param type The type of message sent
698 * @param indexOrDestination The destination or address to which the message was sent
699 * @param apsFrame The APS frame for the message
700 * @param msgLen The length of the message
701 * @param message The message that was sent
702 * @param status The status of the sent message
704 void emberAfGeneralCommissioningClusterClientMessageSentCallback(EmberOutgoingMessageType type, uint64_t indexOrDestination,
705 EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message,
708 /** @brief General Commissioning Cluster Client Pre Attribute Changed
710 * client Pre Attribute Changed
712 * @param endpoint Endpoint that is being initialized
713 * @param attributeId Attribute to be changed
714 * @param attributeType Attribute type
715 * @param size Attribute size
716 * @param value Attribute value
718 EmberAfStatus emberAfGeneralCommissioningClusterClientPreAttributeChangedCallback(chip::EndpointId endpoint,
719 chip::AttributeId attributeId,
720 EmberAfAttributeType attributeType, uint8_t size,
723 /** @brief General Commissioning Cluster Client Tick
727 * @param endpoint Endpoint that is being served
729 void emberAfGeneralCommissioningClusterClientTickCallback(chip::EndpointId endpoint);
732 // Groups Cluster client
735 /** @brief Groups Cluster Client Init
739 * @param endpoint Endpoint that is being initialized
741 void emberAfGroupsClusterClientInitCallback(chip::EndpointId endpoint);
743 /** @brief Groups Cluster Client Attribute Changed
745 * Client Attribute Changed
747 * @param endpoint Endpoint that is being initialized
748 * @param attributeId Attribute that changed
750 void emberAfGroupsClusterClientAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId);
752 /** @brief Groups Cluster Client Manufacturer Specific Attribute Changed
754 * Client Manufacturer Specific Attribute Changed
756 * @param endpoint Endpoint that is being initialized
757 * @param attributeId Attribute that changed
758 * @param manufacturerCode Manufacturer Code of the attribute that changed
760 void emberAfGroupsClusterClientManufacturerSpecificAttributeChangedCallback(chip::EndpointId endpoint,
761 chip::AttributeId attributeId,
762 uint16_t manufacturerCode);
764 /** @brief Groups Cluster Client Message Sent
766 * Client Message Sent
768 * @param type The type of message sent
769 * @param indexOrDestination The destination or address to which the message was sent
770 * @param apsFrame The APS frame for the message
771 * @param msgLen The length of the message
772 * @param message The message that was sent
773 * @param status The status of the sent message
775 void emberAfGroupsClusterClientMessageSentCallback(EmberOutgoingMessageType type, uint64_t indexOrDestination,
776 EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message,
779 /** @brief Groups Cluster Client Pre Attribute Changed
781 * client Pre Attribute Changed
783 * @param endpoint Endpoint that is being initialized
784 * @param attributeId Attribute to be changed
785 * @param attributeType Attribute type
786 * @param size Attribute size
787 * @param value Attribute value
789 EmberAfStatus emberAfGroupsClusterClientPreAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId,
790 EmberAfAttributeType attributeType, uint8_t size,
793 /** @brief Groups Cluster Client Tick
797 * @param endpoint Endpoint that is being served
799 void emberAfGroupsClusterClientTickCallback(chip::EndpointId endpoint);
802 // Identify Cluster client
805 /** @brief Identify Cluster Client Init
809 * @param endpoint Endpoint that is being initialized
811 void emberAfIdentifyClusterClientInitCallback(chip::EndpointId endpoint);
813 /** @brief Identify Cluster Client Attribute Changed
815 * Client Attribute Changed
817 * @param endpoint Endpoint that is being initialized
818 * @param attributeId Attribute that changed
820 void emberAfIdentifyClusterClientAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId);
822 /** @brief Identify Cluster Client Manufacturer Specific Attribute Changed
824 * Client Manufacturer Specific Attribute Changed
826 * @param endpoint Endpoint that is being initialized
827 * @param attributeId Attribute that changed
828 * @param manufacturerCode Manufacturer Code of the attribute that changed
830 void emberAfIdentifyClusterClientManufacturerSpecificAttributeChangedCallback(chip::EndpointId endpoint,
831 chip::AttributeId attributeId,
832 uint16_t manufacturerCode);
834 /** @brief Identify Cluster Client Message Sent
836 * Client Message Sent
838 * @param type The type of message sent
839 * @param indexOrDestination The destination or address to which the message was sent
840 * @param apsFrame The APS frame for the message
841 * @param msgLen The length of the message
842 * @param message The message that was sent
843 * @param status The status of the sent message
845 void emberAfIdentifyClusterClientMessageSentCallback(EmberOutgoingMessageType type, uint64_t indexOrDestination,
846 EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message,
849 /** @brief Identify Cluster Client Pre Attribute Changed
851 * client Pre Attribute Changed
853 * @param endpoint Endpoint that is being initialized
854 * @param attributeId Attribute to be changed
855 * @param attributeType Attribute type
856 * @param size Attribute size
857 * @param value Attribute value
859 EmberAfStatus emberAfIdentifyClusterClientPreAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId,
860 EmberAfAttributeType attributeType, uint8_t size,
863 /** @brief Identify Cluster Client Tick
867 * @param endpoint Endpoint that is being served
869 void emberAfIdentifyClusterClientTickCallback(chip::EndpointId endpoint);
872 // Level Control Cluster client
875 /** @brief Level Control Cluster Client Init
879 * @param endpoint Endpoint that is being initialized
881 void emberAfLevelControlClusterClientInitCallback(chip::EndpointId endpoint);
883 /** @brief Level Control Cluster Client Attribute Changed
885 * Client Attribute Changed
887 * @param endpoint Endpoint that is being initialized
888 * @param attributeId Attribute that changed
890 void emberAfLevelControlClusterClientAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId);
892 /** @brief Level Control Cluster Client Manufacturer Specific Attribute Changed
894 * Client Manufacturer Specific Attribute Changed
896 * @param endpoint Endpoint that is being initialized
897 * @param attributeId Attribute that changed
898 * @param manufacturerCode Manufacturer Code of the attribute that changed
900 void emberAfLevelControlClusterClientManufacturerSpecificAttributeChangedCallback(chip::EndpointId endpoint,
901 chip::AttributeId attributeId,
902 uint16_t manufacturerCode);
904 /** @brief Level Control Cluster Client Message Sent
906 * Client Message Sent
908 * @param type The type of message sent
909 * @param indexOrDestination The destination or address to which the message was sent
910 * @param apsFrame The APS frame for the message
911 * @param msgLen The length of the message
912 * @param message The message that was sent
913 * @param status The status of the sent message
915 void emberAfLevelControlClusterClientMessageSentCallback(EmberOutgoingMessageType type, uint64_t indexOrDestination,
916 EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message,
919 /** @brief Level Control Cluster Client Pre Attribute Changed
921 * client Pre Attribute Changed
923 * @param endpoint Endpoint that is being initialized
924 * @param attributeId Attribute to be changed
925 * @param attributeType Attribute type
926 * @param size Attribute size
927 * @param value Attribute value
929 EmberAfStatus emberAfLevelControlClusterClientPreAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId,
930 EmberAfAttributeType attributeType, uint8_t size,
933 /** @brief Level Control Cluster Client Tick
937 * @param endpoint Endpoint that is being served
939 void emberAfLevelControlClusterClientTickCallback(chip::EndpointId endpoint);
942 // Low Power Cluster client
945 /** @brief Low Power Cluster Client Init
949 * @param endpoint Endpoint that is being initialized
951 void emberAfLowPowerClusterClientInitCallback(chip::EndpointId endpoint);
953 /** @brief Low Power Cluster Client Attribute Changed
955 * Client Attribute Changed
957 * @param endpoint Endpoint that is being initialized
958 * @param attributeId Attribute that changed
960 void emberAfLowPowerClusterClientAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId);
962 /** @brief Low Power Cluster Client Manufacturer Specific Attribute Changed
964 * Client Manufacturer Specific Attribute Changed
966 * @param endpoint Endpoint that is being initialized
967 * @param attributeId Attribute that changed
968 * @param manufacturerCode Manufacturer Code of the attribute that changed
970 void emberAfLowPowerClusterClientManufacturerSpecificAttributeChangedCallback(chip::EndpointId endpoint,
971 chip::AttributeId attributeId,
972 uint16_t manufacturerCode);
974 /** @brief Low Power Cluster Client Message Sent
976 * Client Message Sent
978 * @param type The type of message sent
979 * @param indexOrDestination The destination or address to which the message was sent
980 * @param apsFrame The APS frame for the message
981 * @param msgLen The length of the message
982 * @param message The message that was sent
983 * @param status The status of the sent message
985 void emberAfLowPowerClusterClientMessageSentCallback(EmberOutgoingMessageType type, uint64_t indexOrDestination,
986 EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message,
989 /** @brief Low Power Cluster Client Pre Attribute Changed
991 * client Pre Attribute Changed
993 * @param endpoint Endpoint that is being initialized
994 * @param attributeId Attribute to be changed
995 * @param attributeType Attribute type
996 * @param size Attribute size
997 * @param value Attribute value
999 EmberAfStatus emberAfLowPowerClusterClientPreAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId,
1000 EmberAfAttributeType attributeType, uint8_t size,
1003 /** @brief Low Power Cluster Client Tick
1007 * @param endpoint Endpoint that is being served
1009 void emberAfLowPowerClusterClientTickCallback(chip::EndpointId endpoint);
1012 // Media Playback Cluster client
1015 /** @brief Media Playback Cluster Client Init
1019 * @param endpoint Endpoint that is being initialized
1021 void emberAfMediaPlaybackClusterClientInitCallback(chip::EndpointId endpoint);
1023 /** @brief Media Playback Cluster Client Attribute Changed
1025 * Client Attribute Changed
1027 * @param endpoint Endpoint that is being initialized
1028 * @param attributeId Attribute that changed
1030 void emberAfMediaPlaybackClusterClientAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId);
1032 /** @brief Media Playback Cluster Client Manufacturer Specific Attribute Changed
1034 * Client Manufacturer Specific Attribute Changed
1036 * @param endpoint Endpoint that is being initialized
1037 * @param attributeId Attribute that changed
1038 * @param manufacturerCode Manufacturer Code of the attribute that changed
1040 void emberAfMediaPlaybackClusterClientManufacturerSpecificAttributeChangedCallback(chip::EndpointId endpoint,
1041 chip::AttributeId attributeId,
1042 uint16_t manufacturerCode);
1044 /** @brief Media Playback Cluster Client Message Sent
1046 * Client Message Sent
1048 * @param type The type of message sent
1049 * @param indexOrDestination The destination or address to which the message was sent
1050 * @param apsFrame The APS frame for the message
1051 * @param msgLen The length of the message
1052 * @param message The message that was sent
1053 * @param status The status of the sent message
1055 void emberAfMediaPlaybackClusterClientMessageSentCallback(EmberOutgoingMessageType type, uint64_t indexOrDestination,
1056 EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message,
1057 EmberStatus status);
1059 /** @brief Media Playback Cluster Client Pre Attribute Changed
1061 * client Pre Attribute Changed
1063 * @param endpoint Endpoint that is being initialized
1064 * @param attributeId Attribute to be changed
1065 * @param attributeType Attribute type
1066 * @param size Attribute size
1067 * @param value Attribute value
1069 EmberAfStatus emberAfMediaPlaybackClusterClientPreAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId,
1070 EmberAfAttributeType attributeType, uint8_t size,
1073 /** @brief Media Playback Cluster Client Tick
1077 * @param endpoint Endpoint that is being served
1079 void emberAfMediaPlaybackClusterClientTickCallback(chip::EndpointId endpoint);
1082 // On/off Cluster client
1085 /** @brief On/off Cluster Client Init
1089 * @param endpoint Endpoint that is being initialized
1091 void emberAfOnOffClusterClientInitCallback(chip::EndpointId endpoint);
1093 /** @brief On/off Cluster Client Attribute Changed
1095 * Client Attribute Changed
1097 * @param endpoint Endpoint that is being initialized
1098 * @param attributeId Attribute that changed
1100 void emberAfOnOffClusterClientAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId);
1102 /** @brief On/off Cluster Client Manufacturer Specific Attribute Changed
1104 * Client Manufacturer Specific Attribute Changed
1106 * @param endpoint Endpoint that is being initialized
1107 * @param attributeId Attribute that changed
1108 * @param manufacturerCode Manufacturer Code of the attribute that changed
1110 void emberAfOnOffClusterClientManufacturerSpecificAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId,
1111 uint16_t manufacturerCode);
1113 /** @brief On/off Cluster Client Message Sent
1115 * Client Message Sent
1117 * @param type The type of message sent
1118 * @param indexOrDestination The destination or address to which the message was sent
1119 * @param apsFrame The APS frame for the message
1120 * @param msgLen The length of the message
1121 * @param message The message that was sent
1122 * @param status The status of the sent message
1124 void emberAfOnOffClusterClientMessageSentCallback(EmberOutgoingMessageType type, uint64_t indexOrDestination,
1125 EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message, EmberStatus status);
1127 /** @brief On/off Cluster Client Pre Attribute Changed
1129 * client Pre Attribute Changed
1131 * @param endpoint Endpoint that is being initialized
1132 * @param attributeId Attribute to be changed
1133 * @param attributeType Attribute type
1134 * @param size Attribute size
1135 * @param value Attribute value
1137 EmberAfStatus emberAfOnOffClusterClientPreAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId,
1138 EmberAfAttributeType attributeType, uint8_t size,
1141 /** @brief On/off Cluster Client Tick
1145 * @param endpoint Endpoint that is being served
1147 void emberAfOnOffClusterClientTickCallback(chip::EndpointId endpoint);
1150 // Scenes Cluster client
1153 /** @brief Scenes Cluster Client Init
1157 * @param endpoint Endpoint that is being initialized
1159 void emberAfScenesClusterClientInitCallback(chip::EndpointId endpoint);
1161 /** @brief Scenes Cluster Client Attribute Changed
1163 * Client Attribute Changed
1165 * @param endpoint Endpoint that is being initialized
1166 * @param attributeId Attribute that changed
1168 void emberAfScenesClusterClientAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId);
1170 /** @brief Scenes Cluster Client Manufacturer Specific Attribute Changed
1172 * Client Manufacturer Specific Attribute Changed
1174 * @param endpoint Endpoint that is being initialized
1175 * @param attributeId Attribute that changed
1176 * @param manufacturerCode Manufacturer Code of the attribute that changed
1178 void emberAfScenesClusterClientManufacturerSpecificAttributeChangedCallback(chip::EndpointId endpoint,
1179 chip::AttributeId attributeId,
1180 uint16_t manufacturerCode);
1182 /** @brief Scenes Cluster Client Message Sent
1184 * Client Message Sent
1186 * @param type The type of message sent
1187 * @param indexOrDestination The destination or address to which the message was sent
1188 * @param apsFrame The APS frame for the message
1189 * @param msgLen The length of the message
1190 * @param message The message that was sent
1191 * @param status The status of the sent message
1193 void emberAfScenesClusterClientMessageSentCallback(EmberOutgoingMessageType type, uint64_t indexOrDestination,
1194 EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message,
1195 EmberStatus status);
1197 /** @brief Scenes Cluster Client Pre Attribute Changed
1199 * client Pre Attribute Changed
1201 * @param endpoint Endpoint that is being initialized
1202 * @param attributeId Attribute to be changed
1203 * @param attributeType Attribute type
1204 * @param size Attribute size
1205 * @param value Attribute value
1207 EmberAfStatus emberAfScenesClusterClientPreAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId,
1208 EmberAfAttributeType attributeType, uint8_t size,
1211 /** @brief Scenes Cluster Client Tick
1215 * @param endpoint Endpoint that is being served
1217 void emberAfScenesClusterClientTickCallback(chip::EndpointId endpoint);
1220 // Temperature Measurement Cluster client
1223 /** @brief Temperature Measurement Cluster Client Init
1227 * @param endpoint Endpoint that is being initialized
1229 void emberAfTemperatureMeasurementClusterClientInitCallback(chip::EndpointId endpoint);
1231 /** @brief Temperature Measurement Cluster Client Attribute Changed
1233 * Client Attribute Changed
1235 * @param endpoint Endpoint that is being initialized
1236 * @param attributeId Attribute that changed
1238 void emberAfTemperatureMeasurementClusterClientAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId);
1240 /** @brief Temperature Measurement Cluster Client Manufacturer Specific Attribute Changed
1242 * Client Manufacturer Specific Attribute Changed
1244 * @param endpoint Endpoint that is being initialized
1245 * @param attributeId Attribute that changed
1246 * @param manufacturerCode Manufacturer Code of the attribute that changed
1248 void emberAfTemperatureMeasurementClusterClientManufacturerSpecificAttributeChangedCallback(chip::EndpointId endpoint,
1249 chip::AttributeId attributeId,
1250 uint16_t manufacturerCode);
1252 /** @brief Temperature Measurement Cluster Client Message Sent
1254 * Client Message Sent
1256 * @param type The type of message sent
1257 * @param indexOrDestination The destination or address to which the message was sent
1258 * @param apsFrame The APS frame for the message
1259 * @param msgLen The length of the message
1260 * @param message The message that was sent
1261 * @param status The status of the sent message
1263 void emberAfTemperatureMeasurementClusterClientMessageSentCallback(EmberOutgoingMessageType type, uint64_t indexOrDestination,
1264 EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message,
1265 EmberStatus status);
1267 /** @brief Temperature Measurement Cluster Client Pre Attribute Changed
1269 * client Pre Attribute Changed
1271 * @param endpoint Endpoint that is being initialized
1272 * @param attributeId Attribute to be changed
1273 * @param attributeType Attribute type
1274 * @param size Attribute size
1275 * @param value Attribute value
1277 EmberAfStatus emberAfTemperatureMeasurementClusterClientPreAttributeChangedCallback(chip::EndpointId endpoint,
1278 chip::AttributeId attributeId,
1279 EmberAfAttributeType attributeType,
1280 uint8_t size, uint8_t * value);
1282 /** @brief Temperature Measurement Cluster Client Tick
1286 * @param endpoint Endpoint that is being served
1288 void emberAfTemperatureMeasurementClusterClientTickCallback(chip::EndpointId endpoint);
1290 // Cluster Commands Callback
1293 * @brief Content Launch Cluster LaunchContentResponse Command callback
1294 * @param contentLaunchStatus
1297 bool emberAfContentLaunchClusterLaunchContentResponseCallback(uint8_t contentLaunchStatus);
1300 * @brief Content Launch Cluster LaunchURLResponse Command callback
1301 * @param contentLaunchStatus
1304 bool emberAfContentLaunchClusterLaunchURLResponseCallback(uint8_t contentLaunchStatus);
1307 * @brief Door Lock Cluster ClearAllPinsResponse Command callback
1311 bool emberAfDoorLockClusterClearAllPinsResponseCallback(uint8_t status);
1314 * @brief Door Lock Cluster ClearAllRfidsResponse Command callback
1318 bool emberAfDoorLockClusterClearAllRfidsResponseCallback(uint8_t status);
1321 * @brief Door Lock Cluster ClearHolidayScheduleResponse Command callback
1325 bool emberAfDoorLockClusterClearHolidayScheduleResponseCallback(uint8_t status);
1328 * @brief Door Lock Cluster ClearPinResponse Command callback
1332 bool emberAfDoorLockClusterClearPinResponseCallback(uint8_t status);
1335 * @brief Door Lock Cluster ClearRfidResponse Command callback
1339 bool emberAfDoorLockClusterClearRfidResponseCallback(uint8_t status);
1342 * @brief Door Lock Cluster ClearWeekdayScheduleResponse Command callback
1346 bool emberAfDoorLockClusterClearWeekdayScheduleResponseCallback(uint8_t status);
1349 * @brief Door Lock Cluster ClearYeardayScheduleResponse Command callback
1353 bool emberAfDoorLockClusterClearYeardayScheduleResponseCallback(uint8_t status);
1356 * @brief Door Lock Cluster GetHolidayScheduleResponse Command callback
1359 * @param localStartTime
1360 * @param localEndTime
1361 * @param operatingModeDuringHoliday
1364 bool emberAfDoorLockClusterGetHolidayScheduleResponseCallback(uint8_t scheduleId, uint8_t status, uint32_t localStartTime,
1365 uint32_t localEndTime, uint8_t operatingModeDuringHoliday);
1368 * @brief Door Lock Cluster GetLogRecordResponse Command callback
1373 * @param eventIdOrAlarmCode
1378 bool emberAfDoorLockClusterGetLogRecordResponseCallback(uint16_t logEntryId, uint32_t timestamp, uint8_t eventType, uint8_t source,
1379 uint8_t eventIdOrAlarmCode, uint16_t userId, uint8_t * pin);
1382 * @brief Door Lock Cluster GetPinResponse Command callback
1389 bool emberAfDoorLockClusterGetPinResponseCallback(uint16_t userId, uint8_t userStatus, uint8_t userType, uint8_t * pin);
1392 * @brief Door Lock Cluster GetRfidResponse Command callback
1399 bool emberAfDoorLockClusterGetRfidResponseCallback(uint16_t userId, uint8_t userStatus, uint8_t userType, uint8_t * rfid);
1402 * @brief Door Lock Cluster GetUserTypeResponse Command callback
1407 bool emberAfDoorLockClusterGetUserTypeResponseCallback(uint16_t userId, uint8_t userType);
1410 * @brief Door Lock Cluster GetWeekdayScheduleResponse Command callback
1416 * @param startMinute
1421 bool emberAfDoorLockClusterGetWeekdayScheduleResponseCallback(uint8_t scheduleId, uint16_t userId, uint8_t status, uint8_t daysMask,
1422 uint8_t startHour, uint8_t startMinute, uint8_t endHour,
1426 * @brief Door Lock Cluster GetYeardayScheduleResponse Command callback
1430 * @param localStartTime
1431 * @param localEndTime
1434 bool emberAfDoorLockClusterGetYeardayScheduleResponseCallback(uint8_t scheduleId, uint16_t userId, uint8_t status,
1435 uint32_t localStartTime, uint32_t localEndTime);
1438 * @brief Door Lock Cluster LockDoorResponse Command callback
1442 bool emberAfDoorLockClusterLockDoorResponseCallback(uint8_t status);
1445 * @brief Door Lock Cluster SetHolidayScheduleResponse Command callback
1449 bool emberAfDoorLockClusterSetHolidayScheduleResponseCallback(uint8_t status);
1452 * @brief Door Lock Cluster SetPinResponse Command callback
1456 bool emberAfDoorLockClusterSetPinResponseCallback(uint8_t status);
1459 * @brief Door Lock Cluster SetRfidResponse Command callback
1463 bool emberAfDoorLockClusterSetRfidResponseCallback(uint8_t status);
1466 * @brief Door Lock Cluster SetUserTypeResponse Command callback
1470 bool emberAfDoorLockClusterSetUserTypeResponseCallback(uint8_t status);
1473 * @brief Door Lock Cluster SetWeekdayScheduleResponse Command callback
1477 bool emberAfDoorLockClusterSetWeekdayScheduleResponseCallback(uint8_t status);
1480 * @brief Door Lock Cluster SetYeardayScheduleResponse Command callback
1484 bool emberAfDoorLockClusterSetYeardayScheduleResponseCallback(uint8_t status);
1487 * @brief Door Lock Cluster UnlockDoorResponse Command callback
1491 bool emberAfDoorLockClusterUnlockDoorResponseCallback(uint8_t status);
1494 * @brief Door Lock Cluster UnlockWithTimeoutResponse Command callback
1498 bool emberAfDoorLockClusterUnlockWithTimeoutResponseCallback(uint8_t status);
1501 * @brief General Commissioning Cluster ArmFailSafeResponse Command callback
1506 bool emberAfGeneralCommissioningClusterArmFailSafeResponseCallback(uint8_t errorCode, uint8_t * debugText);
1509 * @brief General Commissioning Cluster CommissioningCompleteResponse Command callback
1514 bool emberAfGeneralCommissioningClusterCommissioningCompleteResponseCallback(uint8_t errorCode, uint8_t * debugText);
1517 * @brief General Commissioning Cluster SetFabricResponse Command callback
1522 bool emberAfGeneralCommissioningClusterSetFabricResponseCallback(uint8_t errorCode, uint8_t * debugText);
1525 * @brief Groups Cluster AddGroupResponse Command callback
1530 bool emberAfGroupsClusterAddGroupResponseCallback(uint8_t status, uint16_t groupId);
1533 * @brief Groups Cluster GetGroupMembershipResponse Command callback
1539 bool emberAfGroupsClusterGetGroupMembershipResponseCallback(uint8_t capacity, uint8_t groupCount,
1540 /* TYPE WARNING: array array defaults to */ uint8_t * groupList);
1543 * @brief Groups Cluster RemoveGroupResponse Command callback
1548 bool emberAfGroupsClusterRemoveGroupResponseCallback(uint8_t status, uint16_t groupId);
1551 * @brief Groups Cluster ViewGroupResponse Command callback
1557 bool emberAfGroupsClusterViewGroupResponseCallback(uint8_t status, uint16_t groupId, uint8_t * groupName);
1560 * @brief Identify Cluster IdentifyQueryResponse Command callback
1564 bool emberAfIdentifyClusterIdentifyQueryResponseCallback(uint16_t timeout);
1567 * @brief Media Playback Cluster Playback Command callback
1570 bool emberAfMediaPlaybackClusterPlaybackCallback();
1573 * @brief Scenes Cluster AddSceneResponse Command callback
1579 bool emberAfScenesClusterAddSceneResponseCallback(uint8_t status, uint16_t groupId, uint8_t sceneId);
1582 * @brief Scenes Cluster GetSceneMembershipResponse Command callback
1590 bool emberAfScenesClusterGetSceneMembershipResponseCallback(uint8_t status, uint8_t capacity, uint16_t groupId, uint8_t sceneCount,
1591 /* TYPE WARNING: array array defaults to */ uint8_t * sceneList);
1594 * @brief Scenes Cluster RemoveAllScenesResponse Command callback
1599 bool emberAfScenesClusterRemoveAllScenesResponseCallback(uint8_t status, uint16_t groupId);
1602 * @brief Scenes Cluster RemoveSceneResponse Command callback
1608 bool emberAfScenesClusterRemoveSceneResponseCallback(uint8_t status, uint16_t groupId, uint8_t sceneId);
1611 * @brief Scenes Cluster StoreSceneResponse Command callback
1617 bool emberAfScenesClusterStoreSceneResponseCallback(uint8_t status, uint16_t groupId, uint8_t sceneId);
1620 * @brief Scenes Cluster ViewSceneResponse Command callback
1624 * @param transitionTime
1626 * @param extensionFieldSets
1629 bool emberAfScenesClusterViewSceneResponseCallback(uint8_t status, uint16_t groupId, uint8_t sceneId, uint16_t transitionTime,
1630 uint8_t * sceneName,
1631 /* TYPE WARNING: array array defaults to */ uint8_t * extensionFieldSets);
1634 // Non-Cluster Related Callbacks
1637 /** @brief Add To Current App Tasks
1639 * This function is only useful to sleepy end devices. This function will note
1640 * the passed item as part of a set of tasks the application has outstanding
1641 * (e.g. message sent requiring APS acknwoledgement). This will affect how the
1642 * application behaves with regard to sleeping and polling. Until the
1643 * outstanding task is completed, the device may poll more frequently and sleep
1646 * @param tasks Ver.: always
1648 void emberAfAddToCurrentAppTasksCallback(EmberAfApplicationTask tasks);
1650 /** @brief Remove From Current App Tasks
1652 * This function is only useful to sleepy end devices. This function will
1653 * remove the passed item from the set of tasks the application has outstanding
1654 * (e.g. message sent requiring APS acknwoledgement). This will affect how the
1655 * application behaves with regard to sleeping and polling. Removing the item
1656 * from the list of outstanding tasks may allow the device to sleep longer and
1657 * poll less frequently. If there are other outstanding tasks the system may
1658 * still have to stay away and poll more often.
1660 * @param tasks Ver.: always
1662 void emberAfRemoveFromCurrentAppTasksCallback(EmberAfApplicationTask tasks);
1664 /** @brief Allow Network Write Attribute
1666 * This function is called by the application framework before it writes an
1667 * attribute in response to a write attribute request from an external device.
1668 * The value passed into this callback is the value to which the attribute is to
1669 * be set by the framework.
1670 Example: In mirroring simple metering data
1671 * on an Energy Services Interface (ESI) (formerly called Energy Service Portal
1672 * (ESP) in SE 1.0).), a mirrored simple meter needs to write read-only
1673 * attributes on its mirror. The-meter-mirror sample application, located in
1674 * app/framework/sample-apps, uses this callback to allow the mirrored device to
1675 * write simple metering attributes on the mirror regardless of the fact that
1676 * most simple metering attributes are defined as read-only by the ZigBee
1678 Note: The ZCL specification does not (as of this
1679 * writing) specify any permission-level security for writing writeable
1680 * attributes. As far as the ZCL specification is concerned, if an attribute is
1681 * writeable, any device that has a link key for the device should be able to
1682 * write that attribute. Furthermore if an attribute is read only, it should not
1683 * be written over the air. Thus, if you implement permissions for writing
1684 * attributes as a feature, you MAY be operating outside the specification. This
1685 * is unlikely to be a problem for writing read-only attributes, but it may be a
1686 * problem for attributes that are writeable according to the specification but
1687 * restricted by the application implementing this callback.
1689 * @param endpoint Ver.: always
1690 * @param clusterId Ver.: always
1691 * @param attributeId Ver.: always
1692 * @param mask Ver.: always
1693 * @param manufacturerCode Ver.: always
1694 * @param value Ver.: always
1695 * @param type Ver.: always
1697 EmberAfAttributeWritePermission emberAfAllowNetworkWriteAttributeCallback(chip::EndpointId endpoint, chip::ClusterId clusterId,
1698 chip::AttributeId attributeId, uint8_t mask,
1699 uint16_t manufacturerCode, uint8_t * value, uint8_t type);
1701 /** @brief Attribute Read Access
1703 * This function is called whenever the Application Framework needs to check
1704 * access permission for an attribute read.
1706 * @param endpoint Ver.: always
1707 * @param clusterId Ver.: always
1708 * @param manufacturerCode Ver.: always
1709 * @param attributeId Ver.: always
1711 bool emberAfAttributeReadAccessCallback(chip::EndpointId endpoint, chip::ClusterId clusterId, uint16_t manufacturerCode,
1712 chip::AttributeId attributeId);
1714 /** @brief Attribute Write Access
1716 * This function is called whenever the Application Framework needs to check
1717 * access permission for an attribute write.
1719 * @param endpoint Ver.: always
1720 * @param clusterId Ver.: always
1721 * @param manufacturerCode Ver.: always
1722 * @param attributeId Ver.: always
1724 bool emberAfAttributeWriteAccessCallback(chip::EndpointId endpoint, chip::ClusterId clusterId, uint16_t manufacturerCode,
1725 chip::AttributeId attributeId);
1727 /** @brief Default Response
1729 * This function is called by the application framework when a Default Response
1730 * command is received from an external device. The application should return
1731 * true if the message was processed or false if it was not.
1733 * @param clusterId The cluster identifier of this response. Ver.: always
1734 * @param commandId The command identifier to which this is a response. Ver.:
1736 * @param status Specifies either SUCCESS or the nature of the error that was
1737 * detected in the received command. Ver.: always
1739 bool emberAfDefaultResponseCallback(chip::ClusterId clusterId, chip::CommandId commandId, EmberAfStatus status);
1741 /** @brief Configure Reporting Response
1743 * This function is called by the application framework when a Configure
1744 * Reporting Response command is received from an external device. The
1745 * application should return true if the message was processed or false if it
1748 * @param clusterId The cluster identifier of this response. Ver.: always
1749 * @param buffer Buffer containing the list of attribute status records. Ver.:
1751 * @param bufLen The length in bytes of the list. Ver.: always
1753 bool emberAfConfigureReportingResponseCallback(chip::ClusterId clusterId, uint8_t * buffer, uint16_t bufLen);
1755 /** @brief Read Reporting Configuration Response
1757 * This function is called by the application framework when a Read Reporting
1758 * Configuration Response command is received from an external device. The
1759 * application should return true if the message was processed or false if it
1762 * @param clusterId The cluster identifier of this response. Ver.: always
1763 * @param buffer Buffer containing the list of attribute reporting configuration
1764 * records. Ver.: always
1765 * @param bufLen The length in bytes of the list. Ver.: always
1767 bool emberAfReadReportingConfigurationResponseCallback(chip::ClusterId clusterId, uint8_t * buffer, uint16_t bufLen);
1769 /** @brief Discover Attributes Response
1771 * This function is called by the application framework when a Discover
1772 * Attributes Response or Discover Attributes Extended Response command is
1773 * received from an external device. The Discover Attributes Response command
1774 * contains a bool indicating if discovery is complete and a list of zero or
1775 * more attribute identifier/type records. The final argument indicates whether
1776 * the response is in the extended format or not. The application should return
1777 * true if the message was processed or false if it was not.
1779 * @param clusterId The cluster identifier of this response. Ver.: always
1780 * @param discoveryComplete Indicates whether there are more attributes to be
1781 * discovered. true if there are no more attributes to be discovered. Ver.:
1783 * @param buffer Buffer containing the list of attribute identifier/type
1784 * records. Ver.: always
1785 * @param bufLen The length in bytes of the list. Ver.: always
1786 * @param extended Indicates whether the response is in the extended format or
1789 bool emberAfDiscoverAttributesResponseCallback(chip::ClusterId clusterId, bool discoveryComplete, uint8_t * buffer, uint16_t bufLen,
1792 /** @brief Discover Commands Generated Response
1794 * This function is called by the framework when Discover Commands Generated
1795 * Response is received.
1797 * @param clusterId The cluster identifier of this response. Ver.: always
1798 * @param manufacturerCode Manufacturer code Ver.: always
1799 * @param discoveryComplete Indicates whether there are more commands to be
1800 * discovered. Ver.: always
1801 * @param commandIds Buffer containing the list of command identifiers. Ver.:
1803 * @param commandIdCount The length of bytes of the list, whish is the same as
1804 * the number of identifiers. Ver.: always
1806 bool emberAfDiscoverCommandsGeneratedResponseCallback(chip::ClusterId clusterId, uint16_t manufacturerCode, bool discoveryComplete,
1807 chip::CommandId * commandIds, uint16_t commandIdCount);
1809 /** @brief Discover Commands Received Response
1811 * This function is called by the framework when Discover Commands Received
1812 * Response is received.
1814 * @param clusterId The cluster identifier of this response. Ver.: always
1815 * @param manufacturerCode Manufacturer code Ver.: always
1816 * @param discoveryComplete Indicates whether there are more commands to be
1817 * discovered. Ver.: always
1818 * @param commandIds Buffer containing the list of command identifiers. Ver.:
1820 * @param commandIdCount The length of bytes of the list, whish is the same as
1821 * the number of identifiers. Ver.: always
1823 bool emberAfDiscoverCommandsReceivedResponseCallback(chip::ClusterId clusterId, uint16_t manufacturerCode, bool discoveryComplete,
1824 chip::CommandId * commandIds, uint16_t commandIdCount);
1826 /** @brief Pre Command Received
1828 * This callback is the second in the Application Framework's message processing
1829 * chain. At this point in the processing of incoming over-the-air messages, the
1830 * application has determined that the incoming message is a ZCL command. It
1831 * parses enough of the message to populate an EmberAfClusterCommand struct. The
1832 * Application Framework defines this struct value in a local scope to the
1833 * command processing but also makes it available through a global pointer
1834 * called emberAfCurrentCommand, in app/framework/util/util.c. When command
1835 * processing is complete, this pointer is cleared.
1837 * @param cmd Ver.: always
1839 bool emberAfPreCommandReceivedCallback(EmberAfClusterCommand * cmd);
1841 /** @brief Pre Message Send
1843 * This function is called by the framework when it is about to pass a message
1844 * to the stack primitives for sending. This message may or may not be ZCL,
1845 * ZDO, or some other protocol. This is called prior to
1847 * fragmentation that may be done. If the function returns true it is assumed
1848 * the callback has consumed and processed the message. The callback must also
1849 * set the EmberStatus status code to be passed back to the caller. The
1850 * framework will do no further processing on the message.
1852 * function returns false then it is assumed that the callback has not processed
1853 * the mesasge and the framework will continue to process accordingly.
1855 * @param messageStruct The structure containing the parameters of the APS
1856 * message to be sent. Ver.: always
1857 * @param status A pointer to the status code value that will be returned to the
1858 * caller. Ver.: always
1860 bool emberAfPreMessageSendCallback(EmberAfMessageStruct * messageStruct, EmberStatus * status);
1862 /** @brief Message Sent
1864 * This function is called by the application framework from the message sent
1865 * handler, when it is informed by the stack regarding the message sent status.
1866 * All of the values passed to the emberMessageSentHandler are passed on to this
1867 * callback. This provides an opportunity for the application to verify that its
1868 * message has been sent successfully and take the appropriate action. This
1869 * callback should return a bool value of true or false. A value of true
1870 * indicates that the message sent notification has been handled and should not
1871 * be handled by the application framework.
1873 * @param type Ver.: always
1874 * @param indexOrDestination Ver.: always
1875 * @param apsFrame Ver.: always
1876 * @param msgLen Ver.: always
1877 * @param message Ver.: always
1878 * @param status Ver.: always
1880 bool emberAfMessageSentCallback(EmberOutgoingMessageType type, uint64_t indexOrDestination, EmberApsFrame * apsFrame,
1881 uint16_t msgLen, uint8_t * message, EmberStatus status);
1883 /** @brief Pre Attribute Change
1885 * This function is called by the application framework before it changes an
1886 * attribute value. The value passed into this callback is the value to which
1887 * the attribute is to be set by the framework. The application should return
1888 * ::EMBER_ZCL_STATUS_SUCCESS to permit the change or any other ::EmberAfStatus
1891 * @param endpoint Ver.: always
1892 * @param clusterId Ver.: always
1893 * @param attributeId Ver.: always
1894 * @param mask Ver.: always
1895 * @param manufacturerCode Ver.: always
1896 * @param type Ver.: always
1897 * @param size Ver.: always
1898 * @param value Ver.: always
1900 EmberAfStatus emberAfPreAttributeChangeCallback(chip::EndpointId endpoint, chip::ClusterId clusterId, chip::AttributeId attributeId,
1901 uint8_t mask, uint16_t manufacturerCode, uint8_t type, uint8_t size,
1904 /** @brief Post Attribute Change
1906 * This function is called by the application framework after it changes an
1907 * attribute value. The value passed into this callback is the value to which
1908 * the attribute was set by the framework.
1910 * @param endpoint Ver.: always
1911 * @param clusterId Ver.: always
1912 * @param attributeId Ver.: always
1913 * @param mask Ver.: always
1914 * @param manufacturerCode Ver.: always
1915 * @param type Ver.: always
1916 * @param size Ver.: always
1917 * @param value Ver.: always
1919 void emberAfPostAttributeChangeCallback(chip::EndpointId endpoint, chip::ClusterId clusterId, chip::AttributeId attributeId,
1920 uint8_t mask, uint16_t manufacturerCode, uint8_t type, uint8_t size, uint8_t * value);
1922 /** @brief Read Attributes Response
1924 * This function is called by the application framework when a Read Attributes
1925 * Response command is received from an external device. The application should
1926 * return true if the message was processed or false if it was not.
1928 * @param clusterId The cluster identifier of this response. Ver.: always
1929 * @param buffer Buffer containing the list of read attribute status records.
1931 * @param bufLen The length in bytes of the list. Ver.: always
1933 bool emberAfReadAttributesResponseCallback(chip::ClusterId clusterId, uint8_t * buffer, uint16_t bufLen);
1935 /** @brief External Attribute Read
1937 * Like emberAfExternalAttributeWriteCallback above, this function is called
1938 * when the framework needs to read an attribute that is not stored within the
1939 * Application Framework's data structures.
1940 All of the important
1941 * information about the attribute itself is passed as a pointer to an
1942 * EmberAfAttributeMetadata struct, which is stored within the application and
1943 * used to manage the attribute. A complete description of the
1944 * EmberAfAttributeMetadata struct is provided in
1945 * app/framework/include/af-types.h
1946 This function assumes that the
1947 * application is able to read the attribute, write it into the passed buffer,
1948 * and return immediately. Any attributes that require a state machine for
1949 * reading and writing are not really candidates for externalization at the
1950 * present time. The Application Framework does not currently include a state
1951 * machine for reading or writing attributes that must take place across a
1952 * series of application ticks. Attributes that cannot be read in a timely
1953 * manner should be stored within the Application Framework and updated
1954 * occasionally by the application code from within the
1955 * emberAfMainTickCallback.
1956 If the application was successfully able to
1957 * read the attribute and write it into the passed buffer, it should return a
1958 * value of EMBER_ZCL_STATUS_SUCCESS. Ensure that the size of the externally
1959 * managed attribute value is smaller than what the buffer can hold. In the case
1960 * of a buffer overflow throw an appropriate error such as
1961 * EMBER_ZCL_STATUS_INSUFFICIENT_SPACE. Any other return value indicates the
1962 * application was not able to read the attribute.
1964 * @param endpoint Ver.: always
1965 * @param clusterId Ver.: always
1966 * @param attributeMetadata Ver.: always
1967 * @param manufacturerCode Ver.: always
1968 * @param buffer Ver.: always
1969 * @param maxReadLength Ver.: always
1971 EmberAfStatus emberAfExternalAttributeReadCallback(chip::EndpointId endpoint, chip::ClusterId clusterId,
1972 EmberAfAttributeMetadata * attributeMetadata, uint16_t manufacturerCode,
1973 uint8_t * buffer, uint16_t maxReadLength);
1975 /** @brief Write Attributes Response
1977 * This function is called by the application framework when a Write Attributes
1978 * Response command is received from an external device. The application should
1979 * return true if the message was processed or false if it was not.
1981 * @param clusterId The cluster identifier of this response. Ver.: always
1982 * @param buffer Buffer containing the list of write attribute status records.
1984 * @param bufLen The length in bytes of the list. Ver.: always
1986 bool emberAfWriteAttributesResponseCallback(chip::ClusterId clusterId, uint8_t * buffer, uint16_t bufLen);
1988 /** @brief External Attribute Write
1990 * This function is called whenever the Application Framework needs to write an
1991 * attribute which is not stored within the data structures of the Application
1992 * Framework itself. One of the new features in Version 2 is the ability to
1993 * store attributes outside the Framework. This is particularly useful for
1994 * attributes that do not need to be stored because they can be read off the
1995 * hardware when they are needed, or are stored in some central location used by
1996 * many modules within the system. In this case, you can indicate that the
1997 * attribute is stored externally. When the framework needs to write an external
1998 * attribute, it makes a call to this callback.
1999 This callback is very
2000 * useful for host micros which need to store attributes in persistent memory.
2001 * Because each host micro (used with an Ember NCP) has its own type of
2002 * persistent memory storage, the Application Framework does not include the
2003 * ability to mark attributes as stored in flash the way that it does for Ember
2004 * SoCs like the EM35x. On a host micro, any attributes that need to be stored
2005 * in persistent memory should be marked as external and accessed through the
2006 * external read and write callbacks. Any host code associated with the
2007 * persistent storage should be implemented within this callback.
2009 * the important information about the attribute itself is passed as a pointer
2010 * to an EmberAfAttributeMetadata struct, which is stored within the application
2011 * and used to manage the attribute. A complete description of the
2012 * EmberAfAttributeMetadata struct is provided in
2013 * app/framework/include/af-types.h.
2014 This function assumes that the
2015 * application is able to write the attribute and return immediately. Any
2016 * attributes that require a state machine for reading and writing are not
2017 * candidates for externalization at the present time. The Application Framework
2018 * does not currently include a state machine for reading or writing attributes
2019 * that must take place across a series of application ticks. Attributes that
2020 * cannot be written immediately should be stored within the Application
2021 * Framework and updated occasionally by the application code from within the
2022 * emberAfMainTickCallback.
2023 If the application was successfully able to
2024 * write the attribute, it returns a value of EMBER_ZCL_STATUS_SUCCESS. Any
2025 * other return value indicates the application was not able to write the
2028 * @param endpoint Ver.: always
2029 * @param clusterId Ver.: always
2030 * @param attributeMetadata Ver.: always
2031 * @param manufacturerCode Ver.: always
2032 * @param buffer Ver.: always
2034 EmberAfStatus emberAfExternalAttributeWriteCallback(chip::EndpointId endpoint, chip::ClusterId clusterId,
2035 EmberAfAttributeMetadata * attributeMetadata, uint16_t manufacturerCode,
2038 /** @brief Report Attributes
2040 * This function is called by the application framework when a Report Attributes
2041 * command is received from an external device. The application should return
2042 * true if the message was processed or false if it was not.
2044 * @param clusterId The cluster identifier of this command. Ver.: always
2045 * @param buffer Buffer containing the list of attribute report records. Ver.:
2047 * @param bufLen The length in bytes of the list. Ver.: always
2049 bool emberAfReportAttributesCallback(chip::ClusterId clusterId, uint8_t * buffer, uint16_t bufLen);
2051 /** @brief Get Current Time
2053 * This callback is called when device attempts to get current time from the
2054 * hardware. If this device has means to retrieve exact time, then this method
2055 * should implement it. If the callback can't provide the exact time it should
2056 * return 0 to indicate failure. Default action is to return 0, which indicates
2057 * that device does not have access to real time.
2060 uint32_t emberAfGetCurrentTimeCallback();
2062 /** @brief Get Endpoint Info
2064 * This function is a callback to an application implemented endpoint that
2065 * operates outside the normal application framework. When the framework wishes
2066 * to perform operations with that endpoint it uses this callback to retrieve
2067 * the endpoint's information. If the endpoint exists and the application can
2068 * provide data then true shall be returned. Otherwise the callback must return
2071 * @param endpoint The endpoint to retrieve data for. Ver.: always
2072 * @param returnNetworkIndex The index corresponding to the ZigBee network the
2073 * endpoint belongs to. If not using a multi-network device, 0 must be
2074 * returned. Otherwise on a multi-network device the stack will switch to this
2075 * network before sending the message. Ver.: always
2076 * @param returnEndpointInfo A pointer to a data struct that will be written
2077 * with information about the endpoint. Ver.: always
2079 bool emberAfGetEndpointInfoCallback(chip::EndpointId endpoint, uint8_t * returnNetworkIndex,
2080 EmberAfEndpointInfoStruct * returnEndpointInfo);
2082 /** @brief Get Source Route Overhead
2084 * This function is called by the framework to determine the overhead required
2085 * in the network frame for source routing to a particular destination.
2087 * @param destination The node id of the destination Ver.: always
2089 uint8_t emberAfGetSourceRouteOverheadCallback(chip::NodeId destination);
2091 /** @brief Registration Abort
2093 * This callback is called when the device should abort the registration
2097 void emberAfRegistrationAbortCallback();
2099 /** @brief Interpan Send Message
2101 * This function will send a raw MAC message with interpan frame format using
2102 * the passed parameters.
2104 * @param header Interpan header info Ver.: always
2105 * @param messageLength The length of the message received or to send Ver.:
2107 * @param message The message data received or to send. Ver.: always
2109 EmberStatus emberAfInterpanSendMessageCallback(EmberAfInterpanHeader * header, uint16_t messageLength, uint8_t * message);
2111 /** @brief Start Move
2113 * This function is called to initiate the process for a device to move (rejoin)
2117 bool emberAfStartMoveCallback();