1. Manuals
  2. Brands
  3. Rainforest Automation Manuals
  4. Gateway
  5. RFA-Z109 EAGLE
  6. Manual

Rainforest Automation EAGLE RFA-Z109 Manual

Energy access gateway link to ethernet
Hide thumbs Also See for EAGLE RFA-Z109:
Table of Contents

Advertisement

Quick Links

Download this manual
EAGLE™
Energy Access Gateway Link to Ethernet
Uploader API
Manual
Version 6
July 2014

Advertisement

Table of Contents
loading

Related Manuals for Rainforest Automation EAGLE RFA-Z109

Summary of Contents for Rainforest Automation EAGLE RFA-Z109

  • Page 1 EAGLE™ Energy Access Gateway Link to Ethernet Uploader API Manual Version 6 July 2014...
  • Page 2 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.

  • Page 3: Table Of Contents

    2. Command: get_ fast_poll_status ............16 3. Command: get_history_data .............. 17 4. Command: get_ profile_data ............. 17 5. Command: set_schedule ..............18 HANDLING THE NUMBERS ..................19 Summation and Demand Readings ................19 Price Readings ......................20 Rainforest Automation, Inc.

  • Page 4: Overview

    </rainforest> The first line is the standard XML (eXtensible Markup Language) Prolog. This is followed by the Root Element, which for our purposes is enclosed by the tags <rainforest> and </rainforest>. The Root Element has three attributes: Rainforest Automation, Inc.
  • Page 5 EAGLE™. Example Here is an example of a POST request: POST /rfaeagle.php HTTP/1.0 Host: 192.168.11.3:8888 Accept: */* From: nobody@rainforestautomation.com User-Agent: Raven Uploader/v1 Content-Length: 483 Content-Type: application/x-www-form-urlencoded <?xml version="1.0"?> <rainforest macId="0xf0ad4e00ce69" timestamp="1355292588s"> Rainforest Automation, Inc.

  • Page 6: Replies

    <body> is optional and can contain a single XML fragment. Example Here is an example of a reply: HTTP/1.0 200 OK Date: Wed, 18 Dec 2013 21:28:44 GMT Server: Apache/2.2.15 (CentOS) X-Powered-By: PHP/5.3.3 Content-Length: 168 Connection: close Content-Type: text/html; charset=UTF-8 <LocalCommand> <Name>get_history_data</Name> <MacId>0x00178d0000000004</MacId> Rainforest Automation, Inc.
  • Page 7 <body> of a reply. A command sent to the EAGLE™ in the <body> of a reply may change the operation of the gateway, and may also cause the generation of a POST request containing specific data. Rainforest Automation, Inc.

  • Page 8: Xml Fragments

    Text Manufacturer’s date code and lot number DateCode YYYYMMDDZZZZZZZZ 2. NetworkInfo NetworkInfo fragments provide detailed information about the ZigBee network that the EAGLE™ is connected to. <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> Rainforest Automation, Inc.

  • Page 9: Instantaneousdemand

    MAC Address of EAGLE™ ZigBee radio DeviceMacId 16 hex digits MeterMacId 16 hex digits MAC Address of Meter UTC Time (offset in seconds from 00:00:00 TimeStamp Up to 8 hex digits 01Jan2000) when demand data was received from meter. Rainforest Automation, Inc.

  • Page 10: Pricecluster

    (e.g. 2 means divide Price by 100). Tier 1 - 5 The price Tier in effect. Rate label for the current price tier; will be “Set RateLabel Text by User” if a user-defined price is set Rainforest Automation, Inc.

  • Page 11: Message

    Y: the user confirmation has been sent; Confirmed Y | N N: the user confirmation has not been sent (default) Active: Indicates message is in active queue Queue Active | Cancel Pending Cancel Pending: Indicates message is in cancel pending queue Rainforest Automation, Inc.

  • Page 12: Currentsummation

    Up to 2 hex digits point to display Number of digits to the left of the decimal point DigitsLeft Up to 2 hex digits to display Suppress Y: Do not display leading zeros Y | N LeadingZero N: Display leading zeros Rainforest Automation, Inc.

  • Page 13: Meterinfo

    <FastPollStatus> <DeviceMacId>0xFFFFFFFFFFFFFFFF</DeviceMacId> <MeterMacId>0xFFFFFFFFFFFFFFFF</MeterMacId> <Frequency>0x00</Frequency> <EndTime>0xFFFFFFFF</EndTime> </FastPollStatus> Element Range Description MAC Address of EAGLE™ ZigBee radio DeviceMacId 16 hex digits MeterMacId 16 hex digits MAC Address of Meter 0x01 – 0xFF Frequency Frequency to poll meter, in seconds Rainforest Automation, Inc.

  • Page 14: Historydata

    This time interval is reported in the ProfileIntervalPeriod field. The type of interval data (summation delivered or received) depends upon the IntervalChannel field in the get_profile_data command. Data is organized in reverse chronological order: the most recent interval is transmitted first and the oldest interval is transmitted last. Rainforest Automation, Inc.
  • Page 15 The number of intervals being returned. X = 1-12. Series of up to 12 interval data points from the meter. Most recent IntervalDataX Up to 6 hex digits interval is first; oldest is last. Invalid intervals are marked as 0xFFFFFF. Rainforest Automation, Inc.

  • Page 16: Xml Commands

    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 MAC Address of EAGLE™ ZigBee radio MacId 16 hex digits Rainforest Automation, Inc.

  • Page 17: Command: Get_History_Data

    Send the get_profile_data command to have the EAGLE™ retrieve interval data information stored in the meter. The EAGLE™ will send a ProfileData fragment in response. Note that the tag <RavenCommand> is used instead of <LocalCommand>. <RavenCommand> <Name>get_profile_data</Name> <DeviceMacId>0xFFFFFFFFFFFFFFFF</DeviceMacId> [<MeterMacId>0xFFFFFFFFFFFFFFFF</MeterMacId>] <NumberOfPeriods>0x00</NumberOfPeriods> <EndTime>0xFFFFFFFF</EndTime> <IntervalChannel>{enumeration}</IntervalChannel> </RavenCommand> Rainforest Automation, Inc.

  • Page 18: Command: Set_Schedule

    Type of reading to get from meter demand | message Frequency 4 hex digits Frequency to poll meter, in seconds Y: Set this rate for this type of reading Enabled Y | N N: Disable polling for this type of reading Rainforest Automation, Inc.

  • Page 19: Handling The Numbers

    For Summation, the same process is used, and the multiplier and divisor are used by both the SummationDelivered and SummationReceived readings in the CurrentSummation notification. The other formatting values (DigitsRight, DigitsLeft, SupressLeadingZeros) are the preferred display settings set by the utility and can be ignored for the purposes of calculating values. Rainforest Automation, Inc.

  • Page 20: Price Readings

    The actual value of the Price is determined by placing the decimal point 3 digits from the right. The Currency Code indicates that the value is in US Dollars (see ISO 4217). So the final price is $0.125. Rainforest Automation, Inc.

Table of Contents