Price Client#

Callbacks for Price Client Component.

Callbacks#

void
emberAfPriceClusterClientAttributeChangedCallback(uint8_t endpoint, EmberAfAttributeId attributeId)

Price cluster client attribute changed.

void
emberAfPriceClusterClientDefaultResponseCallback(uint8_t endpoint, uint8_t commandId, EmberAfStatus status)

Price cluster client default response.

void

Initialize the price cluster client.

void
emberAfPriceClusterClientManufacturerSpecificAttributeChangedCallback(uint8_t endpoint, EmberAfAttributeId attributeId, uint16_t manufacturerCode)

Price cluster client manufacturer-specific attribute changed.

void
emberAfPriceClusterClientMessageSentCallback(EmberOutgoingMessageType type, uint16_t indexOrDestination, EmberApsFrame *apsFrame, uint16_t msgLen, uint8_t *message, EmberStatus status)

Send the price cluster client message.

emberAfPriceClusterClientPreAttributeChangedCallback(uint8_t endpoint, EmberAfAttributeId attributeId, EmberAfAttributeType attributeType, uint8_t size, uint8_t *value)

Price cluster client pre attribute changed.

void

Price cluster client tick.

void
emberAfPluginPriceClientPriceStartedCallback(EmberAfPluginPriceClientPrice *price)

Start price.

void
emberAfPluginPriceClientPriceExpiredCallback(EmberAfPluginPriceClientPrice *price)

Expire price.

uint8_t

Pending CPP event.

Callbacks Documentation#

emberAfPriceClusterClientAttributeChangedCallback#

void emberAfPriceClusterClientAttributeChangedCallback (uint8_t endpoint, EmberAfAttributeId attributeId)

Price cluster client attribute changed.

Parameters
N/Aendpoint

Endpoint that is being initialized Ver.: always

N/AattributeId

Attribute that changed Ver.: always


Definition at line 472 of file app/framework/plugin/price-client/price-client.h

emberAfPriceClusterClientDefaultResponseCallback#

void emberAfPriceClusterClientDefaultResponseCallback (uint8_t endpoint, uint8_t commandId, EmberAfStatus status)

Price cluster client default response.

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 483 of file app/framework/plugin/price-client/price-client.h

emberAfPriceClusterClientInitCallback#

void emberAfPriceClusterClientInitCallback (uint8_t endpoint)

Initialize the price cluster client.

Parameters
N/Aendpoint

Endpoint that is being initialized Ver.: always


Definition at line 491 of file app/framework/plugin/price-client/price-client.h

emberAfPriceClusterClientManufacturerSpecificAttributeChangedCallback#

void emberAfPriceClusterClientManufacturerSpecificAttributeChangedCallback (uint8_t endpoint, EmberAfAttributeId attributeId, uint16_t manufacturerCode)

Price cluster client manufacturer-specific attribute 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


Definition at line 500 of file app/framework/plugin/price-client/price-client.h

emberAfPriceClusterClientMessageSentCallback#

void emberAfPriceClusterClientMessageSentCallback (EmberOutgoingMessageType type, uint16_t indexOrDestination, EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message, EmberStatus status)

Send the price cluster client message.

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


Definition at line 514 of file app/framework/plugin/price-client/price-client.h

emberAfPriceClusterClientPreAttributeChangedCallback#

EmberAfStatus emberAfPriceClusterClientPreAttributeChangedCallback (uint8_t endpoint, EmberAfAttributeId attributeId, EmberAfAttributeType attributeType, uint8_t size, uint8_t * value)

Price cluster client pre attribute 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


Definition at line 529 of file app/framework/plugin/price-client/price-client.h

emberAfPriceClusterClientTickCallback#

void emberAfPriceClusterClientTickCallback (uint8_t endpoint)

Price cluster client tick.

Parameters
N/Aendpoint

Endpoint that is being served Ver.: always


Definition at line 539 of file app/framework/plugin/price-client/price-client.h

emberAfPluginPriceClientPriceStartedCallback#

void emberAfPluginPriceClientPriceStartedCallback (EmberAfPluginPriceClientPrice * price)

Start price.

Parameters
N/Aprice

The price that has started. Ver.: always

This function is called by the Price client plugin whenever a price starts.


Definition at line 547 of file app/framework/plugin/price-client/price-client.h

emberAfPluginPriceClientPriceExpiredCallback#

void emberAfPluginPriceClientPriceExpiredCallback (EmberAfPluginPriceClientPrice * price)

Expire price.

Parameters
N/Aprice

The price that has expired. Ver.: always

This function is called by the Price client plugin whenever a price expires.


Definition at line 554 of file app/framework/plugin/price-client/price-client.h

emberAfPluginPriceClientPendingCppEventCallback#

uint8_t emberAfPluginPriceClientPendingCppEventCallback (uint8_t cppAuth)

Pending CPP event.

Parameters
N/AcppAuth

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.


Definition at line 562 of file app/framework/plugin/price-client/price-client.h