Prepayment Client#

Callbacks for Prepayment Client Component.

Callbacks#

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.

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.

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.

void

Initialize prepayment cluster client.

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.

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.

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.

void

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.

Parameters
N/AfriendlyCredit

Ver.: always

N/AfriendlyCreditCalendarId

Ver.: always

N/AemergencyCreditLimit

Ver.: always

N/AemergencyCreditThreshold

Ver.: always

Returns

  • bool


Definition at line 84 of file app/framework/plugin/prepayment-client/prepayment-client.h

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.

Parameters
N/Aendpoint

Endpoint that is being initialized Ver.: always

N/AattributeId

Attribute that changed Ver.: always

Client attribute has changed.


Definition at line 93 of file app/framework/plugin/prepayment-client/prepayment-client.h

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.

Parameters
N/Aendpoint

Destination endpoint Ver.: always

N/AcommandId

Command id Ver.: always

N/Astatus

Status in default response Ver.: always

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


Definition at line 105 of file app/framework/plugin/prepayment-client/prepayment-client.h

sl_zigbee_af_prepayment_cluster_client_init_cb#

void sl_zigbee_af_prepayment_cluster_client_init_cb (uint8_t endpoint)

Initialize prepayment cluster client.

Parameters
N/Aendpoint

Endpoint that is being initialized Ver.: always

Client initialization.


Definition at line 114 of file app/framework/plugin/prepayment-client/prepayment-client.h

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.

Parameters
N/Aendpoint

Endpoint that is being initialized Ver.: always

N/AattributeId

Attribute that changed Ver.: always

N/AmanufacturerCode

Manufacturer Code of the attribute that changed Ver.: always

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


Definition at line 126 of file app/framework/plugin/prepayment-client/prepayment-client.h

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.

Parameters
N/Atype

The type of message sent Ver.: always

N/AindexOrDestination

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

N/AapsFrame

The APS frame for the message Ver.: always

N/AmsgLen

The length of the message Ver.: always

N/Amessage

The message that was sent Ver.: always

N/Astatus

The status of the sent message Ver.: always

Client message was sent.


Definition at line 141 of file app/framework/plugin/prepayment-client/prepayment-client.h

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.

Parameters
N/Aendpoint

Endpoint that is being initialized Ver.: always

N/AattributeId

Attribute to be changed Ver.: always

N/AattributeType

Attribute type Ver.: always

N/Asize

Attribute size Ver.: always

N/Avalue

Attribute value Ver.: always

Client pre attribute has changed.


Definition at line 158 of file app/framework/plugin/prepayment-client/prepayment-client.h

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.

Parameters
N/Aendpoint

Endpoint that is being served Ver.: always

Client tick.


Definition at line 169 of file app/framework/plugin/prepayment-client/prepayment-client.h