Rainforest Automation RAVEn, Руководство по XML API

Страница: 25 / 29

Rainforest Automation , Inc .
RAVEn™
XML API Manual
25
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
5. Command: GET_CURRENT_PERIOD_USAGE
Send the GET_CURRENT_PERIOD_USAGE command to get the accumulated usage
information from the
RAVEn ™. The RAVEn ™ will send a CurrentPeriodUsage notification in
response. Note that this command will not cause the current period consumption total to be
updated. To do this, send a GET_CURRENT_SUMMATION_DELIVERED command with
Refresh set to Y.
<Command>
<Name>get_current_period_usage</Name>
[<MeterMacId>0xFFFFFFFFFFFFFFFF</MeterMacId>]
</Command>
Element Range Description
MeterMacId 0xFFFFFFFFFFFFFFFF;
Optional if only one meter Unique MAC Address of meter
6. Notify:
CurrentPeriodUsage
CurrentPeriodUsage notification provides the total consumption for the current accumulation
period, as calculated by the RAVEn ™. The Multiplier and Divisor are used to calculate the
actual decimal value from the CurrentPeriod, which is an integer. If the Multiplier and Divisor are
Zero, then ignore them for calculation purposes (i.e., treat them as a value of one). The
DigitsRight and DigitsLeft are formatting hints for the data. These indicate what the
recommended formatting is for the value. The SuppressLeadingZero flag overrides the
DigitsLeft formatting hint. StartDate is a UTC timestamp indicating when the current period
started.
<CurrentPeriodUsage>
<DeviceMacId>0xFFFFFFFFFFFFFFFF</DeviceMacId>
<MeterMacId>0xFFFFFFFFFFFFFFFF</MeterMacId>
<TimeStamp>0xFFFFFFFF</TimeStamp>
<CurrentUsage>0x00000000</CurrentUsage>
<Multiplier>0x00000000</Multiplier>
<Divisor>0x00000000</Divisor>
<DigitsRight>0x00</DigitsRight>
<DigitsLeft>0x00</DigitsLeft>
<SuppressLeadingZero>{enumeration}</SuppressLeadingZero>
<StartDate>0xFFFFFFFF</StartDate>
</CurrentPeriodUsage>