Macros | |
#define | ZB_ZCL_CLUSTER_ID_PRICE_SERVER_ROLE_GENERATED_CMD_LIST |
#define | ZB_ZCL_CLUSTER_ID_PRICE_CLIENT_ROLE_RECEIVED_CMD_LIST ZB_ZCL_CLUSTER_ID_PRICE_SERVER_ROLE_GENERATED_CMD_LIST |
#define | ZB_ZCL_CLUSTER_ID_PRICE_CLIENT_ROLE_GENERATED_CMD_LIST |
#define | ZB_ZCL_CLUSTER_ID_PRICE_SERVER_ROLE_RECEIVED_CMD_LIST ZB_ZCL_CLUSTER_ID_PRICE_CLIENT_ROLE_GENERATED_CMD_LIST |
#define | ZB_ZCL_PRICE_PUBLISH_PRICE_PAYLOAD_SIZE_IS_VALID(size) |
Returns 'true' if payload is in range [min_payload_size, max_payload_size]. More... | |
#define | ZB_ZCL_PRICE_PUBLISH_PRICE_PAYLOAD_EXPECTED_SIZE(pl) |
Returns actual size of payload. More... | |
#define | ZB_ZCL_PRICE_DEFAULT_PRICE_CONTROL_VALUE 0x01 |
Controls PriceAck policy for outcoming PublishPrice packets. SE devices can enable this field (refer zb_zcl_price_publish_price_payload_t::price_control) if they want to receive PriceAcknowledgement command as response to PublishPrice command, but this behavior is valid only for SE version >= 1.1. SE 1.2 is used, so this field is set to 1 by default. | |
#define | ZB_ZCL_PRICE_PUBLISH_PRICE_PAYLOAD_INIT |
Macro for initializing PublishPrice Command payload. More... | |
#define | ZB_ZCL_PRICE_GET_SCHEDULED_PRICES_PAYLOAD_INIT (zb_zcl_price_get_scheduled_prices_payload_t) {0} |
Macro for initializing GetScheduledPrices Command payload. | |
#define | ZB_ZCL_PRICE_GET_SCHEDULED_PRICES_PAYLOAD_SIZE_IS_VALID(size) ((size) == sizeof(zb_zcl_price_get_scheduled_prices_payload_t)) |
Check if GetScheduledPrices Command payload is valid. | |
#define | ZB_ZCL_PRICE_GET_TIER_LABELS_PAYLOAD_SIZE_IS_VALID(size) ((size) == sizeof(zb_zcl_price_get_tier_labels_payload_t)) |
#define | ZB_ZCL_PRICE_PUBLISH_TIER_LABELS_PAYLOAD_SIZE_IS_VALID(size) ((size >= (sizeof(zb_zcl_price_publish_tier_labels_payload_t)-sizeof(zb_void_t *)) ? ZB_TRUE : ZB_FALSE)) |
#define | ZB_ZCL_PRICE_SEND_CMD_GET_CURRENT_PRICE(_param, _dst_addr, _dst_addr_mode, _dst_ep, _src_ep, _rx_on_when_idle) |
Macro for sending GetCurrentPrice command. More... | |
#define | ZB_ZCL_PRICE_SEND_CMD_GET_SCHEDULED_PRICES(_param, _dst_addr, _dst_addr_mode, _dst_ep, _src_ep, _payload) |
Macro for sending GetScheduledPrices command. More... | |
#define | ZB_ZCL_PRICE_SEND_CMD_PUBLISH_PRICE(_param, _dst_addr, _dst_addr_mode, _dst_ep, _src_ep, _payload) |
Macro for sending PublishPrice command. More... | |
#define | ZB_ZCL_PRICE_SEND_CMD_GET_TIER_LABELS(_param, _dst_addr, _dst_addr_mode, _dst_ep, _src_ep, _payload) |
Macro for sending GetTierLabels command. More... | |
#define | ZB_ZCL_PRICE_SEND_CMD_PUBLISH_TIER_LABELS(_param, _dst_addr, _dst_addr_mode, _dst_ep, _src_ep, _payload) |
Macro for sending PublishTierLabels command. More... | |
#define ZB_ZCL_CLUSTER_ID_PRICE_CLIENT_ROLE_GENERATED_CMD_LIST |
#define ZB_ZCL_CLUSTER_ID_PRICE_SERVER_ROLE_GENERATED_CMD_LIST |
#define ZB_ZCL_PRICE_PUBLISH_PRICE_PAYLOAD_EXPECTED_SIZE | ( | pl | ) |
Returns actual size of payload.
PublishPrice packet payload doesn't have fixed length because of 'rate_label' field. This macro can be used to check payload size of incomming packet.
#define ZB_ZCL_PRICE_PUBLISH_PRICE_PAYLOAD_INIT |
Macro for initializing PublishPrice Command payload.
#define ZB_ZCL_PRICE_PUBLISH_PRICE_PAYLOAD_SIZE_IS_VALID | ( | size | ) |
Returns 'true' if payload is in range [min_payload_size, max_payload_size].
#define ZB_ZCL_PRICE_PUBLISH_TIER_LABELS_PAYLOAD_SIZE_IS_VALID | ( | size | ) | ((size >= (sizeof(zb_zcl_price_publish_tier_labels_payload_t)-sizeof(zb_void_t *)) ? ZB_TRUE : ZB_FALSE)) |
Check if PublishTierLabels command payload size is valid
size | - size of received data payload |
#define ZB_ZCL_PRICE_SEND_CMD_GET_CURRENT_PRICE | ( | _param, | |
_dst_addr, | |||
_dst_addr_mode, | |||
_dst_ep, | |||
_src_ep, | |||
_rx_on_when_idle | |||
) |
Macro for sending GetCurrentPrice command.
_param | - Reference to buffer. |
_dst_addr | - Address of the device to send command to. |
_dst_addr_mode | - Address mode for _dst_addr. |
_dst_ep | - Destination endpoint. |
_src_ep | - Current endpoint. |
_rx_on_when_idle | - Helps to determine publishing policy for the server, (see SE spec, subclause D.4.2.3.2.1.1) |
#define ZB_ZCL_PRICE_SEND_CMD_GET_SCHEDULED_PRICES | ( | _param, | |
_dst_addr, | |||
_dst_addr_mode, | |||
_dst_ep, | |||
_src_ep, | |||
_payload | |||
) |
Macro for sending GetScheduledPrices command.
_param | - Reference to buffer. |
_dst_addr | - Address of the device to send command to. |
_dst_addr_mode | - Address mode for _dst_addr. |
_dst_ep | - Destination endpoint. |
_src_ep | - Current endpoint. |
_payload | - Packet payload (zb_zcl_price_get_scheduled_prices_payload_t). |
#define ZB_ZCL_PRICE_SEND_CMD_GET_TIER_LABELS | ( | _param, | |
_dst_addr, | |||
_dst_addr_mode, | |||
_dst_ep, | |||
_src_ep, | |||
_payload | |||
) |
Macro for sending GetTierLabels command.
_param | - Reference to buffer. |
_dst_addr | - Address of the device to send command to. |
_dst_addr_mode | - Address mode for _dst_addr. |
_dst_ep | - Destination endpoint. |
_src_ep | - Current endpoint. |
_payload | - Packet payload (ref to zb_zcl_price_get_tier_labels_payload_t). |
#define ZB_ZCL_PRICE_SEND_CMD_PUBLISH_PRICE | ( | _param, | |
_dst_addr, | |||
_dst_addr_mode, | |||
_dst_ep, | |||
_src_ep, | |||
_payload | |||
) |
Macro for sending PublishPrice command.
_param | - Reference to buffer. |
_dst_addr | - Address of the device to send command to. |
_dst_addr_mode | - Address mode for _dst_addr. |
_dst_ep | - Destination endpoint. |
_src_ep | - Current endpoint. |
_payload | - Packet payload (zb_zcl_price_publish_price_payload_t). |
#define ZB_ZCL_PRICE_SEND_CMD_PUBLISH_TIER_LABELS | ( | _param, | |
_dst_addr, | |||
_dst_addr_mode, | |||
_dst_ep, | |||
_src_ep, | |||
_payload | |||
) |
Macro for sending PublishTierLabels command.
_param | - Reference to buffer. |
_dst_addr | - Address of the device to send command to. |
_dst_addr_mode | - Address mode for _dst_addr. |
_dst_ep | - Destination endpoint. |
_src_ep | - Current endpoint. |
_payload | - Packet payload (ref to zb_zcl_price_publish_tier_labels_payload_t). |
typedef struct zb_zcl_price_ack_payload_s zb_zcl_price_ack_payload_t |
PriceAcknowledgement Command payload
typedef enum zb_zcl_price_block_period_control_field_bitmap_e zb_zcl_price_block_period_control_field_t |
Block Period Control Field BitMap
typedef enum zb_zcl_price_block_period_duration_control_e zb_zcl_price_block_period_duration_control_t |
Block Period Duration Control Enumeration.
typedef struct zb_zcl_price_block_threshold_sub_payload_s zb_zcl_price_block_threshold_sub_payload_t |
BlockThreshold Sub-Payload Format
CancelTariff command payload
typedef enum zb_zcl_price_client_cmd_e zb_zcl_price_client_cmd_t |
Price cluster client command identifiers.
typedef struct zb_zcl_price_get_block_period_payload_s zb_zcl_price_client_get_block_period_payload_t |
GetBlockPeriod command payload
typedef struct zb_zcl_price_client_get_calorific_value_payload_s zb_zcl_price_client_get_calorific_value_payload_t |
GetCalorificValue command payload
CPPEventResponse command payload
CPP Auth Enumeration
CPP Auth Enumeration
Currency Change Control Enumeration
GetBillingPeriod command payload
typedef struct zb_zcl_price_get_block_thresholds_payload_s zb_zcl_price_get_block_thresholds_payload_t |
GetBlockThresholds command payload
GetCO2Value command payload
typedef struct zb_zcl_price_get_consolidated_bill_payload_s zb_zcl_price_get_consolidated_bill_payload_t |
GetConsolidatedBill command payload
typedef struct zb_zcl_price_get_conversion_factor_payload_s zb_zcl_price_get_conversion_factor_payload_t |
GetConversionFactor command payload.
GetCreditPayment command payload
GetPriceMatrix command payload
typedef struct zb_zcl_price_get_scheduled_prices_payload_s zb_zcl_price_get_scheduled_prices_payload_t |
GetScheduledPrices Command Payload Format
typedef struct zb_zcl_price_get_tariff_information_payload_s zb_zcl_price_get_tariff_information_payload_t |
GetTariffInformation command payload
GetTierLabels command payload
PriceMatrix Sub-Payload
typedef struct zb_zcl_price_publish_billing_period_payload_s zb_zcl_price_publish_billing_period_payload_t |
PublishBillingPeriod command payload
typedef struct zb_zcl_price_publish_block_period_payload_s zb_zcl_price_publish_block_period_payload_t |
PublishBlockPeriod command payload
typedef struct zb_zcl_price_publish_block_thresholds_payload_s zb_zcl_price_publish_block_thresholds_payload_t |
PublishBlockThresholds command payload
typedef enum zb_zcl_price_publish_block_thresholds_type_e zb_zcl_price_publish_block_thresholds_type_t |
PublishBlockThresholds Sub-Payload Control values
typedef struct zb_zcl_price_publish_calorific_value_payload_s zb_zcl_price_publish_calorific_value_payload_t |
PublishCalorificValue command payload
PublishCO2Value command payload
typedef struct zb_zcl_price_publish_consolidated_bill_payload_s zb_zcl_price_publish_consolidated_bill_payload_t |
PublishConsolidatedBill command payload
typedef struct zb_zcl_price_publish_conversion_factor_payload_s zb_zcl_price_publish_conversion_factor_payload_t |
PublishConversionFactor comamdn payload
PublishCPPEvent command payload
typedef struct zb_zcl_price_publish_credit_payment_payload_s zb_zcl_price_publish_credit_payment_payload_t |
PublishCreditPayment command payload.
typedef struct zb_zcl_price_publish_currency_conversion_payload_s zb_zcl_price_publish_currency_conversion_payload_t |
PublishCurrencyConversion command payload.
PublishPriceMatrix Sub-Payload Control values.
typedef struct zb_zcl_price_publish_price_matrix_payload_s zb_zcl_price_publish_price_matrix_payload_t |
PublishPriceMatrix command payload
PublishPrice command payload.
typedef struct zb_zcl_price_publish_tariff_information_payload_s zb_zcl_price_publish_tariff_information_payload_t |
PublishTariffInformation command payload
typedef struct zb_zcl_price_publish_tier_labels_payload_s zb_zcl_price_publish_tier_labels_payload_t |
PublishTierLabels command payload
typedef struct zb_zcl_price_publish_tier_labels_sub_payload_s zb_zcl_price_publish_tier_labels_sub_payload_t |
typedef enum zb_zcl_price_server_cmd_e zb_zcl_price_server_cmd_t |
Price cluster server command identifiers.
Tariff Charging Scheme Enumeration
typedef enum zb_zcl_price_tariff_type_e zb_zcl_price_tariff_type_t |
Tariff Type Enumeration
Block Period Control Field BitMap
Price cluster client command identifiers.
Enumerator | |
---|---|
ZB_ZCL_PRICE_CLI_CMD_GET_CURRENT_PRICE |
GetCurrentPrice command initiates a PublishPrice command for the current time.
|
ZB_ZCL_PRICE_CLI_CMD_GET_SCHEDULED_PRICES |
GetScheduledPrices command initiates a PublishPrice command for available price events.
|
ZB_ZCL_PRICE_CLI_CMD_PRICE_ACK |
PriceAcknowledgement command provides the ability to acknowledge a previously sent PublishPrice command.
|
ZB_ZCL_PRICE_CLI_CMD_GET_BLOCK_PERIOD |
GetBlockPeriod(s) command. This command initiates a PublishBlockPeriod command for the currently scheduled block periods.
|
ZB_ZCL_PRICE_CLI_CMD_GET_CONVERSION_FACTOR |
GetConversionFactor command. This command initiates a PublishConversionFactor command(s) for scheduled conversion factor updates.
|
ZB_ZCL_PRICE_CLI_CMD_GET_CALORIFIC_VALUE |
GetCalorificValue command. This command initiates a PublishCalorificValue command(s) for scheduled calorific value updates.
|
ZB_ZCL_PRICE_CLI_CMD_GET_TARIFF_INFORMATION |
GetTariffInformation command. This command initiates PublishTariffInformation command(s) for scheduled tariff updates.
|
ZB_ZCL_PRICE_CLI_CMD_GET_PRICE_MATRIX |
GetPriceMatrix command. This command initiates a PublishPriceMatrix command for the scheduled Price Matrix updates.
|
ZB_ZCL_PRICE_CLI_CMD_GET_BLOCK_THRESHOLDS |
GetBlockThresholds command. This command initiates a PublishBlockThreshold command for the scheduled Block Threshold updates.
|
ZB_ZCL_PRICE_CLI_CMD_GET_CO2_VALUE |
GetCO2Value command. This command initiates PublishCO2Value command(s) for scheduled CO2 conversion factor updates.
|
ZB_ZCL_PRICE_CLI_CMD_GET_TIER_LABELS |
GetTierLabels command. This command allows a client to retrieve the tier labels associated with a given tariff; this command initiates a PublishTierLabels command from the server.
|
ZB_ZCL_PRICE_CLI_CMD_GET_BILLING_PERIOD |
GetBillingPeriod command. This command initiates one or more PublishBillingPeriod commands for currently scheduled billing periods.
|
ZB_ZCL_PRICE_CLI_CMD_GET_CONSOLIDATED_BILL |
GetConsolidatedBill command. This command initiates one or more PublishConsolidatedBill commands with the requested billing information.
|
ZB_ZCL_PRICE_CLI_CMD_CPP_EVENT_RESPONSE |
CPPEventResponse command. The CPPEventResponse command is sent from a Client (IHD) to the ESI to notify it of a Critical Peak Pricing event authorization.
|
ZB_ZCL_PRICE_CLI_CMD_GET_CREDIT_PAYMENT |
GetCreditPayment command. This command initiates PublishCreditPayment commands for the requested credit payment information.
|
ZB_ZCL_PRICE_CLI_CMD_GET_CURRENCY_CONVERSION |
GetCurrencyConversion command. This command initiates a PublishCurrencyConversion command for the currency conversion factor updates.
|
ZB_ZCL_PRICE_CLI_CMD_GET_TARIFF_CANCELLATION |
GetTariffCancellation command. This command initiates the return of the last CancelTariff command held on the associated server.
|
Currency Change Control Enumeration
PublishBlockThresholds Sub-Payload Control values
PublishPriceMatrix Sub-Payload Control values.
Price cluster server command identifiers.
Enumerator | |
---|---|
ZB_ZCL_PRICE_SRV_CMD_PUBLISH_PRICE |
PublishPrice command. The Publish Price command is generated in response to receiving a GetCurrentPrice command, in response to a GetScheduledPrices command, and when an update to the pricing information is available from the commodity provider.
|
ZB_ZCL_PRICE_SRV_CMD_PUBLISH_BLOCK_PERIOD |
PublishBlockPeriod command. The Publish Block Period command is generated in response to receiving a GetBlockPeriod(s) command (see sub-clause D.4.2.3.5) or when an update to the block tariff schedule is available from the commodity provider.
|
ZB_ZCL_PRICE_SRV_CMD_PUBLISH_CONVERSION_FACTOR |
PublishConversionFactor command. The PublishConversionFactor command is sent in response to a GetConversionFactor command or if a new conversion factor is available.
|
ZB_ZCL_PRICE_SRV_CMD_PUBLISH_CALORIFIC_VALUE |
PublishCalorificValue command. The PublishCalorificValue command is sent in response to a GetCalorificValue command or if a new calorific value is available.
|
ZB_ZCL_PRICE_SRV_CMD_PUBLISH_TARIFF_INFORMATION |
PublishTariffInformation command. The PublishTariffInformation command is sent in response to a GetTariffInformation command or if new tariff information is available (including Price Matrix and Block Thresholds).
|
ZB_ZCL_PRICE_SRV_CMD_PUBLISH_PRICE_MATRIX |
PublishPriceMatrix command. The PublishPriceMatrix command is used to publish the Block Price Information Set (up to 15 tiers x 15 blocks) and the Extended Price Information Set (up to 48 tiers). The PublishPriceMatrix command is sent in response to a GetPriceMatrix command.
|
ZB_ZCL_PRICE_SRV_CMD_PUBLISH_BLOCK_THRESHOLDS |
PublishBlockThresholds command. The PublishBlockThresholds command is sent in response to a GetBlockThresholds command.
|
ZB_ZCL_PRICE_SRV_CMD_PUBLISH_CO2_VALUE |
PublishCO2Value command. The PublishCO2Value command is sent in response to a GetCO2Value command or if a new CO2 conversion factor is available.
|
ZB_ZCL_PRICE_SRV_CMD_PUBLISH_TIER_LABELS |
PublishTierLabels command. The PublishTierLabels command is generated in response to receiving a GetTierLabels command or when there is a tier label change.
|
ZB_ZCL_PRICE_SRV_CMD_PUBLISH_BILLING_PERIOD |
PublishBillingPeriod command. The PublishBillingPeriod command is generated in response to receiving a GetBillingPeriod(s) command or when an update to the Billing schedule is available from the commodity supplier.
|
ZB_ZCL_PRICE_SRV_CMD_PUBLISH_CONSOLIDATED_BILL |
PublishConsolidatedBill command. The PublishConsolidatedBill command is used to make consolidated billing information from previous billing periods available to other end devices. This command is issued in response to a GetConsolidatedBill command or if new billing information is available.
|
ZB_ZCL_PRICE_SRV_CMD_PUBLISH_CPP_EVENT |
PublishCPPEvent command. The PublishCPPEvent command is sent from an ESI to its Price clients to notify them of a Critical Peak Pricing (CPP) event.
|
ZB_ZCL_PRICE_SRV_CMD_PUBLISH_CREDIT_PAYMENT |
PublishCreditPayment command. The PublishCreditPayment command is used to update the credit payment information when available.
|
ZB_ZCL_PRICE_SRV_CMD_PUBLISH_CURRENCY_CONVERSION |
PublishCurrencyConversion command. The PublishCurrencyConversion command is sent in response to a GetCurrencyConversion command or when a new currency becomes available.
|
ZB_ZCL_PRICE_SRV_CMD_CANCEL_TARIFF |
CancelTariff command. The CancelTariff command indicates that all data associated with a particular tariff instance should be discarded.
|
PublishPriceMatrix and PublishBlockThresholds Sub-Payload Control Bitmap
Enumerator | |
---|---|
ZB_ZCL_PRICE_SUB_PAYLOAD_TYPE |
0-bit of bitfield |
Tariff Charging Scheme Enumeration