Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve README #6

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve README #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Script to export Linky consumption in JSON format !

## What is this?
This is a script based on Linkindle, created by Outadoc (https://github.com/outadoc/linkindle), allowing to get consumption from Enedis' website (https://espace-client-connexion.erdf.fr/auth/UI/Login?realm=particuliers), through API.
This generates JSON files ready to be plotted with Highcharts for example.
This is a script based on Linkindle, created by Outadoc (https://github.com/outadoc/linkindle), allowing to get power consumption from Enedis' website (https://espace-client-connexion.erdf.fr/auth/UI/Login?realm=particuliers), through the API.

It generates JSON files ready to be plotted with Highcharts for example.

## Output
The script will generate 4 JSON files for :
Expand All @@ -15,17 +16,15 @@ The script will generate 4 JSON files for :
## Requirements
This script requires the use of Python 3 with the following dependencies:

- dateutil
- requests
- json
- dateutil (`pip3 install python-dateutil`)
- requests (`pip3 install requests`)

## Usage
In "gen_json.sh" script, set up environment variables containing your Enedis email and password.
Don't forget to uncomment the following lines:
In the `gen_json.sh` script, set up environment variables containing your Enedis credentials by uncommenting and editing the following lines:

export LINKY_USERNAME="[email protected]"
export LINKY_PASSWORD="password"

Then, just run `./gen_json.sh` to generate the JSON files. A log will be saved in `linky.log`.

Then, just run "gen_json.sh" script to generate the JSON files.
Fell free to add a cron to get ENEDIS data periodically.