volkszaehler 0.2.2

Python Wrapper for interacting with the Volkszahler API.

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.

$ pip3 install volkszaehler

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

$ 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.

$ 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.

$ 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"
}

Development

For development is recommended to use a venv.

$ python3 -m venv .
$ source bin/activate
$ python3 setup.py develop

License

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