Skip to main content

Web-camera based watermeter for Juham

Project description

Watermeter plugin for Juham™

Description

A web camera and AI-based water meter solution for Juham™ home automation.

This package includes two different water meter implementations:

  • A simple class that compares subsequent images to measure differences. The greater the difference between images, the more the arrows and digits on the water meter have changed, indicating water consumption. This solution also uploads the images to a specified FTP site when water consumption is detected, allowing homeowners to inspect the water meter visually. While this solution doesn’t provide exact water consumption readings, it is highly reliable for detecting leaks. Just ensure that spiders or other potentially moving objects don't obstruct the camera's view of the water meter.

  • Tesseract OCR and OpenCV solution for reading and interpreting water meter digits. This class requires further work to be truly useful. My Raspberry Pi didn't have enough disk space, so I decided to set this aside for now.

.. image:: _static/images/watermeter_diff.png :alt: Web camera based water meter leak detector based on comparison of subsequent images :width: 640px :align: center

Getting Started

To install:

.. code-block:: bash

  pip install juham-watermeter

Which installs everything needed for reading water meters with the simple image comparison based solution.

If you want to play with the Tesseract OCR and OpenCV solution for reading and interpreting water meter digits, please read on.

Installing Tesseract OCR to read the digits:

.. code-block:: bash

  sudo apt install tesseract-ocr

If you are on Windows, visit the Tesseract GitHub repository, or Download a precompiled Windows binary from UB Mannheim.

  1. Install

    .. code-block:: bash

    pip install juham-watermeter

  2. Configure

To adjust update interval and other attributes edit WaterMeter.json configuration file.

Note about OpenCV and contributors

The Python coverage failed with the No source for code: 'juham_watermeter\config-3.py' error, when all the other Python projects with precisely identical structures worked fine. Traced down the bug to opencv package, and added a .coveragerc file with the following content:

.. code-block:: bash

[run]
omit = 
  config.py
  config-3.py

as a solution. This will of course blow up sooner or later, when some OpenCV developer decides to rename those files.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

juham_watermeter-0.1.6.tar.gz (16.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

juham_watermeter-0.1.6-py3-none-any.whl (14.7 kB view details)

Uploaded Python 3

File details

Details for the file juham_watermeter-0.1.6.tar.gz.

File metadata

  • Download URL: juham_watermeter-0.1.6.tar.gz
  • Upload date:
  • Size: 16.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for juham_watermeter-0.1.6.tar.gz
Algorithm Hash digest
SHA256 79ee01444f7bafae20139d2049dc9f9a43a31e4fbee59f86857db89f55e80336
MD5 863d026bd42d37ec50409ec3aede88c3
BLAKE2b-256 67bc1103241fedc02eb810c7850304619b935fec06f66e67a081e7ce0e6cdf11

See more details on using hashes here.

File details

Details for the file juham_watermeter-0.1.6-py3-none-any.whl.

File metadata

File hashes

Hashes for juham_watermeter-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 be2fc2ae24207db38a7498d2abfd787654097cbe89c381f385a400d5137206cc
MD5 58218bd4f77c351edfee39fd3916bb67
BLAKE2b-256 402bbb10aa4ba94b0e4ab0b4330b47d0fed1ed5d16064ebbf64fc06bd7b2231f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page