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-1.5.1.tar.gz
(5.4 kB
view details)
Built Distribution
File details
Details for the file pykeyatome-1.5.1.tar.gz
.
File metadata
- Download URL: pykeyatome-1.5.1.tar.gz
- Upload date:
- Size: 5.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.9.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3fccb68e897edc551f40b9e48998ecaae77249423c31f8f1b0c50673c8dfc0e3 |
|
MD5 | e096283719f0423d86b0408635cd97af |
|
BLAKE2b-256 | 3fe4dd9b5fd7455cdcf9e7eefd53dc7f711a25e9e64a0c4ecbc8f600df56f7b3 |
File details
Details for the file pykeyatome-1.5.1-py3-none-any.whl
.
File metadata
- Download URL: pykeyatome-1.5.1-py3-none-any.whl
- Upload date:
- Size: 5.5 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 | c96583c21cd34f51e4e35e6829387e77bce9918008d9c9de9ad6a2904e2f7884 |
|
MD5 | e9433e37e8ca51f9298e24b30dd23a06 |
|
BLAKE2b-256 | 0b3b42ea446d9a1a963db6f90b098e15ff9baff50c70e47f9e2083b3137ed5a6 |