https://github.com/nlamirault/kylin
EDF Teleinformation Python library
https://github.com/nlamirault/kylin
edf teleinfo
Last synced: 11 months ago
JSON representation
EDF Teleinformation Python library
- Host: GitHub
- URL: https://github.com/nlamirault/kylin
- Owner: nlamirault
- License: apache-2.0
- Created: 2017-10-05T12:00:33.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-03-16T22:04:31.000Z (about 3 years ago)
- Last Synced: 2024-08-09T15:52:26.056Z (almost 2 years ago)
- Topics: edf, teleinfo
- Language: Python
- Homepage:
- Size: 116 KB
- Stars: 9
- Watchers: 6
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- Changelog: ChangeLog.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Kylin -- EDF Teleinformation Python library
=================================================
.. image:: https://badge.fury.io/py/kylin.png
:target: http://badge.fury.io/py/kylin
.. image:: https://coveralls.io/repos/nlamirault/kylin/badge.png?branch=master
:target: https://coveralls.io/r/nlamirault/kylin?branch=master
.. image:: https://gemnasium.com/nlamirault/kylin.png
:target: https://gemnasium.com/nlamirault/kylin
.. image:: https://gitlab.com/nicolas-lamirault/kylin/badges/master/build.svg
:target: https://gitlab.com/nicolas-lamirault/kylin/commits/master
:alt: master build status
.. image:: https://gitlab.com/nicolas-lamirault/kylin/badges/develop/build.svg
:target: https://gitlab.com/nicolas-lamirault/kylin/develop/master
:alt: 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-block:: bash
$ tox -r
* Code coverage:
.. code-block:: bash
$ tox -r -ecoverage
Documentation
-------------
Documentation is available at: http://readthedocs.org/docs/kylin/en/latest
Contribute
----------
#. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
#. Fork `the repository`_ on GitHub to start making your changes to the **develop** branch (or branch off of it).
#. Write a test which shows that the bug was fixed or that the feature works as expected.
#. Send a pull request and bug the maintainer until it gets merged and published. :)
ChangeLog
---------
A changelog is available ChangeLog_.
Contact
-------
Nicolas Lamirault
.. _Teleinfo: http://www.enedis.fr/sites/default/files/Enedis-NOI-CPT_54E.pdf
.. _Tox: http://tox.testrun.org
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
.. _Sphinx: http://sphinx-doc.org
.. _`the repository`: http://github.com/nlamirault/kylin
.. _ChangeLog: http://github.com/nlamirault/kylin/blob/master/ChangeLog.md