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#
emberAfPriceClusterClientAttributeChangedCallback#
void emberAfPriceClusterClientAttributeChangedCallback (uint8_t endpoint, EmberAfAttributeId attributeId)
Price cluster client attribute changed.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | Endpoint that is being initialized Ver.: always |
| EmberAfAttributeId | N/A | attributeId | Attribute that changed Ver.: always |
emberAfPriceClusterClientDefaultResponseCallback#
void emberAfPriceClusterClientDefaultResponseCallback (uint8_t endpoint, uint8_t commandId, EmberAfStatus 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 |
| EmberAfStatus | N/A | status | Status in default response Ver.: always |
This function is called when the client receives the default response from the server.
emberAfPriceClusterClientInitCallback#
void emberAfPriceClusterClientInitCallback (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 |
emberAfPriceClusterClientManufacturerSpecificAttributeChangedCallback#
void emberAfPriceClusterClientManufacturerSpecificAttributeChangedCallback (uint8_t endpoint, EmberAfAttributeId 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 |
| EmberAfAttributeId | N/A | attributeId | Attribute that changed Ver.: always |
| uint16_t | N/A | manufacturerCode | Manufacturer Code of the attribute that changed Ver.: always |
emberAfPriceClusterClientMessageSentCallback#
void emberAfPriceClusterClientMessageSentCallback (EmberOutgoingMessageType type, uint16_t indexOrDestination, EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message, EmberStatus status)
Send the price cluster client message.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberOutgoingMessageType | 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 |
| EmberApsFrame * | 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 |
| EmberStatus | N/A | status | The status of the sent message Ver.: always |
emberAfPriceClusterClientPreAttributeChangedCallback#
EmberAfStatus emberAfPriceClusterClientPreAttributeChangedCallback (uint8_t endpoint, EmberAfAttributeId attributeId, EmberAfAttributeType 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 |
| EmberAfAttributeId | N/A | attributeId | Attribute to be changed Ver.: always |
| EmberAfAttributeType | 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 |
emberAfPriceClusterClientTickCallback#
void emberAfPriceClusterClientTickCallback (uint8_t endpoint)
Price cluster client tick.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | Endpoint that is being served Ver.: always |
emberAfPluginPriceClientPriceStartedCallback#
void emberAfPluginPriceClientPriceStartedCallback (EmberAfPluginPriceClientPrice * price)
Start price.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberAfPluginPriceClientPrice * | N/A | price | The price that has started. Ver.: always |
This function is called by the Price client plugin whenever a price starts.
emberAfPluginPriceClientPriceExpiredCallback#
void emberAfPluginPriceClientPriceExpiredCallback (EmberAfPluginPriceClientPrice * price)
Expire price.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberAfPluginPriceClientPrice * | N/A | price | The price that has expired. Ver.: always |
This function is called by the Price client plugin whenever a price expires.
emberAfPluginPriceClientPendingCppEventCallback#
uint8_t emberAfPluginPriceClientPendingCppEventCallback (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.