Rainforest Automation RAVEn, Xml Api Manual

Page: 15 / 29

Rainforest Automation , Inc .
RAVEn™
XML API Manual
15
Enabled Y | N; Optional Y: to start transmitting data to host
N: to stop transmitting data to host
3. Command: GET_NETWORK_INFO
Send the GET_NETWORK_STATUS Command to get the status of device on the network. The
RAVEn ™ will send a NetworkInfo notification in response.
<Command>
<Name>get_network_info</Name>
</Command>
4. Notify: NetworkInfo
NetworkInfo notifications provide information about the network that the device is on.
<NetworkInfo>
<DeviceMacId>0xFFFFFFFFFFFFFFFF</DeviceMacId>
<CoordMacId>0xFFFFFFFFFFFFFFFF</CoordMacId>
<Status>{enumeration}</Status>
<Description>{string}</Description>
<StatusCode>[0xFF]</StatusCode>
<ExtPanId>0xFFFFFFFFFFFFFFFF</ExtPanId>
<Channel>00</Channel>
<ShortAddr>0xFFFF</ShortAddr>
<LinkStrength>0xFF</LinkStrength>
</NetworkInfo>
Element Range Description
DeviceMacId 0xFFFFFFFFFFFFFFFF Unique MAC Address of the RAVEn ™
CoordMacId 0xFFFFFFFFFFFFFFFF MAC Address of the network coordinator
(normally the meter)
Status Initializing | Network
Discovery | Joining | Join:
Fail | Join: Success |
Authenticating |
Authenticating: Success |
Authenticating: Fail|
Connected| Disconnected|
Rejoining Indicates the current state of the device
Description Text Gives a description of the device state
StatusCode 0x00 – 0xFF If available, provides a status code for the
current state; if not available, then null
ExtPanId 0x0 -
0xFFFFFFFFFFFFFFFF Provides the extended PAN ID of the network
the device is trying to join or has joined
Channel 11 – 26 Indicates the channel on which the device is
operating
ShortAddr 0x0000 – 0xFFFF The short address assigned to the RAVEn ™