Rainforest Automation
,
Inc
.
RAVEn™
XML API Manual
20
Price Feature
The Price Feature provides the commands and notifications for managing prices from the smart
meters.
Key commands and notifications include:
•
Price notifications from a smart meter
•
Price Tier notifications from a smart meter
•
Set a user-defined Price when the smart meter does not provide a price
1. Command: GET_CURRENT_PRICE
Send the GET_CURRENT_PRICE command to get the price information. Set the Refresh
element to Y to force the
RAVEn
™ to get the information from the meter, not from cache.
The
RAVEn
™ will send a
PriceCluster
notification in response.
<Command>
<Name>get_current_price</Name>
[<MeterMacId>0xFFFFFFFFFFFFFFFF</MeterMacId>]
[<Refresh>{enumeration}</Refresh>]
</Command>
Element
Range
Description
MeterMacId
0xFFFFFFFFFFFFFFFF;
Optional if only one meter
Unique MAC Address of meter
Refresh
Y | N; Optional
If user price is set, this is ignored; price is
always from
RAVEn
™ cache.
If user price is not set:
Y: Get current price from meter
N: Get price from
RAVEn
™ cache (default)
2.
Command: SET_CURRENT_PRICE
Send the SET_CURRENT_PRICE command to set the user-defined price on the
RAVEn
™.
The Price field is an integer; the Trailing Digits field indicates where the decimal place goes (i.e.,
the divisor). The user-defined price will override the meter price. Setting the user-defined price
to zero will clear the user entered price in the
RAVEn
™, and the meter price will be used, if
available.
<Command>
<Name>set_current_price</Name>
[<MeterMacId>0xFFFFFFFFFFFFFFFF</MeterMacId>]
<Price>0x000000</Price>
<TrailingDigits>0x00</TrailingDigits>
</Command>