Rainforest Automation
,
Inc
.
RAVEn™
XML API Manual
23
1. Command: GET_INSTANTANEOUS_DEMAND
Send the GET_INSTANTANEOUS_DEMAND command to get the demand information from the
RAVEn
™. Set the Refresh element to Y to force the
RAVEn
™ to get the information from the
meter, rather than its local cache. The
RAVEn
™ will send an
InstantaneousDemand
notification
in response.
<Command>
<Name>get_instantaneous_demand</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
Y: Get current reading from meter
N: Get data from
RAVEn
™ cache (default)
2. Notify:
InstantaneousDemand
InstantaneousDemand
notification provides the current consumption rate as recorded by the
meter.
<InstantaneousDemand>
<DeviceMacId>0xFFFFFFFFFFFFFFFF</DeviceMacId>
<MeterMacId>0xFFFFFFFFFFFFFFFF</MeterMacId>
<TimeStamp>0xFFFFFFFF</TimeStamp>
<Demand>0x000000</Demand>
<Multiplier>0x00000000</Multiplier>
<Divisor>0x00000000</Divisor>
<DigitsRight>0x00</DigitsRight>
<DigitsLeft>0x00</DigitsLeft>
<SuppressLeadingZero>{enumeration}</SuppressLeadingZero>
</InstantaneousDemand>
Element
Range
Description
DeviceMacId
0xFFFFFFFFFFFFFFFF
Unique MAC Address of the
RAVEn
™
MeterMacId
0xFFFFFFFFFFFFFFFF
Unique MAC Address of meter
TimeStamp
0xFFFFFFFF
UTC Time when demand data was received
from meter
Demand
0x0 – 0xFFFFFF
The raw instantaneous demand
Multiplier
0x0 – 0xFFFFFFFF
The multiplier; ignore if zero
Divisor
0x0 – 0xFFFFFFFF
The divisor; ignore if zero
DigitsRight
0x00 – 0xFF
Number of digits to the right of the decimal
point to display
DigitsLeft
0x00 – 0xFF
Number of digits to the left of the decimal point
to display
Suppress
LeadingZero
Y | N
Y: Do not display leading zeros
N: Display leading zeros
