A YouLess energy monitor is a handy device to monitor your power and gas usage. It has its downsides though, one is a limited amount of historical data that is stored. This package aims to solve that problem by storing the monitored data of each interval for a much longer period of time. And it is able to do so for multiple YouLess devices. It also provides an API compatible with YouLess' own API so the service can easily be used by any existing client.
Key features are:
- no more limits on monitored data
- get data from multiple devices
- only monitor the utility services you want
- configure update intervals
- classic api can serve older data
- support for grpc and graphql
A CLI tool is available to display info or communicate with the configured devices. Login to the Docker container and
use yl list to list all available commands. It is also possible to run the tool outside of the Docker container
via docker exec -it {container_name} yl {command}.
docker pull roeldev/casa-youless-logger
services:
youless-logger-service:
image: roeldev/casa-youless-logger:latest
volumes:
- config:/youless-logger/config/
- data:/youless-logger/data/
- log:/youless-logger/log/
| Path | Contains |
|---|---|
/youless-logger/config |
Config files |
/youless-logger/data |
Database (backup) files |
/youless-logger/log |
Log files |
Support for multiple YouLess devices means a little more configuration. Altough it should be pretty self explanatory, most important stuff is mentioned in this chapter. But first, have a look at the sample config for a quick overview of possibilities.
Each device should have at least an ip option set so the logger can reach the device's API. All other values are not required. However, this probably results in way too much useless data being saved. Therefore it's recommended to only enable the data service(s) that are actually monitored. and disables classic API support
Note: Latest YouLess devices support data from multiple different counters: power, gas, s0 and water. Older versions only support power.
Below example adds two devices:
- house which requires a password to access the API on 192.168.1.27 and provides data of power and gas consumption;
- shed which is hosted on 192.168.1.32 and only provides data of the s0 pulse counter.
'devices' => [
'house' => [
'ip' => 'http://192.168.1.27',
'password' => 'secret',
'services' => [
'power' => true,
'gas' => true,
's0' => false,
]
],
'shed' => [
'ip' => 'http://192.168.1.32'
'services' => [ 's0' ]
]
]
A new SQLite database is created on first run. All data values are stored in the data table within this database.
| Id | Interval | API equiv. | LS110 history* | LS120 history* | Unit (power/s0) | Unit (gas) |
|---|---|---|---|---|---|---|
| 1 | minute | h | 1 hour (2x30) | 10 hours (20x30) | watt | n/a |
| 2 | 10 mins | w | 24 hours (3x48) | 10 days (30x48) | watt | liter |
| 3 | hour | d | 7 days (7x24) | 70 days (70x24) | watt | liter |
| 4 | day | m | 1 year (12x31) | 1 year (12x31) | kWh | m3 (cubic meter) |
- = max. history (amount of pages x data entries)
| Id | Unit | API equiv. | Service |
|---|---|---|---|
| 1 | watt | Watt | power/s0 |
| 2 | kwh | kWh | power/s0 |
| 3 | liter | l | gas |
| 4 | m3 | m3 | gas |
Additional detailed documentation is available at pkg.go.dev
- Github: https://github.com/roeldev/youless-logger
- Docker hub: https://hub.docker.com/r/roeldev/casa-youless-logger
- YouLess: https://youless.nl
- YouLess API info: http://wiki.td-er.nl/index.php?title=YouLess
Copyright © 2019-2024 Roel Schut. All rights reserved.
This project is governed by a BSD-style license that can be found in the LICENSE file.