background image

Rainforest Automation, Inc.  

EAGLE

™ 

Uploader API Manual 

 

 

 
 
Copyright © 2014 

by RAINFOREST AUTOMATION, INC (“RFA”). All rights reserved. 

No  part  of  this  manual  may  be  reproduced  or  transmitted  in  any  from  without  the  expressed,  written 
permission of RFA. 
 
Under  copyright  law,  this  manual  or  the  software  described  within,  cannot  be  copied,  in  whole  or  part, 
without  the  written  consent  of  the  manufacturer,  except  in  the  normal  use  of  the  software  to  make  a 
backup  copy.  The  same  proprietary  and  copyright  notices  must  be  affixed  to  any  permitted  copies  as 
were affixed to the original. This exception  does  not  allow copies to be made for others,  whether or  not 
sold, but all of the material purchased (with all backup copies) can be sold, given, or loaned to another 
person. Under the law, copying includes translating into another language or format. 
 
Rainforest Automation may have patents, patent applications, trademarks, copyrights, or other intellectual 
property  rights  covering  subject  matter  in  this  document.  Except  as  expressly  provided  in  any  written 
license  agreement  from  Rainforest  Automation,  the  furnishing  of  this  document  does  not  give  you  any 
license to these patents, trademarks, copyrights, or other intellectual property.  
 
 

Trademarks 

Third-party  brands  and  company  Names  mentioned  herein  may  be  trademarks  and/or  registered 
trademarks of their respective companies and are the sole property of their respective manufacturers. 
 

Notice 

The author(s) assumes no responsibility for any errors or omissions that may appear in this document nor 
does it make a commitment to update the information contained herein. 

Summary of Contents for RFA-Z109 EAGLE

Page 1: ...EAGLE Energy Access Gateway Link to Ethernet Uploader API Manual Version 6 July 2014...

Page 2: ...copies can be sold given or loaned to another person Under the law copying includes translating into another language or format Rainforest Automation may have patents patent applications trademarks c...

Page 3: ...Replies 6 XML FRAGMENTS 8 1 DeviceInfo 8 2 NetworkInfo 8 3 InstantaneousDemand 9 4 PriceCluster 10 5 Message 11 6 CurrentSummation 12 7 MeterInfo 13 8 FastPollStatus 13 9 HistoryData 14 10 ProfileData...

Page 4: ...sts contains the meter data structured as XML Fragments Data Structures 1 Requests The EAGLE sends data in a POST request POST requests have the following structure POST URL HTTP 1 1 headers blank bod...

Page 5: ...ement will have a unique element name indicates the variable number of specific elements Element values can be of various types string indicates an element consisting of Extended ASCII text enumeratio...

Page 6: ...pects to see a valid HTTP response to each POST request These look like HTTP 1 0 code headers blank body Where Every line ends with the newline character 0x0A code is an HTTP status code which consist...

Page 7: ...onent and will simply acknowledge a POST sent by the EAGLE However it is also possible to send a single XML formatted command to the EAGLE in the body of the reply While a command sent in this way is...

Page 8: ...allCode 16 hex digits Install Code for EAGLE ZigBee radio LinkKey 32 hex digits ZigBee radio Link Key FWVersion Text Firmware Version HWVersion Text Hardware Version ImageType 4 hex digits ZigBee code...

Page 9: ...rk coordinator LinkStrength 0x00 0x64 Indicates the strength of the radio link 3 InstantaneousDemand InstantaneousDemand fragments provide the current consumption rate as recorded by the meter Note th...

Page 10: ...FFFFFFFFFFFFF DeviceMacId MeterMacId 0xFFFFFFFFFFFFFFFF MeterMacId TimeStamp 0xFFFFFFFF TimeStamp Price 0xFFFFFFFF Price Currency 0xFFFF Currency TrailingDigits 0xFF TrailingDigits Tier 00 Tier TierLa...

Page 11: ...ation Queue MessageCluster Element Range Description DeviceMacId 16 hex digits MAC Address of EAGLE ZigBee radio MeterMacId 16 hex digits MAC Address of Meter TimeStamp Up to 8 hex digits UTC Time off...

Page 12: ...SuppressLeadingZero CurrentSummationDelivered Element Range Description DeviceMacId 16 hex digits MAC Address of EAGLE ZigBee radio MeterMacId 16 hex digits MAC Address of Meter TimeStamp Up to 8 hex...

Page 13: ...Nickname Text Nickname set for the meter Account Text Account Identification Auth Text Authentication code Host Text Hosting Provider Enabled Y N Y to start transmitting data to host N to stop transm...

Page 14: ...acId 0xFFFFFFFFFFFFFFFF DeviceMacId MeterMacId 0xFFFFFFFFFFFFFFFF MeterMacId TimeStamp 0xFFFFFFFF TimeStamp SummationDelivered 0xFFFFFFFF SummationDelivered SummationReceived 0xFFFFFFFF SummationRecei...

Page 15: ...seconds from 00 00 00 01Jan2000 of the end of the most chronologically recent interval 0x0 indicates the most recent interval block Status 0x0 0x05 Status of returned data 0x00 Success 0x01 Undefined...

Page 16: ...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 LocalComman...

Page 17: ...n the oldest sample then the interval will start from the oldest sample EndTime Up to 8 hex digits UTC Time offset in seconds from 00 00 00 01Jan2000 of the end of the history interval If not specifie...

Page 18: ...ser Received Interval data for commodity received by the utility from the user 5 Command set_schedule Send the set_schedule command to change how the EAGLE polls the meter The rate at which each type...

Page 19: ...Right DigitsLeft 0x00 DigitsLeft SuppressLeadingZero Y SuppressLeadingZero InstantaneousDemand The values from this notification are Demand reading 1738 hex 5944 decimal Multiplier 1 Divisor 3E8 hex 1...

Page 20: ...11cf431 MeterMacId TimeStamp 0x1a462b4d TimeStamp Price 0x0000007d Price Currency 0x0348 Currency TrailingDigits 0x03 TrailingDigits Tier 0x01 Tier RateLabel Set by User RateLabel PriceCluster The val...

Reviews: