Rainforest Automation, Inc.
EAGLE™
Uploader API Manual
16
XML COMMANDS
These XML-formatted commands can be used in the body of a reply to change the operation of
the
EAGLE
™, and to cause the
EAGLE
™ to generate a POST request containing specific data.
The
<body>
of a reply can only contain one command.
1. Command: set_fast_poll
Send the
set_fast_poll
command to have the
EAGLE
™ set the fast poll mode on the meter. In
fast poll mode, the meter will send Instantaneous Demand updates at the frequency requested.
This is a ZigBee Smart Energy 1.1 feature.
For ZigBee Smart Energy 1.0 meters, the
EAGLE
™ will emulate this feature, if possible. For
some meters fast poll mode will not be allowed. In that case, polling will default to a maximum
frequency of every 4 seconds for up to 15 minutes.
If Duration is zero, then fast poll mode is turned off.
Note that the tag <RavenCommand> is used instead of <LocalCommand>.
<RavenCommand>
<Name>set_fast_poll</Name>
<MacId>0xFFFFFFFFFFFFFFFF</MacId>
<Frequency>0x00</Frequency>
<Duration>0x00</Duration>
</RavenCommand>
Element
Range
Description
MacId
16 hex digits
MAC Address of
EAGLE
™ ZigBee radio
Frequency
0x01
– 0xFF
Frequency to poll meter, in seconds
Duration
0x00
– 0x0F
Duration of fast poll mode, in minutes;
maximum is 15 minutes
2. Command: get_ fast_poll_status
Send the
get_fast_poll_status
command to get the current status of fast poll mode. The
EAGLE
™ will send a
FastPollStatus
fragment in response.
<LocalCommand>
<Name>get_fast_poll_status</Name>
<MacId>0xFFFFFFFFFFFFFFFF</MacId>
</LocalCommand>
Element
Range
Description
MacId
16 hex digits
MAC Address of
EAGLE
™ ZigBee radio
