A simple API for key atome electricity consumption
Project description
KeyAtome PyPi
Get your energy consumption data from Atome, a Linky-compatible device made by Total/Direct-Energie. A account can have several linky. With this library, you can address them one by one
Installing
pip install pykeyatome
Use
The __main__.py
is provided to show an example of use.
4 types of function provided by client.py in AtomeClient
class:
- login : to be logged to the server
- get_user_reference : to know which linky you have addressed
- get_live : to retrieve live statistics (instant power)
- get_consumption : to retrieve the consumption (by day over 3 months)
Acknowledgments
- Thanks to k20human for the original inspiration with https://github.com/k20human/domoticz-atome
- Thanks to reverse engineering of Atome IOS APP performed by BaQs.
- This project is a fork of https://github.com/BaQs/pyAtome (seems to be unmaintained)
Breaking change
V1.2.0 Since this version PyAtomeError exception is no more used. Instead login return False if error , and live/consumption return None
V1.3.0 Login return None if error
V2.0.0 1rst implementation of TotalEnergy V2 protocol : Login, Live, Day are available.
V2.1.0 Clean APIv1 i.e. no more period (day, week, month, year)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file pykeyatome-2.1.2.tar.gz
.
File metadata
- Download URL: pykeyatome-2.1.2.tar.gz
- Upload date:
- Size: 4.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6f320a46a52ae117183088e5cd12c83edc2efe80a4f5b5fc093587b636f8253d |
|
MD5 | b1e2a354f5b7df24f78364a96c5ec32c |
|
BLAKE2b-256 | 711736666ec3a81acafc8c1ee1a8bc8be2245301b69ac729923b3929a6b1f989 |
File details
Details for the file pykeyatome-2.1.2-py3-none-any.whl
.
File metadata
- Download URL: pykeyatome-2.1.2-py3-none-any.whl
- Upload date:
- Size: 5.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 34bea06d4453f21ce358655e9238d2639ac19ae0b90399b45acff5843872508e |
|
MD5 | e12adafabff1eb2e02d1e643d4181e33 |
|
BLAKE2b-256 | b55dc9094dadb1726e7dc0de7be946cbed9fd8dc15acb130257bfdb735dcdcf8 |