https://github.com/jugla/pykeyatome

library to retrieve data from Atome Key
https://github.com/jugla/pykeyatome

atome homeassistant keyatome linky

Last synced: about 1 month ago
JSON representation

library to retrieve data from Atome Key

• Host: GitHub
• URL: https://github.com/jugla/pykeyatome
• Owner: jugla
• License: mit
• Created: 2021-12-01T23:12:55.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2023-03-03T20:13:47.000Z (almost 2 years ago)
• Last Synced: 2024-11-15T21:34:41.356Z (about 2 months ago)
• Topics: atome, homeassistant, keyatome, linky
• Language: Python
• Homepage:
• Size: 71.3 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# KeyAtome PyPi

![GitHub release](https://img.shields.io/github/release/jugla/pyKeyAtome)

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)