Price Client#
API and Callbacks for the Price Cluster Client Component.
This component provides an implementation of a Price client. It simply stores the prices received over-the-air. This component requires extending to act on the price changes.
Modules#
sl_zigbee_af_price_client_common_info_t
sl_zigbee_af_price_client_billing_period_t
sl_zigbee_af_price_client_block_period_t
sl_zigbee_af_price_client_block_threshold_t
sl_zigbee_af_price_client_calorific_value_t
sl_zigbee_af_price_client_co2_value_t
sl_zigbee_af_price_client_conversion_factor_t
sl_zigbee_af_price_client_cpp_event_t
sl_zigbee_af_price_client_credit_payment_t
sl_zigbee_af_price_client_currency_conversion_t
sl_zigbee_af_price_client_tier_labels_t
sl_zigbee_af_price_client_billing_period_table_t
sl_zigbee_af_price_client_block_period_table_t
sl_zigbee_af_price_client_block_threshold_table_t
sl_zigbee_af_price_client_calorific_value_table_t
sl_zigbee_af_price_client_co2_value_table_t
sl_zigbee_af_price_client_conversion_factor_table_t
sl_zigbee_af_price_client_cpp_event_table_t
sl_zigbee_af_price_client_credit_payment_table_t
sl_zigbee_af_price_client_currency_conversion_table_t
sl_zigbee_af_price_client_tier_labels_table_t
sl_zigbee_af_price_client_info_t
API#
Initialize the consolidated bills table.
Return the index of the currently active CO2 entry, or 0xFF if no active entry can be found.
Print information about the CPP event.
Return the currency conversion table index with a matching eventId.
Return the index of the currently active currency conversion entry, or 0xFF if no active entry can be found.
Functions#
Return the block period table index with a matching eventId.
Print the information at the specified index of the block period table.
Return the conversion factor table index with a matching eventId.
Print the information at the specified index of the conversion factor table.
Return the calorific value table index with a matching eventId.
Print the information at the specified index of the calorific value table.
Return the index of the currently active tier label table entry, or 0xFF if no active entry can be found.
Print the information at the specified index of the tier label table.
Print the information at the specified index of the CO2 value table.
Return the consolidated bill table index with a matching eventId.
Return the index of the active consolidated bill table.
Print the information at the specified index of the consolidated bill table.
Return the credit payment table index with a matching eventId.
Print the credit payment table entry data of the index with a valid matching eventId.
Print the information at the specified index of the credit payment table.
Print the information at the specified index of the currency conversion table.
Return the index of the currently active billing period entry, or 0xFF if no active entry can be found.
Print the information at the specified index of the billing period table.
Macros#
API Documentation#
sl_zigbee_af_price_init_consolidated_bills_table#
void sl_zigbee_af_price_init_consolidated_bills_table (uint8_t endpoint)
Initialize the consolidated bills table.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
sl_zigbee_af_price_cluster_get_active_co2_value_index#
uint8_t sl_zigbee_af_price_cluster_get_active_co2_value_index (uint8_t endpoint)
Return the index of the currently active CO2 entry, or 0xFF if no active entry can be found.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
Returns
The index of the active CO2 entry.
sl_zigbee_af_price_print_cpp_event#
void sl_zigbee_af_price_print_cpp_event (uint8_t endpoint)
Print information about the CPP event.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | THe relevant endpoint. |
sl_zigbee_af_price_cluster_currency_conversion_table_get_index_by_event_id#
uint8_t sl_zigbee_af_price_cluster_currency_conversion_table_get_index_by_event_id (uint8_t endpoint, uint32_t issuerEventId)
Return the currency conversion table index with a matching eventId.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
| uint32_t | N/A | issuerEventId | The eventId that should be searched for in the currency conversion table. |
Returns
The index with a valid matching event ID.
sl_zigbee_af_price_cluster_get_active_currency_index#
uint8_t sl_zigbee_af_price_cluster_get_active_currency_index (uint8_t endpoint)
Return the index of the currently active currency conversion entry, or 0xFF if no active entry can be found.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
Returns
The index of the active currency conversion entry.
Function Documentation#
sli_zigbee_af_price_client_print_info#
void sli_zigbee_af_price_client_print_info (uint8_t endpoint)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint |
sli_zigbee_af_price_client_print_by_event_id#
void sli_zigbee_af_price_client_print_by_event_id (uint8_t endpoint, uint32_t issuerEventId)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | |
| uint32_t | N/A | issuerEventId |
sli_zigbee_af_price_clear_price_table#
void sli_zigbee_af_price_clear_price_table (uint8_t endpoint)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint |
sli_zigbee_af_price_get_block_period_table_index_by_event_id#
uint8_t sli_zigbee_af_price_get_block_period_table_index_by_event_id (uint8_t endpoint, uint32_t issuerEventId)
Return the block period table index with a matching eventId.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
| uint32_t | N/A | issuerEventId | The eventId that should be searched for in the block period table. |
Returns
The index with a valid matching event ID.
sli_zigbee_af_price_print_block_period_table_index#
void sli_zigbee_af_price_print_block_period_table_index (uint8_t endpoint, uint8_t index)
Print the information at the specified index of the block period table.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
| uint8_t | N/A | index | The index whose data should be printed. |
sli_zigbee_af_price_get_conversion_factor_index_by_event_id#
uint8_t sli_zigbee_af_price_get_conversion_factor_index_by_event_id (uint8_t endpoint, uint32_t issuerEventId)
Return the conversion factor table index with a matching eventId.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
| uint32_t | N/A | issuerEventId | The eventId that should be searched for in the conversion factor table. |
Returns
The index with a valid matching event ID.
sli_zigbee_af_price_print_conversion_factor_entry_index#
void sli_zigbee_af_price_print_conversion_factor_entry_index (uint8_t endpoint, uint8_t index)
Print the information at the specified index of the conversion factor table.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
| uint8_t | N/A | index | The index whose data should be printed. |
sli_zigbee_af_price_get_calorific_value_index_by_event_id#
uint8_t sli_zigbee_af_price_get_calorific_value_index_by_event_id (uint8_t endpoint, uint32_t issuerEventId)
Return the calorific value table index with a matching eventId.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
| uint32_t | N/A | issuerEventId | The eventId that should be searched for in the calorific value table. |
Returns
The index with a valid matching event ID.
sli_zigbee_af_price_print_calorific_value_entry_index#
void sli_zigbee_af_price_print_calorific_value_entry_index (uint8_t endpoint, uint8_t index)
Print the information at the specified index of the calorific value table.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
| uint8_t | N/A | index | The index whose data should be printed. |
sli_zigbee_af_price_get_active_tier_label_table_index_by_tariff_id#
uint8_t sli_zigbee_af_price_get_active_tier_label_table_index_by_tariff_id (uint8_t endpoint, uint32_t tariffId)
Return the index of the currently active tier label table entry, or 0xFF if no active entry can be found.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
| uint32_t | N/A | tariffId |
Returns
The index of the active tier label table entry.
sli_zigbee_af_price_print_tier_label_table_entry_index#
void sli_zigbee_af_price_print_tier_label_table_entry_index (uint8_t endpoint, uint8_t index)
Print the information at the specified index of the tier label table.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
| uint8_t | N/A | index | The index whose data should be printed. |
sli_zigbee_af_price_print_co2_value_table_print_index#
void sli_zigbee_af_price_print_co2_value_table_print_index (uint8_t endpoint, uint8_t index)
Print the information at the specified index of the CO2 value table.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
| uint8_t | N/A | index | The index whose data should be printed. |
sli_zigbee_af_price_consolidated_bill_table_get_index_with_event_id#
uint8_t sli_zigbee_af_price_consolidated_bill_table_get_index_with_event_id (uint8_t endpoint, uint32_t issuerEventId)
Return the consolidated bill table index with a matching eventId.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
| uint32_t | N/A | issuerEventId | The eventId that should be searched for in the consolidated bill table. |
Returns
The index with a valid matching event ID.
sli_zigbee_af_price_consolidated_bill_table_get_current_index#
uint8_t sli_zigbee_af_price_consolidated_bill_table_get_current_index (uint8_t endpoint)
Return the index of the active consolidated bill table.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
Returns
The index of the consolidated bills table with a valid matching event ID, or 0xFF if no valid match is found.
sli_zigbee_af_price_print_consolidated_bill_table_index#
void sli_zigbee_af_price_print_consolidated_bill_table_index (uint8_t endpoint, uint8_t index)
Print the information at the specified index of the consolidated bill table.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
| uint8_t | N/A | index | The index whose data should be printed. |
sli_zigbee_af_price_credit_payment_table_get_index_with_event_id#
uint8_t sli_zigbee_af_price_credit_payment_table_get_index_with_event_id (uint8_t endpoint, uint32_t issuerEventId)
Return the credit payment table index with a matching eventId.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The eventId that should be searched for in the credit payment table. |
| uint32_t | N/A | issuerEventId |
Returns
The index with a valid matching event ID.
sli_zigbee_af_price_print_credit_payment_table_event_id#
void sli_zigbee_af_price_print_credit_payment_table_event_id (uint32_t issuerEventId, issuerEventId)
Print the credit payment table entry data of the index with a valid matching eventId.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint32_t | N/A | issuerEventId | The relevant endpoint. |
| N/A | issuerEventId | The eventId that should be found in the credit payment table. |
sli_zigbee_af_price_print_credit_payment_table_index#
void sli_zigbee_af_price_print_credit_payment_table_index (uint8_t endpoint, uint8_t index)
Print the information at the specified index of the credit payment table.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
| uint8_t | N/A | index | The index whose data should be printed. |
sli_zigbee_af_price_print_currency_conversion_table_index#
void sli_zigbee_af_price_print_currency_conversion_table_index (uint8_t endpoint, uint8_t index)
Print the information at the specified index of the currency conversion table.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
| uint8_t | N/A | index | The index whose data should be printed. |
sli_zigbee_af_price_get_active_billing_period_index#
uint8_t sli_zigbee_af_price_get_active_billing_period_index (uint8_t endpoint)
Return the index of the currently active billing period entry, or 0xFF if no active entry can be found.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
Returns
The index of the active billing period entry.
sli_zigbee_af_price_print_billing_period_table_entry_index#
void sli_zigbee_af_price_print_billing_period_table_entry_index (uint8_t endpoint, uint8_t index)
Print the information at the specified index of the billing period table.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
| uint8_t | N/A | index | The index whose data should be printed. |