Skip to content

nlamirault/kylin

Repository files navigation

Kylin -- EDF Teleinformation Python library

image

image

image

master build status

develop build status

This library is to read Teleinfo frames

Usage

For meters in the "Teleinfo Standard" mode (linky): .. code-block:: python

import kylin

teleinfo = kylin.TICStandard(timeout=2, verbose=True) teleinfo.open() teleinfo.readframe() teleinfo.close()

For meters in the "Teleinfo Historique" mode (old meters): .. code-block:: python

import kylin

teleinfo = kylin.TICHistorique(timeout=2, verbose=True) teleinfo.open() teleinfo.readframe() teleinfo.close()

Development

  • Unit tests using Tox
  • Code coverage:

Documentation

Documentation is available at: http://readthedocs.org/docs/kylin/en/latest

Contribute

  1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
  2. Fork the repository on GitHub to start making your changes to the develop branch (or branch off of it).
  3. Write a test which shows that the bug was fixed or that the feature works as expected.
  4. Send a pull request and bug the maintainer until it gets merged and published. :)

ChangeLog

A changelog is available ChangeLog.

Contact

Nicolas Lamirault <nicolas.lamirault@gmail.com>