Skip to main content

A simple API for key atome electricity consumption

Project description

KeyAtome PyPi

GitHub release

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

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


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.1.2.tar.gz (4.7 kB view hashes)

Uploaded Source

Built Distribution

pykeyatome-2.1.2-py3-none-any.whl (5.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page