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 Color Control Cluster Init
68 * @param endpoint Endpoint that is being initialized
70 void emberAfColorControlClusterInitCallback(chip::EndpointId endpoint);
72 /** @brief Content Launch Cluster Init
76 * @param endpoint Endpoint that is being initialized
78 void emberAfContentLaunchClusterInitCallback(chip::EndpointId endpoint);
80 /** @brief Door Lock Cluster Init
84 * @param endpoint Endpoint that is being initialized
86 void emberAfDoorLockClusterInitCallback(chip::EndpointId endpoint);
88 /** @brief Groups Cluster Init
92 * @param endpoint Endpoint that is being initialized
94 void emberAfGroupsClusterInitCallback(chip::EndpointId endpoint);
96 /** @brief IAS Zone Cluster Init
100 * @param endpoint Endpoint that is being initialized
102 void emberAfIasZoneClusterInitCallback(chip::EndpointId endpoint);
104 /** @brief Identify Cluster Init
108 * @param endpoint Endpoint that is being initialized
110 void emberAfIdentifyClusterInitCallback(chip::EndpointId endpoint);
112 /** @brief Level Control Cluster Init
116 * @param endpoint Endpoint that is being initialized
118 void emberAfLevelControlClusterInitCallback(chip::EndpointId endpoint);
120 /** @brief Low Power Cluster Init
124 * @param endpoint Endpoint that is being initialized
126 void emberAfLowPowerClusterInitCallback(chip::EndpointId endpoint);
128 /** @brief Media Playback Cluster Init
132 * @param endpoint Endpoint that is being initialized
134 void emberAfMediaPlaybackClusterInitCallback(chip::EndpointId endpoint);
136 /** @brief On/off Cluster Init
140 * @param endpoint Endpoint that is being initialized
142 void emberAfOnOffClusterInitCallback(chip::EndpointId endpoint);
144 /** @brief Scenes Cluster Init
148 * @param endpoint Endpoint that is being initialized
150 void emberAfScenesClusterInitCallback(chip::EndpointId endpoint);
152 /** @brief Temperature Measurement Cluster Init
156 * @param endpoint Endpoint that is being initialized
158 void emberAfTemperatureMeasurementClusterInitCallback(chip::EndpointId endpoint);
160 // Cluster Server/Client Init Functions
163 // Application Basic Cluster server
166 /** @brief Application Basic Cluster Server Init
170 * @param endpoint Endpoint that is being initialized
172 void emberAfApplicationBasicClusterServerInitCallback(chip::EndpointId endpoint);
174 /** @brief Application Basic Cluster Server Attribute Changed
176 * Server Attribute Changed
178 * @param endpoint Endpoint that is being initialized
179 * @param attributeId Attribute that changed
181 void emberAfApplicationBasicClusterServerAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId);
183 /** @brief Application Basic Cluster Server Manufacturer Specific Attribute Changed
185 * Server Manufacturer Specific Attribute Changed
187 * @param endpoint Endpoint that is being initialized
188 * @param attributeId Attribute that changed
189 * @param manufacturerCode Manufacturer Code of the attribute that changed
191 void emberAfApplicationBasicClusterServerManufacturerSpecificAttributeChangedCallback(chip::EndpointId endpoint,
192 chip::AttributeId attributeId,
193 uint16_t manufacturerCode);
195 /** @brief Application Basic Cluster Server Message Sent
197 * Server Message Sent
199 * @param type The type of message sent
200 * @param indexOrDestination The destination or address to which the message was sent
201 * @param apsFrame The APS frame for the message
202 * @param msgLen The length of the message
203 * @param message The message that was sent
204 * @param status The status of the sent message
206 void emberAfApplicationBasicClusterServerMessageSentCallback(EmberOutgoingMessageType type, uint64_t indexOrDestination,
207 EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message,
210 /** @brief Application Basic Cluster Server Pre Attribute Changed
212 * server Pre Attribute Changed
214 * @param endpoint Endpoint that is being initialized
215 * @param attributeId Attribute to be changed
216 * @param attributeType Attribute type
217 * @param size Attribute size
218 * @param value Attribute value
220 EmberAfStatus emberAfApplicationBasicClusterServerPreAttributeChangedCallback(chip::EndpointId endpoint,
221 chip::AttributeId attributeId,
222 EmberAfAttributeType attributeType, uint8_t size,
225 /** @brief Application Basic Cluster Server Tick
229 * @param endpoint Endpoint that is being served
231 void emberAfApplicationBasicClusterServerTickCallback(chip::EndpointId endpoint);
234 // Barrier Control Cluster client
237 /** @brief Barrier Control Cluster Client Init
241 * @param endpoint Endpoint that is being initialized
243 void emberAfBarrierControlClusterClientInitCallback(chip::EndpointId endpoint);
245 /** @brief Barrier Control Cluster Client Attribute Changed
247 * Client Attribute Changed
249 * @param endpoint Endpoint that is being initialized
250 * @param attributeId Attribute that changed
252 void emberAfBarrierControlClusterClientAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId);
254 /** @brief Barrier Control Cluster Client Manufacturer Specific Attribute Changed
256 * Client Manufacturer Specific Attribute Changed
258 * @param endpoint Endpoint that is being initialized
259 * @param attributeId Attribute that changed
260 * @param manufacturerCode Manufacturer Code of the attribute that changed
262 void emberAfBarrierControlClusterClientManufacturerSpecificAttributeChangedCallback(chip::EndpointId endpoint,
263 chip::AttributeId attributeId,
264 uint16_t manufacturerCode);
266 /** @brief Barrier Control Cluster Client Message Sent
268 * Client Message Sent
270 * @param type The type of message sent
271 * @param indexOrDestination The destination or address to which the message was sent
272 * @param apsFrame The APS frame for the message
273 * @param msgLen The length of the message
274 * @param message The message that was sent
275 * @param status The status of the sent message
277 void emberAfBarrierControlClusterClientMessageSentCallback(EmberOutgoingMessageType type, uint64_t indexOrDestination,
278 EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message,
281 /** @brief Barrier Control Cluster Client Pre Attribute Changed
283 * client Pre Attribute Changed
285 * @param endpoint Endpoint that is being initialized
286 * @param attributeId Attribute to be changed
287 * @param attributeType Attribute type
288 * @param size Attribute size
289 * @param value Attribute value
291 EmberAfStatus emberAfBarrierControlClusterClientPreAttributeChangedCallback(chip::EndpointId endpoint,
292 chip::AttributeId attributeId,
293 EmberAfAttributeType attributeType, uint8_t size,
296 /** @brief Barrier Control Cluster Client Tick
300 * @param endpoint Endpoint that is being served
302 void emberAfBarrierControlClusterClientTickCallback(chip::EndpointId endpoint);
305 // Barrier Control Cluster server
308 /** @brief Barrier Control Cluster Server Init
312 * @param endpoint Endpoint that is being initialized
314 void emberAfBarrierControlClusterServerInitCallback(chip::EndpointId endpoint);
316 /** @brief Barrier Control Cluster Server Attribute Changed
318 * Server Attribute Changed
320 * @param endpoint Endpoint that is being initialized
321 * @param attributeId Attribute that changed
323 void emberAfBarrierControlClusterServerAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId);
325 /** @brief Barrier Control Cluster Server Manufacturer Specific Attribute Changed
327 * Server Manufacturer Specific Attribute Changed
329 * @param endpoint Endpoint that is being initialized
330 * @param attributeId Attribute that changed
331 * @param manufacturerCode Manufacturer Code of the attribute that changed
333 void emberAfBarrierControlClusterServerManufacturerSpecificAttributeChangedCallback(chip::EndpointId endpoint,
334 chip::AttributeId attributeId,
335 uint16_t manufacturerCode);
337 /** @brief Barrier Control Cluster Server Message Sent
339 * Server Message Sent
341 * @param type The type of message sent
342 * @param indexOrDestination The destination or address to which the message was sent
343 * @param apsFrame The APS frame for the message
344 * @param msgLen The length of the message
345 * @param message The message that was sent
346 * @param status The status of the sent message
348 void emberAfBarrierControlClusterServerMessageSentCallback(EmberOutgoingMessageType type, uint64_t indexOrDestination,
349 EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message,
352 /** @brief Barrier Control Cluster Server Pre Attribute Changed
354 * server Pre Attribute Changed
356 * @param endpoint Endpoint that is being initialized
357 * @param attributeId Attribute to be changed
358 * @param attributeType Attribute type
359 * @param size Attribute size
360 * @param value Attribute value
362 EmberAfStatus emberAfBarrierControlClusterServerPreAttributeChangedCallback(chip::EndpointId endpoint,
363 chip::AttributeId attributeId,
364 EmberAfAttributeType attributeType, uint8_t size,
367 /** @brief Barrier Control Cluster Server Tick
371 * @param endpoint Endpoint that is being served
373 void emberAfBarrierControlClusterServerTickCallback(chip::EndpointId endpoint);
376 // Basic Cluster server
379 /** @brief Basic Cluster Server Init
383 * @param endpoint Endpoint that is being initialized
385 void emberAfBasicClusterServerInitCallback(chip::EndpointId endpoint);
387 /** @brief Basic Cluster Server Attribute Changed
389 * Server Attribute Changed
391 * @param endpoint Endpoint that is being initialized
392 * @param attributeId Attribute that changed
394 void emberAfBasicClusterServerAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId);
396 /** @brief Basic Cluster Server Manufacturer Specific Attribute Changed
398 * Server Manufacturer Specific Attribute Changed
400 * @param endpoint Endpoint that is being initialized
401 * @param attributeId Attribute that changed
402 * @param manufacturerCode Manufacturer Code of the attribute that changed
404 void emberAfBasicClusterServerManufacturerSpecificAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId,
405 uint16_t manufacturerCode);
407 /** @brief Basic Cluster Server Message Sent
409 * Server Message Sent
411 * @param type The type of message sent
412 * @param indexOrDestination The destination or address to which the message was sent
413 * @param apsFrame The APS frame for the message
414 * @param msgLen The length of the message
415 * @param message The message that was sent
416 * @param status The status of the sent message
418 void emberAfBasicClusterServerMessageSentCallback(EmberOutgoingMessageType type, uint64_t indexOrDestination,
419 EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message, EmberStatus status);
421 /** @brief Basic Cluster Server Pre Attribute Changed
423 * server Pre Attribute Changed
425 * @param endpoint Endpoint that is being initialized
426 * @param attributeId Attribute to be changed
427 * @param attributeType Attribute type
428 * @param size Attribute size
429 * @param value Attribute value
431 EmberAfStatus emberAfBasicClusterServerPreAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId,
432 EmberAfAttributeType attributeType, uint8_t size,
435 /** @brief Basic Cluster Server Tick
439 * @param endpoint Endpoint that is being served
441 void emberAfBasicClusterServerTickCallback(chip::EndpointId endpoint);
444 // Color Control Cluster client
447 /** @brief Color Control Cluster Client Init
451 * @param endpoint Endpoint that is being initialized
453 void emberAfColorControlClusterClientInitCallback(chip::EndpointId endpoint);
455 /** @brief Color Control Cluster Client Attribute Changed
457 * Client Attribute Changed
459 * @param endpoint Endpoint that is being initialized
460 * @param attributeId Attribute that changed
462 void emberAfColorControlClusterClientAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId);
464 /** @brief Color Control Cluster Client Manufacturer Specific Attribute Changed
466 * Client Manufacturer Specific Attribute Changed
468 * @param endpoint Endpoint that is being initialized
469 * @param attributeId Attribute that changed
470 * @param manufacturerCode Manufacturer Code of the attribute that changed
472 void emberAfColorControlClusterClientManufacturerSpecificAttributeChangedCallback(chip::EndpointId endpoint,
473 chip::AttributeId attributeId,
474 uint16_t manufacturerCode);
476 /** @brief Color Control Cluster Client Message Sent
478 * Client Message Sent
480 * @param type The type of message sent
481 * @param indexOrDestination The destination or address to which the message was sent
482 * @param apsFrame The APS frame for the message
483 * @param msgLen The length of the message
484 * @param message The message that was sent
485 * @param status The status of the sent message
487 void emberAfColorControlClusterClientMessageSentCallback(EmberOutgoingMessageType type, uint64_t indexOrDestination,
488 EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message,
491 /** @brief Color Control Cluster Client Pre Attribute Changed
493 * client Pre Attribute Changed
495 * @param endpoint Endpoint that is being initialized
496 * @param attributeId Attribute to be changed
497 * @param attributeType Attribute type
498 * @param size Attribute size
499 * @param value Attribute value
501 EmberAfStatus emberAfColorControlClusterClientPreAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId,
502 EmberAfAttributeType attributeType, uint8_t size,
505 /** @brief Color Control Cluster Client Tick
509 * @param endpoint Endpoint that is being served
511 void emberAfColorControlClusterClientTickCallback(chip::EndpointId endpoint);
514 // Color Control Cluster server
517 /** @brief Color Control Cluster Server Init
521 * @param endpoint Endpoint that is being initialized
523 void emberAfColorControlClusterServerInitCallback(chip::EndpointId endpoint);
525 /** @brief Color Control Cluster Server Attribute Changed
527 * Server Attribute Changed
529 * @param endpoint Endpoint that is being initialized
530 * @param attributeId Attribute that changed
532 void emberAfColorControlClusterServerAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId);
534 /** @brief Color Control Cluster Server Manufacturer Specific Attribute Changed
536 * Server Manufacturer Specific Attribute Changed
538 * @param endpoint Endpoint that is being initialized
539 * @param attributeId Attribute that changed
540 * @param manufacturerCode Manufacturer Code of the attribute that changed
542 void emberAfColorControlClusterServerManufacturerSpecificAttributeChangedCallback(chip::EndpointId endpoint,
543 chip::AttributeId attributeId,
544 uint16_t manufacturerCode);
546 /** @brief Color Control Cluster Server Message Sent
548 * Server Message Sent
550 * @param type The type of message sent
551 * @param indexOrDestination The destination or address to which the message was sent
552 * @param apsFrame The APS frame for the message
553 * @param msgLen The length of the message
554 * @param message The message that was sent
555 * @param status The status of the sent message
557 void emberAfColorControlClusterServerMessageSentCallback(EmberOutgoingMessageType type, uint64_t indexOrDestination,
558 EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message,
561 /** @brief Color Control Cluster Server Pre Attribute Changed
563 * server Pre Attribute Changed
565 * @param endpoint Endpoint that is being initialized
566 * @param attributeId Attribute to be changed
567 * @param attributeType Attribute type
568 * @param size Attribute size
569 * @param value Attribute value
571 EmberAfStatus emberAfColorControlClusterServerPreAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId,
572 EmberAfAttributeType attributeType, uint8_t size,
575 /** @brief Color Control Cluster Server Tick
579 * @param endpoint Endpoint that is being served
581 void emberAfColorControlClusterServerTickCallback(chip::EndpointId endpoint);
584 // Content Launch Cluster server
587 /** @brief Content Launch Cluster Server Init
591 * @param endpoint Endpoint that is being initialized
593 void emberAfContentLaunchClusterServerInitCallback(chip::EndpointId endpoint);
595 /** @brief Content Launch Cluster Server Attribute Changed
597 * Server Attribute Changed
599 * @param endpoint Endpoint that is being initialized
600 * @param attributeId Attribute that changed
602 void emberAfContentLaunchClusterServerAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId);
604 /** @brief Content Launch Cluster Server Manufacturer Specific Attribute Changed
606 * Server Manufacturer Specific Attribute Changed
608 * @param endpoint Endpoint that is being initialized
609 * @param attributeId Attribute that changed
610 * @param manufacturerCode Manufacturer Code of the attribute that changed
612 void emberAfContentLaunchClusterServerManufacturerSpecificAttributeChangedCallback(chip::EndpointId endpoint,
613 chip::AttributeId attributeId,
614 uint16_t manufacturerCode);
616 /** @brief Content Launch Cluster Server Message Sent
618 * Server Message Sent
620 * @param type The type of message sent
621 * @param indexOrDestination The destination or address to which the message was sent
622 * @param apsFrame The APS frame for the message
623 * @param msgLen The length of the message
624 * @param message The message that was sent
625 * @param status The status of the sent message
627 void emberAfContentLaunchClusterServerMessageSentCallback(EmberOutgoingMessageType type, uint64_t indexOrDestination,
628 EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message,
631 /** @brief Content Launch Cluster Server Pre Attribute Changed
633 * server Pre Attribute Changed
635 * @param endpoint Endpoint that is being initialized
636 * @param attributeId Attribute to be changed
637 * @param attributeType Attribute type
638 * @param size Attribute size
639 * @param value Attribute value
641 EmberAfStatus emberAfContentLaunchClusterServerPreAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId,
642 EmberAfAttributeType attributeType, uint8_t size,
645 /** @brief Content Launch Cluster Server Tick
649 * @param endpoint Endpoint that is being served
651 void emberAfContentLaunchClusterServerTickCallback(chip::EndpointId endpoint);
654 // Door Lock Cluster client
657 /** @brief Door Lock Cluster Client Init
661 * @param endpoint Endpoint that is being initialized
663 void emberAfDoorLockClusterClientInitCallback(chip::EndpointId endpoint);
665 /** @brief Door Lock Cluster Client Attribute Changed
667 * Client Attribute Changed
669 * @param endpoint Endpoint that is being initialized
670 * @param attributeId Attribute that changed
672 void emberAfDoorLockClusterClientAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId);
674 /** @brief Door Lock Cluster Client Manufacturer Specific Attribute Changed
676 * Client Manufacturer Specific Attribute Changed
678 * @param endpoint Endpoint that is being initialized
679 * @param attributeId Attribute that changed
680 * @param manufacturerCode Manufacturer Code of the attribute that changed
682 void emberAfDoorLockClusterClientManufacturerSpecificAttributeChangedCallback(chip::EndpointId endpoint,
683 chip::AttributeId attributeId,
684 uint16_t manufacturerCode);
686 /** @brief Door Lock Cluster Client Message Sent
688 * Client Message Sent
690 * @param type The type of message sent
691 * @param indexOrDestination The destination or address to which the message was sent
692 * @param apsFrame The APS frame for the message
693 * @param msgLen The length of the message
694 * @param message The message that was sent
695 * @param status The status of the sent message
697 void emberAfDoorLockClusterClientMessageSentCallback(EmberOutgoingMessageType type, uint64_t indexOrDestination,
698 EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message,
701 /** @brief Door Lock Cluster Client Pre Attribute Changed
703 * client Pre Attribute Changed
705 * @param endpoint Endpoint that is being initialized
706 * @param attributeId Attribute to be changed
707 * @param attributeType Attribute type
708 * @param size Attribute size
709 * @param value Attribute value
711 EmberAfStatus emberAfDoorLockClusterClientPreAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId,
712 EmberAfAttributeType attributeType, uint8_t size,
715 /** @brief Door Lock Cluster Client Tick
719 * @param endpoint Endpoint that is being served
721 void emberAfDoorLockClusterClientTickCallback(chip::EndpointId endpoint);
724 // Door Lock Cluster server
727 /** @brief Door Lock Cluster Server Init
731 * @param endpoint Endpoint that is being initialized
733 void emberAfDoorLockClusterServerInitCallback(chip::EndpointId endpoint);
735 /** @brief Door Lock Cluster Server Attribute Changed
737 * Server Attribute Changed
739 * @param endpoint Endpoint that is being initialized
740 * @param attributeId Attribute that changed
742 void emberAfDoorLockClusterServerAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId);
744 /** @brief Door Lock Cluster Server Manufacturer Specific Attribute Changed
746 * Server Manufacturer Specific Attribute Changed
748 * @param endpoint Endpoint that is being initialized
749 * @param attributeId Attribute that changed
750 * @param manufacturerCode Manufacturer Code of the attribute that changed
752 void emberAfDoorLockClusterServerManufacturerSpecificAttributeChangedCallback(chip::EndpointId endpoint,
753 chip::AttributeId attributeId,
754 uint16_t manufacturerCode);
756 /** @brief Door Lock Cluster Server Message Sent
758 * Server Message Sent
760 * @param type The type of message sent
761 * @param indexOrDestination The destination or address to which the message was sent
762 * @param apsFrame The APS frame for the message
763 * @param msgLen The length of the message
764 * @param message The message that was sent
765 * @param status The status of the sent message
767 void emberAfDoorLockClusterServerMessageSentCallback(EmberOutgoingMessageType type, uint64_t indexOrDestination,
768 EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message,
771 /** @brief Door Lock Cluster Server Pre Attribute Changed
773 * server Pre Attribute Changed
775 * @param endpoint Endpoint that is being initialized
776 * @param attributeId Attribute to be changed
777 * @param attributeType Attribute type
778 * @param size Attribute size
779 * @param value Attribute value
781 EmberAfStatus emberAfDoorLockClusterServerPreAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId,
782 EmberAfAttributeType attributeType, uint8_t size,
785 /** @brief Door Lock Cluster Server Tick
789 * @param endpoint Endpoint that is being served
791 void emberAfDoorLockClusterServerTickCallback(chip::EndpointId endpoint);
794 // Groups Cluster server
797 /** @brief Groups Cluster Server Init
801 * @param endpoint Endpoint that is being initialized
803 void emberAfGroupsClusterServerInitCallback(chip::EndpointId endpoint);
805 /** @brief Groups Cluster Server Attribute Changed
807 * Server Attribute Changed
809 * @param endpoint Endpoint that is being initialized
810 * @param attributeId Attribute that changed
812 void emberAfGroupsClusterServerAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId);
814 /** @brief Groups Cluster Server Manufacturer Specific Attribute Changed
816 * Server Manufacturer Specific Attribute Changed
818 * @param endpoint Endpoint that is being initialized
819 * @param attributeId Attribute that changed
820 * @param manufacturerCode Manufacturer Code of the attribute that changed
822 void emberAfGroupsClusterServerManufacturerSpecificAttributeChangedCallback(chip::EndpointId endpoint,
823 chip::AttributeId attributeId,
824 uint16_t manufacturerCode);
826 /** @brief Groups Cluster Server Message Sent
828 * Server Message Sent
830 * @param type The type of message sent
831 * @param indexOrDestination The destination or address to which the message was sent
832 * @param apsFrame The APS frame for the message
833 * @param msgLen The length of the message
834 * @param message The message that was sent
835 * @param status The status of the sent message
837 void emberAfGroupsClusterServerMessageSentCallback(EmberOutgoingMessageType type, uint64_t indexOrDestination,
838 EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message,
841 /** @brief Groups Cluster Server Pre Attribute Changed
843 * server Pre Attribute Changed
845 * @param endpoint Endpoint that is being initialized
846 * @param attributeId Attribute to be changed
847 * @param attributeType Attribute type
848 * @param size Attribute size
849 * @param value Attribute value
851 EmberAfStatus emberAfGroupsClusterServerPreAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId,
852 EmberAfAttributeType attributeType, uint8_t size,
855 /** @brief Groups Cluster Server Tick
859 * @param endpoint Endpoint that is being served
861 void emberAfGroupsClusterServerTickCallback(chip::EndpointId endpoint);
864 // IAS Zone Cluster server
867 /** @brief IAS Zone Cluster Server Init
871 * @param endpoint Endpoint that is being initialized
873 void emberAfIasZoneClusterServerInitCallback(chip::EndpointId endpoint);
875 /** @brief IAS Zone Cluster Server Attribute Changed
877 * Server Attribute Changed
879 * @param endpoint Endpoint that is being initialized
880 * @param attributeId Attribute that changed
882 void emberAfIasZoneClusterServerAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId);
884 /** @brief IAS Zone Cluster Server Manufacturer Specific Attribute Changed
886 * Server Manufacturer Specific Attribute Changed
888 * @param endpoint Endpoint that is being initialized
889 * @param attributeId Attribute that changed
890 * @param manufacturerCode Manufacturer Code of the attribute that changed
892 void emberAfIasZoneClusterServerManufacturerSpecificAttributeChangedCallback(chip::EndpointId endpoint,
893 chip::AttributeId attributeId,
894 uint16_t manufacturerCode);
896 /** @brief IAS Zone Cluster Server Message Sent
898 * Server Message Sent
900 * @param type The type of message sent
901 * @param indexOrDestination The destination or address to which the message was sent
902 * @param apsFrame The APS frame for the message
903 * @param msgLen The length of the message
904 * @param message The message that was sent
905 * @param status The status of the sent message
907 void emberAfIasZoneClusterServerMessageSentCallback(EmberOutgoingMessageType type, uint64_t indexOrDestination,
908 EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message,
911 /** @brief IAS Zone Cluster Server Pre Attribute Changed
913 * server Pre Attribute Changed
915 * @param endpoint Endpoint that is being initialized
916 * @param attributeId Attribute to be changed
917 * @param attributeType Attribute type
918 * @param size Attribute size
919 * @param value Attribute value
921 EmberAfStatus emberAfIasZoneClusterServerPreAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId,
922 EmberAfAttributeType attributeType, uint8_t size,
925 /** @brief IAS Zone Cluster Server Tick
929 * @param endpoint Endpoint that is being served
931 void emberAfIasZoneClusterServerTickCallback(chip::EndpointId endpoint);
934 // Identify Cluster server
937 /** @brief Identify Cluster Server Init
941 * @param endpoint Endpoint that is being initialized
943 void emberAfIdentifyClusterServerInitCallback(chip::EndpointId endpoint);
945 /** @brief Identify Cluster Server Attribute Changed
947 * Server Attribute Changed
949 * @param endpoint Endpoint that is being initialized
950 * @param attributeId Attribute that changed
952 void emberAfIdentifyClusterServerAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId);
954 /** @brief Identify Cluster Server Manufacturer Specific Attribute Changed
956 * Server Manufacturer Specific Attribute Changed
958 * @param endpoint Endpoint that is being initialized
959 * @param attributeId Attribute that changed
960 * @param manufacturerCode Manufacturer Code of the attribute that changed
962 void emberAfIdentifyClusterServerManufacturerSpecificAttributeChangedCallback(chip::EndpointId endpoint,
963 chip::AttributeId attributeId,
964 uint16_t manufacturerCode);
966 /** @brief Identify Cluster Server Message Sent
968 * Server Message Sent
970 * @param type The type of message sent
971 * @param indexOrDestination The destination or address to which the message was sent
972 * @param apsFrame The APS frame for the message
973 * @param msgLen The length of the message
974 * @param message The message that was sent
975 * @param status The status of the sent message
977 void emberAfIdentifyClusterServerMessageSentCallback(EmberOutgoingMessageType type, uint64_t indexOrDestination,
978 EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message,
981 /** @brief Identify Cluster Server Pre Attribute Changed
983 * server Pre Attribute Changed
985 * @param endpoint Endpoint that is being initialized
986 * @param attributeId Attribute to be changed
987 * @param attributeType Attribute type
988 * @param size Attribute size
989 * @param value Attribute value
991 EmberAfStatus emberAfIdentifyClusterServerPreAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId,
992 EmberAfAttributeType attributeType, uint8_t size,
995 /** @brief Identify Cluster Server Tick
999 * @param endpoint Endpoint that is being served
1001 void emberAfIdentifyClusterServerTickCallback(chip::EndpointId endpoint);
1004 // Level Control Cluster server
1007 /** @brief Level Control Cluster Server Init
1011 * @param endpoint Endpoint that is being initialized
1013 void emberAfLevelControlClusterServerInitCallback(chip::EndpointId endpoint);
1015 /** @brief Level Control Cluster Server Attribute Changed
1017 * Server Attribute Changed
1019 * @param endpoint Endpoint that is being initialized
1020 * @param attributeId Attribute that changed
1022 void emberAfLevelControlClusterServerAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId);
1024 /** @brief Level Control Cluster Server Manufacturer Specific Attribute Changed
1026 * Server Manufacturer Specific Attribute Changed
1028 * @param endpoint Endpoint that is being initialized
1029 * @param attributeId Attribute that changed
1030 * @param manufacturerCode Manufacturer Code of the attribute that changed
1032 void emberAfLevelControlClusterServerManufacturerSpecificAttributeChangedCallback(chip::EndpointId endpoint,
1033 chip::AttributeId attributeId,
1034 uint16_t manufacturerCode);
1036 /** @brief Level Control Cluster Server Message Sent
1038 * Server Message Sent
1040 * @param type The type of message sent
1041 * @param indexOrDestination The destination or address to which the message was sent
1042 * @param apsFrame The APS frame for the message
1043 * @param msgLen The length of the message
1044 * @param message The message that was sent
1045 * @param status The status of the sent message
1047 void emberAfLevelControlClusterServerMessageSentCallback(EmberOutgoingMessageType type, uint64_t indexOrDestination,
1048 EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message,
1049 EmberStatus status);
1051 /** @brief Level Control Cluster Server Pre Attribute Changed
1053 * server Pre Attribute Changed
1055 * @param endpoint Endpoint that is being initialized
1056 * @param attributeId Attribute to be changed
1057 * @param attributeType Attribute type
1058 * @param size Attribute size
1059 * @param value Attribute value
1061 EmberAfStatus emberAfLevelControlClusterServerPreAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId,
1062 EmberAfAttributeType attributeType, uint8_t size,
1065 /** @brief Level Control Cluster Server Tick
1069 * @param endpoint Endpoint that is being served
1071 void emberAfLevelControlClusterServerTickCallback(chip::EndpointId endpoint);
1074 // Low Power Cluster server
1077 /** @brief Low Power Cluster Server Init
1081 * @param endpoint Endpoint that is being initialized
1083 void emberAfLowPowerClusterServerInitCallback(chip::EndpointId endpoint);
1085 /** @brief Low Power Cluster Server Attribute Changed
1087 * Server Attribute Changed
1089 * @param endpoint Endpoint that is being initialized
1090 * @param attributeId Attribute that changed
1092 void emberAfLowPowerClusterServerAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId);
1094 /** @brief Low Power Cluster Server Manufacturer Specific Attribute Changed
1096 * Server Manufacturer Specific Attribute Changed
1098 * @param endpoint Endpoint that is being initialized
1099 * @param attributeId Attribute that changed
1100 * @param manufacturerCode Manufacturer Code of the attribute that changed
1102 void emberAfLowPowerClusterServerManufacturerSpecificAttributeChangedCallback(chip::EndpointId endpoint,
1103 chip::AttributeId attributeId,
1104 uint16_t manufacturerCode);
1106 /** @brief Low Power Cluster Server Message Sent
1108 * Server Message Sent
1110 * @param type The type of message sent
1111 * @param indexOrDestination The destination or address to which the message was sent
1112 * @param apsFrame The APS frame for the message
1113 * @param msgLen The length of the message
1114 * @param message The message that was sent
1115 * @param status The status of the sent message
1117 void emberAfLowPowerClusterServerMessageSentCallback(EmberOutgoingMessageType type, uint64_t indexOrDestination,
1118 EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message,
1119 EmberStatus status);
1121 /** @brief Low Power Cluster Server Pre Attribute Changed
1123 * server Pre Attribute Changed
1125 * @param endpoint Endpoint that is being initialized
1126 * @param attributeId Attribute to be changed
1127 * @param attributeType Attribute type
1128 * @param size Attribute size
1129 * @param value Attribute value
1131 EmberAfStatus emberAfLowPowerClusterServerPreAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId,
1132 EmberAfAttributeType attributeType, uint8_t size,
1135 /** @brief Low Power Cluster Server Tick
1139 * @param endpoint Endpoint that is being served
1141 void emberAfLowPowerClusterServerTickCallback(chip::EndpointId endpoint);
1144 // Media Playback Cluster server
1147 /** @brief Media Playback Cluster Server Init
1151 * @param endpoint Endpoint that is being initialized
1153 void emberAfMediaPlaybackClusterServerInitCallback(chip::EndpointId endpoint);
1155 /** @brief Media Playback Cluster Server Attribute Changed
1157 * Server Attribute Changed
1159 * @param endpoint Endpoint that is being initialized
1160 * @param attributeId Attribute that changed
1162 void emberAfMediaPlaybackClusterServerAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId);
1164 /** @brief Media Playback Cluster Server Manufacturer Specific Attribute Changed
1166 * Server Manufacturer Specific Attribute Changed
1168 * @param endpoint Endpoint that is being initialized
1169 * @param attributeId Attribute that changed
1170 * @param manufacturerCode Manufacturer Code of the attribute that changed
1172 void emberAfMediaPlaybackClusterServerManufacturerSpecificAttributeChangedCallback(chip::EndpointId endpoint,
1173 chip::AttributeId attributeId,
1174 uint16_t manufacturerCode);
1176 /** @brief Media Playback Cluster Server Message Sent
1178 * Server Message Sent
1180 * @param type The type of message sent
1181 * @param indexOrDestination The destination or address to which the message was sent
1182 * @param apsFrame The APS frame for the message
1183 * @param msgLen The length of the message
1184 * @param message The message that was sent
1185 * @param status The status of the sent message
1187 void emberAfMediaPlaybackClusterServerMessageSentCallback(EmberOutgoingMessageType type, uint64_t indexOrDestination,
1188 EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message,
1189 EmberStatus status);
1191 /** @brief Media Playback Cluster Server Pre Attribute Changed
1193 * server Pre Attribute Changed
1195 * @param endpoint Endpoint that is being initialized
1196 * @param attributeId Attribute to be changed
1197 * @param attributeType Attribute type
1198 * @param size Attribute size
1199 * @param value Attribute value
1201 EmberAfStatus emberAfMediaPlaybackClusterServerPreAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId,
1202 EmberAfAttributeType attributeType, uint8_t size,
1205 /** @brief Media Playback Cluster Server Tick
1209 * @param endpoint Endpoint that is being served
1211 void emberAfMediaPlaybackClusterServerTickCallback(chip::EndpointId endpoint);
1214 // On/off Cluster server
1217 /** @brief On/off Cluster Server Init
1221 * @param endpoint Endpoint that is being initialized
1223 void emberAfOnOffClusterServerInitCallback(chip::EndpointId endpoint);
1225 /** @brief On/off Cluster Server Attribute Changed
1227 * Server Attribute Changed
1229 * @param endpoint Endpoint that is being initialized
1230 * @param attributeId Attribute that changed
1232 void emberAfOnOffClusterServerAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId);
1234 /** @brief On/off Cluster Server Manufacturer Specific Attribute Changed
1236 * Server Manufacturer Specific Attribute Changed
1238 * @param endpoint Endpoint that is being initialized
1239 * @param attributeId Attribute that changed
1240 * @param manufacturerCode Manufacturer Code of the attribute that changed
1242 void emberAfOnOffClusterServerManufacturerSpecificAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId,
1243 uint16_t manufacturerCode);
1245 /** @brief On/off Cluster Server Message Sent
1247 * Server Message Sent
1249 * @param type The type of message sent
1250 * @param indexOrDestination The destination or address to which the message was sent
1251 * @param apsFrame The APS frame for the message
1252 * @param msgLen The length of the message
1253 * @param message The message that was sent
1254 * @param status The status of the sent message
1256 void emberAfOnOffClusterServerMessageSentCallback(EmberOutgoingMessageType type, uint64_t indexOrDestination,
1257 EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message, EmberStatus status);
1259 /** @brief On/off Cluster Server Pre Attribute Changed
1261 * server Pre Attribute Changed
1263 * @param endpoint Endpoint that is being initialized
1264 * @param attributeId Attribute to be changed
1265 * @param attributeType Attribute type
1266 * @param size Attribute size
1267 * @param value Attribute value
1269 EmberAfStatus emberAfOnOffClusterServerPreAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId,
1270 EmberAfAttributeType attributeType, uint8_t size,
1273 /** @brief On/off Cluster Server Tick
1277 * @param endpoint Endpoint that is being served
1279 void emberAfOnOffClusterServerTickCallback(chip::EndpointId endpoint);
1282 // Scenes Cluster server
1285 /** @brief Scenes Cluster Server Init
1289 * @param endpoint Endpoint that is being initialized
1291 void emberAfScenesClusterServerInitCallback(chip::EndpointId endpoint);
1293 /** @brief Scenes Cluster Server Attribute Changed
1295 * Server Attribute Changed
1297 * @param endpoint Endpoint that is being initialized
1298 * @param attributeId Attribute that changed
1300 void emberAfScenesClusterServerAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId);
1302 /** @brief Scenes Cluster Server Manufacturer Specific Attribute Changed
1304 * Server Manufacturer Specific Attribute Changed
1306 * @param endpoint Endpoint that is being initialized
1307 * @param attributeId Attribute that changed
1308 * @param manufacturerCode Manufacturer Code of the attribute that changed
1310 void emberAfScenesClusterServerManufacturerSpecificAttributeChangedCallback(chip::EndpointId endpoint,
1311 chip::AttributeId attributeId,
1312 uint16_t manufacturerCode);
1314 /** @brief Scenes Cluster Server Message Sent
1316 * Server Message Sent
1318 * @param type The type of message sent
1319 * @param indexOrDestination The destination or address to which the message was sent
1320 * @param apsFrame The APS frame for the message
1321 * @param msgLen The length of the message
1322 * @param message The message that was sent
1323 * @param status The status of the sent message
1325 void emberAfScenesClusterServerMessageSentCallback(EmberOutgoingMessageType type, uint64_t indexOrDestination,
1326 EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message,
1327 EmberStatus status);
1329 /** @brief Scenes Cluster Server Pre Attribute Changed
1331 * server Pre Attribute Changed
1333 * @param endpoint Endpoint that is being initialized
1334 * @param attributeId Attribute to be changed
1335 * @param attributeType Attribute type
1336 * @param size Attribute size
1337 * @param value Attribute value
1339 EmberAfStatus emberAfScenesClusterServerPreAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId,
1340 EmberAfAttributeType attributeType, uint8_t size,
1343 /** @brief Scenes Cluster Server Tick
1347 * @param endpoint Endpoint that is being served
1349 void emberAfScenesClusterServerTickCallback(chip::EndpointId endpoint);
1352 // Temperature Measurement Cluster server
1355 /** @brief Temperature Measurement Cluster Server Init
1359 * @param endpoint Endpoint that is being initialized
1361 void emberAfTemperatureMeasurementClusterServerInitCallback(chip::EndpointId endpoint);
1363 /** @brief Temperature Measurement Cluster Server Attribute Changed
1365 * Server Attribute Changed
1367 * @param endpoint Endpoint that is being initialized
1368 * @param attributeId Attribute that changed
1370 void emberAfTemperatureMeasurementClusterServerAttributeChangedCallback(chip::EndpointId endpoint, chip::AttributeId attributeId);
1372 /** @brief Temperature Measurement Cluster Server Manufacturer Specific Attribute Changed
1374 * Server Manufacturer Specific Attribute Changed
1376 * @param endpoint Endpoint that is being initialized
1377 * @param attributeId Attribute that changed
1378 * @param manufacturerCode Manufacturer Code of the attribute that changed
1380 void emberAfTemperatureMeasurementClusterServerManufacturerSpecificAttributeChangedCallback(chip::EndpointId endpoint,
1381 chip::AttributeId attributeId,
1382 uint16_t manufacturerCode);
1384 /** @brief Temperature Measurement Cluster Server Message Sent
1386 * Server Message Sent
1388 * @param type The type of message sent
1389 * @param indexOrDestination The destination or address to which the message was sent
1390 * @param apsFrame The APS frame for the message
1391 * @param msgLen The length of the message
1392 * @param message The message that was sent
1393 * @param status The status of the sent message
1395 void emberAfTemperatureMeasurementClusterServerMessageSentCallback(EmberOutgoingMessageType type, uint64_t indexOrDestination,
1396 EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message,
1397 EmberStatus status);
1399 /** @brief Temperature Measurement Cluster Server Pre Attribute Changed
1401 * server Pre Attribute Changed
1403 * @param endpoint Endpoint that is being initialized
1404 * @param attributeId Attribute to be changed
1405 * @param attributeType Attribute type
1406 * @param size Attribute size
1407 * @param value Attribute value
1409 EmberAfStatus emberAfTemperatureMeasurementClusterServerPreAttributeChangedCallback(chip::EndpointId endpoint,
1410 chip::AttributeId attributeId,
1411 EmberAfAttributeType attributeType,
1412 uint8_t size, uint8_t * value);
1414 /** @brief Temperature Measurement Cluster Server Tick
1418 * @param endpoint Endpoint that is being served
1420 void emberAfTemperatureMeasurementClusterServerTickCallback(chip::EndpointId endpoint);
1422 // Cluster Commands Callback
1425 * @brief Barrier Control Cluster BarrierControlGoToPercent Command callback
1426 * @param percentOpen
1429 bool emberAfBarrierControlClusterBarrierControlGoToPercentCallback(uint8_t percentOpen);
1432 * @brief Barrier Control Cluster BarrierControlStop Command callback
1435 bool emberAfBarrierControlClusterBarrierControlStopCallback();
1438 * @brief Basic Cluster ResetToFactoryDefaults Command callback
1441 bool emberAfBasicClusterResetToFactoryDefaultsCallback();
1444 * @brief Color Control Cluster MoveColor Command callback
1447 * @param optionsMask
1448 * @param optionsOverride
1451 bool emberAfColorControlClusterMoveColorCallback(int16_t rateX, int16_t rateY, uint8_t optionsMask, uint8_t optionsOverride);
1454 * @brief Color Control Cluster MoveColorTemperature Command callback
1457 * @param colorTemperatureMinimum
1458 * @param colorTemperatureMaximum
1459 * @param optionsMask
1460 * @param optionsOverride
1463 bool emberAfColorControlClusterMoveColorTemperatureCallback(uint8_t moveMode, uint16_t rate, uint16_t colorTemperatureMinimum,
1464 uint16_t colorTemperatureMaximum, uint8_t optionsMask,
1465 uint8_t optionsOverride);
1468 * @brief Color Control Cluster MoveHue Command callback
1471 * @param optionsMask
1472 * @param optionsOverride
1475 bool emberAfColorControlClusterMoveHueCallback(uint8_t moveMode, uint8_t rate, uint8_t optionsMask, uint8_t optionsOverride);
1478 * @brief Color Control Cluster MoveSaturation Command callback
1481 * @param optionsMask
1482 * @param optionsOverride
1485 bool emberAfColorControlClusterMoveSaturationCallback(uint8_t moveMode, uint8_t rate, uint8_t optionsMask, uint8_t optionsOverride);
1488 * @brief Color Control Cluster MoveToColor Command callback
1491 * @param transitionTime
1492 * @param optionsMask
1493 * @param optionsOverride
1496 bool emberAfColorControlClusterMoveToColorCallback(uint16_t colorX, uint16_t colorY, uint16_t transitionTime, uint8_t optionsMask,
1497 uint8_t optionsOverride);
1500 * @brief Color Control Cluster MoveToColorTemperature Command callback
1501 * @param colorTemperature
1502 * @param transitionTime
1503 * @param optionsMask
1504 * @param optionsOverride
1507 bool emberAfColorControlClusterMoveToColorTemperatureCallback(uint16_t colorTemperature, uint16_t transitionTime,
1508 uint8_t optionsMask, uint8_t optionsOverride);
1511 * @brief Color Control Cluster MoveToHue Command callback
1514 * @param transitionTime
1515 * @param optionsMask
1516 * @param optionsOverride
1519 bool emberAfColorControlClusterMoveToHueCallback(uint8_t hue, uint8_t direction, uint16_t transitionTime, uint8_t optionsMask,
1520 uint8_t optionsOverride);
1523 * @brief Color Control Cluster MoveToHueAndSaturation Command callback
1526 * @param transitionTime
1527 * @param optionsMask
1528 * @param optionsOverride
1531 bool emberAfColorControlClusterMoveToHueAndSaturationCallback(uint8_t hue, uint8_t saturation, uint16_t transitionTime,
1532 uint8_t optionsMask, uint8_t optionsOverride);
1535 * @brief Color Control Cluster MoveToSaturation Command callback
1537 * @param transitionTime
1538 * @param optionsMask
1539 * @param optionsOverride
1542 bool emberAfColorControlClusterMoveToSaturationCallback(uint8_t saturation, uint16_t transitionTime, uint8_t optionsMask,
1543 uint8_t optionsOverride);
1546 * @brief Color Control Cluster StepColor Command callback
1549 * @param transitionTime
1550 * @param optionsMask
1551 * @param optionsOverride
1554 bool emberAfColorControlClusterStepColorCallback(int16_t stepX, int16_t stepY, uint16_t transitionTime, uint8_t optionsMask,
1555 uint8_t optionsOverride);
1558 * @brief Color Control Cluster StepColorTemperature Command callback
1561 * @param transitionTime
1562 * @param colorTemperatureMinimum
1563 * @param colorTemperatureMaximum
1564 * @param optionsMask
1565 * @param optionsOverride
1568 bool emberAfColorControlClusterStepColorTemperatureCallback(uint8_t stepMode, uint16_t stepSize, uint16_t transitionTime,
1569 uint16_t colorTemperatureMinimum, uint16_t colorTemperatureMaximum,
1570 uint8_t optionsMask, uint8_t optionsOverride);
1573 * @brief Color Control Cluster StepHue Command callback
1576 * @param transitionTime
1577 * @param optionsMask
1578 * @param optionsOverride
1581 bool emberAfColorControlClusterStepHueCallback(uint8_t stepMode, uint8_t stepSize, uint8_t transitionTime, uint8_t optionsMask,
1582 uint8_t optionsOverride);
1585 * @brief Color Control Cluster StepSaturation Command callback
1588 * @param transitionTime
1589 * @param optionsMask
1590 * @param optionsOverride
1593 bool emberAfColorControlClusterStepSaturationCallback(uint8_t stepMode, uint8_t stepSize, uint8_t transitionTime,
1594 uint8_t optionsMask, uint8_t optionsOverride);
1597 * @brief Color Control Cluster StopMoveStep Command callback
1598 * @param optionsMask
1599 * @param optionsOverride
1602 bool emberAfColorControlClusterStopMoveStepCallback(uint8_t optionsMask, uint8_t optionsOverride);
1605 * @brief Content Launch Cluster LaunchContent Command callback
1608 bool emberAfContentLaunchClusterLaunchContentCallback();
1611 * @brief Content Launch Cluster LaunchURL Command callback
1614 bool emberAfContentLaunchClusterLaunchURLCallback();
1617 * @brief Door Lock Cluster LockDoorResponse Command callback
1621 bool emberAfDoorLockClusterLockDoorResponseCallback(uint8_t status);
1624 * @brief Door Lock Cluster UnlockDoorResponse Command callback
1628 bool emberAfDoorLockClusterUnlockDoorResponseCallback(uint8_t status);
1631 * @brief Door Lock Cluster ClearAllPins Command callback
1634 bool emberAfDoorLockClusterClearAllPinsCallback();
1637 * @brief Door Lock Cluster ClearAllRfids Command callback
1640 bool emberAfDoorLockClusterClearAllRfidsCallback();
1643 * @brief Door Lock Cluster ClearHolidaySchedule Command callback
1647 bool emberAfDoorLockClusterClearHolidayScheduleCallback(uint8_t scheduleId);
1650 * @brief Door Lock Cluster ClearPin Command callback
1654 bool emberAfDoorLockClusterClearPinCallback(uint16_t userId);
1657 * @brief Door Lock Cluster ClearRfid Command callback
1661 bool emberAfDoorLockClusterClearRfidCallback(uint16_t userId);
1664 * @brief Door Lock Cluster ClearWeekdaySchedule Command callback
1669 bool emberAfDoorLockClusterClearWeekdayScheduleCallback(uint8_t scheduleId, uint16_t userId);
1672 * @brief Door Lock Cluster ClearYeardaySchedule Command callback
1677 bool emberAfDoorLockClusterClearYeardayScheduleCallback(uint8_t scheduleId, uint16_t userId);
1680 * @brief Door Lock Cluster GetHolidaySchedule Command callback
1684 bool emberAfDoorLockClusterGetHolidayScheduleCallback(uint8_t scheduleId);
1687 * @brief Door Lock Cluster GetLogRecord Command callback
1691 bool emberAfDoorLockClusterGetLogRecordCallback(uint16_t logIndex);
1694 * @brief Door Lock Cluster GetPin Command callback
1698 bool emberAfDoorLockClusterGetPinCallback(uint16_t userId);
1701 * @brief Door Lock Cluster GetRfid Command callback
1705 bool emberAfDoorLockClusterGetRfidCallback(uint16_t userId);
1708 * @brief Door Lock Cluster GetUserType Command callback
1712 bool emberAfDoorLockClusterGetUserTypeCallback(uint16_t userId);
1715 * @brief Door Lock Cluster GetWeekdaySchedule Command callback
1720 bool emberAfDoorLockClusterGetWeekdayScheduleCallback(uint8_t scheduleId, uint16_t userId);
1723 * @brief Door Lock Cluster GetYeardaySchedule Command callback
1728 bool emberAfDoorLockClusterGetYeardayScheduleCallback(uint8_t scheduleId, uint16_t userId);
1731 * @brief Door Lock Cluster LockDoor Command callback
1735 bool emberAfDoorLockClusterLockDoorCallback(uint8_t * PIN);
1738 * @brief Door Lock Cluster SetHolidaySchedule Command callback
1740 * @param localStartTime
1741 * @param localEndTime
1742 * @param operatingModeDuringHoliday
1745 bool emberAfDoorLockClusterSetHolidayScheduleCallback(uint8_t scheduleId, uint32_t localStartTime, uint32_t localEndTime,
1746 uint8_t operatingModeDuringHoliday);
1749 * @brief Door Lock Cluster SetPin Command callback
1756 bool emberAfDoorLockClusterSetPinCallback(uint16_t userId, uint8_t userStatus, uint8_t userType, uint8_t * pin);
1759 * @brief Door Lock Cluster SetRfid Command callback
1766 bool emberAfDoorLockClusterSetRfidCallback(uint16_t userId, uint8_t userStatus, uint8_t userType, uint8_t * id);
1769 * @brief Door Lock Cluster SetUserType Command callback
1774 bool emberAfDoorLockClusterSetUserTypeCallback(uint16_t userId, uint8_t userType);
1777 * @brief Door Lock Cluster SetWeekdaySchedule Command callback
1782 * @param startMinute
1787 bool emberAfDoorLockClusterSetWeekdayScheduleCallback(uint8_t scheduleId, uint16_t userId, uint8_t daysMask, uint8_t startHour,
1788 uint8_t startMinute, uint8_t endHour, uint8_t endMinute);
1791 * @brief Door Lock Cluster SetYeardaySchedule Command callback
1794 * @param localStartTime
1795 * @param localEndTime
1798 bool emberAfDoorLockClusterSetYeardayScheduleCallback(uint8_t scheduleId, uint16_t userId, uint32_t localStartTime,
1799 uint32_t localEndTime);
1802 * @brief Door Lock Cluster UnlockDoor Command callback
1806 bool emberAfDoorLockClusterUnlockDoorCallback(uint8_t * PIN);
1809 * @brief Door Lock Cluster UnlockWithTimeout Command callback
1810 * @param timeoutInSeconds
1814 bool emberAfDoorLockClusterUnlockWithTimeoutCallback(uint16_t timeoutInSeconds, uint8_t * pin);
1817 * @brief Groups Cluster AddGroup Command callback
1822 bool emberAfGroupsClusterAddGroupCallback(uint16_t groupId, uint8_t * groupName);
1825 * @brief Groups Cluster AddGroupIfIdentifying Command callback
1830 bool emberAfGroupsClusterAddGroupIfIdentifyingCallback(uint16_t groupId, uint8_t * groupName);
1833 * @brief Groups Cluster GetGroupMembership Command callback
1838 bool emberAfGroupsClusterGetGroupMembershipCallback(uint8_t groupCount,
1839 /* TYPE WARNING: array array defaults to */ uint8_t * groupList);
1842 * @brief Groups Cluster RemoveAllGroups Command callback
1845 bool emberAfGroupsClusterRemoveAllGroupsCallback();
1848 * @brief Groups Cluster RemoveGroup Command callback
1852 bool emberAfGroupsClusterRemoveGroupCallback(uint16_t groupId);
1855 * @brief Groups Cluster ViewGroup Command callback
1859 bool emberAfGroupsClusterViewGroupCallback(uint16_t groupId);
1862 * @brief IAS Zone Cluster ZoneEnrollResponse Command callback
1863 * @param enrollResponseCode
1867 bool emberAfIasZoneClusterZoneEnrollResponseCallback(uint8_t enrollResponseCode, uint8_t zoneId);
1870 * @brief Identify Cluster Identify Command callback
1871 * @param identifyTime
1874 bool emberAfIdentifyClusterIdentifyCallback(uint16_t identifyTime);
1877 * @brief Identify Cluster IdentifyQuery Command callback
1880 bool emberAfIdentifyClusterIdentifyQueryCallback();
1883 * @brief Level Control Cluster Move Command callback
1887 * @param optionOverride
1890 bool emberAfLevelControlClusterMoveCallback(uint8_t moveMode, uint8_t rate, uint8_t optionMask, uint8_t optionOverride);
1893 * @brief Level Control Cluster MoveToLevel Command callback
1895 * @param transitionTime
1897 * @param optionOverride
1900 bool emberAfLevelControlClusterMoveToLevelCallback(uint8_t level, uint16_t transitionTime, uint8_t optionMask,
1901 uint8_t optionOverride);
1904 * @brief Level Control Cluster MoveToLevelWithOnOff Command callback
1906 * @param transitionTime
1909 bool emberAfLevelControlClusterMoveToLevelWithOnOffCallback(uint8_t level, uint16_t transitionTime);
1912 * @brief Level Control Cluster MoveWithOnOff Command callback
1917 bool emberAfLevelControlClusterMoveWithOnOffCallback(uint8_t moveMode, uint8_t rate);
1920 * @brief Level Control Cluster Step Command callback
1923 * @param transitionTime
1925 * @param optionOverride
1928 bool emberAfLevelControlClusterStepCallback(uint8_t stepMode, uint8_t stepSize, uint16_t transitionTime, uint8_t optionMask,
1929 uint8_t optionOverride);
1932 * @brief Level Control Cluster StepWithOnOff Command callback
1935 * @param transitionTime
1938 bool emberAfLevelControlClusterStepWithOnOffCallback(uint8_t stepMode, uint8_t stepSize, uint16_t transitionTime);
1941 * @brief Level Control Cluster Stop Command callback
1943 * @param optionOverride
1946 bool emberAfLevelControlClusterStopCallback(uint8_t optionMask, uint8_t optionOverride);
1949 * @brief Level Control Cluster StopWithOnOff Command callback
1952 bool emberAfLevelControlClusterStopWithOnOffCallback();
1955 * @brief Low Power Cluster Sleep Command callback
1958 bool emberAfLowPowerClusterSleepCallback();
1961 * @brief Media Playback Cluster FastForwardRequest Command callback
1964 bool emberAfMediaPlaybackClusterFastForwardRequestCallback();
1967 * @brief Media Playback Cluster NextRequest Command callback
1970 bool emberAfMediaPlaybackClusterNextRequestCallback();
1973 * @brief Media Playback Cluster PauseRequest Command callback
1976 bool emberAfMediaPlaybackClusterPauseRequestCallback();
1979 * @brief Media Playback Cluster PlayRequest Command callback
1982 bool emberAfMediaPlaybackClusterPlayRequestCallback();
1985 * @brief Media Playback Cluster PreviousRequest Command callback
1988 bool emberAfMediaPlaybackClusterPreviousRequestCallback();
1991 * @brief Media Playback Cluster RewindRequest Command callback
1994 bool emberAfMediaPlaybackClusterRewindRequestCallback();
1997 * @brief Media Playback Cluster SkipBackwardRequest Command callback
2000 bool emberAfMediaPlaybackClusterSkipBackwardRequestCallback();
2003 * @brief Media Playback Cluster SkipForwardRequest Command callback
2006 bool emberAfMediaPlaybackClusterSkipForwardRequestCallback();
2009 * @brief Media Playback Cluster StartOverRequest Command callback
2012 bool emberAfMediaPlaybackClusterStartOverRequestCallback();
2015 * @brief Media Playback Cluster StopRequest Command callback
2018 bool emberAfMediaPlaybackClusterStopRequestCallback();
2021 * @brief On/off Cluster Off Command callback
2024 bool emberAfOnOffClusterOffCallback();
2027 * @brief On/off Cluster On Command callback
2030 bool emberAfOnOffClusterOnCallback();
2033 * @brief On/off Cluster Toggle Command callback
2036 bool emberAfOnOffClusterToggleCallback();
2039 * @brief Scenes Cluster AddScene Command callback
2042 * @param transitionTime
2044 * @param extensionFieldSets
2047 bool emberAfScenesClusterAddSceneCallback(uint16_t groupId, uint8_t sceneId, uint16_t transitionTime, uint8_t * sceneName,
2048 /* TYPE WARNING: array array defaults to */ uint8_t * extensionFieldSets);
2051 * @brief Scenes Cluster GetSceneMembership Command callback
2055 bool emberAfScenesClusterGetSceneMembershipCallback(uint16_t groupId);
2058 * @brief Scenes Cluster RecallScene Command callback
2061 * @param transitionTime
2064 bool emberAfScenesClusterRecallSceneCallback(uint16_t groupId, uint8_t sceneId, uint16_t transitionTime);
2067 * @brief Scenes Cluster RemoveAllScenes Command callback
2071 bool emberAfScenesClusterRemoveAllScenesCallback(uint16_t groupId);
2074 * @brief Scenes Cluster RemoveScene Command callback
2079 bool emberAfScenesClusterRemoveSceneCallback(uint16_t groupId, uint8_t sceneId);
2082 * @brief Scenes Cluster StoreScene Command callback
2087 bool emberAfScenesClusterStoreSceneCallback(uint16_t groupId, uint8_t sceneId);
2090 * @brief Scenes Cluster ViewScene Command callback
2095 bool emberAfScenesClusterViewSceneCallback(uint16_t groupId, uint8_t sceneId);
2098 // Non-Cluster Related Callbacks
2101 /** @brief Add To Current App Tasks
2103 * This function is only useful to sleepy end devices. This function will note
2104 * the passed item as part of a set of tasks the application has outstanding
2105 * (e.g. message sent requiring APS acknwoledgement). This will affect how the
2106 * application behaves with regard to sleeping and polling. Until the
2107 * outstanding task is completed, the device may poll more frequently and sleep
2110 * @param tasks Ver.: always
2112 void emberAfAddToCurrentAppTasksCallback(EmberAfApplicationTask tasks);
2114 /** @brief Remove From Current App Tasks
2116 * This function is only useful to sleepy end devices. This function will
2117 * remove the passed item from the set of tasks the application has outstanding
2118 * (e.g. message sent requiring APS acknwoledgement). This will affect how the
2119 * application behaves with regard to sleeping and polling. Removing the item
2120 * from the list of outstanding tasks may allow the device to sleep longer and
2121 * poll less frequently. If there are other outstanding tasks the system may
2122 * still have to stay away and poll more often.
2124 * @param tasks Ver.: always
2126 void emberAfRemoveFromCurrentAppTasksCallback(EmberAfApplicationTask tasks);
2128 /** @brief Allow Network Write Attribute
2130 * This function is called by the application framework before it writes an
2131 * attribute in response to a write attribute request from an external device.
2132 * The value passed into this callback is the value to which the attribute is to
2133 * be set by the framework.
2134 Example: In mirroring simple metering data
2135 * on an Energy Services Interface (ESI) (formerly called Energy Service Portal
2136 * (ESP) in SE 1.0).), a mirrored simple meter needs to write read-only
2137 * attributes on its mirror. The-meter-mirror sample application, located in
2138 * app/framework/sample-apps, uses this callback to allow the mirrored device to
2139 * write simple metering attributes on the mirror regardless of the fact that
2140 * most simple metering attributes are defined as read-only by the ZigBee
2142 Note: The ZCL specification does not (as of this
2143 * writing) specify any permission-level security for writing writeable
2144 * attributes. As far as the ZCL specification is concerned, if an attribute is
2145 * writeable, any device that has a link key for the device should be able to
2146 * write that attribute. Furthermore if an attribute is read only, it should not
2147 * be written over the air. Thus, if you implement permissions for writing
2148 * attributes as a feature, you MAY be operating outside the specification. This
2149 * is unlikely to be a problem for writing read-only attributes, but it may be a
2150 * problem for attributes that are writeable according to the specification but
2151 * restricted by the application implementing this callback.
2153 * @param endpoint Ver.: always
2154 * @param clusterId Ver.: always
2155 * @param attributeId Ver.: always
2156 * @param mask Ver.: always
2157 * @param manufacturerCode Ver.: always
2158 * @param value Ver.: always
2159 * @param type Ver.: always
2161 EmberAfAttributeWritePermission emberAfAllowNetworkWriteAttributeCallback(chip::EndpointId endpoint, chip::ClusterId clusterId,
2162 chip::AttributeId attributeId, uint8_t mask,
2163 uint16_t manufacturerCode, uint8_t * value, uint8_t type);
2165 /** @brief Attribute Read Access
2167 * This function is called whenever the Application Framework needs to check
2168 * access permission for an attribute read.
2170 * @param endpoint Ver.: always
2171 * @param clusterId Ver.: always
2172 * @param manufacturerCode Ver.: always
2173 * @param attributeId Ver.: always
2175 bool emberAfAttributeReadAccessCallback(chip::EndpointId endpoint, chip::ClusterId clusterId, uint16_t manufacturerCode,
2176 chip::AttributeId attributeId);
2178 /** @brief Attribute Write Access
2180 * This function is called whenever the Application Framework needs to check
2181 * access permission for an attribute write.
2183 * @param endpoint Ver.: always
2184 * @param clusterId Ver.: always
2185 * @param manufacturerCode Ver.: always
2186 * @param attributeId Ver.: always
2188 bool emberAfAttributeWriteAccessCallback(chip::EndpointId endpoint, chip::ClusterId clusterId, uint16_t manufacturerCode,
2189 chip::AttributeId attributeId);
2191 /** @brief Default Response
2193 * This function is called by the application framework when a Default Response
2194 * command is received from an external device. The application should return
2195 * true if the message was processed or false if it was not.
2197 * @param clusterId The cluster identifier of this response. Ver.: always
2198 * @param commandId The command identifier to which this is a response. Ver.:
2200 * @param status Specifies either SUCCESS or the nature of the error that was
2201 * detected in the received command. Ver.: always
2203 bool emberAfDefaultResponseCallback(chip::ClusterId clusterId, chip::CommandId commandId, EmberAfStatus status);
2205 /** @brief Configure Reporting Response
2207 * This function is called by the application framework when a Configure
2208 * Reporting Response command is received from an external device. The
2209 * application should return true if the message was processed or false if it
2212 * @param clusterId The cluster identifier of this response. Ver.: always
2213 * @param buffer Buffer containing the list of attribute status records. Ver.:
2215 * @param bufLen The length in bytes of the list. Ver.: always
2217 bool emberAfConfigureReportingResponseCallback(chip::ClusterId clusterId, uint8_t * buffer, uint16_t bufLen);
2219 /** @brief Read Reporting Configuration Response
2221 * This function is called by the application framework when a Read Reporting
2222 * Configuration Response command is received from an external device. The
2223 * application should return true if the message was processed or false if it
2226 * @param clusterId The cluster identifier of this response. Ver.: always
2227 * @param buffer Buffer containing the list of attribute reporting configuration
2228 * records. Ver.: always
2229 * @param bufLen The length in bytes of the list. Ver.: always
2231 bool emberAfReadReportingConfigurationResponseCallback(chip::ClusterId clusterId, uint8_t * buffer, uint16_t bufLen);
2233 /** @brief Discover Attributes Response
2235 * This function is called by the application framework when a Discover
2236 * Attributes Response or Discover Attributes Extended Response command is
2237 * received from an external device. The Discover Attributes Response command
2238 * contains a bool indicating if discovery is complete and a list of zero or
2239 * more attribute identifier/type records. The final argument indicates whether
2240 * the response is in the extended format or not. The application should return
2241 * true if the message was processed or false if it was not.
2243 * @param clusterId The cluster identifier of this response. Ver.: always
2244 * @param discoveryComplete Indicates whether there are more attributes to be
2245 * discovered. true if there are no more attributes to be discovered. Ver.:
2247 * @param buffer Buffer containing the list of attribute identifier/type
2248 * records. Ver.: always
2249 * @param bufLen The length in bytes of the list. Ver.: always
2250 * @param extended Indicates whether the response is in the extended format or
2253 bool emberAfDiscoverAttributesResponseCallback(chip::ClusterId clusterId, bool discoveryComplete, uint8_t * buffer, uint16_t bufLen,
2256 /** @brief Discover Commands Generated Response
2258 * This function is called by the framework when Discover Commands Generated
2259 * Response is received.
2261 * @param clusterId The cluster identifier of this response. Ver.: always
2262 * @param manufacturerCode Manufacturer code Ver.: always
2263 * @param discoveryComplete Indicates whether there are more commands to be
2264 * discovered. Ver.: always
2265 * @param commandIds Buffer containing the list of command identifiers. Ver.:
2267 * @param commandIdCount The length of bytes of the list, whish is the same as
2268 * the number of identifiers. Ver.: always
2270 bool emberAfDiscoverCommandsGeneratedResponseCallback(chip::ClusterId clusterId, uint16_t manufacturerCode, bool discoveryComplete,
2271 chip::CommandId * commandIds, uint16_t commandIdCount);
2273 /** @brief Discover Commands Received Response
2275 * This function is called by the framework when Discover Commands Received
2276 * Response is received.
2278 * @param clusterId The cluster identifier of this response. Ver.: always
2279 * @param manufacturerCode Manufacturer code Ver.: always
2280 * @param discoveryComplete Indicates whether there are more commands to be
2281 * discovered. Ver.: always
2282 * @param commandIds Buffer containing the list of command identifiers. Ver.:
2284 * @param commandIdCount The length of bytes of the list, whish is the same as
2285 * the number of identifiers. Ver.: always
2287 bool emberAfDiscoverCommandsReceivedResponseCallback(chip::ClusterId clusterId, uint16_t manufacturerCode, bool discoveryComplete,
2288 chip::CommandId * commandIds, uint16_t commandIdCount);
2290 /** @brief Pre Command Received
2292 * This callback is the second in the Application Framework's message processing
2293 * chain. At this point in the processing of incoming over-the-air messages, the
2294 * application has determined that the incoming message is a ZCL command. It
2295 * parses enough of the message to populate an EmberAfClusterCommand struct. The
2296 * Application Framework defines this struct value in a local scope to the
2297 * command processing but also makes it available through a global pointer
2298 * called emberAfCurrentCommand, in app/framework/util/util.c. When command
2299 * processing is complete, this pointer is cleared.
2301 * @param cmd Ver.: always
2303 bool emberAfPreCommandReceivedCallback(EmberAfClusterCommand * cmd);
2305 /** @brief Pre Message Send
2307 * This function is called by the framework when it is about to pass a message
2308 * to the stack primitives for sending. This message may or may not be ZCL,
2309 * ZDO, or some other protocol. This is called prior to
2311 * fragmentation that may be done. If the function returns true it is assumed
2312 * the callback has consumed and processed the message. The callback must also
2313 * set the EmberStatus status code to be passed back to the caller. The
2314 * framework will do no further processing on the message.
2316 * function returns false then it is assumed that the callback has not processed
2317 * the mesasge and the framework will continue to process accordingly.
2319 * @param messageStruct The structure containing the parameters of the APS
2320 * message to be sent. Ver.: always
2321 * @param status A pointer to the status code value that will be returned to the
2322 * caller. Ver.: always
2324 bool emberAfPreMessageSendCallback(EmberAfMessageStruct * messageStruct, EmberStatus * status);
2326 /** @brief Message Sent
2328 * This function is called by the application framework from the message sent
2329 * handler, when it is informed by the stack regarding the message sent status.
2330 * All of the values passed to the emberMessageSentHandler are passed on to this
2331 * callback. This provides an opportunity for the application to verify that its
2332 * message has been sent successfully and take the appropriate action. This
2333 * callback should return a bool value of true or false. A value of true
2334 * indicates that the message sent notification has been handled and should not
2335 * be handled by the application framework.
2337 * @param type Ver.: always
2338 * @param indexOrDestination Ver.: always
2339 * @param apsFrame Ver.: always
2340 * @param msgLen Ver.: always
2341 * @param message Ver.: always
2342 * @param status Ver.: always
2344 bool emberAfMessageSentCallback(EmberOutgoingMessageType type, uint64_t indexOrDestination, EmberApsFrame * apsFrame,
2345 uint16_t msgLen, uint8_t * message, EmberStatus status);
2347 /** @brief Pre Attribute Change
2349 * This function is called by the application framework before it changes an
2350 * attribute value. The value passed into this callback is the value to which
2351 * the attribute is to be set by the framework. The application should return
2352 * ::EMBER_ZCL_STATUS_SUCCESS to permit the change or any other ::EmberAfStatus
2355 * @param endpoint Ver.: always
2356 * @param clusterId Ver.: always
2357 * @param attributeId Ver.: always
2358 * @param mask Ver.: always
2359 * @param manufacturerCode Ver.: always
2360 * @param type Ver.: always
2361 * @param size Ver.: always
2362 * @param value Ver.: always
2364 EmberAfStatus emberAfPreAttributeChangeCallback(chip::EndpointId endpoint, chip::ClusterId clusterId, chip::AttributeId attributeId,
2365 uint8_t mask, uint16_t manufacturerCode, uint8_t type, uint8_t size,
2368 /** @brief Post Attribute Change
2370 * This function is called by the application framework after it changes an
2371 * attribute value. The value passed into this callback is the value to which
2372 * the attribute was set by the framework.
2374 * @param endpoint Ver.: always
2375 * @param clusterId Ver.: always
2376 * @param attributeId Ver.: always
2377 * @param mask Ver.: always
2378 * @param manufacturerCode Ver.: always
2379 * @param type Ver.: always
2380 * @param size Ver.: always
2381 * @param value Ver.: always
2383 void emberAfPostAttributeChangeCallback(chip::EndpointId endpoint, chip::ClusterId clusterId, chip::AttributeId attributeId,
2384 uint8_t mask, uint16_t manufacturerCode, uint8_t type, uint8_t size, uint8_t * value);
2386 /** @brief Read Attributes Response
2388 * This function is called by the application framework when a Read Attributes
2389 * Response command is received from an external device. The application should
2390 * return true if the message was processed or false if it was not.
2392 * @param clusterId The cluster identifier of this response. Ver.: always
2393 * @param buffer Buffer containing the list of read attribute status records.
2395 * @param bufLen The length in bytes of the list. Ver.: always
2397 bool emberAfReadAttributesResponseCallback(chip::ClusterId clusterId, uint8_t * buffer, uint16_t bufLen);
2399 /** @brief External Attribute Read
2401 * Like emberAfExternalAttributeWriteCallback above, this function is called
2402 * when the framework needs to read an attribute that is not stored within the
2403 * Application Framework's data structures.
2404 All of the important
2405 * information about the attribute itself is passed as a pointer to an
2406 * EmberAfAttributeMetadata struct, which is stored within the application and
2407 * used to manage the attribute. A complete description of the
2408 * EmberAfAttributeMetadata struct is provided in
2409 * app/framework/include/af-types.h
2410 This function assumes that the
2411 * application is able to read the attribute, write it into the passed buffer,
2412 * and return immediately. Any attributes that require a state machine for
2413 * reading and writing are not really candidates for externalization at the
2414 * present time. The Application Framework does not currently include a state
2415 * machine for reading or writing attributes that must take place across a
2416 * series of application ticks. Attributes that cannot be read in a timely
2417 * manner should be stored within the Application Framework and updated
2418 * occasionally by the application code from within the
2419 * emberAfMainTickCallback.
2420 If the application was successfully able to
2421 * read the attribute and write it into the passed buffer, it should return a
2422 * value of EMBER_ZCL_STATUS_SUCCESS. Ensure that the size of the externally
2423 * managed attribute value is smaller than what the buffer can hold. In the case
2424 * of a buffer overflow throw an appropriate error such as
2425 * EMBER_ZCL_STATUS_INSUFFICIENT_SPACE. Any other return value indicates the
2426 * application was not able to read the attribute.
2428 * @param endpoint Ver.: always
2429 * @param clusterId Ver.: always
2430 * @param attributeMetadata Ver.: always
2431 * @param manufacturerCode Ver.: always
2432 * @param buffer Ver.: always
2433 * @param maxReadLength Ver.: always
2435 EmberAfStatus emberAfExternalAttributeReadCallback(chip::EndpointId endpoint, chip::ClusterId clusterId,
2436 EmberAfAttributeMetadata * attributeMetadata, uint16_t manufacturerCode,
2437 uint8_t * buffer, uint16_t maxReadLength);
2439 /** @brief Write Attributes Response
2441 * This function is called by the application framework when a Write Attributes
2442 * Response command is received from an external device. The application should
2443 * return true if the message was processed or false if it was not.
2445 * @param clusterId The cluster identifier of this response. Ver.: always
2446 * @param buffer Buffer containing the list of write attribute status records.
2448 * @param bufLen The length in bytes of the list. Ver.: always
2450 bool emberAfWriteAttributesResponseCallback(chip::ClusterId clusterId, uint8_t * buffer, uint16_t bufLen);
2452 /** @brief External Attribute Write
2454 * This function is called whenever the Application Framework needs to write an
2455 * attribute which is not stored within the data structures of the Application
2456 * Framework itself. One of the new features in Version 2 is the ability to
2457 * store attributes outside the Framework. This is particularly useful for
2458 * attributes that do not need to be stored because they can be read off the
2459 * hardware when they are needed, or are stored in some central location used by
2460 * many modules within the system. In this case, you can indicate that the
2461 * attribute is stored externally. When the framework needs to write an external
2462 * attribute, it makes a call to this callback.
2463 This callback is very
2464 * useful for host micros which need to store attributes in persistent memory.
2465 * Because each host micro (used with an Ember NCP) has its own type of
2466 * persistent memory storage, the Application Framework does not include the
2467 * ability to mark attributes as stored in flash the way that it does for Ember
2468 * SoCs like the EM35x. On a host micro, any attributes that need to be stored
2469 * in persistent memory should be marked as external and accessed through the
2470 * external read and write callbacks. Any host code associated with the
2471 * persistent storage should be implemented within this callback.
2473 * the important information about the attribute itself is passed as a pointer
2474 * to an EmberAfAttributeMetadata struct, which is stored within the application
2475 * and used to manage the attribute. A complete description of the
2476 * EmberAfAttributeMetadata struct is provided in
2477 * app/framework/include/af-types.h.
2478 This function assumes that the
2479 * application is able to write the attribute and return immediately. Any
2480 * attributes that require a state machine for reading and writing are not
2481 * candidates for externalization at the present time. The Application Framework
2482 * does not currently include a state machine for reading or writing attributes
2483 * that must take place across a series of application ticks. Attributes that
2484 * cannot be written immediately should be stored within the Application
2485 * Framework and updated occasionally by the application code from within the
2486 * emberAfMainTickCallback.
2487 If the application was successfully able to
2488 * write the attribute, it returns a value of EMBER_ZCL_STATUS_SUCCESS. Any
2489 * other return value indicates the application was not able to write the
2492 * @param endpoint Ver.: always
2493 * @param clusterId Ver.: always
2494 * @param attributeMetadata Ver.: always
2495 * @param manufacturerCode Ver.: always
2496 * @param buffer Ver.: always
2498 EmberAfStatus emberAfExternalAttributeWriteCallback(chip::EndpointId endpoint, chip::ClusterId clusterId,
2499 EmberAfAttributeMetadata * attributeMetadata, uint16_t manufacturerCode,
2502 /** @brief Report Attributes
2504 * This function is called by the application framework when a Report Attributes
2505 * command is received from an external device. The application should return
2506 * true if the message was processed or false if it was not.
2508 * @param clusterId The cluster identifier of this command. Ver.: always
2509 * @param buffer Buffer containing the list of attribute report records. Ver.:
2511 * @param bufLen The length in bytes of the list. Ver.: always
2513 bool emberAfReportAttributesCallback(chip::ClusterId clusterId, uint8_t * buffer, uint16_t bufLen);
2515 /** @brief Get Current Time
2517 * This callback is called when device attempts to get current time from the
2518 * hardware. If this device has means to retrieve exact time, then this method
2519 * should implement it. If the callback can't provide the exact time it should
2520 * return 0 to indicate failure. Default action is to return 0, which indicates
2521 * that device does not have access to real time.
2524 uint32_t emberAfGetCurrentTimeCallback();
2526 /** @brief Get Endpoint Info
2528 * This function is a callback to an application implemented endpoint that
2529 * operates outside the normal application framework. When the framework wishes
2530 * to perform operations with that endpoint it uses this callback to retrieve
2531 * the endpoint's information. If the endpoint exists and the application can
2532 * provide data then true shall be returned. Otherwise the callback must return
2535 * @param endpoint The endpoint to retrieve data for. Ver.: always
2536 * @param returnNetworkIndex The index corresponding to the ZigBee network the
2537 * endpoint belongs to. If not using a multi-network device, 0 must be
2538 * returned. Otherwise on a multi-network device the stack will switch to this
2539 * network before sending the message. Ver.: always
2540 * @param returnEndpointInfo A pointer to a data struct that will be written
2541 * with information about the endpoint. Ver.: always
2543 bool emberAfGetEndpointInfoCallback(chip::EndpointId endpoint, uint8_t * returnNetworkIndex,
2544 EmberAfEndpointInfoStruct * returnEndpointInfo);
2546 /** @brief Get Source Route Overhead
2548 * This function is called by the framework to determine the overhead required
2549 * in the network frame for source routing to a particular destination.
2551 * @param destination The node id of the destination Ver.: always
2553 uint8_t emberAfGetSourceRouteOverheadCallback(chip::NodeId destination);
2555 /** @brief Registration Abort
2557 * This callback is called when the device should abort the registration
2561 void emberAfRegistrationAbortCallback();
2563 /** @brief Interpan Send Message
2565 * This function will send a raw MAC message with interpan frame format using
2566 * the passed parameters.
2568 * @param header Interpan header info Ver.: always
2569 * @param messageLength The length of the message received or to send Ver.:
2571 * @param message The message data received or to send. Ver.: always
2573 EmberStatus emberAfInterpanSendMessageCallback(EmberAfInterpanHeader * header, uint16_t messageLength, uint8_t * message);
2575 /** @brief Start Move
2577 * This function is called to initiate the process for a device to move (rejoin)
2581 bool emberAfStartMoveCallback();