Rainforest Automation RAVEn, Xml Api Manual

Page: 27 / 29

Rainforest Automation , Inc .
RAVEn™
XML API Manual
27
8. Notify: LastPeriodUsage
LastPeriodUsage notification provides the total consumption for the previous accumulation
period as calculated by the RAVEn ™. The Start Date and End Date are UTC timestamps
indicating the start and end times that define the previous period.
<LastPeriodUsage>
<DeviceMacId>0xFFFFFFFFFFFFFFFF</DeviceMacId>
<MeterMacId>0xFFFFFFFFFFFFFFFF</MeterMacId>
<LastUsage>0x00000000</LastUsage>
<Multiplier>0x00000000</Multiplier>
<Divisor>0x00000000</Divisor>
<DigitsRight>0x00</DigitsRight>
<DigitsLeft>0x00</DigitsLeft>
<SuppressLeadingZero>{enumeration}</SuppressLeadingZero>
<StartDate>0xFFFFFFFF</StartDate>
<EndDate>0xFFFFFFFF</EndDate>
</LastPeriodUsage>
Element Range Description
DeviceMacId 0xFFFFFFFFFFFFFFFF Unique MAC Address of the RAVEn ™
MeterMacId 0xFFFFFFFFFFFFFFFF Unique MAC Address of meter
LastUsage 0x0 – 0xFFFFFFFF The previous period total consumption value
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
Leading Zero Y | N Y: Do not display leading zeros
N: Display leading zeros
StartDate 0x0 – 0xFFFFFFFF UTC Time of the start of the previous period
EndDate 0x0 – 0xFFFFFFFF UTC Time of the end of the previous period
9. Command: CLOSE_CURRENT_PERIOD
Send the CLOSE_CURRENT_PERIOD command to have the RAVEn ™ roll over the current
period to the last period and to initialize the current period.
<Command>
<Name>close_current_period</Name>
[<MeterMacId>0xFFFFFFFFFFFFFFFF</MeterMacId>]
</Command>
Element Range Description
MeterMacId 0xFFFFFFFFFFFFFFFF;
Optional if only one meter Unique MAC Address of meter