ekmixon/python-p1monitor

🖥️ Asynchronous Python client for the P1 Monitor

Python - P1 Monitor API Client

Asynchronous Python client for the P1 Monitor API.

About

There are many ways to read the serial port (P1) of your smart meter and what you do with the data that comes out. With this python library your platform can read P1 Monitor via the API and use the data for example for an integration in Home Assistant.

Installation

pip install p1monitor

Usage

import asyncio

from p1monitor import P1Monitor


async def main():
    """Show example on getting P1 Monitor data."""
    async with P1Monitor(host="example_host") as client:
        smartmeter = await client.smartmeter()
        print(smartmeter)


if __name__ == "__main__":
    loop = asyncio.get_event_loop()
    loop.run_until_complete(main())

Data

There is a lot of data that you can read via the API:

SmartMeter

• Gas Consumption
• Power Consumption / Production
• Energy Consumption Low/High
• Energy Production Low/High
• Energy Tariff Period

Phases

• Voltage phases L1/2/3
• Current Phases L1/2/3
• Power consumed phases L1/2/3
• Power Produced phases L1/2/3

Settings

• Gas Consumption Price
• Energy Consumption Price Low/High
• Energy Production Price Low/High

Setting up development environment

This Python project is fully managed using the Poetry dependency manager. But also relies on the use of NodeJS for certain checks during development.

You need at least:

• Python 3.7+
• Poetry

To install all packages, including all development requirements:

poetry install

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