| Name | teleinfo-exporter JSON |
| Version |
1.2.0
JSON |
| download |
| home_page | None |
| Summary | Simple prometheus exporter for Linky teleinfo. |
| upload_time | 2024-04-02 18:08:55 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2023 d3vyce Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
teleinfo
linky
prometheus
exporter
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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
```
Raw data
{
"_id": null,
"home_page": null,
"name": "teleinfo-exporter",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "teleinfo, linky, prometheus, exporter",
"author": null,
"author_email": "d3vyce <contact@d3vyce.fr>",
"download_url": "https://files.pythonhosted.org/packages/a3/ed/956dbc04d465d78be3e6840b79dcb773e98094f02522dc5359edec9290c7/teleinfo-exporter-1.2.0.tar.gz",
"platform": null,
"description": "# Teleinfo Exporter\n\n\n\nSimple prometheus exporter for Linky teleinfo.\n\n[Teleinfo Tasmota project](https://github.com/NicolasBernaerts/tasmota/tree/master/teleinfo)\n\n[Grafana Dashboard](https://grafana.com/grafana/dashboards/20182-linky-teleinfo/)\n\n## Installation\n### Pip\n```\npython3 -m pip install teleinfo-exporter\nteleinfo-exporter --help\n```\n\n### Docker\nMinimal Docker compose:\n```yaml\nservices:\n web:\n image: ghcr.io/d3vyce/teleinfo-exporter:latest\n environment:\n - BROKER_HOSTNAME=10.10.0.10\n ports: \n - 8000:8000\n restart: always\n```\n\n#### Architectures\n| Architecture | Available | Tag |\n| ------------ | --------- | ----------------------- |\n| x86-64 | \u2705 | amd64-\\<version tag\\> |\n| arm64 | \u2705 | arm64-\\<version tag\\> |\n\n#### Version Tags\n| Tag | Available | Description |\n| ------ | --------- | ---------------------------------------------------- |\n| latest | \u2705 | Latest version |\n\n#### Variables\n| Argument | Variable | Description | Default |\n| ------------------- | -------------------- | ------------------ | ---------------------- |\n| `--http_port` | `-e HTTP_PORT` | HTTP Port | `8000` |\n| `--auth_user` | `-e AUTH_USER` | Basic Auth User | |\n| `--auth_hash` | `-e AUTH_HASH` | Basic Auth Hash | |\n| `--http_cert` | `-e HTTP_CERT` | HTTP Certificate | |\n| `--http_key` | `-e HTTP_KEY` | HTTP Key | |\n| `--broker_host` | `-e BROKER_HOST` | MQTT Host | |\n| `--broker_port` | `-e BROKER_PORT` | MQTT Port | `1883` |\n| `--broker_user` | `-e BROKER_USER` | MQTT User | |\n| `--broker_password` | `-e BROKER_PASSWORD` | MQTT Password | |\n| `--broker_topic` | `-e BROKER_TOPIC` | Teleinfo Topic | `teleinfo/tele/SENSOR` |\n\n## Configuration\n### HTTP Authentication\nTo generate the password hash use the following command:\n```bash\nhtpasswd -bnBC 10 \"\" PASSWORD | tr -d ':'\n```\n\n### Prometheus\nConfig example:\n```yaml\nscrape_configs:\n - job_name: 'Teleinfo'\n scheme: https\n tls_config:\n ca_file: teleinfo.crt\n basic_auth:\n username: USER\n password: PASSWORD\n static_configs:\n - targets:\n - 192.168.1.2:8000\n```\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 d3vyce Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Simple prometheus exporter for Linky teleinfo.",
"version": "1.2.0",
"project_urls": {
"Changelog": "https://github.com/d3vyce/teleinfo-exporter/blob/main/CHANGELOG.md",
"Homepage": "https://github.com/d3vyce/teleinfo-exporter",
"Issues": "https://github.com/d3vyce/teleinfo-exporter/issues",
"Repository": "https://github.com/d3vyce/teleinfo-exporter.git"
},
"split_keywords": [
"teleinfo",
" linky",
" prometheus",
" exporter"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5ec4b2c088ece7953e35d60207fa0204d40266cb77dfc66f136e2e6eb07ec3a1",
"md5": "e5594b6c16e6210b13db8492ee9caad3",
"sha256": "9cf009e8c921b6e36e8c999246322b0d7ea73357651dff262b09c9e187c82524"
},
"downloads": -1,
"filename": "teleinfo_exporter-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e5594b6c16e6210b13db8492ee9caad3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6839,
"upload_time": "2024-04-02T18:08:54",
"upload_time_iso_8601": "2024-04-02T18:08:54.847671Z",
"url": "https://files.pythonhosted.org/packages/5e/c4/b2c088ece7953e35d60207fa0204d40266cb77dfc66f136e2e6eb07ec3a1/teleinfo_exporter-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a3ed956dbc04d465d78be3e6840b79dcb773e98094f02522dc5359edec9290c7",
"md5": "c1780adc72e1887d0e69d198360cf5ca",
"sha256": "08eb7fd5cf3bf92d0be53b0a18d0fa2de53b12e0fcf76f7685a25dd7ca1ff860"
},
"downloads": -1,
"filename": "teleinfo-exporter-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "c1780adc72e1887d0e69d198360cf5ca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 6427,
"upload_time": "2024-04-02T18:08:55",
"upload_time_iso_8601": "2024-04-02T18:08:55.953897Z",
"url": "https://files.pythonhosted.org/packages/a3/ed/956dbc04d465d78be3e6840b79dcb773e98094f02522dc5359edec9290c7/teleinfo-exporter-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-02 18:08:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "d3vyce",
"github_project": "teleinfo-exporter",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "teleinfo-exporter"
}
