Skip to main content

A library to interact with eneco's "Toon" smart meter via their official api https://api.toon.eu

Project description

A library to interact with eneco’s “Toon” smart meter via their official api https://api.toon.eu

Development Workflow

The workflow supports the following steps

  • lint

  • test

  • build

  • document

  • upload

  • graph

These actions are supported out of the box by the corresponding scripts under _CI/scripts directory with sane defaults based on best practices. Sourcing setup_aliases.ps1 for windows powershell or setup_aliases.sh in bash on Mac or Linux will provide with handy aliases for the shell of all those commands prepended with an underscore.

The bootstrap script creates a .venv directory inside the project directory hosting the virtual environment. It uses pipenv for that. It is called by all other scripts before they do anything. So one could simple start by calling _lint and that would set up everything before it tried to actually lint the project

Once the code is ready to be delivered the _tag script should be called accepting one of three arguments, patch, minor, major following the semantic versioning scheme. So for the initial delivery one would call

$ _tag –minor

which would bump the version of the project to 0.1.0 tag it in git and do a push and also ask for the change and automagically update HISTORY.rst with the version and the change provided.

So the full workflow after git is initialized is:

  • repeat as necessary (of course it could be test - code - lint :) ) * code * lint * test

  • commit and push

  • develop more through the code-lint-test cycle

  • tag (with the appropriate argument)

  • build

  • upload (if you want to host your package in pypi)

  • document (of course this could be run at any point)

Important Information

This template is based on pipenv. In order to be compatible with requirements.txt so the actual created package can be used by any part of the existing python ecosystem some hacks were needed. So when building a package out of this do not simple call

$ python setup.py sdist bdist_egg

as this will produce an unusable artifact with files missing. Instead use the provided build and upload scripts that create all the necessary files in the artifact.

Project Features

  • Reads values for gas, electric, temperature.

  • Identifies connected hue lights and fibaro smartplugs

  • Can read and set temperature and thermostat state

  • Can turn lights or plugs on, off or toggle their state

  • Can get consumption values from fibaro plugs

  • More …

History

0.0.1 (09-12-2017)

  • First code creation

3.0.2 (16-02-2019)

  • Ported to the latest template. Fixed an issue with the monkey patched requests get method assuming no other process running. Refactored some code to 3.7 specific.

3.0.3 (16-02-2019)

  • Small template cleanup

3.0.4 (16-02-2019)

  • fixed float representation for temperature

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

toonapilib-3.0.4.tar.gz (62.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

toonapilib-3.0.4-py3.7.egg (63.1 kB view details)

Uploaded Egg

File details

Details for the file toonapilib-3.0.4.tar.gz.

File metadata

  • Download URL: toonapilib-3.0.4.tar.gz
  • Upload date:
  • Size: 62.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.0

File hashes

Hashes for toonapilib-3.0.4.tar.gz
Algorithm Hash digest
SHA256 78ad7e78cdc8665a2ca8256d53979e3b595bb76a594c79a96926a0a5ed250c2e
MD5 fcb5c0f290b6532e8a9dbd2e1ad32fe5
BLAKE2b-256 77dc1c2a4ccb926488d1d29edc66c37605c1b279399aee1e31938a209224433d

See more details on using hashes here.

File details

Details for the file toonapilib-3.0.4-py3.7.egg.

File metadata

  • Download URL: toonapilib-3.0.4-py3.7.egg
  • Upload date:
  • Size: 63.1 kB
  • Tags: Egg
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.0

File hashes

Hashes for toonapilib-3.0.4-py3.7.egg
Algorithm Hash digest
SHA256 5653316aa098f3a96b6ab0b07e51781d60ee0461ba6bbe8a42dc649feed566fb
MD5 e5c490d7c66b5807ef5f2a56cf245909
BLAKE2b-256 27ad29e9827f978560308819413f00e881d777efb016f52a068417707e4881bb

See more details on using hashes here.

Supported by

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