This custom integration adds support for the Proteus EcoFrog WLAN WiFi tank level sensor by Proteus. (or is that E-Sensorix?)
You get access to the information provided by the E-sensorix API:
- Current volume of fluid in the tank
- Maximum volume of fluid in the tank
- Percentage of fluid
- Sensor temperature
- Battery (in volts)
Since this is a custom component, you must copy the contents of the
custom_components folder/directory to your Home Assistant config
folder/directory, so it looks like this:
config/
└ custom_components/
└ ecofrog/
├ __init__.py
└ ...
The exact method to do this depends on whether you're using a VM image, HA appliance or Docker.
Once you've done this, restart Home Assistant, and the integration should be visible. Go to Settings → Devices & Services, click the ADD INTEGRATION button, then search for EcoFrog.
You need four pieces of information to authenticate with the Proteus/E-Sensorix API:
- a numeric user ID called a ‘username’,
- the E-Mail address you bought or registered the EcoFrog with,
- a ‘Security Stamp’, which is a UUID like
xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, and - the Device ID, a numeric ID of the device to monitor.
To get this information and ensure the API is enabled for your account, please email [email protected].
Once you've added the device, it should appear in the Integrations, and show one device for each of your EcoFrogs, and several sensors. These can be added to your dashboards or used in automations as always.
If you have more than one EcoFrog, you need to add the integration once for each sensor, using the appropriate authentication information.
In order to be nice to the API servers, polling is limited to once every hour. A fresh copy of the data is fetched when Home Assistant restarts.
The EcoFrog samples the tank a few times a day, but seemingly only uploads fresh data once per 24 hour period. So hourly polls should be fine.
This is alpha software of the worst possible type.
I hope it works for you, and please let me know if it doesn't! I'd especially like to know if it works correctly for multiple EcoFrogs, as I only have one.