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(period) : to retrieve the consumption since a period (day/week/month/year)
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
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
pykeyatome-2.0.0.tar.gz
(5.3 kB
view details)
Built Distribution
File details
Details for the file pykeyatome-2.0.0.tar.gz
.
File metadata
- Download URL: pykeyatome-2.0.0.tar.gz
- Upload date:
- Size: 5.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.9.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d7de88c22625e13a6a7f274318f7da4c987e1d12c9ce43cd6313b876490b16f2 |
|
MD5 | 39e39c085ef9b7a6658dc24ad3b362ac |
|
BLAKE2b-256 | 54ff06f0f012d773962599fefaa8114515822f51e7f1ac4f919abc4b0b0c920f |
File details
Details for the file pykeyatome-2.0.0-py3-none-any.whl
.
File metadata
- Download URL: pykeyatome-2.0.0-py3-none-any.whl
- Upload date:
- Size: 5.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.9.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 15c8d968505ed6b474cc983b531c4d8293ad5f4f2a0764d0ec065dde82bd9649 |
|
MD5 | 4a8754ee3b0f49f183145a7cf943d438 |
|
BLAKE2b-256 | b8fc155b99f602da702be7934ca5e1d3239c17010a13d1b6af6fd84796731983 |