Package: p1monitor
Asynchronous Python client for the P1 Monitor API.AboutThere 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 readP1 Monitorvia the API and use the data for example for an integration inHome Assistant.Installationpipinstallp1monitorUsageimportasynciofromp1monitorimportP1Monitorasyncdefmain():"""Show example on getting P1 Monitor data."""asyncwithP1Monitor(host="example_host")asclient:smartmeter=awaitclient.smartmeter()watermeter=awaitclient.watermeter()settings=awaitclient.settings()phases=awaitclient.phases()print(smartmeter)print(watermeter)print(settings)print(phases)if__name__=="__main__":asyncio.run(main())DataThere is a lot of data that you can read via the API:SmartMeterGas ConsumptionPower Consumption / ProductionEnergy Consumption Low/HighEnergy Production Low/HighEnergy Tariff PeriodPhasesVoltage phases L1/2/3Current Phases L1/2/3Power consumed phases L1/2/3Power Produced phases L1/2/3WaterMeterNOTE:WaterMeter is only available when you run version 1.1.0 or higher due the use of the new v2 API url.Day Consumption (liters)Total Consumption (m3)Day Pulse countSettingsGas Consumption PriceEnergy Consumption Price Low/HighEnergy Production Price Low/HighContributingThis 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 ourcontribution guidelines.Thank you for being involved! :heart_eyes:Setting up development environmentThe simplest way to begin is by utilizing theDev Containerfeature of Visual Studio Code or by opening a CodeSpace directly on GitHub.
By clicking the button below you immediately start a Dev Container in Visual Studio Code.This Python project relies onPoetryas its dependency manager,
providing comprehensive management and control over project dependencies.You need at least:Python 3.11+PoetryInstall all packages, including all development requirements:poetryinstallPoetry creates by default an virtual environment where it installs all
necessary pip packages, to enter or exit the venv run the following commands:poetryshellexitSetup the pre-commit check, you must run this inside the virtual environment:pre-commitinstallNow you're all set to get started!As this repository uses thepre-commitframework, all changes
are linted and tested with each commit. You can run all checks and tests
manually, using the following command:poetryrunpre-commitrun--all-filesTo run just the Python tests:poetryrunpytestLicenseMIT LicenseCopyright (c) 2021-2023 Klaas SchoutePermission 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.