cemm 0.5.1

Asynchronous Python client for the CEMM devices

Asynchronous Python client for the CEMM devices.

About

A python package with which you can read the data from your CEMM device via a local API. You can use it to read your smart meter via the P1, read your water meter and gain insight into how much your solar panels are producing.

Installation

pip install cemm

Usage

import asyncio

from cemm import CEMM


async def main() -> None:
    """Show example on getting data from your CEMM device."""
    async with CEMM(
        host="127.0.0.1",
    ) as client:
        connections = await client.all_connections()
        device = await client.device()
        smartmeter = await client.smartpanel("p1")
        watermeter = await client.watermeter("pulse-1")
        solarpanel = await client.solarpanel("mb3")
        print(connections)
        print(device)
        print(smartmeter)
        print(watermeter)
        print(solarpanel)


if __name__ == "__main__":
    asyncio.run(main())

Data

You can read the following data with this package, the power flow entities can also give a negative value.

Connections

• ID
• Type
• Alias

Device

• Model
• Mac address
• Version
• Core version

SmartMeter

• Power Flow (W)
• Gas Consumption (m3)
• Energy Tariff Period
• Energy Consumption - High / Low (kWh)
• Energy Returned - High / Low (kWh)
• Billed Energy - High / Low (kWh)

WaterMeter

• Flow (liters)
• Volume

Solarpanel

• Power Flow (W)
• Device Consumption - High / Low / Total (kWh)
• Gross Production - High / Low / Total (kWh)
• Net Production - High / Low / Total (kWh)

Contributing

This is an active open-source project. We are always open to people who want to use the code or contribute to it.

We've set up a separate document for our contribution guidelines.

Thank you for being involved! :heart_eyes:

Setting up development environment

This Python project is fully managed using the Poetry dependency manager.

You need at least:

• Python 3.9+
• Poetry

Install all packages, including all development requirements:

poetry install

Poetry creates by default an virtual environment where it installs all necessary pip packages, to enter or exit the venv run the following commands:

poetry shell
exit

Setup the pre-commit check, you must run this inside the virtual environment:

pre-commit install

Now you're all set to get started!

As this repository uses the pre-commit framework, all changes are linted and tested with each commit. You can run all checks and tests manually, using the following command:

poetry run pre-commit run --all-files

To run just the Python tests:

poetry run pytest

License

MIT License

Copyright (c) 2021-2023 Klaas Schoute

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.