Add doctests, general cleanup.

[python_utils.git] / camera_utils.py

diff --git a/camera_utils.py b/camera_utils.py
index 83664fdc1bad65cb5e9ee4f70de4161df4fad832..66ef6ac8e4d77f76f1775569f808f1ab57839176 100644 (file)
--- a/camera_utils.py
+++ b/camera_utils.py
@@ -32,7 +32,7 @@ class SanityCheckImageMetadata(NamedTuple):
 
 
 def sanity_check_image(hsv: np.ndarray) -> SanityCheckImageMetadata:
-    """See if a Blue Iris image is bad and infrared."""
+    """See if a Blue Iris or Shinobi image is bad and infrared."""
     def is_near(a, b) -> bool:
         return abs(a - b) < 3
 
@@ -65,20 +65,26 @@ def fetch_camera_image_from_video_server(
     camera_name = camera_name.replace(".house", "")
     camera_name = camera_name.replace(".cabin", "")
     url = f"http://10.0.0.226:8080/Umtxxf1uKMBniFblqeQ9KRbb6DDzN4/jpeg/GKlT2FfiSQ/{camera_name}/s.jpg"
+    logger.debug(f'Fetching image from {url}')
     try:
         response = requests.get(url, stream=False, timeout=10.0)
         if response.ok:
             raw = response.content
             logger.debug(f'Read {len(response.content)} byte image from HTTP server')
             tmp = np.frombuffer(raw, dtype="uint8")
-            logger.debug(f'Translated raw content into {tmp.shape} {type(tmp)} with element type {type(tmp[0])}.')
+            logger.debug(
+                f'Translated raw content into {tmp.shape} {type(tmp)} with element type {type(tmp[0])}.'
+            )
             jpg = cv2.imdecode(tmp, cv2.IMREAD_COLOR)
-            logger.debug(f'Decoded into {jpg.shape} jpeg {type(jpg)} with element type {type(jpg[0][0])}')
+            logger.debug(
+                f'Decoded into {jpg.shape} jpeg {type(jpg)} with element type {type(jpg[0][0])}'
+            )
             hsv = cv2.cvtColor(jpg, cv2.COLOR_BGR2HSV)
-            logger.debug(f'Converted JPG into HSV {hsv.shape} HSV {type(hsv)} with element type {type(hsv[0][0])}')
+            logger.debug(
+                f'Converted JPG into HSV {hsv.shape} HSV {type(hsv)} with element type {type(hsv[0][0])}'
+            )
             (_, is_bad_image) = sanity_check_image(hsv)
             if not is_bad_image:
-                logger.debug(f"Got a good image from {url}")
                 return raw
     except Exception as e:
         logger.exception(e)
@@ -88,7 +94,16 @@ def fetch_camera_image_from_video_server(
     return None
 
 
-def blue_iris_camera_name_to_hostname(camera_name: str) -> str:
+def camera_name_to_hostname(camera_name: str) -> str:
+    """Map a camera name to a hostname
+
+    >>> camera_name_to_hostname('driveway')
+    'driveway.house'
+
+    >>> camera_name_to_hostname('cabin_driveway')
+    'driveway.cabin'
+
+    """
     mapping = {
         "driveway": "driveway.house",
         "backyard": "backyard.house",
@@ -108,8 +123,9 @@ def fetch_camera_image_from_rtsp_stream(
     camera_name: str, *, width: int = 256
 ) -> Optional[bytes]:
     """Fetch the raw webcam image straight from the webcam's RTSP stream."""
-    hostname = blue_iris_camera_name_to_hostname(camera_name)
+    hostname = camera_name_to_hostname(camera_name)
     stream = f"rtsp://camera:IaLaIok@{hostname}:554/live"
+    logger.debug(f'Fetching image from RTSP stream {stream}')
     try:
         cmd = [
             "/usr/bin/timeout",
@@ -144,7 +160,9 @@ def fetch_camera_image_from_rtsp_stream(
 def _fetch_camera_image(
     camera_name: str, *, width: int = 256, quality: int = 70
 ) -> RawJpgHsv:
-    """Fetch a webcam image given the camera name."""
+    """Fetch a webcam image given the camera name.
+
+    """
     logger.debug("Trying to fetch camera image from video server")
     raw = fetch_camera_image_from_video_server(
         camera_name, width=width, quality=quality
@@ -175,4 +193,10 @@ def fetch_camera_image(
     try:
         return _fetch_camera_image(camera_name, width=width, quality=quality)
     except exceptions.TimeoutError:
+        logger.warning('Fetching camera image operation timed out.')
         return RawJpgHsv(None, None, None)
+
+
+if __name__ == '__main__':
+    import doctest
+    doctest.testmod()