Developing with ZBOSS for Zigbee
zb_zcl_price_publish_tariff_information_payload_s Struct Reference

#include <zb_zcl_price.h>

Data Fields

zb_uint32_t provider_id
 
zb_uint32_t issuer_event_id
 
zb_uint32_t issuer_tariff_id
 
zb_uint32_t start_time
 
zb_uint8_t tariff_type_charging_scheme
 
zb_uint8_t tariff_label [25]
 
zb_uint8_t number_of_price_tiers_in_use
 
zb_uint8_t number_of_block_thresholds_in_use
 
zb_uint8_t unit_of_measure
 
zb_uint16_t currency
 
zb_uint8_t price_trailing_digit
 
zb_uint32_t standing_charge
 
zb_uint8_t tier_block_mode
 
zb_uint24_t block_threshold_multiplier
 
zb_uint24_t block_threshold_devisor
 

Detailed Description

PublishTariffInformation command payload

See also
SE spec, subclause D.4.2.4.5.2

Field Documentation

◆ block_threshold_devisor

zb_uint24_t zb_zcl_price_publish_tariff_information_payload_s::block_threshold_devisor

BlockThresholdDivisor provides a value to divide the result of applying the ThresholdMultiplier attribute to BlockThreshold values to derive values that can be compared against the CurrentBlockPeriodConsumptionDelivered attribute within the Metering cluster. This attribute must be used in conjunction with the BlockThresholdMultiplier parameter(s). In case no divisor is defined, this field shall be set to 1.

◆ block_threshold_multiplier

zb_uint24_t zb_zcl_price_publish_tariff_information_payload_s::block_threshold_multiplier

BlockThresholdMultiplier provides a value to be multiplied against Threshold parameter(s). If present, this attribute must be applied to all BlockThreshold values to derive values that can be compared against the CurrentBlockPeriodConsumptionDelivered attribute within the Metering cluster. This parameter must be used in conjunction with the BlockThresholdDivisor parameter(s).

◆ currency

zb_uint16_t zb_zcl_price_publish_tariff_information_payload_s::currency

The format and use of this field is the same as for the Currencyattribute

◆ issuer_event_id

zb_uint32_t zb_zcl_price_publish_tariff_information_payload_s::issuer_event_id

Unique identifier generated by the commodity provider. When new information is provided that replaces older information for the same time period, this field allows devices to determine which information is newer.

◆ issuer_tariff_id

zb_uint32_t zb_zcl_price_publish_tariff_information_payload_s::issuer_tariff_id

Unique identifier generated by the commodity supplier.

◆ number_of_block_thresholds_in_use

zb_uint8_t zb_zcl_price_publish_tariff_information_payload_s::number_of_block_thresholds_in_use

The format and use of this field is the same as for the NumberOfBlockThresholdsInUse attribute or ReceivedNumberOfBlockThresholdsInUse attribute

◆ number_of_price_tiers_in_use

zb_uint8_t zb_zcl_price_publish_tariff_information_payload_s::number_of_price_tiers_in_use

The format and use of this field is the same as for the NumberOfPriceTiersInUse attribute or ReceivedNumberOfPriceTiersInUse attribute

◆ price_trailing_digit

zb_uint8_t zb_zcl_price_publish_tariff_information_payload_s::price_trailing_digit

The format and use of this field is the same as for the PriceTrailingDigit attribute

◆ provider_id

zb_uint32_t zb_zcl_price_publish_tariff_information_payload_s::provider_id

A unique identifier for the commodity supplier.

◆ standing_charge

zb_uint32_t zb_zcl_price_publish_tariff_information_payload_s::standing_charge

The format and use of this field is the same as for the StandingCharge attribute. A value of 0xFFFFFFFF indicates the field is not used

◆ start_time

zb_uint32_t zb_zcl_price_publish_tariff_information_payload_s::start_time

A UTC Time field to denote the time at which the price signal becomes valid.

◆ tariff_label

zb_uint8_t zb_zcl_price_publish_tariff_information_payload_s::tariff_label[25]

The format and use of this field is the same as for the TariffLabel attribute or ReceivedTariffLabel attribute

◆ tariff_type_charging_scheme

zb_uint8_t zb_zcl_price_publish_tariff_information_payload_s::tariff_type_charging_scheme

An 8-bit bitmap identifying the type of tariff published in this command. The least significant nibble represents an enumeration of the tariff type, the most significant nibble represents an enumeration specifying the charging scheme.

See also
SE spec, Table D-108 and Table D-109
zb_zcl_price_tariff_type_t
zb_zcl_price_tariff_charging_scheme_e

◆ tier_block_mode

zb_uint8_t zb_zcl_price_publish_tariff_information_payload_s::tier_block_mode

The format and use of this field is the same as for the TierBlockMode attribute or ReceivedTierBlockMode attribute

◆ unit_of_measure

zb_uint8_t zb_zcl_price_publish_tariff_information_payload_s::unit_of_measure

The format and use of this field is the same as for the UnitOfMeasure attribute


The documentation for this struct was generated from the following file: