juham-watermeter 0.0.7__tar.gz → 0.0.9__tar.gz

{juham_watermeter-0.0.7 → juham_watermeter-0.0.9}/CHANGELOG.rst

@@ -1,6 +1,22 @@
 Changelog
 =========
 
+
+
+[0.0.9] - June 1, 2025
+------------------------
+
+- Duplicate interval attribute, defined in both derived and the base class, fixed.
+  The default time interval increased from 30 s to 10 min. 
+
+
+
+[0.0.8] - April 18, 2025
+------------------------
+
+- Updated pyproject.toml to comply with the new SPDX expression for packaging standards
+
+
 [0.0.7] - March 09, 2025
 ------------------------
 

{juham_watermeter-0.0.7/juham_watermeter.egg-info → juham_watermeter-0.0.9}/PKG-INFO

@@ -1,32 +1,10 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: juham-watermeter
-Version: 0.0.7
+Version: 0.0.9
 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
-        
-        
+License-Expression: MIT
 Project-URL: Homepage, https://gitlab.com/juham/juham
 Project-URL: Bug Reports, https://gitlab.com/juham/juham
 Project-URL: Funding, https://meskanen.com
@@ -36,18 +14,18 @@ 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.2
+Requires-Dist: juham-core>=0.1.5
 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"
+Dynamic: license-file
 
 Watermeter plugin for Juham™
 =============================

{juham_watermeter-0.0.7 → juham_watermeter-0.0.9}/juham_watermeter/watermeter_imgdiff.py

@@ -143,10 +143,6 @@ class WaterMeterThreadImgDiff(WebCameraThread):
         # Return a value between 0.0 (identical) and 1.0 (maximally different)
         return min(max(change_area, 0.0), 1.0)
 
-    @override
-    def update_interval(self) -> float:
-        return self._interval
-
     def upload_file(self, filename: str) -> None:
         """Upload the given filename to the ftp server, if the server is configured.
 
@@ -256,7 +252,7 @@ class WaterMeterImgDiff(WebCamera):
     ]
 
     _workerThreadId: str = WaterMeterThreadImgDiff.get_class_id()
-    update_interval: float = 30
+    update_interval: float = 60 * 10 # 10 minutes
     topic = "watermeter"
     location = "home"
     camera: int = 0

{juham_watermeter-0.0.7 → juham_watermeter-0.0.9}/juham_watermeter/webcamera.py

@@ -1,6 +1,4 @@
-"""Web camera with basic image processing features.
-
-"""
+"""Web camera with basic image processing features."""
 
 import cv2
 import numpy as np
@@ -64,7 +62,6 @@ class WebCameraThread(MasterPieceThread):
 
         # Check if the webcam is opened correctly
         if not cap.isOpened():
-            print("CANNOT ACCESS THE CAMERA")
             self.error(f"Could not access the camera {self._camera}.")
             return np.zeros(
                 (1, 1, 3), dtype=np.uint8
@@ -74,7 +71,6 @@ class WebCameraThread(MasterPieceThread):
         try:
             ret, frame = cap.read()
             if not ret:
-                print("WTF, Camera failed")
                 self.error("Could not capture image.")
                 frame = np.zeros(
                     (1, 1, 3), dtype=np.uint8
@@ -142,7 +138,6 @@ class WebCamera(JuhamThread):
     _WEBCAMERA_ATTRS: list[str] = ["location", "camera"]
 
     _workerThreadId: str = WebCameraThread.get_class_id()
-    update_interval: float = 60
     location = "home"
     camera: int = 0
 

{juham_watermeter-0.0.7 → juham_watermeter-0.0.9/juham_watermeter.egg-info}/PKG-INFO

@@ -1,32 +1,10 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: juham-watermeter
-Version: 0.0.7
+Version: 0.0.9
 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
-        
-        
+License-Expression: MIT
 Project-URL: Homepage, https://gitlab.com/juham/juham
 Project-URL: Bug Reports, https://gitlab.com/juham/juham
 Project-URL: Funding, https://meskanen.com
@@ -36,18 +14,18 @@ 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.2
+Requires-Dist: juham-core>=0.1.5
 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"
+Dynamic: license-file
 
 Watermeter plugin for Juham™
 =============================

{juham_watermeter-0.0.7 → juham_watermeter-0.0.9}/juham_watermeter.egg-info/SOURCES.txt

@@ -17,4 +17,6 @@ juham_watermeter.egg-info/entry_points.txt
 juham_watermeter.egg-info/requires.txt
 juham_watermeter.egg-info/top_level.txt
 tests/__init__.py
-tests/test_watermeter.py
+tests/test_leakdetector.py
+tests/test_watermeter.py
+tests/test_webcamera.py

{juham_watermeter-0.0.7 → juham_watermeter-0.0.9}/juham_watermeter.egg-info/requires.txt

@@ -1,4 +1,4 @@
-juham-core>=0.1.2
+juham-core>=0.1.5
 numpy
 Pillow>=10.4.0
 opencv-python-headless>=4.10.0

{juham_watermeter-0.0.7 → juham_watermeter-0.0.9}/pyproject.toml

@@ -10,11 +10,11 @@ packages = ["juham_watermeter"]
 
 [project]
 name = "juham-watermeter"
-version = "0.0.7"
+version = "0.0.9"
 description = "Web-camera based watermeter for Juham"
 readme = {file = "README.rst", content-type = "text/markdown"}
 requires-python = ">=3.8"
-license = {file = "LICENSE.rst", content-type = "text/markdown"}
+license = "MIT"
 keywords = ["object-oriented", "plugin", "framework", "watermeter", "home automation"]
 authors = [
   {name = "J Meskanen", email = "juham.api@gmail.com" }
@@ -27,12 +27,11 @@ classifiers = [
   "Development Status :: 2 - Pre-Alpha",
   "Intended Audience :: Developers",
   "Topic :: Software Development",
-  "License :: OSI Approved :: MIT License",
   "Programming Language :: Python :: 3.8",
 ]
 
 dependencies = [
-  "juham-core >= 0.1.2",
+  "juham-core >= 0.1.5",
   "numpy",
   "Pillow >= 10.4.0",
   "opencv-python-headless >= 4.10.0",

juham_watermeter-0.0.9/tests/test_leakdetector.py

@@ -0,0 +1,124 @@
+import unittest
+from unittest.mock import patch, MagicMock
+from typing import Any
+from juham_watermeter.leakdetector import LeakDetector
+from masterpiece.mqtt import MqttMsg
+
+
+class MqttTestMsg:
+    def __init__(self, topic: str, payload: bytes):
+        self.topic = topic
+        self.payload = payload
+
+
+class TestLeakDetector(unittest.TestCase):
+
+    def setUp(self) -> None:
+        self.leak_detector = LeakDetector()
+        self.leak_detector.activity_timeout = 300.0  # Set timeout to 5 minutes
+
+    def test_initialization(self) -> None:
+        self.assertFalse(self.leak_detector.leak_detected)
+        self.assertEqual(self.leak_detector.zero_usage_periods_count, 0)
+        self.assertTrue(self.leak_detector.watermeter_full_topic.endswith("watermeter"))
+        self.assertTrue(self.leak_detector.motion_full_topic.endswith("motion"))
+
+    def test_to_from_dict(self) -> None:
+        state = self.leak_detector.to_dict()
+        new_instance = LeakDetector()
+        new_instance.from_dict(state)
+        self.assertEqual(new_instance.motion_topic, self.leak_detector.motion_topic)
+
+    @patch.object(LeakDetector, "subscribe")
+    def test_on_connect_success(self, mock_subscribe: MagicMock) -> None:
+        self.leak_detector.on_connect(None, None, 0, 0)
+        self.assertEqual(mock_subscribe.call_count, 2)
+
+    @patch.object(LeakDetector, "process_water_meter_data")
+    @patch.object(LeakDetector, "process_motion_data")
+    def test_on_message_routing(
+        self, mock_motion: MagicMock, mock_water: MagicMock
+    ) -> None:
+        water_payload = MqttTestMsg(
+            topic=self.leak_detector.watermeter_full_topic,
+            payload=b'{"active_lpm": 1.0, "ts": 123}',
+        )
+
+        motion_payload = MqttTestMsg(
+            topic=self.leak_detector.motion_full_topic,
+            payload=b'{"motion": true, "ts": 123}',
+        )
+
+        self.leak_detector.on_message(None, None, water_payload)
+        mock_water.assert_called_once()
+
+        self.leak_detector.on_message(None, None, motion_payload)
+        mock_motion.assert_called_once()
+
+    @patch("juham_watermeter.leakdetector.timestamp", return_value=1000.0)
+    def test_detect_activity_true(self, _: MagicMock) -> None:
+        self.leak_detector.motion_last_detected_ts = 500000.0
+        self.assertTrue(self.leak_detector.detect_activity(1000.0))
+
+    def test_detect_activity_false(self) -> None:
+        self.leak_detector.motion_last_detected_ts = 0.0
+        self.assertFalse(self.leak_detector.detect_activity(500000.0))
+
+    @patch.object(LeakDetector, "publish")
+    @patch.object(LeakDetector, "warning")
+    def test_process_water_leak_detected(
+        self, mock_warning: MagicMock, mock_publish: MagicMock
+    ) -> None:
+        self.leak_detector.motion_last_detected_ts = 0.0  # No motion
+        data = {"active_lpm": 1.2, "ts": 1000000.0}
+
+        # Process water meter data
+        self.leak_detector.process_water_meter_data(data)
+
+        # Assert leak is detected
+        self.assertTrue(self.leak_detector.leak_detected)
+        self.assertEqual(self.leak_detector.zero_usage_periods_count, 0)
+        mock_warning.assert_called_once()
+        mock_publish.assert_called_once()
+
+    @patch.object(LeakDetector, "publish")
+    def test_process_water_leak_reset(self, mock_publish: MagicMock) -> None:
+        self.leak_detector.leak_detected = True
+        self.leak_detector.zero_usage_periods_count = 61
+        data = {"active_lpm": 0.0, "ts": 2000.0}
+
+        # Process water meter data
+        self.leak_detector.process_water_meter_data(data)
+
+        # Assert leak is reset
+        self.assertFalse(self.leak_detector.leak_detected)
+        self.assertEqual(self.leak_detector.motion_last_detected_ts, 2000.0)
+        mock_publish.assert_called_once()
+
+    @patch.object(LeakDetector, "publish")
+    def test_process_water_normal_usage(self, mock_publish: MagicMock) -> None:
+        self.leak_detector.motion_last_detected_ts = 900.0
+        self.leak_detector.detect_activity = MagicMock(return_value=True)
+        data = {"active_lpm": 2.0, "ts": 1000.0}
+
+        # Process water meter data
+        self.leak_detector.process_water_meter_data(data)
+
+        # Assert no leak detected and no warning
+        self.assertFalse(self.leak_detector.leak_detected)
+        self.assertEqual(self.leak_detector.zero_usage_periods_count, 0)
+        mock_publish.assert_called_once()
+
+    def test_process_motion_data(self) -> None:
+        self.leak_detector.motion_last_detected_ts = 0.0
+        data = {"motion": True, "ts": 1337.0}
+
+        # Process motion data
+        self.leak_detector.process_motion_data(data)
+
+        # Assert last motion timestamp updated
+        self.assertEqual(self.leak_detector.motion_last_detected_ts, 1337.0)
+
+
+if __name__ == "__main__":
+    unittest.main()

juham_watermeter-0.0.9/tests/test_webcamera.py

@@ -0,0 +1,100 @@
+import unittest
+from unittest.mock import patch, MagicMock
+import numpy as np
+import cv2
+
+from typing import Any
+from juham_watermeter.webcamera import WebCameraThread
+
+
+class TestWebCameraThread(unittest.TestCase):
+    def setUp(self) -> None:
+        self.cam = WebCameraThread()
+
+    def test_init_sets_defaults(self) -> None:
+        self.assertEqual(self.cam._interval, 60)
+        self.assertEqual(self.cam._location, "unknown")
+        self.assertEqual(self.cam._camera, 0)
+        self.assertEqual(self.cam.image.shape, (1, 1, 3))
+        self.assertEqual(self.cam.image_timestamp, 0.0)
+
+    def test_init_method_sets_values(self) -> None:
+        self.cam.init(30.0, "office", 1)
+        self.assertEqual(self.cam._interval, 30.0)
+        self.assertEqual(self.cam._location, "office")
+        self.assertEqual(self.cam._camera, 1)
+
+    @patch("cv2.VideoCapture")
+    def test_capture_image_successful(self, mock_VideoCapture: MagicMock) -> None:
+        mock_cap = MagicMock()
+        mock_frame = np.ones((480, 640, 3), dtype=np.uint8)
+        mock_cap.isOpened.return_value = True
+        mock_cap.read.return_value = (True, mock_frame)
+        mock_VideoCapture.return_value = mock_cap
+
+        result = self.cam.capture_image()
+        self.assertEqual(result.shape, mock_frame.shape)
+
+    @patch("cv2.VideoCapture")
+    def test_capture_image_camera_unavailable(
+        self, mock_VideoCapture: MagicMock
+    ) -> None:
+        mock_cap = MagicMock()
+        mock_cap.isOpened.return_value = False
+        mock_VideoCapture.return_value = mock_cap
+
+        result = self.cam.capture_image()
+        self.assertTrue(np.array_equal(result, np.zeros((1, 1, 3), dtype=np.uint8)))
+
+    @patch("cv2.VideoCapture")
+    def test_capture_image_read_failure(self, mock_VideoCapture: MagicMock) -> None:
+        mock_cap = MagicMock()
+        mock_cap.isOpened.return_value = True
+        mock_cap.read.return_value = (False, None)
+        mock_VideoCapture.return_value = mock_cap
+
+        result = self.cam.capture_image()
+        self.assertTrue(np.array_equal(result, np.zeros((1, 1, 3), dtype=np.uint8)))
+
+    def test_process_image_with_empty_input(self) -> None:
+        result = self.cam.process_image(np.zeros((1, 1, 3), dtype=np.uint8))
+        self.assertEqual(result.shape, (1, 1, 3))
+
+    def test_process_image_grayscale_conversion(self) -> None:
+        dummy_img = np.ones((480, 640, 3), dtype=np.uint8) * 255
+        self.cam._expected_image_size = dummy_img.size
+        result = self.cam.process_image(dummy_img)
+        self.assertEqual(result.ndim, 2)  # grayscale image
+
+    def test_enhance_contrast_on_invalid_input(self) -> None:
+        # Input is not grayscale
+        dummy_img = np.ones((480, 640, 3), dtype=np.uint8)
+        result = self.cam.enhance_contrast(dummy_img)
+        self.assertTrue((result == dummy_img).all())
+
+    def test_enhance_contrast_output_shape(self) -> None:
+        gray_img = np.ones((480, 640), dtype=np.uint8) * 100
+        result = self.cam.enhance_contrast(gray_img)
+        self.assertEqual(result.shape, gray_img.shape)
+        self.assertEqual(result.dtype, gray_img.dtype)
+
+    def test_update_interval_returns_correct_value(self) -> None:
+        self.cam._interval = 42.0
+        self.assertEqual(self.cam.update_interval(), 42.0)
+
+    @patch("juham_watermeter.webcamera.timestamp", return_value=123.456)
+    @patch.object(
+        WebCameraThread,
+        "capture_image",
+        return_value=np.ones((480, 640, 3), dtype=np.uint8),
+    )
+    def test_update_method(self, mock_capture, mock_timestamp):
+        self.cam._expected_image_size = 480 * 640 * 3
+        result = self.cam.update()
+        self.assertTrue(result)
+        self.assertEqual(self.cam.image.shape, (480, 640, 3))
+        self.assertEqual(self.cam.image_timestamp, 123.456)
+
+
+if __name__ == "__main__":
+    unittest.main()