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

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

Rainforest Automation , Inc .
RAVEn™
XML API Manual
14
Meter Feature
The Meter Feature provides the commands and notifications for getting information about the
meter and the network the device is on.
Key commands and notifications include:
•
Getting information about the type of meter and its identifiers
•
Finding the status of the network connection and the quality of the link
1. Command: GET_METER_INFO
Send the GET_METER_INFO Command to get the meter information. The RAVEn ™ will send
a MeterInfo notification in response.
<Command>
<Name>get_meter_info</Name>
[<MeterMacId>0xFFFFFFFFFFFFFFFF</MeterMacId>]
</Command>
Element Range Description
MeterMacId 0xFFFFFFFFFFFFFFFF;
Optional if only one meter Unique MAC Address of meter
2. Notify: MeterInfo
MeterInfo notifications provide information about meters that are on the network.
<MeterInfo>
<DeviceMacId>0xFFFFFFFFFFFFFFFF</DeviceMacId>
<MeterMacId>0xFFFFFFFFFFFFFFFF</MeterMacId>
<MeterType>{enumeration}</MeterType>
<NickName>{string}</NickName>
[<Account>{string}</Account>]
[<Auth>{string}</Auth>]
[<Host>{string}</Host>]
[<Enabled>{enumeration}</Enabled>]
</MeterInfo>
Element Range Description
DeviceMacId 0xFFFFFFFFFFFFFFFF Unique MAC Address of the RAVEn ™
MeterMacId 0xFFFFFFFFFFFFFFFF Unique MAC Address of meter
Meter Type electric | gas | water |
other Type of meter
Nickname Text Nickname set for the meter
Account Text; Optional Account Identification
Auth Text; Optional Authentication code
Host Text; Optional Hosting Provider