Prepayment Client#
Callbacks for Prepayment Client Component.
Callbacks#
Payment mode change callback.
Called when the prepayment cluster client attribute has changed.
Called when the client receives the default response from the server.
Initialize prepayment cluster client.
Called when the prepayment cluster client manufacturer -specific attribute has changed.
Called when the prepayment cluster client message was sent.
Called when the prepayment cluster client pre attribute has changed.
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.
| N/A | friendlyCredit | Ver.: always |
| N/A | friendlyCreditCalendarId | Ver.: always |
| N/A | emergencyCreditLimit | Ver.: always |
| N/A | emergencyCreditThreshold | Ver.: always |
Returns
bool
84 of file app/framework/plugin/prepayment-client/prepayment-client.hemberAfPrepaymentClusterClientAttributeChangedCallback#
void emberAfPrepaymentClusterClientAttributeChangedCallback (uint8_t endpoint, EmberAfAttributeId attributeId)
Called when the prepayment cluster client attribute has changed.
| N/A | endpoint | Endpoint that is being initialized Ver.: always |
| N/A | attributeId | Attribute that changed Ver.: always |
Client attribute has changed.
93 of file app/framework/plugin/prepayment-client/prepayment-client.hemberAfPrepaymentClusterClientDefaultResponseCallback#
void emberAfPrepaymentClusterClientDefaultResponseCallback (uint8_t endpoint, uint8_t commandId, EmberAfStatus status)
Called when the client receives the default response from the server.
| N/A | endpoint | Destination endpoint Ver.: always |
| N/A | commandId | Command id Ver.: always |
| N/A | status | Status in default response Ver.: always |
This function is called when the client receives the default response from the server.
105 of file app/framework/plugin/prepayment-client/prepayment-client.hemberAfPrepaymentClusterClientInitCallback#
void emberAfPrepaymentClusterClientInitCallback (uint8_t endpoint)
Initialize prepayment cluster client.
| N/A | endpoint | Endpoint that is being initialized Ver.: always |
Client initialization.
114 of file app/framework/plugin/prepayment-client/prepayment-client.hemberAfPrepaymentClusterClientManufacturerSpecificAttributeChangedCallback#
void emberAfPrepaymentClusterClientManufacturerSpecificAttributeChangedCallback (uint8_t endpoint, EmberAfAttributeId attributeId, uint16_t manufacturerCode)
Called when the prepayment cluster client manufacturer -specific attribute has changed.
| N/A | endpoint | Endpoint that is being initialized Ver.: always |
| N/A | attributeId | Attribute that changed Ver.: always |
| N/A | manufacturerCode | Manufacturer Code of the attribute that changed Ver.: always |
Called when the prepayment cluster client manufacturer -specific attribute has changed.
126 of file app/framework/plugin/prepayment-client/prepayment-client.hemberAfPrepaymentClusterClientMessageSentCallback#
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.
| N/A | type | The type of message sent Ver.: always |
| N/A | indexOrDestination | The destination or address to which the message was sent Ver.: always |
| N/A | apsFrame | The APS frame for the message Ver.: always |
| N/A | msgLen | The length of the message Ver.: always |
| N/A | message | The message that was sent Ver.: always |
| N/A | status | The status of the sent message Ver.: always |
Client message was sent.
141 of file app/framework/plugin/prepayment-client/prepayment-client.hemberAfPrepaymentClusterClientPreAttributeChangedCallback#
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.
| N/A | endpoint | Endpoint that is being initialized Ver.: always |
| N/A | attributeId | Attribute to be changed Ver.: always |
| N/A | attributeType | Attribute type Ver.: always |
| N/A | size | Attribute size Ver.: always |
| N/A | value | Attribute value Ver.: always |
Client pre attribute has changed.
158 of file app/framework/plugin/prepayment-client/prepayment-client.hemberAfPrepaymentClusterClientTickCallback#
void emberAfPrepaymentClusterClientTickCallback (uint8_t endpoint)
Called upon the prepayment cluster client tick.
| N/A | endpoint | Endpoint that is being served Ver.: always |
Client tick.
169 of file app/framework/plugin/prepayment-client/prepayment-client.h