Rainforest Automation
,
Inc
.
RAVEn™
XML API Manual
21
Element
Range
Description
MeterMacId
0xFFFFFFFFFFFFFFFF;
Optional if only one meter
Unique MAC Address of meter
Price
0x0 – 0xFFFFFFFF
Price to be set; set to zero to clear the user
defined price and meter price will be used, if
available
TrailingDigits
0x00 – 0xFF
The number of implicit decimal places in the
price.
3. Notify:
PriceCluster
PriceCluster
notification provides the current price in effect on the meter, or the user-defined
price set on the
RAVEn
™. If the user-defined price is set, the meter price is ignored. If the user-
defined price is not set and the meter price is not set, then the price returned is zero. Either the
TierLabel or the RateLabel, or neither, may be provided; for now, consider these labels as
substitutes. The label provided is a
RAVEn
™ firmware compile option that is set to match the
configuration of the smart meter.
<PriceCluster>
<DeviceMacId>0xFFFFFFFFFFFFFFFF</DeviceMacId>
<MeterMacId>0xFFFFFFFFFFFFFFFF</MeterMacId>
<TimeStamp>0xFFFFFFFF</TimeStamp>
<Price>0x00000000</Price>
<Currency>0x0000</Currency>
<TrailingDigits>0x00</TrailingDigits>
<Tier>0x00</Tier>
[<TierLabel>{string}</TierLabel> |
<RateLabel>{string}</RateLabel>]
</PriceCluster>
Element
Range
Description
DeviceMacId
0xFFFFFFFFFFFFFFFF
Unique MAC Address of the
RAVEn
™
MeterMacId
0xFFFFFFFFFFFFFFFF
Unique MAC Address of meter
TimeStamp
0xFFFFFFFF
UTC Time when price cluster data was
received from meter or set by user
Price
0x0 – 0xFFFFFFFF
Price on meter; will be zero if no price is set
Currency
0x0000
Currency being used; value of this field
matches the values defined by ISO 4217
TrailingDigits
0x00 – 0xFF
The number of implicit decimal places in the
price. (e.g. 2 means divide price by 100).
Tier
0x00 – 0xFF
The price Tier in effect.
TierLabel
Text; Optional
Tier label for the current price tier; will be “Set
by User” if a user-defined price is set
RateLabel
Text; Optional
Rate label for the current price; will be “Set by
User” if a user-defined price is set
