Prepayment Client#

Callbacks for Prepayment Client Component.

Callbacks#

bool
emberAfPluginPrepaymentClusterChangePaymentModeResponseCallback(uint8_t friendlyCredit, uint32_t friendlyCreditCalendarId, uint32_t emergencyCreditLimit, uint32_t emergencyCreditThreshold)

Payment mode change callback.

void
emberAfPrepaymentClusterClientAttributeChangedCallback(uint8_t endpoint, EmberAfAttributeId attributeId)

Called when the prepayment cluster client attribute has changed.

void
emberAfPrepaymentClusterClientDefaultResponseCallback(uint8_t endpoint, uint8_t commandId, EmberAfStatus status)

Called when the client receives the default response from the server.

void
emberAfPrepaymentClusterClientInitCallback(uint8_t endpoint)

Initialize prepayment cluster client.

void
emberAfPrepaymentClusterClientManufacturerSpecificAttributeChangedCallback(uint8_t endpoint, EmberAfAttributeId attributeId, uint16_t manufacturerCode)

Called when the prepayment cluster client manufacturer -specific attribute has changed.

void
emberAfPrepaymentClusterClientMessageSentCallback(EmberOutgoingMessageType type, uint16_t indexOrDestination, EmberApsFrame *apsFrame, uint16_t msgLen, uint8_t *message, EmberStatus status)

Called when the prepayment cluster client message was sent.

EmberAfStatus
emberAfPrepaymentClusterClientPreAttributeChangedCallback(uint8_t endpoint, EmberAfAttributeId attributeId, EmberAfAttributeType attributeType, uint8_t size, uint8_t *value)

Called when the prepayment cluster client pre attribute has changed.

void
emberAfPrepaymentClusterClientTickCallback(uint8_t endpoint)

Called upon the prepayment cluster client tick.

Callbacks Documentation#

emberAfPluginPrepaymentClusterChangePaymentModeResponseCallback#

bool emberAfPluginPrepaymentClusterChangePaymentModeResponseCallback (uint8_t friendlyCredit, uint32_t friendlyCreditCalendarId, uint32_t emergencyCreditLimit, uint32_t emergencyCreditThreshold)

Payment mode change callback.

Parameters
TypeDirectionArgument NameDescription
uint8_tN/AfriendlyCredit

Ver.: always

uint32_tN/AfriendlyCreditCalendarId

Ver.: always

uint32_tN/AemergencyCreditLimit

Ver.: always

uint32_tN/AemergencyCreditThreshold

Ver.: always

Returns

  • bool


emberAfPrepaymentClusterClientAttributeChangedCallback#

void emberAfPrepaymentClusterClientAttributeChangedCallback (uint8_t endpoint, EmberAfAttributeId attributeId)

Called when the prepayment cluster client attribute has changed.

Parameters
TypeDirectionArgument NameDescription
uint8_tN/Aendpoint

Endpoint that is being initialized Ver.: always

EmberAfAttributeIdN/AattributeId

Attribute that changed Ver.: always

Client attribute has changed.


emberAfPrepaymentClusterClientDefaultResponseCallback#

void emberAfPrepaymentClusterClientDefaultResponseCallback (uint8_t endpoint, uint8_t commandId, EmberAfStatus status)

Called when the client receives the default response from the server.

Parameters
TypeDirectionArgument NameDescription
uint8_tN/Aendpoint

Destination endpoint Ver.: always

uint8_tN/AcommandId

Command id Ver.: always

EmberAfStatusN/Astatus

Status in default response Ver.: always

This function is called when the client receives the default response from the server.


emberAfPrepaymentClusterClientInitCallback#

void emberAfPrepaymentClusterClientInitCallback (uint8_t endpoint)

Initialize prepayment cluster client.

Parameters
TypeDirectionArgument NameDescription
uint8_tN/Aendpoint

Endpoint that is being initialized Ver.: always

Client initialization.


emberAfPrepaymentClusterClientManufacturerSpecificAttributeChangedCallback#

void emberAfPrepaymentClusterClientManufacturerSpecificAttributeChangedCallback (uint8_t endpoint, EmberAfAttributeId attributeId, uint16_t manufacturerCode)

Called when the prepayment cluster client manufacturer -specific attribute has changed.

Parameters
TypeDirectionArgument NameDescription
uint8_tN/Aendpoint

Endpoint that is being initialized Ver.: always

EmberAfAttributeIdN/AattributeId

Attribute that changed Ver.: always

uint16_tN/AmanufacturerCode

Manufacturer Code of the attribute that changed Ver.: always

Called when the prepayment cluster client manufacturer -specific attribute has changed.


emberAfPrepaymentClusterClientMessageSentCallback#

void emberAfPrepaymentClusterClientMessageSentCallback (EmberOutgoingMessageType type, uint16_t indexOrDestination, EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message, EmberStatus status)

Called when the prepayment cluster client message was sent.

Parameters
TypeDirectionArgument NameDescription
EmberOutgoingMessageTypeN/Atype

The type of message sent Ver.: always

uint16_tN/AindexOrDestination

The destination or address to which the message was sent Ver.: always

EmberApsFrame *N/AapsFrame

The APS frame for the message Ver.: always

uint16_tN/AmsgLen

The length of the message Ver.: always

uint8_t *N/Amessage

The message that was sent Ver.: always

EmberStatusN/Astatus

The status of the sent message Ver.: always

Client message was sent.


emberAfPrepaymentClusterClientPreAttributeChangedCallback#

EmberAfStatus emberAfPrepaymentClusterClientPreAttributeChangedCallback (uint8_t endpoint, EmberAfAttributeId attributeId, EmberAfAttributeType attributeType, uint8_t size, uint8_t * value)

Called when the prepayment cluster client pre attribute has changed.

Parameters
TypeDirectionArgument NameDescription
uint8_tN/Aendpoint

Endpoint that is being initialized Ver.: always

EmberAfAttributeIdN/AattributeId

Attribute to be changed Ver.: always

EmberAfAttributeTypeN/AattributeType

Attribute type Ver.: always

uint8_tN/Asize

Attribute size Ver.: always

uint8_t *N/Avalue

Attribute value Ver.: always

Client pre attribute has changed.


emberAfPrepaymentClusterClientTickCallback#

void emberAfPrepaymentClusterClientTickCallback (uint8_t endpoint)

Called upon the prepayment cluster client tick.

Parameters
TypeDirectionArgument NameDescription
uint8_tN/Aendpoint

Endpoint that is being served Ver.: always

Client tick.