mirror of
https://github.com/d3vyce/teleinfo-exporter.git
synced 2025-04-03 16:53:23 +02:00
78 lines
2.6 KiB
Markdown
78 lines
2.6 KiB
Markdown
# Teleinfo Exporter
|
|
|
|
|
|
|
|
Simple prometheus exporter for Linky teleinfo.
|
|
|
|
[Teleinfo Tasmota project](https://github.com/NicolasBernaerts/tasmota/tree/master/teleinfo)
|
|
|
|
[Grafana Dashboard](https://grafana.com/grafana/dashboards/20182-linky-teleinfo/)
|
|
|
|
## Installation
|
|
### Pip
|
|
```
|
|
python3 -m pip install teleinfo-exporter
|
|
teleinfo-exporter --help
|
|
```
|
|
|
|
### Docker
|
|
Minimal Docker compose:
|
|
```yaml
|
|
services:
|
|
web:
|
|
image: ghcr.io/d3vyce/teleinfo-exporter:latest
|
|
environment:
|
|
- BROKER_HOSTNAME=10.10.0.10
|
|
ports:
|
|
- 8000:8000
|
|
restart: always
|
|
```
|
|
|
|
#### Architectures
|
|
| Architecture | Available | Tag |
|
|
| ------------ | --------- | ----------------------- |
|
|
| x86-64 | ✅ | amd64-\<version tag\> |
|
|
| arm64 | ✅ | arm64-\<version tag\> |
|
|
|
|
#### Version Tags
|
|
| Tag | Available | Description |
|
|
| ------ | --------- | ---------------------------------------------------- |
|
|
| latest | ✅ | Latest version |
|
|
|
|
#### Variables
|
|
| Argument | Variable | Description | Default |
|
|
| ------------------- | -------------------- | ------------------ | ---------------------- |
|
|
| `--http_port` | `-e HTTP_PORT` | HTTP Port | `8000` |
|
|
| `--auth_user` | `-e AUTH_USER` | Basic Auth User | |
|
|
| `--auth_hash` | `-e AUTH_HASH` | Basic Auth Hash | |
|
|
| `--http_cert` | `-e HTTP_CERT` | HTTP Certificate | |
|
|
| `--http_key` | `-e HTTP_KEY` | HTTP Key | |
|
|
| `--broker_host` | `-e BROKER_HOST` | MQTT Host | |
|
|
| `--broker_port` | `-e BROKER_PORT` | MQTT Port | `1883` |
|
|
| `--broker_user` | `-e BROKER_USER` | MQTT User | |
|
|
| `--broker_password` | `-e BROKER_PASSWORD` | MQTT Password | |
|
|
| `--broker_topic` | `-e BROKER_TOPIC` | Teleinfo Topic | `teleinfo/tele/SENSOR` |
|
|
|
|
## Configuration
|
|
### HTTP Authentication
|
|
To generate the password hash use the following command:
|
|
```bash
|
|
htpasswd -bnBC 10 "" PASSWORD | tr -d ':'
|
|
```
|
|
|
|
### Prometheus
|
|
Config example:
|
|
```yaml
|
|
scrape_configs:
|
|
- job_name: 'Teleinfo'
|
|
scheme: https
|
|
tls_config:
|
|
ca_file: teleinfo.crt
|
|
basic_auth:
|
|
username: USER
|
|
password: PASSWORD
|
|
static_configs:
|
|
- targets:
|
|
- 192.168.1.2:8000
|
|
```
|