https://github.com/home-assistant-ecosystem/python-volkszaehler

Python Wrapper for interacting with the Volkszahler API
https://github.com/home-assistant-ecosystem/python-volkszaehler

home-assistant iot python smart-home volkszaehler

Last synced: 25 days ago
JSON representation

Python Wrapper for interacting with the Volkszahler API

• Host: GitHub
• URL: https://github.com/home-assistant-ecosystem/python-volkszaehler
• Owner: home-assistant-ecosystem
• License: mit
• Created: 2018-08-25T10:07:35.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-04-02T21:57:57.000Z (7 months ago)
• Last Synced: 2024-10-01T05:41:30.450Z (about 1 month ago)
• Topics: home-assistant, iot, python, smart-home, volkszaehler
• Language: Python
• Homepage:
• Size: 63.5 KB
• Stars: 1
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
python-volkszaehler

===================

Python API for interacting with `Volkszaehler `_. At

the moment only the consumption of data is supported. Sorry, uploading is not

possible.

This module is not official, developed, supported or endorsed by Volkzaehler.

Installation

------------

The module is available from the `Python Package Index `_.

.. code:: bash

    $ pip3 install volkszaehler

On a Fedora-based system or a CentOS/RHEL host with EPEL.

.. code:: bash

    $ sudo dnf -y install python3-volkszaehler

For Nix or NixOS users is a package available. Keep in mind that the lastest releases might only

be present in the ``unstable`` channel.

.. code:: bash

    $ nix-env -iA nixos.python39Packages.volkszaehler

Usage

-----

The file ``example.py`` contains an example about how to use this module.

Basically it's just a wrapper to get the JSON data from a given UUID which

represents the device.

.. code:: bash

   $ http https://demo.volkszaehler.org/middleware.php/data/57acbef0-88a9-11e4-934f-6b0f9ecd95a8.json

   [...]

   {

       "data": {

           "average": 0.01,

           "consumption": 38.099,

           "from": 1584390593336,

           "max": [

               1597701600000,

               0.01

           ],

           "min": [

               1597701600000,

               0.01

           ],

           "rows": 3,

           "to": 1598106085887,

           "tuples": [

               [

                   1597701600000,

                   0.01,

                   1

               ],

               [

                   1598106085887,

                   0.01,

                   1

               ]

           ],

           "uuid": "57acbef0-88a9-11e4-934f-6b0f9ecd95a8"

       },

       "version": "0.3"

   }

License

-------

``python-volkszaehler`` is licensed under MIT, for more details check LICENSE.