https://github.com/roeldev/youless-client
Client written in Go for YouLess energy monitor
https://github.com/roeldev/youless-client
client energy-monitor go golang home-automation iot youless
Last synced: 5 months ago
JSON representation
Client written in Go for YouLess energy monitor
- Host: GitHub
- URL: https://github.com/roeldev/youless-client
- Owner: roeldev
- License: bsd-3-clause
- Created: 2024-03-01T22:22:18.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-10T15:42:01.000Z (over 1 year ago)
- Last Synced: 2026-01-14T19:22:11.570Z (5 months ago)
- Topics: client, energy-monitor, go, golang, home-automation, iot, youless
- Language: Go
- Homepage:
- Size: 123 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Client for YouLess energy monitor
=================================
[![Latest release][latest-release-img]][latest-release-url]
[![Build status][build-status-img]][build-status-url]
[![Go Report Card][report-img]][report-url]
[![Documentation][doc-img]][doc-url]
[latest-release-img]: https://img.shields.io/github/release/roeldev/youless-client.svg?label=latest
[latest-release-url]: https://github.com/roeldev/youless-client/releases
[build-status-img]: https://github.com/roeldev/youless-client/actions/workflows/test.yml/badge.svg
[build-status-url]: https://github.com/roeldev/youless-client/actions/workflows/test.yml
[report-img]: https://goreportcard.com/badge/github.com/roeldev/youless-client
[report-url]: https://goreportcard.com/report/github.com/roeldev/youless-client
[doc-img]: https://godoc.org/github.com/roeldev/youless-client?status.svg
[doc-url]: https://pkg.go.dev/github.com/roeldev/youless-client
Package `youless` contains a client which can read from the api of a _YouLess_ device.
```sh
go get github.com/roeldev/youless-client
```
```go
import "github.com/roeldev/youless-client"
```
### API
| Method | Endpoint | Description |
|-------------------|----------|-------------------------------------|
| `GetDeviceInfo` | /d | Get device information |
| `GetMeterReading` | /e | Get meter reading |
| `GetPhaseReading` | /f | Get phase reading |
| `GetP1Telegram` | /V?p=# | Get P1 telegram |
| `GetLog` | /V | Get report of `Electricity` utility |
| | /W | Get report of `Gas` utility |
| | /K | Get report of `Water` utility |
| | /Z | Get report of `S0` utility |
### Utilities
| Const | Page | Units |
|---------------|------|-----------|
| `Electricity` | `V` | Watt, kWh |
| `S0` | `Z` | Watt, kWh |
| `Gas` | `W` | L, m3 |
| `Water` | `K` | L, m3 |
### Intervals
| Const | Interval | Param | LS110 history* | LS120 history* | Unit (electricity/s0) | Unit (gas/water) |
|------------|------------|-------|----------------|------------------|-----------------------|------------------|
| `PerMin` | 1 minute | `h` | 1 hour (2x30) | 10 hours (20x30) | watt | n/a |
| `Per10Min` | 10 minutes | `w` | 1 day (3x48) | 10 days (30x48) | watt | liter |
| `PerHour` | 1 hour | `d` | 7 days (7x24) | 70 days (70x24) | watt | liter |
| `PerDay` | 1 day | `m` | 1 year (12x31) | 1 year (12x31) | kWh | m3 (cubic meter) |
* = max. history (amount of pages x data entries)
### Units
| Const | API equiv. | Utilities |
|--------------|------------|-----------------|
| `Watt` | Watt | electricity, s0 |
| `KWh` | kWh | electricity, s0 |
| `Liter` | L | gas, water |
| `CubicMeter` | m3 | gas, water |
## Documentation
Additional detailed documentation is available at [pkg.go.dev][doc-url]
## Links
- YouLess: https://youless.nl
- YouLess API info: http://wiki.td-er.nl/index.php?title=YouLess
## Created with
## License
Copyright © 2024-2025 [Roel Schut](https://roelschut.nl). All rights reserved.
This project is governed by a BSD-style license that can be found in the [LICENSE](LICENSE) file.