Custom Component: Rainforest Eagle-200 local meter reader

gregtd · May 12, 2021, 9:22pm

About a month or so ago I went back to graphing daily usage and noticed a spike which would then throw off all of my calculations. So I stopped looking at daily and monthly usage, and just went to instant data.

I’ll give this a try! Hopefully I can get back to using my daily and monthly graphs.

superpanjy · May 21, 2021, 6:46pm

Hi @gregtd
I added this to sensors.yaml.

  - platform: rainforest_eagle
    ip_address: 192.168.1.222
    cloud_id: 0033xx
    install_code: f8xxxxxxxxxxxxx
    scan_interval: 30

I see 4 entities were added,
sensor.eagle_200_meter_power_demand
sensor.eagle_200_net_meter_energy_delivered_minus_received
sensor.eagle_200_total_meter_energy_received
sensor.eagle_200_total_meter_energy_delivered
But all show up with “unknown”

Eagle-200 has fixed IP Address. software version: 3.15.4.475
I also double checked cloud Id and installation code (with no dash).

Please advise. Thank you

BTW, I can review data one the web portal and app

gregtd · May 22, 2021, 1:00am

@superpanjy

Have you tried with a single quote around the CloudID. It was mentioned in a previous post above.

If that doesn’t work is there anything the in the Home Assistant log file?

superpanjy · May 22, 2021, 1:11am

Thanks for your reply.
I tried a single quote around the CloudID, all four entities disappeared. So i guess I dont need single quote.

I actually don’t know how to check log file. is it home-assistant.log?
I saw this:

2021-05-21 18:10:13 DEBUG (MainThread) [homeassistant.components.websocket_api.http.connection] [140171243294880] Sending {“id”: 2, “type”: “event”, “event”: {“event_type”: “state_changed”, “data”: {“entity_id”: “sensor.eagle_200_meter_power_demand”, “old_state”: null, “new_state”: {“entity_id”: “sensor.eagle_200_meter_power_demand”, “state”: “unknown”, “attributes”: {“unit_of_measurement”: “kW”, “friendly_name”: “Eagle-200 Meter Power Demand”, “device_class”: “power”}, “last_changed”: “2021-05-22T01:10:13.014284+00:00”, “last_updated”: “2021-05-22T01:10:13.014284+00:00”, “context”: {“id”: “f37819d3fb90997a57680732dbf176f9”, “parent_id”: null, “user_id”: null}}}, “origin”: “LOCAL”, “time_fired”: “2021-05-22T01:10:13.014284+00:00”, “context”: {“id”: “f37819d3fb90997a57680732dbf176f9”, “parent_id”: null, “user_id”: null}}}

gregtd · May 22, 2021, 1:34am

@superpanjy
Yeah home-assistant.log is the log file.

Look for any lines that have [homeassistant.components.rainforest_eagle.sensor]. This can point to any errors with the Eagle integration or API

superpanjy · May 22, 2021, 2:07am

I see this:

2021-05-21 18:12:43 DEBUG (SyncWorker_25) [homeassistant.components.rainforest_eagle.sensor] API data: {‘instantanous_demand’: None, ‘summation_delivered’: None, ‘summation_received’: None, ‘summation_total’: None}

gregtd · May 22, 2021, 2:47am

It appears the data coming from the Eagle-200 is not correct.

Can you run the eagle200_reader.py from the command line?

If the above standalone python program fails, try rebooting the Eagle200 and then re-run the same program to see if the issue has resolved itself.

docBliny · August 4, 2021, 11:48pm

In case anyone else runs into problems with the integration installation with the “Expecting value:” error, make sure both Cloud ID and Install code are all lower case. I’d copied the Cloud ID from the website URL and it was in uppercase and thus it wouldn’t start. Might be good to mention that in the docs actually.

//TB

rowanator · August 19, 2021, 7:18pm

Were you ever able to add the cost data to the integration? I just installed it recently and I only see the original 4 sensors (current/in/out/total).

I queried my -200 directly and the price value is “invalid” so I’m getting a bit ahead of myself; opened a ticket with Rainforest support as the price is being displayed on their cloud portal.

jjlink.net · August 20, 2021, 3:36pm

How can I run this in home assistant OS?

Install the ‘eagle200_reader’ Python module by running: ‘python -m pip install eagle200_reader’

natabat · August 24, 2021, 11:06pm

My sensors are not getting populated. I believe it’s because my Eagle is actually returning two power meter devices and the first is not connected (ConnectionStatus = Not joined). I was able to make that eagle200_reader.py script work for me by modifying _get_device_address to use this in the for loop:

for node in tree.iterfind(".//Device[ConnectionStatus='Connected']/HardwareAddress"):

I’m not sure what the other power meter device is (maybe something in my solar installation?), but I don’t see anyway to remove it. Any ideas how I could work around this?

It seems like it needs a code fix to filter the device list down to just connected devices. I think either of these places would work:

github.com

home-assistant/core/blob/2ddeb0c013b859bc8d17585522570881188ef2d6/homeassistant/components/rainforest_eagle/data.py#L63


    with async_timeout.timeout(30):
        meters = await hub.get_device_list()
except aioeagle.BadAuth as err:
    raise InvalidAuth from err
except aiohttp.ClientError:
    # This can happen if it's an eagle-100
    meters = None

if meters is not None:
    if meters:
        hardware_address = meters[0].hardware_address
    else:
        hardware_address = None

    return TYPE_EAGLE_200, hardware_address

reader = Eagle100Reader(cloud_id, install_code, host)

try:
    response = await hass.async_add_executor_job(reader.get_network_info)
except ValueError as err:

or

github.com

home-assistant-libs/aioeagle/blob/324eb5c2624465ecd663ea5bd7fa3d92c9ff8637/aioeagle/hub.py#L72



        text = await response.text()
        return xmltodict.parse(text, dict_constructor=dict)

async def get_device_list(self) -> list[ElectricMeter]:
    """Get a list of devices."""
    response = await self.make_request(create_command("device_list"))
    result = []

    for device in xmltodict_ensure_list(response["DeviceList"], "Device"):
        if device["ModelId"] == "electric_meter":
            result.append(ElectricMeter(device, self.make_request))
        else:
            _LOGGER.debug(f"Skipping unknown device {device['ModelId']}")

    return result

Thanks!

gregtd · August 27, 2021, 7:48pm

The library I was using has been replaced with different one. I’m not maintaining the eagle200_reader API any longer.

Maybe with the new Energy dashboard rather than having the Eagle being queried, you can enter in the Price value directly in Home Assistant?

EDIT: I did see a PR that was merged and probably make it in the HA 2021.9 or 2021.10, where the price will be queried and returned to HA. The PR is 54887.

Here is a screenshot from the latest dev branch that has the Meter Price value from the Eagle-200
Screen Shot 2021-08-28 at 10.29.49 AM

gregtd · August 27, 2021, 7:53pm

@jjlink.net You can add the Eagle device in Home Assistant by going adding this to your configuration.yaml

sensor:
  - platform: rainforest_eagle
    ip_address: 1.1.1.2
    cloud_id: 123456
    install_code: 4234343242343242

In an upcoming release you’ll be able to add the Eagle device through the web interface but no yet.

gregtd · August 27, 2021, 8:05pm

@natabat Yeah this was a limitation when I first wrote the eagle200_reader library. The newer library aioeagle might overcome the limitation but it appears the Home Assistant Eagle integration code is hardcoded to only look for the first meter.

github.com

home-assistant/core/blob/2ddeb0c013b859bc8d17585522570881188ef2d6/homeassistant/components/rainforest_eagle/data.py#L63


    with async_timeout.timeout(30):
        meters = await hub.get_device_list()
except aioeagle.BadAuth as err:
    raise InvalidAuth from err
except aiohttp.ClientError:
    # This can happen if it's an eagle-100
    meters = None

if meters is not None:
    if meters:
        hardware_address = meters[0].hardware_address
    else:
        hardware_address = None

    return TYPE_EAGLE_200, hardware_address

reader = Eagle100Reader(cloud_id, install_code, host)

try:
    response = await hass.async_add_executor_job(reader.get_network_info)
except ValueError as err:

Have you opened an Issue in Home Assistant to track this issue?

natabat · August 27, 2021, 8:56pm

@gregtd I haven’t submitted an issue yet, but I can definitely do that. I’m also toying with the idea of fixing it myself but I’m 38 weeks pregnant and it seems like there are other things I should be worrying about right now.

Edit: just submitted the issue:

gregtd · August 28, 2021, 5:29am

Thank you for submitting the issue! While I can’t say I completely understand (never been pregnant nor have kids) I can empathize juggling priorities and picking what is truly important. Take care!

Oh and thank you for posting the XML output. This will help out.

gregoinc · January 25, 2022, 6:17am

Thought rather than starting a new thread I would post my question here… I have recently setup my Rainforest Eagle 200, and have been configuring the HA Energy Dashboard.

I am a little confused about Energy Delivered (kWh) and Energy Received (kWh)?? I have the HA Energy Dashboard configured like this…

Grid consumption = Eagle-200 Total Meter Energy Received
Return to grid = Eagle-200 Total Meter Energy Delivered

But I have a funny feeling this might be the wrong way around? Can anyone give me some advice?

Ezekiel · January 26, 2022, 12:04pm

I think you might have that around the wrong way.

Have a look at these two videos on YouTube.
He has one and goes through the steps.

&

gregoinc · January 27, 2022, 5:41am

Yes, I looked at the output and it looked weird, so I flipped them and now it looks great. Thanks for the videos, much appreciated.

Ezekiel · January 28, 2022, 10:31pm

I’ve been thinking about getting one myself. They were sold out for a while and have just come back in stock.

I’ve read some negative reports around the connectivity so I’d like to ask has it been stable?

Are you using wifi or directly connected to your network?

How far away is the device from your smart meter?

Thanks in advance.

Ezekiel