Repository navigation
Plugin water consumption counter
Estimates and reports water consumption from configured station flow rates and master-station runtime.
| Item | Value |
|---|---|
| Version | 1.2.7 |
| Category | Irrigation and water management |
| Author | Martin Pihrt |
| License | GPL-3.0 |
| OSPy |
3.0.296 or newer |
| Python |
3.8 or newer |
| Permissions |
email, files, system
|
| Hardware | No dedicated hardware requirement declared |
| Dependencies | None |
| Python/OS packages | None |
| Interfaces | Mobile API v1 |
| Source | Open the plug-in directory |
Estimates and reports water consumption from configured station flow rates and master-station runtime.
Version 1.2.3 refreshes the settings overview automatically and checkpoints an active master counter every ten seconds, so a missing final OFF event can lose at most the uncheckpointed tail instead of the complete run.
Version 1.2.2 queues master start and stop processing in the plug-in worker so counter persistence and optional SMTP delivery can never delay OSPy's physical outputs or scheduler. Version 1.2.1 prevents a completed-run report from displaying a misleading zero master consumption while the master OFF counter update is still pending. The report-only fallback is calculated from the completed station duration and configured master flow and never modifies the saved counters.
Tested in Python 3+
This plugin read Water consumption on master station or second master station. Total sum is the calculated as run of the main (or second) station per second. This is not an actual flow meter (physical flow sensor). Used for an overview of water consumption.
The plug-in includes a manifest for compatibility and permission checks, keeps its master-station signal subscriptions in the shared OSPy lifecycle, disconnects them during shutdown, and reports counters, events and e-mail state through the Diagnostics health interface.
Version 1.2.0 makes the live Home values unambiguous. An active main or second main station shows the total estimated consumption since the last counter reset, including the current run. Every active ordinary station configured to use that master shows its increasing estimated consumption for the current run. The configured flow is no longer appended to the station value. Values below 1000 liters are displayed in liters and larger values in cubic meters. A station without an assigned master does not display an estimated value. Home updates the values automatically; Options > System > Show plug-ins on home must be enabled.
The read-only completed-run report is available to notification plug-ins. It contains the applicable master, consumption of its complete current or just-finished activation, the current total master counter and consumption of the specific completed station. The master and station values can differ when master delays or consecutive stations extend the master activation.
-
Liter/sec master: The amount of water per second for the main station.
-
Liter/sec second master: The amount of water per second for the second main station.
-
Last counter reset: The measured value for the main and sub main stations is measured from that time.
-
Check Send email: If checked send email notification plugin sends e-mail water consumption. For this function required e-mail notification plugin with all setup in plugin.
-
Button for counter reset: The button deletes the total measured consumption values.
The calculation remains an estimate based on configured liters per second and running time. It does not read or verify a physical water meter.
The following notes are generated from the help page shipped with this plug-in. Field names are also explained directly in the OSPy settings page.
This plugin read Water consumption on master station or second master station.
Total sum is the calculated as run of the main (or second) station.
This is not an actual flow meter (physical flow sensor).
Used for an overview of water consumption.
When plug-in data on Home is enabled, an active master station shows total estimated consumption since the last reset, including the current run.
Every running station assigned to a master shows its increasing estimated consumption for the current run. Stations without an assigned master show no estimated value.
Values below 1000 liters are displayed in liters; larger values are displayed in cubic meters.
Check OSPy → Diagnostics first and remove passwords, tokens, private addresses and other secrets before sharing logs. Report reproducible plug-in problems in the OSPy-plugins issue tracker.
Start
Reference
Catalog sections