Capture tidy up (#117)

* Tidy up capture code.

Better naming and double check work actually needs doing.

* Tidy up capture code.

Better naming and double check work actually needs doing.

* Tidy up capture code.

Better naming and double check work actually needs doing.

* Tidy up capture code.

Better naming and double check work actually needs doing.

Author: twrecked

changelog

@@ -1,3 +1,7 @@
+0.8.0b7:
+  Fix missing event issue.
+  Tidy capture code.
+  Specify Python 3
 0.8.0b6: Simplify state checking; bring API up to date and remove deprecated
     calls
   Add back the packet docs.

pyaarlo.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 
 from pyaarlo.main import main_func
 

pyaarlo/__init__.py

@@ -45,7 +45,7 @@
 
 _LOGGER = logging.getLogger("pyaarlo")
 
-__version__ = "0.8.0b6"
+__version__ = "0.8.0b7"
 
 
 class PyArlo(object):

pyaarlo/camera.py

@@ -146,7 +146,7 @@ def _dump_activities(self, msg):
         )
 
     # Media library has updated, reload today's events.
-    def _update_media(self):
+    def _update_from_media_library(self):
         self.debug("reloading cache for " + self._name)
         count, videos = self._arlo.ml.videos_for(self)
         if videos:
@@ -163,7 +163,7 @@ def _update_media(self):
             self._cache_count = count
             self._cached_videos = videos
 
-        # update latest video details
+        # Update latest video details.
         if videos:
             if videos[0].created_at != self._load(LAST_VIDEO_CREATED_KEY):
                 self._save_and_do_callbacks(LAST_VIDEO_CREATED_KEY, videos[0].created_at)
@@ -172,7 +172,7 @@ def _update_media(self):
                 self._save_and_do_callbacks(LAST_VIDEO_OBJECT_TYPE, videos[0].object_type)
                 self._save_and_do_callbacks(LAST_VIDEO_OBJECT_REGION, videos[0].object_region)
 
-        # signal video up!
+        # Tell anyone listening about the new capture and how it affects things.
         self._save_and_do_callbacks(CAPTURED_TODAY_KEY, captured_today)
         if last_captured is not None:
             self._save_and_do_callbacks(LAST_CAPTURE_KEY, last_captured)
@@ -181,18 +181,24 @@ def _update_media(self):
         # new snapshot?
         snapshot = self._arlo.ml.snapshot_for(self)
         if snapshot is not None:
-            self.debug("snapshot updated for media " + self.name)
-            self._save(SNAPSHOT_KEY, snapshot.image_url)
-            self._arlo.bg.run_low(self._update_snapshot)
+            if self._load(SNAPSHOT_KEY, None) != snapshot.image_url:
+                self.debug("snapshot updated for media " + self.name)
+                self._save(SNAPSHOT_KEY, snapshot.image_url)
+                self._arlo.bg.run_low(self._update_image_from_snapshot)
+            else:
+                self.debug("snapshot already done for " + self.name)
 
-        # new image?
+        # New image? Then fetch it an update image details.
         if last_image is not None:
-            self.debug("image updated for media " + self.name)
-            self._save(LAST_IMAGE_KEY, last_image)
-            self._arlo.bg.run_low(self._update_image)
+            if self._load(LAST_IMAGE_KEY, None) != last_image:
+                self.debug("image updated for media " + self.name)
+                self._save(LAST_IMAGE_KEY, last_image)
+                self._arlo.bg.run_low(self._update_image_from_capture)
+            else:
+                self.debug("image already done for " + self.name)
 
     # Update last captured image.
-    def _update_image(self):
+    def _update_image_from_capture(self):
         # Get image and date, if fails ignore
         img, date = http_get_img(self._load(LAST_IMAGE_KEY, None))
         if img is None:
@@ -205,14 +211,13 @@ def _update_image(self):
             date = date.strftime(self._arlo.cfg.last_format)
             self.debug(f"updating image for {self.name} ({date})")
             self._save_and_do_callbacks(LAST_IMAGE_SRC_KEY, "capture/" + date)
-            self._save_and_do_callbacks(LAST_CAPTURE_KEY, date)
             self._save_and_do_callbacks(LAST_IMAGE_DATA_KEY, img)
         else:
             date = date.strftime(self._arlo.cfg.last_format)
             self.vdebug(f"ignoring image for {self.name} ({date})")
 
     # Update the last snapshot
-    def _update_snapshot(self, ignore_date=False):
+    def _update_image_from_snapshot(self, ignore_date=False):
         # Get image and date, if fails ignore.
         img, date = http_get_img(self._load(SNAPSHOT_KEY, None), ignore_date)
         if img is None:
@@ -270,7 +275,7 @@ def _queue_media_updates(self):
         for retry in self._arlo.cfg.media_retry:
             self.debug("queueing update in {}".format(retry))
             self._arlo.bg.run_in(
-                self._arlo.ml.queue_update, retry, cb=self._update_media
+                self._arlo.ml.queue_update, retry, cb=self._update_from_media_library
             )
 
     def _mark_as_idle(self):
@@ -371,20 +376,20 @@ def _event_handler(self, resource, event):
             if LAST_IMAGE_KEY in event:
                 if not self.is_taking_snapshot:
                     self.debug("{} -> thumbnail changed".format(self.name))
-                    self._arlo.bg.run_low(self._update_image)
+                    self._arlo.bg.run_low(self._update_image_from_capture)
                 else:
                     self.debug(
                         "{} -> snapshot(thumbnail) ready".format(self.name)
                     )
                     self._save(SNAPSHOT_KEY, event.get(LAST_IMAGE_KEY, ""))
-                    self._arlo.bg.run_low(self._update_snapshot, ignore_date=True)
+                    self._arlo.bg.run_low(self._update_image_from_snapshot, ignore_date=True)
 
             # Recording has stopped so a new video is available. Queue an
             # media update, this could later trigger a snapshot or image
             # update.
             if event.get(RECORDING_STOPPED_KEY, False):
                 self.debug("{} -> recording stopped".format(self.name))
-                self._arlo.ml.queue_update(self._update_media)
+                self._arlo.ml.queue_update(self._update_from_media_library)
 
             # Examine the URL passed; snapshots contain `/snapshots/` and
             # recordings contain `recordings`. For snapshot, save URL and queue
@@ -394,7 +399,7 @@ def _event_handler(self, resource, event):
             if "/snapshots/" in value:
                 self.debug("{} -> snapshot1 ready".format(self.name))
                 self._save(SNAPSHOT_KEY, value)
-                self._arlo.bg.run_low(self._update_snapshot)
+                self._arlo.bg.run_low(self._update_image_from_snapshot)
             if "/recordings/" in value:
                 self.debug("{} -> new recording ready".format(self.name))
 
@@ -443,15 +448,15 @@ def _event_handler(self, resource, event):
             if value is not None:
                 self.debug("{} -> snapshot2 ready".format(self.name))
                 self._save(SNAPSHOT_KEY, value)
-                self._arlo.bg.run_low(self._update_snapshot)
+                self._arlo.bg.run_low(self._update_image_from_snapshot)
 
         # Non subscription...
         if event.get("action", "") == "lastImageSnapshotAvailable":
             value = event.get("properties", {}).get("presignedLastImageUrl", None)
             if value is not None:
                 self.debug("{} -> snapshot3 ready".format(self.name))
                 self._save(SNAPSHOT_KEY, value)
-                self._arlo.bg.run_low(self._update_snapshot)
+                self._arlo.bg.run_low(self._update_image_from_snapshot)
 
         # Ambient sensors update, decode and push changes.
         if resource.endswith("/ambientSensors/history"):
@@ -704,10 +709,10 @@ def update_media(self, wait=None):
             wait = self._arlo.cfg.synchronous_mode
         if wait:
             self.debug("doing media update")
-            self._update_media()
+            self._update_from_media_library()
         else:
             self.debug("queueing media update")
-            self._arlo.bg.run_low(self._update_media)
+            self._arlo.bg.run_low(self._update_from_media_library)
 
     def update_last_image(self, wait=None):
         """Requests last thumbnail from the backend server.
@@ -721,10 +726,10 @@ def update_last_image(self, wait=None):
             wait = self._arlo.cfg.synchronous_mode
         if wait:
             self.debug("doing image update")
-            self._update_image()
+            self._update_image_from_capture()
         else:
             self.debug("queueing image update")
-            self._arlo.bg.run_low(self._update_image)
+            self._arlo.bg.run_low(self._update_image_from_capture)
 
     def update_ambient_sensors(self):
         """Requests the latest temperature, humidity and air quality settings.
@@ -812,7 +817,7 @@ def request_snapshot(self):
         for check in self._arlo.cfg.snapshot_checks:
             self.debug("queueing snapshot check in {}".format(check))
             self._arlo.bg.run_in(
-                self._arlo.ml.queue_update, check, cb=self._update_media
+                self._arlo.ml.queue_update, check, cb=self._update_from_media_library
             )
 
         self.vdebug("handle dodgy cameras")

setup.py

@@ -11,7 +11,7 @@ def readme():
 setup(
 
     name='pyaarlo',
-    version='0.8.0b6',
+    version='0.8.0b7',
     packages=['pyaarlo'],
 
     python_requires='>=3.6',