Price Common#
API and Callbacks for the Price Common Component.
This component provides common utility functions used by both the Price Server and Price Client components.
Modules#
API#
Return the best matching or other index to use for inserting new data.
Sort price-related data structures.
Update durations to avoid overlapping the next event.
Determine the time until the next index becomes active.
Find valid entries in the EmberAfPriceCommonInfo structure array.
Return the index of the active entry in the EmberAfPriceCommonInfo array.
Return the index to the most recent entry that will become active in the future.
Macros#
API Documentation#
emberAfPluginPriceCommonGetCommonMatchingOrUnusedIndex#
uint8_t emberAfPluginPriceCommonGetCommonMatchingOrUnusedIndex (EmberAfPriceCommonInfo * commonInfos, uint8_t numberOfEntries, uint32_t newIssuerEventId, uint32_t newStartTime, bool expireTimedOut)
Return the best matching or other index to use for inserting new data.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberAfPriceCommonInfo * | N/A | commonInfos | An array of EmberAfPriceCommonInfo structures whose data is used to find the best available index. |
| uint8_t | N/A | numberOfEntries | The number of entries in the EmberAfPriceCommonInfo array. |
| uint32_t | N/A | newIssuerEventId | The issuerEventId of the new data. This is used to see if a match is present. |
| uint32_t | N/A | newStartTime | The startTime of the new data. |
| bool | N/A | expireTimedOut | Treats any timed-out entries as invalid if set to true. |
Returns
The best index - either a matching index, if found, or an invalid or timed out index.
emberAfPluginPriceCommonSort#
void emberAfPluginPriceCommonSort (EmberAfPriceCommonInfo * commonInfos, uint8_t * dataArray, uint16_t dataArrayBlockSizeInByte, uint16_t dataArraySize)
Sort price-related data structures.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberAfPriceCommonInfo * | N/A | commonInfos | The destination address to which the command should be sent. |
| uint8_t * | N/A | dataArray | The source endpoint used in the transmission. |
| uint16_t | N/A | dataArrayBlockSizeInByte | The source endpoint used in the transmission. |
| uint16_t | N/A | dataArraySize | The source endpoint used in the transmission. |
This semi-generic sorting function can be used to sort all structures that utilizes the EmberAfPriceCommonInfo data type.
emberAfPluginPriceCommonUpdateDurationForOverlappingEvents#
void emberAfPluginPriceCommonUpdateDurationForOverlappingEvents (EmberAfPriceCommonInfo * commonInfos, uint8_t numberOfEntries)
Update durations to avoid overlapping the next event.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberAfPriceCommonInfo * | N/A | commonInfos | An array of EmberAfPriceCommonInfo structures that will be evaluated. |
| uint8_t | N/A | numberOfEntries | The number of entries in the EmberAfPriceCommonInfo array. |
emberAfPluginPriceCommonSecondsUntilSecondIndexActive#
uint32_t emberAfPluginPriceCommonSecondsUntilSecondIndexActive (EmberAfPriceCommonInfo * commonInfos, uint8_t numberOfEntries)
Determine the time until the next index becomes active.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberAfPriceCommonInfo * | N/A | commonInfos | An array of EmberAfPriceCommonInfo structures that will be evaluated. |
| uint8_t | N/A | numberOfEntries | The number of entries in the EmberAfPriceCommonInfo array. |
This function assumes the commonInfos[] array is already sorted by startTime from earliest to latest.
emberAfPluginPriceCommonFindValidEntries#
uint8_t emberAfPluginPriceCommonFindValidEntries (uint8_t * validEntries, uint8_t numberOfEntries, EmberAfPriceCommonInfo * commonInfos, uint32_t earliestStartTime, uint32_t minIssuerEventId, uint8_t numberOfCommands)
Find valid entries in the EmberAfPriceCommonInfo structure array.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t * | N/A | validEntries | An array of the same size as the EmberAfPriceCommonInfo array that will store the valid flag for each entry (true or false). |
| uint8_t | N/A | numberOfEntries | The number of entries in the validEntries array and the commonInfos array. |
| EmberAfPriceCommonInfo * | N/A | commonInfos | The EmberAfPriceCommonInfo array that will be searched for valid entries. |
| uint32_t | N/A | earliestStartTime | A minimum start time such that all valid entries have a start time greater than or equal to this value. @minIssuerEventId A minimum event ID such that all valid entries have an issuerEventId greater than or equal to this. @numberOfRequestedCommands The maximum number of valid entries to be returned. |
| uint32_t | N/A | minIssuerEventId | |
| uint8_t | N/A | numberOfCommands |
Returns
The number of valid commands found in the commonInfos array.
emberAfPluginPriceCommonServerGetActiveIndex#
uint8_t emberAfPluginPriceCommonServerGetActiveIndex (EmberAfPriceCommonInfo * commonInfos, uint8_t numberOfEntries)
Return the index of the active entry in the EmberAfPriceCommonInfo array.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberAfPriceCommonInfo * | N/A | commonInfos | The EmberAfPriceCommonInfo array that will be searched for an active entry. |
| uint8_t | N/A | numberOfEntries | The number of entries in the commonInfo array. |
Search through array for the most recent active entry. "Issuer Event Id" has higher priority than "start time".
Returns
The index of the active entry, or 0xFF if an active entry is not found.
emberAfPluginPriceCommonServerGetFutureIndex#
uint8_t emberAfPluginPriceCommonServerGetFutureIndex (EmberAfPriceCommonInfo * commonInfos, uint8_t numberOfEntries, uint32_t * secUntilFutureEvent)
Return the index to the most recent entry that will become active in the future.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberAfPriceCommonInfo * | N/A | commonInfos | The EmberAfPriceCommonInfo array that will be searched for the entry. @numberOfEntries The number of entries in the commonInfo array. @secUntilFutureEvent The output pointer to the number of seconds until the next active entry. |
| uint8_t | N/A | numberOfEntries | |
| uint32_t * | N/A | secUntilFutureEvent |
Returns
The index of the next-active entry, or 0xFF if an active entry is not found.