eCLD_PPPowerProfileNotificationSend

teZCL_Status eCLD_PPPowerProfileNotificationSend(
     uint8 u8SourceEndPointId,
     uint8 u8DestinationEndPointId,
     tsZCL_Address *psDestinationAddress,
     uint8 *pu8TransactionSequenceNumber,
     tsCLD_PP_PowerProfilePayload *psPayload);

Description

This function can be used on the cluster server to send a Power Profile Notification to a cluster client, in order to inform the client about one power profile supported by the server. The notification contains essential information about the power profile, including the energy phases supported by the profile (and certain details about them). If the server supports multiple power profiles, the function must be called for each profile separately.

On receiving the notification on the client, the event E_CLD_PP_CMD_POWER_PROFILE_NOTIFICATION is generated, containing the sent power profile information in a tsCLD_PP_PowerProfilePayload structure (see Section 21.10.4).

You are required to provide a pointer to a location to receive a Transaction Sequence Number (TSN) for the message. The TSN in the response is set to match the TSN in the request, allowing an incoming response to be paired with a request. This is useful when sending more than one request to the same destination endpoint.

Parameters

  • u8SourceEndPointId: Number of local endpoint on which cluster server resides

  • u8DestinationEndPointId : Number of remote endpoint on which cluster client resides

  • psDestinationAddress: Pointer to a structure containing the destination address of the client node

  • pu8TransactionSequenceNumber: Pointer to a location to receive the Transaction Sequence Number (TSN) of the message

  • psPayload: Pointer to structure containing the payload for the request (see Section 21.10.4), including essential information about the power profile

Returns

  • E_ZCL_SUCCESS

  • E_ZCL_FAIL

  • E_ZCL_ERR_EP_UNKNOWN

  • E_ZCL_ERR_ZBUFFER_FAIL

  • E_ZCL_ERR_ZTRANSMIT_FAIL

Parent topic:Server Functions