juham-watermeter 0.0.5__py3-none-any.whl → 0.0.6__py3-none-any.whl

juham_watermeter/__init__.py

@@ -7,14 +7,14 @@ Web-camera based watermeter classes with leak detector
 """
 
 from .webcamera import WebCamera
-from .watermeter_ocr import WaterMeterOCR
+#from .watermeter_ocr import WaterMeterOCR
 from .watermeter_imgdiff import WaterMeterImgDiff
 from .watermeter_ts import WaterMeterTs
 from .leakdetector import LeakDetector
 
 __all__ = [
     "WebCamera",
-    "WaterMeterOCR",
+#    "WaterMeterOCR",
     "WaterMeterImgDiff",
     "WaterMeterTs",
     "LeakDetector",

juham_watermeter-0.0.6.dist-info/METADATA

@@ -0,0 +1,131 @@
+Metadata-Version: 2.2
+Name: juham-watermeter
+Version: 0.0.6
+Summary: Web-camera based watermeter for Juham
+Author-email: J Meskanen <juham.api@gmail.com>
+Maintainer-email: "J. Meskanen" <juham.api@gmail.com>
+License: MIT License
+        ===========
+        
+        Copyright (c) 2024, Juha Meskanen
+        
+        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
+        
+        
+Project-URL: Homepage, https://gitlab.com/juham/juham
+Project-URL: Bug Reports, https://gitlab.com/juham/juham
+Project-URL: Funding, https://meskanen.com
+Project-URL: Say Thanks!, http://meskanen.com
+Project-URL: Source, https://gitlab.com/juham/juham
+Keywords: object-oriented,plugin,framework,watermeter,home automation
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.8
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE.rst
+Requires-Dist: juham-core>=0.1.1
+Requires-Dist: numpy
+Requires-Dist: Pillow>=10.4.0
+Requires-Dist: opencv-python-headless>=4.10.0
+Requires-Dist: pytesseract>=0.3.13
+Provides-Extra: dev
+Requires-Dist: check-manifest; extra == "dev"
+
+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.
+
+2. 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.
+

{juham_watermeter-0.0.5.dist-info → juham_watermeter-0.0.6.dist-info}/RECORD

@@ -1,13 +1,13 @@
-juham_watermeter/__init__.py,sha256=kFVTpeSgFaXsJJ-uxxYf656Os-zVVVriEx5yAjY1XhE,412
+juham_watermeter/__init__.py,sha256=7BJ-_1Zw2FgJJ_JmL15KyBuQQC8mK1qLXxykvZxEM20,414
 juham_watermeter/leakdetector.py,sha256=IOTlvsRQ7N6zC2kADMr2XjrPMBGFnSBac-PpqixiyZE,6369
 juham_watermeter/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
 juham_watermeter/watermeter_imgdiff.py,sha256=njBhUJpAK5YH5Ob3HpHyqVCikIFtRB8mZ-lTAOObECg,12138
 juham_watermeter/watermeter_ocr.py,sha256=b9DS_7tPPDS_BHrS34x0Rfh3kTotJVMZ9tmtdz8OWz4,9105
 juham_watermeter/watermeter_ts.py,sha256=T4nKoVNpgU53CDvSIRgEbm4oy1UiqET7xfRcg_OtoPI,3246
 juham_watermeter/webcamera.py,sha256=Z7Yk_XcHC6-qk6uMVlUCFwhnRzII0la7QFCkyuFlTTI,5848
-juham_watermeter-0.0.5.dist-info/LICENSE.rst,sha256=xCUTZIYDotncT_ibKn8nNVkUGiK05hJyOWypG8G7Evk,1074
-juham_watermeter-0.0.5.dist-info/METADATA,sha256=PqB9MENkRnE1EloWPt_0eBKvjh0uW1r-PnSWKnih6aQ,1044
-juham_watermeter-0.0.5.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-juham_watermeter-0.0.5.dist-info/entry_points.txt,sha256=4KQZ-XUjd026JX-9dLAvw6e5XE6kdshWYE4pqDgeYtE,252
-juham_watermeter-0.0.5.dist-info/top_level.txt,sha256=kvbS5ION4k6uJwlJuWRNHIKPrOvpVldiWeNLWbqH2X0,17
-juham_watermeter-0.0.5.dist-info/RECORD,,
+juham_watermeter-0.0.6.dist-info/LICENSE.rst,sha256=xCUTZIYDotncT_ibKn8nNVkUGiK05hJyOWypG8G7Evk,1074
+juham_watermeter-0.0.6.dist-info/METADATA,sha256=h8vNkZxa4td0B-n0og4aCadMq1IQ33-VwK1ov9h3V_8,4865
+juham_watermeter-0.0.6.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
+juham_watermeter-0.0.6.dist-info/entry_points.txt,sha256=4KQZ-XUjd026JX-9dLAvw6e5XE6kdshWYE4pqDgeYtE,252
+juham_watermeter-0.0.6.dist-info/top_level.txt,sha256=kvbS5ION4k6uJwlJuWRNHIKPrOvpVldiWeNLWbqH2X0,17
+juham_watermeter-0.0.6.dist-info/RECORD,,

{juham_watermeter-0.0.5.dist-info → juham_watermeter-0.0.6.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.8.0)
+Generator: setuptools (75.8.2)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

juham_watermeter-0.0.5.dist-info/METADATA

@@ -1,27 +0,0 @@
-Metadata-Version: 2.2
-Name: juham-watermeter
-Version: 0.0.5
-Summary: Built-in Test plugin
-Author-email: J Meskanen <juham.api@gmail.com>
-Maintainer-email: "J. Meskanen" <juham.api@gmail.com>
-Project-URL: Homepage, https://meskanen.com
-Project-URL: Bug Reports, https://meskanen.com
-Project-URL: Funding, https://meskanen.com
-Project-URL: Say Thanks!, http://meskanen.com
-Project-URL: Source, https://meskanen.com
-Keywords: object-oriented,plugin,framework,watermeter,home automation
-Classifier: Development Status :: 2 - Pre-Alpha
-Classifier: Intended Audience :: Developers
-Classifier: Topic :: Software Development
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3.8
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-License-File: LICENSE.rst
-Requires-Dist: juham-automation>=0.0.2
-Requires-Dist: opencv-python-headless>=4.10.0
-Requires-Dist: numpy
-Requires-Dist: pytesseract>=0.3.13
-Requires-Dist: Pillow>=10.4.0
-Provides-Extra: dev
-Requires-Dist: check-manifest; extra == "dev"