Agur smart home integration, free and open source
Follow your Agur water meter: index, consumption, invoices and amount due.
Published by cicoub13
- Devices
- Version 0.1.1
- Requires Gladys >=4.86.0
- ★ 0
Follow your Agur water contract in Gladys: meter index, consumption between two readings, average daily consumption, invoice amounts and amount still due, with their history.
Requirements
- An account on the customer website of your water utility, with at least one contract.
- Internet access on the machine running Gladys: the data is read on the website of the water utility.
Configuration
Open the configuration screen of the integration and fill in:
| Field | Description |
|---|---|
| The email you log in with on the Agur customer website. | |
| Password | The password of the customer website. |
Then click Test the connection. On success, the button answers for example
Connected to Agur: 1 contract(s) found.; otherwise it shows one of the
messages described under "Troubleshooting" below.
Devices
As soon as the connection works, each contract of the account shows up in the
Discovery tab of the integration, without a scan, named after the water
utility and the meter number (for example Agur I21FA123456). Create the ones
you want to follow. Their features:
| Feature | Unit | Description |
|---|---|---|
| Meter index | m³ | The meter index at the latest reading. |
| Consumption since previous reading | m³ | Water used between the latest reading and the previous one, as billed. |
| Average daily consumption | L | The average use per day over that same period, as computed by the water utility. Periods do not all last the same, so this is the figure to compare from one reading to the next. |
| Invoice amount | € | The amount, taxes included, of the latest invoice (negative for a credit note). |
| Amount due | € | What is left to pay on the contract: positive when a sum is due, negative when the account is in your favour, 0 when it is settled. |
The device also lists the contract number, the meter number and the delivery address in its parameters.
History
When the device is created, the integration sends Gladys the whole history available on the customer website (readings and invoices), each at its real date: the charts show the past from day one. A very long history is sent over several minutes, to stay within the Gladys limit of 300 values per minute.
Update frequency
The readings are the ones the water utility uses for billing: usually one every six months or so, depending on your contract. The values shown are the ones of the latest reading, not real-time consumption; they change with each new reading or invoice. The integration reads the customer website every 6 hours, and 30 minutes after a failure.
Showing the values
Gladys shows "No recent value" for a value older than 48 hours. To avoid it, the meter index, the invoice amount and the amount due are published again at every read: they stay displayed in a "Devices" dashboard box, and their chart reads as a staircase (latest known value).
The consumption and the average daily consumption are about a past period: they are not published again, so that their charts keep one value per reading. They therefore show "No recent value" in a "Devices" box: follow them with a chart over the last year (bars for the consumption, a line for the average).
Troubleshooting
Error messages show in the connection status of the integration and under the Test the connection button.
"Enter the email and password of your water account in the configuration." Fill in both fields, then save.
"Agur refused the email or password (…)." The text between brackets is the explanation of the water utility (in French). Check your credentials by logging in on its website; if the website asks you to change your password, do so and enter the new one in Gladys. To avoid getting your account locked, the integration suspends its updates after a refusal: they resume when you save the configuration or click Test the connection.
"Agur did not answer in time", "Agur answered with an error (HTTP …)" or "Agur sent an unexpected answer". The website of the water utility is slow or under maintenance. The integration tries again on its own; if it lasts several days, check the integration logs and report the issue.
"Agur cannot be reached." Check the internet access of the machine running Gladys.
A contract is missing from the Discovery tab. Check that it is visible on the customer website with the same account, then click Test the connection: the device list is refreshed right after.
Privacy
The email and password are stored by Gladys (the password as a secret) and only sent to the website of your water utility. The integration talks to nothing else.
This integration is not affiliated with Agur. It uses the interface of their customer website, which may change without notice.
Configuration settings
These are the settings Agur asks for in its configuration screen in Gladys.
| Setting | Type | Required | Description |
|---|---|---|---|
| Connect your water account | section | No | Use the email and password you log in with on the Agur customer website. Each contract of the account then shows up in the Discovery tab. |
string | Yes | ||
| Password | secret | Yes |
How to install Agur in Gladys
- In Gladys, open Integrations: Agur appears in the catalog, next to the native integrations, with a community badge.
- Click Install. Gladys pulls the Docker image (
ghcr.io/cicoub13/gladys-agur:0.1.1), starts it in a sandbox isolated from the core, and generates the integration's interface (devices, discovery and configuration). - Open the Configuration screen of the integration, fill in the settings, and save.
- You can also install it directly from its repository URL: https://github.com/cicoub13/gladys-agur.
Agur requires Gladys >=4.86.0. The catalog inside Gladys refreshes every hour, so a new version becomes available at most one hour after its release.
Not running Gladys yet? It is free and open source: follow the installation guide to get started.
About external integrations
Agur is an external integration: a community integration packaged as a Docker container and published on GitHub, that Gladys installs in one click and runs in a sandbox isolated from its core. It is published and maintained by cicoub13, not by the Gladys core team.
- Browse all external integrations
- Discover the native integrations built into Gladys
- Build and publish your own external integration
- Source code on GitHub — source of this documentation