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.3.tar.gz (28.0 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.3-py3-none-any.whl (14.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for juham_watermeter-0.1.3.tar.gz
Algorithm Hash digest
SHA256 cf6de1e0fa02e8c4d4c8d7e236d0c756e38f7b01f30cc2f3db86d989b52149c4
MD5 695eeb1998e16ebdbfa44479c3e32b1e
BLAKE2b-256 980b343009f943fa324bb212542403d3a434628a0ed8e2e9c8afaec4f92e7387

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for juham_watermeter-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 103eacad1ce651bb550d727714b98c50213018df62a18fc94bda1a22c9219233
MD5 e4c7d4dd02020b4f522dadffbed314c9
BLAKE2b-256 ed44b13723ef6f104538ce806af76e4b37ad5652f33e236ba84f67fd3423ebb3

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