Zigbee Gateway Rainforest Eagle (1st Gen) iCredit
A key feature of this device is its ability to communicate with the electricity meter, which in this case is the iCredit 500. The Rainforest provides a "gateway" to some of the various readings the meter is capable of.
Note: 2021 Jan 04 - this page refers to the -100 unit. The current version sold by Rainforest Automation is the -200 2nd generation unit. Notes have been added to the bottom of the page with a software migration guide as well as an alternate approach using a mock cloud. However the basic principles still apply.
https://rainforestautomation.com/rfa-z114-eagle-200/
Link to power distribution company web site:
Connecting the Rainforest to the meter is done via the electricity distribution company's web site. Essentially the process involves getting an account on the web site. Then you go to the appropriate page on the site and enter the identity of the meter (the so called NMI). Finally you tell the site the identity of the device you would like to authorize to chit chat with the meter. After that you click GO.
If all goes well, and the god of electricity looks favourably upon your request, and despite being told there has been a failure, your device shall be connected and a small green light shall illuminate indicating the god's overall happinness and that access has been granted. Compared to the many stories of pain I've heard about other Victorian electricity distributors I must say that UE's relationship with the god of electricity is clearly in good shape. It's possibly going tad to far to say I actually like my distributor, that would be similar saying you like your bank, however it couldn't have been easier, except maybe for the incorrect error status thing.
Installation tricks:
- Ignore instructions to type in the password as found on the bottom of the unit: *all* characters must be upper case (or lower case, I can't remember now. If you're stuck try this).
- The timezone stuff is wrong. It uses an outdated Linux and the TZ stuff has not been recompiled to update it. In Australia the unit will have the wrong time for about two weeks twice a year. I've emailed and provided instructions on how to fix this (which were duely ignored - but passed on to the devs)
Direct communications with the Rainforest is possible. It was installed here and essentially configured not to divulge information to 3rd party websites. The intention is to directly extract information and use it to create a data source for other things, in time, like monitoring displays and controls.
2021-01-04: As it turns out everything now goes via Logstash to the ElasticSearch cluster where various analytics are then applied - The curl scripts still extract the data and write into files on the disk every minute. Filebeat picks up the files and sends the contents to Logstash which in turn sends enriched/filtered data to Elastic. A lifecycle management script deletes old files after about 10 minutes.
- You can talk directly to the unit using the linux program: curl. Use run_curl.sh from a linux commandline (obviously this works on a Mac too).
./run_curl.sh rainforest_command.curl
{"meter_status":"Connected",
"demand":"-0.8830",
"demand_units":"kW",
"demand_timestamp":"1504882262",
"summation_received":"4423.200",
"summation_delivered":"20932.600",
"summation_units":"kWh",
"price":"0.1400",
"price_units":"840",
"price_label":"Set by User",
"message_timestamp":"946684800",
"message_confirmed":"N",
"message_confirm_required":"N",
"message_id":"0",
"message_queue":"active",
"message_read":"Y",
"threshold_upper_demand":"8.357000",
"threshold_lower_demand":"-3.949000",
"fast_poll_frequency":"0x00",
"fast_poll_endtime":"0x00000000"}
Links to program code:
run_curl.sh
rainforest_command.curl
rainforest_get_historical_data.curl
rainforest_get_instantaneous_demand.curl
rainforest_get_network_info.curl
rainforest_get_network_status.curl
rainforest_get_price_blocks.curl
rainforest_get_usage_data.curl
Some of these work, but not all. Inconsistent with the documentation. If anyone figures it out let me know and I'll update (note: this implies you can talk to me - The preferred mechanism is Twitter).
- Documentation:
Eagle REST API
Eagle Uploader API
Uploader Migration notes (thanks go to @jrwilson01 for pointing this document out)
- Cloud Emulator for Rainforest Automation Eagle (thanks go to Dave B. for point this one out)