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#
sl_zigbee_af_prepayment_cluster_change_payment_mode_response_cb#
bool sl_zigbee_af_prepayment_cluster_change_payment_mode_response_cb (uint8_t friendlyCredit, uint32_t friendlyCreditCalendarId, uint32_t emergencyCreditLimit, uint32_t emergencyCreditThreshold)
Payment mode change callback.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | friendlyCredit | Ver.: always |
| uint32_t | N/A | friendlyCreditCalendarId | Ver.: always |
| uint32_t | N/A | emergencyCreditLimit | Ver.: always |
| uint32_t | N/A | emergencyCreditThreshold | Ver.: always |
Returns
bool
sl_zigbee_af_prepayment_cluster_client_attribute_changed_cb#
void sl_zigbee_af_prepayment_cluster_client_attribute_changed_cb (uint8_t endpoint, sl_zigbee_af_attribute_id_t attributeId)
Called when the prepayment cluster client attribute has changed.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | Endpoint that is being initialized Ver.: always |
| sl_zigbee_af_attribute_id_t | N/A | attributeId | Attribute that changed Ver.: always |
Client attribute has changed.
sl_zigbee_af_prepayment_cluster_client_default_response_cb#
void sl_zigbee_af_prepayment_cluster_client_default_response_cb (uint8_t endpoint, uint8_t commandId, sl_zigbee_af_status_t status)
Called when the client receives the default response from the server.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | Destination endpoint Ver.: always |
| uint8_t | N/A | commandId | Command id Ver.: always |
| sl_zigbee_af_status_t | N/A | status | Status in default response Ver.: always |
This function is called when the client receives the default response from the server.
sl_zigbee_af_prepayment_cluster_client_init_cb#
void sl_zigbee_af_prepayment_cluster_client_init_cb (uint8_t endpoint)
Initialize prepayment cluster client.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | Endpoint that is being initialized Ver.: always |
Client initialization.
sl_zigbee_af_prepayment_cluster_client_manufacturer_specific_attribute_changed_cb#
void sl_zigbee_af_prepayment_cluster_client_manufacturer_specific_attribute_changed_cb (uint8_t endpoint, sl_zigbee_af_attribute_id_t attributeId, uint16_t manufacturerCode)
Called when the prepayment cluster client manufacturer -specific attribute has changed.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | Endpoint that is being initialized Ver.: always |
| sl_zigbee_af_attribute_id_t | N/A | attributeId | Attribute that changed Ver.: always |
| uint16_t | N/A | manufacturerCode | Manufacturer Code of the attribute that changed Ver.: always |
Called when the prepayment cluster client manufacturer -specific attribute has changed.
sl_zigbee_af_prepayment_cluster_client_message_sent_cb#
void sl_zigbee_af_prepayment_cluster_client_message_sent_cb (sl_zigbee_outgoing_message_type_t type, uint16_t indexOrDestination, sl_zigbee_aps_frame_t * apsFrame, uint16_t msgLen, uint8_t * message, sl_status_t status)
Called when the prepayment cluster client message was sent.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_zigbee_outgoing_message_type_t | N/A | type | The type of message sent Ver.: always |
| uint16_t | N/A | indexOrDestination | The destination or address to which the message was sent Ver.: always |
| sl_zigbee_aps_frame_t * | N/A | apsFrame | The APS frame for the message Ver.: always |
| uint16_t | N/A | msgLen | The length of the message Ver.: always |
| uint8_t * | N/A | message | The message that was sent Ver.: always |
| sl_status_t | N/A | status | The status of the sent message Ver.: always |
Client message was sent.
sl_zigbee_af_prepayment_cluster_client_pre_attribute_changed_cb#
sl_zigbee_af_status_t sl_zigbee_af_prepayment_cluster_client_pre_attribute_changed_cb (uint8_t endpoint, sl_zigbee_af_attribute_id_t attributeId, sl_zigbee_af_attribute_type_t attributeType, uint8_t size, uint8_t * value)
Called when the prepayment cluster client pre attribute has changed.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | Endpoint that is being initialized Ver.: always |
| sl_zigbee_af_attribute_id_t | N/A | attributeId | Attribute to be changed Ver.: always |
| sl_zigbee_af_attribute_type_t | N/A | attributeType | Attribute type Ver.: always |
| uint8_t | N/A | size | Attribute size Ver.: always |
| uint8_t * | N/A | value | Attribute value Ver.: always |
Client pre attribute has changed.
sl_zigbee_af_prepayment_cluster_client_tick_cb#
void sl_zigbee_af_prepayment_cluster_client_tick_cb (uint8_t endpoint)
Called upon the prepayment cluster client tick.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | Endpoint that is being served Ver.: always |
Client tick.