pykeyatome 3.0.1

A simple API for key atome electricity consumption

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)

V3.0.0 1rst implementation of TotalEnergy V3 protocol (login) REFERENCE_ID is the ID in your TotalEnergy Profile USER_ID is something to retrieve via a dedicated script find_user_id.bash (https://github.com/jugla/pyKeyAtome/tree/master/find_user_id) You have to edit it to set your password.

V3.0.1 add return in case of success in login