PublishPrice command payload. More...

#include <zb_zcl_price.h>

Data Fields
zb_uint32_t	provider_id

zb_uint8_t	rate_label [13]

zb_uint32_t	issuer_event_id

zb_uint32_t	current_time

zb_uint8_t	unit_of_measure

zb_uint16_t	currency

zb_bitfield_t	price_trailing_digit:4

zb_bitfield_t	price_tier:4

zb_bitfield_t	number_of_price_tiers:4

zb_bitfield_t	register_tier:4

zb_uint32_t	start_time

zb_uint16_t	duration_in_minutes

zb_uint32_t	price

zb_uint8_t	price_ratio

zb_uint32_t	generation_price

zb_uint8_t	generation_price_ratio

zb_uint32_t	alternate_cost_delivered

zb_uint8_t	alternate_cost_unit

zb_uint8_t	alternate_cost_trailing_digit

zb_uint8_t	number_of_block_thresholds

zb_uint8_t	price_control

zb_uint8_t	number_of_generation_tiers

zb_uint8_t	generation_tier

zb_uint8_t	extended_number_of_price_tiers

zb_uint8_t	extended_price_tier

zb_uint8_t	extended_register_tier

Detailed Description

PublishPrice command payload.

See also: SE spec, subclause D.4.2.3.1.1.

Field Documentation

◆ alternate_cost_delivered

zb_uint32_t zb_zcl_price_publish_price_payload_s::alternate_cost_delivered

Provides mechanism to describe an alternative measure of the cost of the energy consumed.

◆ alternate_cost_trailing_digit

zb_uint8_t zb_zcl_price_publish_price_payload_s::alternate_cost_trailing_digit

Determines where the decimal point is located in the alternate cost field.

◆ alternate_cost_unit

zb_uint8_t zb_zcl_price_publish_price_payload_s::alternate_cost_unit

Identifies the unit for Alternate Cost Delivered field (alternate_cost_delivered)

◆ currency

zb_uint16_t zb_zcl_price_publish_price_payload_s::currency

Field identifying information concerning the local unit of currency used in the price field.

See also: ISO-4217

◆ current_time

zb_uint32_t zb_zcl_price_publish_price_payload_s::current_time

UTC Time field containing the current time as determined by the device.

◆ duration_in_minutes

zb_uint16_t zb_zcl_price_publish_price_payload_s::duration_in_minutes

Denotes amount of time in minutes after Start Time (start_time) during which the price signal is valid.

◆ extended_number_of_price_tiers

zb_uint8_t zb_zcl_price_publish_price_payload_s::extended_number_of_price_tiers

Indicates a maximum number of tier available.

See also: number_of_generation_tiers

◆ extended_price_tier

zb_uint8_t zb_zcl_price_publish_price_payload_s::extended_price_tier

Indicates the current price tier.

See also: price_tier

◆ extended_register_tier

zb_uint8_t zb_zcl_price_publish_price_payload_s::extended_register_tier

Indicates the register tier used with the current Price Tier (register_tier).

◆ generation_price

zb_uint32_t zb_zcl_price_publish_price_payload_s::generation_price

Contains the price of the commodity measured in base unit of Currency per Unit of Measure (currency per unit_of_measure) with the decimal point located as indicated by the Price Trailing Digit field (price_trailing_digit) when the commodity is received from premises.

◆ generation_price_ratio

zb_uint8_t zb_zcl_price_publish_price_payload_s::generation_price_ratio

Gives the ratio of the price denoted in the Generation Price field (price) to the "normal" price, chosen by the commodity provider.

◆ generation_tier

zb_uint8_t zb_zcl_price_publish_price_payload_s::generation_tier

Specifies the current generation tier.

◆ issuer_event_id

zb_uint32_t zb_zcl_price_publish_price_payload_s::issuer_event_id

Unique identifier generated by the commodity provider allows devices to determine which pricing information is newer.

◆ number_of_block_thresholds

zb_uint8_t zb_zcl_price_publish_price_payload_s::number_of_block_thresholds

Indicates the number of block thresholds available.

◆ number_of_generation_tiers

zb_uint8_t zb_zcl_price_publish_price_payload_s::number_of_generation_tiers

Specifies the total number of generation tiers applicable in the current tariff.

◆ number_of_price_tiers

zb_bitfield_t zb_zcl_price_publish_price_payload_s::number_of_price_tiers

Represents the maximum number of price tiers available.

◆ price

zb_uint32_t zb_zcl_price_publish_price_payload_s::price

Contains the price of the commodity measured in base unit of Currency per Unit of Measure (currency per unit_of_measure) with the decimal point located as indicated by the Price Trailing Digit field (price_trailing_digit) when the commodity is delivered to premises.

◆ price_control

zb_uint8_t zb_zcl_price_publish_price_payload_s::price_control

Identifies additional control options (PriceAcknowledgement policy and total number of tier flag).

◆ price_ratio

zb_uint8_t zb_zcl_price_publish_price_payload_s::price_ratio

Gives the ratio of the price denoted in the Price field (price) to the "normal" price, chosen by the commodity provider.

◆ price_tier

zb_bitfield_t zb_zcl_price_publish_price_payload_s::price_tier

Indicates the current price tier as chosen by the commodity provider

◆ price_trailing_digit

zb_bitfield_t zb_zcl_price_publish_price_payload_s::price_trailing_digit

Determines where the decimal point is located in the price field

◆ provider_id

zb_uint32_t zb_zcl_price_publish_price_payload_s::provider_id

Unique identifier for the commodity provider.

◆ rate_label

zb_uint8_t zb_zcl_price_publish_price_payload_s::rate_label[13]

Commodity provider-specific information regarding the current billing rate.

◆ register_tier

zb_bitfield_t zb_zcl_price_publish_price_payload_s::register_tier

Indicates the register tier used with the current Price Tier (price_tier).

◆ start_time

zb_uint32_t zb_zcl_price_publish_price_payload_s::start_time

Denotes the time at which the signal becomes valid. Value 0x00000000 is a special time denoting "now".

◆ unit_of_measure

zb_uint8_t zb_zcl_price_publish_price_payload_s::unit_of_measure

Field identifying the commodity as well as this base units of measure.

See also: enum zb_zcl_metering_unit_of_measure_e

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

/jenkins_workspace/workspace/_Zigbee_build-zboss-docs_release/modules/lib/zboss/include/zcl/zb_zcl_price.h

Data Fields