Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nioc/linky-collector
Linky collector is a PHP script for requesting measures from Linky communicating meter.
https://github.com/nioc/linky-collector
enedis grafana grafana-dashboard influxdb linky
Last synced: 13 days ago
JSON representation
Linky collector is a PHP script for requesting measures from Linky communicating meter.
- Host: GitHub
- URL: https://github.com/nioc/linky-collector
- Owner: nioc
- License: agpl-3.0
- Created: 2019-06-10T20:17:54.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-04-19T19:11:54.000Z (over 1 year ago)
- Last Synced: 2024-10-27T20:12:07.916Z (2 months ago)
- Topics: enedis, grafana, grafana-dashboard, influxdb, linky
- Language: PHP
- Homepage:
- Size: 243 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Linky collector
[](https://www.gnu.org/licenses/agpl-3.0)
[](https://github.com/nioc/linky-collector/releases/latest)
[](https://www.codacy.com/app/nioc/linky-collector)
Linky collector is a PHP script for requesting measures from Linky communicating meter.
## Update July 2020
Unfortunately, this script does not work anymore since Enedis has changed authentication mechanism without providing public API.
However, you can still collect your consumption by downloading hourly CSV file from Enedis portal and use workaround script `php index-file.php name_of_your_downloaded_file.csv`.
## Key features
- Automatic script (can be used with cron for example),
- Initialization step (providing a start date and wait for the magic),
- Store measures into an InfluxDB database,
- Explore data with Grafana.
## Installation
### Enedis/Linky
You need to allow consumption recording on [Enedis Portal](https://espace-client-particuliers.enedis.fr/group/espace-particuliers/courbe-de-charge). It may take a few weeks before record is effective.
### Script
Download this project and extract files to directory of your choice.
Configure your Enedis credentials and off-peak periods (depends option subscribed) in `config.php`.
### Dependencies
Install dependencies with [composer](https://getcomposer.org/): `composer install`.
### InfluxDB
You need [InfluxDB](https://docs.influxdata.com/influxdb/v1.7/introduction/installation/) installed.
Default values are ok, but configuration can be changed (see [docs](https://docs.influxdata.com/influxdb/v1.7/administration/config/)).
Script will create database.
### Grafana
You need [Grafana](https://grafana.com/grafana/download) installed.
You also need the following plugins:
- [Pie Chart](https://grafana.com/plugins/grafana-piechart-panel),
- [Carpet plot](https://grafana.com/plugins/petrslavotinek-carpetplot-panel).
```bash
grafana-cli plugins install grafana-piechart-panel
grafana-cli plugins install petrslavotinek-carpetplot-panel
service grafana-server restart
```
Create InfluxDB data source, mainly name and influxDB URL, for example: `http://localhost:8086` (Configuration / Data sources / Add).
Import JSON file (depends option subscribed) from Grafana GUI (Create / Import):
- With [off peak period(s)](dashboard-peak.json) or
- [Single tariff](dashboard-simple.json).
Configure dashboard variables (Dashboard / Settings / Variables):
- `datasource` = the data source name you set up,
- `offPeakCost` = off-peak pricing (€/kWh),
- `peakCost` = peak pricing (€/kWh),
- `simpleCost` = single rate pricing (€/kWh),
- `timezone` = your timezone example: `Europe/Paris` (used in day aggregations).
## Usage
### Initialization
In order to collect oldest measures, script accepts a start date (YYYY-MM-DD) as an optional argument.
Open a shell, go in script directory and execute it: `php -f index.php 2018-12-31`.
### Scheduling repeated executions
Add to your scheduler (cron for exemple) following command (change the path `/usr/local/bin/linky-collector/` according to your installation):
```shell
# /etc/cron.d/linky-collect: crontab fragment for requesting Linky measures
# Requesting Linky measures and storing to database every day at 02:45
45 2 * * * root php -f /usr/local/bin/linky-collector/index.php >> /var/log/syslog 2>&1
```
### Logs
Log settings can be found in `config.xml` file.
In production mode, the default configuration use a file (`linky-collect.log`) for logging at level `INFO`.
For debugging, you can output to console and set a more verbose level (`DEBUG` or even `TRACE`) by overriding the `root` section:
```xml
```
## Versioning
This project is maintained under the [semantic versioning](https://semver.org/) guidelines.
See the [releases](https://github.com/nioc/linky-collector/releases) on this repository for changelog.
## Contributing
Pull requests are welcomed.
## Credits
- **[Nioc](https://github.com/nioc/)** - _Initial work_
See also the list of [contributors](https://github.com/nioc/linky-collector/contributors) to this project.
This project is powered by the following components:
- [influxdb-php](https://github.com/influxdata/influxdb-php) (MIT)
- [Apache log4php](http://logging.apache.org/log4php/) (Apache License)
## License
This project is licensed under the GNU Affero General Public License v3.0 - see the [LICENSE](LICENSE.md) file for details.