Price cluster server attributes

nRF5 SDK for Thread and Zigbee v4.2.0
Modules | Macros | Enumerations

Modules

 Tier Label
 
 Block Threshold
 
 Block Period
 
 Commodity
 
 Block Price Information
 
 Extended Price Information
 
 Tariff Information
 
 Billing Information
 
 Credit Payment
 
 Tier Label
 
 Received Block Threshold
 
 Received Block Period
 
 Received Block Price Information
 
 Received Extended Price Information
 
 Received Tariff Information
 
 Received Billing Information
 

Macros

#define ZB_ZCL_DECLARE_PRICE_SRV_ATTRIB_LIST(attr_list, commodity_type)
 Declare server-side Price cluster attributes. More...
 

Enumerations

enum  zb_zcl_price_srv_attr_set_e {
  ZB_ZCL_PRICE_SET_TIER_LABEL = 0x00, ZB_ZCL_PRICE_SET_BLOCK_THRESHOLD = 0x01, ZB_ZCL_PRICE_SET_BLOCK_PERIOD = 0x02, ZB_ZCL_PRICE_SET_COMMODITY = 0x03,
  ZB_ZCL_PRICE_SET_BLOCK_PRICE_INFORMATION = 0x04, ZB_ZCL_PRICE_SET_EXTENDED_PRICE_INFORMATION = 0x05, ZB_ZCL_PRICE_SET_TARIFF_INFORMATION = 0x06, ZB_ZCL_PRICE_SET_BILLING_INFORMATION = 0x07,
  ZB_ZCL_PRICE_SET_CREDIT_PAYMENT = 0x08, ZB_ZCL_PRICE_SET_RECEIVED_TIER_LABEL = 0x80, ZB_ZCL_PRICE_SET_RECEIVED_BLOCK_THRESHOLD = 0x81, ZB_ZCL_PRICE_SET_RECEIVED_BLOCK_PERIOD = 0x82,
  ZB_ZCL_PRICE_SET_RECEIVED_BLOCK_PRICE_INFORMATION = 0x84, ZB_ZCL_PRICE_SET_RECEIVED_EXTENDED_PRICE_INFORMATION = 0x85, ZB_ZCL_PRICE_SET_RECEIVED_TARIFF_INFORMATION = 0x86, ZB_ZCL_PRICE_SET_RECEIVED_BILLING_INFORMATION = 0x87
}
 Price Cluster General server attributes. More...
 

Detailed Description

For convenience, the attributes defined in this cluster are arranged into sets of related attributes; each set can contain up to 256 attributes. Attribute identifiers are encoded such that the most significant Octet specifies the attribute set and the least significant Octet specifies the attribute within the set.

Macro Definition Documentation

◆ ZB_ZCL_DECLARE_PRICE_SRV_ATTRIB_LIST

#define ZB_ZCL_DECLARE_PRICE_SRV_ATTRIB_LIST (   attr_list,
  commodity_type 
)
Value:
ZB_ZCL_START_DECLARE_ATTRIB_LIST_CLUSTER_REVISION(attr_list, ZB_ZCL_PRICE)    \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_PRICE_SRV_COMMODITY_TYPE, (commodity_type))  \
  ZB_ZCL_FINISH_DECLARE_ATTRIB_LIST
ZB_ZCL_ATTR_PRICE_SRV_COMMODITY_TYPE
Definition: zb_zcl_price.h:662

Declare server-side Price cluster attributes.

Parameters
attr_list- Attribute list name.
commodity_type- pointer to variable to store CommodityType attribute value.

Enumeration Type Documentation

◆ zb_zcl_price_srv_attr_set_e

enum zb_zcl_price_srv_attr_set_e

Price Cluster General server attributes.

See also
SE spec, Table D-73
Enumerator
ZB_ZCL_PRICE_SET_TIER_LABEL 

Provides a method for utilities to assign a label to the Price Tier.

ZB_ZCL_PRICE_SET_BLOCK_THRESHOLD 

Provides remote access to the Price server Block Thresholds.

ZB_ZCL_PRICE_SET_BLOCK_PERIOD 

Provides remote access to the Price server Block Threshold period.

ZB_ZCL_PRICE_SET_COMMODITY 

Represents items that are associated with a particular commodity.

ZB_ZCL_PRICE_SET_BLOCK_PRICE_INFORMATION 

Provides remote access to the block prices.

ZB_ZCL_PRICE_SET_EXTENDED_PRICE_INFORMATION 

Represents extended price information.

ZB_ZCL_PRICE_SET_TARIFF_INFORMATION 

Represents items that are associated with a particular Price Tariff.

ZB_ZCL_PRICE_SET_BILLING_INFORMATION 

Provides remote access to the Price server Billing information.

ZB_ZCL_PRICE_SET_CREDIT_PAYMENT 

Provides a method for the HAN (IHD) to understand the current status of the credit-only payment made to the energy supplier.

ZB_ZCL_PRICE_SET_RECEIVED_TIER_LABEL 

Provides a method for utilities to assign a label to Received Price Tiers.

ZB_ZCL_PRICE_SET_RECEIVED_BLOCK_THRESHOLD 

Provides remote access to the Price server ReceivedBlockThresholds.

ZB_ZCL_PRICE_SET_RECEIVED_BLOCK_PERIOD 

Provides remote access to the Price server Received Block Threshold period.

ZB_ZCL_PRICE_SET_RECEIVED_BLOCK_PRICE_INFORMATION 

This attributes set provide remote access to the block prices. The Block Price Information attribute set supports Block and combined Tier-Block pricing, the number of blocks is one greater than the number of block thresholds defined in the Pricing cluster

ZB_ZCL_PRICE_SET_RECEIVED_EXTENDED_PRICE_INFORMATION 

In case of TOU charging only, the price server allows support for up to 48 TOU rates. To reduce the number of attributes, Tier1Block1Price through Tier15Block1Price attributes are reused to represent rates for tiers 1 to 15. Rates for tiers 16 to 48 are provided in the extended price information set.

ZB_ZCL_PRICE_SET_RECEIVED_TARIFF_INFORMATION 

This set of attributes represents items that are associated with a particular Price Tariff.

Note
The terms tier and rate are used interchangeably here, but do define the same thing.
ZB_ZCL_PRICE_SET_RECEIVED_BILLING_INFORMATION 

This set of attributes provides remote access to the Price server Billing information.