Price Client#
Callbacks for Price Client Component.
Callbacks#
Price cluster client attribute changed.
Price cluster client default response.
Initialize the price cluster client.
Price cluster client manufacturer-specific attribute changed.
Send the price cluster client message.
Price cluster client pre attribute changed.
Price cluster client tick.
Start price.
Expire price.
Pending CPP event.
Callbacks Documentation#
sl_zigbee_af_price_cluster_client_attribute_changed_cb#
void sl_zigbee_af_price_cluster_client_attribute_changed_cb (uint8_t endpoint, sl_zigbee_af_attribute_id_t attributeId)
Price cluster client attribute 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 |
sl_zigbee_af_price_cluster_client_default_response_cb#
void sl_zigbee_af_price_cluster_client_default_response_cb (uint8_t endpoint, uint8_t commandId, sl_zigbee_af_status_t status)
Price cluster client default response.
| 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_price_cluster_client_init_cb#
void sl_zigbee_af_price_cluster_client_init_cb (uint8_t endpoint)
Initialize the price cluster client.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | Endpoint that is being initialized Ver.: always |
sl_zigbee_af_price_cluster_client_manufacturer_specific_attribute_changed_cb#
void sl_zigbee_af_price_cluster_client_manufacturer_specific_attribute_changed_cb (uint8_t endpoint, sl_zigbee_af_attribute_id_t attributeId, uint16_t manufacturerCode)
Price cluster client manufacturer-specific attribute 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 |
sl_zigbee_af_price_cluster_client_message_sent_cb#
void sl_zigbee_af_price_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)
Send the price cluster client message.
| 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 |
sl_zigbee_af_price_cluster_client_pre_attribute_changed_cb#
sl_zigbee_af_status_t sl_zigbee_af_price_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)
Price cluster client pre attribute 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 |
sl_zigbee_af_price_cluster_client_tick_cb#
void sl_zigbee_af_price_cluster_client_tick_cb (uint8_t endpoint)
Price cluster client tick.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | Endpoint that is being served Ver.: always |
sl_zigbee_af_price_client_price_started_cb#
void sl_zigbee_af_price_client_price_started_cb (sl_zigbee_af_plugin_price_client_price_t * price)
Start price.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_zigbee_af_plugin_price_client_price_t * | N/A | price | The price that has started. Ver.: always |
This function is called by the Price client plugin whenever a price starts.
sl_zigbee_af_price_client_price_expired_cb#
void sl_zigbee_af_price_client_price_expired_cb (sl_zigbee_af_plugin_price_client_price_t * price)
Expire price.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_zigbee_af_plugin_price_client_price_t * | N/A | price | The price that has expired. Ver.: always |
This function is called by the Price client plugin whenever a price expires.
sl_zigbee_af_price_client_pending_cpp_event_cb#
uint8_t sl_zigbee_af_price_client_pending_cpp_event_cb (uint8_t cppAuth)
Pending CPP event.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | cppAuth | The CPP Auth status. Ver.: always |
This function is called by the Price client plugin when a CPP event is received with a pending status.