arlo: upstreaming changes to 0.8.15 (#982)

* wip hidden devices

* hidden devices impl

* bump 0.8.12 for beta

* update backup auth hosts

* bump 0.8.13 for release

* use curl-cffi everywhere

* bump 0.8.14 for beta

* Revert "use curl-cffi everywhere"

This reverts commit 80422a8.

* update auth hosts

* bump 0.8.15 for release

Author: bjia56

plugins/arlo/README.md

@@ -10,6 +10,8 @@ If you experience any trouble logging in, clear the username and password boxes,
 
 If you are unable to see shared cameras in your separate Arlo account, ensure that both your primary and secondary accounts are upgraded according to this [forum post](https://web.archive.org/web/20230710141914/https://community.arlo.com/t5/Arlo-Secure/Invited-friend-cannot-see-devices-on-their-dashboard-Arlo-Pro-2/m-p/1889396#M1813). Verify the sharing worked by logging in via the Arlo web dashboard.
 
+**If you add or remove cameras from your main Arlo account, or share/un-share/re-share cameras with the Arlo account used with this plugin, ensure that you reload this plugin to get the updated camera state from Arlo Cloud.**
+
 ## General Setup Notes
 
 * Ensure that your Arlo account's default 2FA option is set to either SMS or email.

plugins/arlo/package-lock.json

@@ -1,6 +1,6 @@
 {
    "name": "@scrypted/arlo",
-   "version": "0.8.11",
+   "version": "0.8.15",
    "description": "Arlo Plugin for Scrypted",
    "license": "Apache",
    "keywords": [

plugins/arlo/package.json

@@ -92,7 +92,7 @@ def change_stream_class(s_class):
 class Arlo(object):
     BASE_URL = 'my.arlo.com'
     AUTH_URL = 'ocapi-app.arlo.com'
-    BACKUP_AUTH_HOSTS = ['NTIuMjEwLjMuMTIx', 'MzQuMjU1LjkyLjIxMg==', 'MzQuMjUxLjE3Ny45MA==', 'NTQuMjQ2LjE3MS4x']
+    BACKUP_AUTH_HOSTS = ["MzQuMjQzLjE3Ljkw","MzQuMjQ4Ljg2LjQ2","MzQuMjQwLjI0Ny4xODY=","NTIuMzEuMTg1LjE4NQ=="]
     TRANSID_PREFIX = 'web'
 
     random.shuffle(BACKUP_AUTH_HOSTS)
@@ -102,6 +102,7 @@ def __init__(self, username, password):
         self.password = password
         self.event_stream = None
         self.request = None
+        self.logged_in = False
 
     def to_timestamp(self, dt):
         if sys.version[0] == '2':
@@ -153,6 +154,7 @@ def UseExistingAuth(self, user_id, headers):
         self.request = Request(mode="cloudscraper")
         self.request.session.headers.update(headers)
         self.BASE_URL = 'myapi.arlo.com'
+        self.logged_in = True
 
     def LoginMFA(self):
         device_id = str(uuid.uuid4())
@@ -258,6 +260,7 @@ def complete_auth(code):
             }
             self.request.session.headers.update(headers)
             self.BASE_URL = 'myapi.arlo.com'
+            self.logged_in = True
 
         return complete_auth
 

plugins/arlo/src/arlo_plugin/arlo/arlo_async.py

@@ -57,6 +57,9 @@ def get_device_manifest(self) -> Device:
         if self.arlo_device.get("parentId") and self.arlo_device["parentId"] != self.arlo_device["deviceId"]:
             parent = self.arlo_device["parentId"]
 
+        if parent in self.provider.hidden_device_ids:
+            parent = None
+
         return {
             "info": {
                 "model": f"{self.arlo_device['modelId']} {self.arlo_device['properties'].get('hwVersion', '')}".strip(),

plugins/arlo/src/arlo_plugin/base.py

@@ -516,10 +516,10 @@ async def _getVideoStreamURL(self, container: str) -> str:
         return url
 
     @async_print_exception_guard
-    async def getVideoStream(self, options: RequestMediaStreamOptions = None) -> MediaObject:
+    async def getVideoStream(self, options: RequestMediaStreamOptions = {}) -> MediaObject:
         self.logger.debug("Entered getVideoStream")
 
-        mso = await self.getVideoStreamOptions(id=options["id"])
+        mso = await self.getVideoStreamOptions(id=options.get("id", "default"))
         mso['refreshAt'] = round(time.time() * 1000) + 30 * 60 * 1000
         container = mso["container"]
 

plugins/arlo/src/arlo_plugin/camera.py

@@ -27,9 +27,10 @@
 class ArloProvider(ScryptedDeviceBase, Settings, DeviceProvider, ScryptedDeviceLoggerMixin, BackgroundTaskMixin):
     arlo_cameras = None
     arlo_basestations = None
+    all_device_ids: set = set()
     _arlo_mfa_code = None
     scrypted_devices = None
-    _arlo = None
+    _arlo: Arlo = None
     _arlo_mfa_complete_auth = None
     device_discovery_lock: asyncio.Lock = None
 
@@ -157,6 +158,23 @@ def imap_mfa_interval(self) -> int:
             self.storage.setItem("imap_mfa_interval", interval)
         return int(interval)
 
+    @property
+    def hidden_devices(self) -> List[str]:
+        hidden = self.storage.getItem("hidden_devices")
+        if hidden is None:
+            hidden = []
+            self.storage.setItem("hidden_devices", hidden)
+        return hidden
+
+    @property
+    def hidden_device_ids(self) -> List[str]:
+        ids = []
+        for id in self.hidden_devices:
+            m = re.match(r".*\((.*)\)$", id)
+            if m is not None:
+                ids.append(m.group(1))
+        return ids
+
     @property
     def arlo(self) -> Arlo:
         if self._arlo is not None:
@@ -530,6 +548,16 @@ async def getSettings(self) -> List[Setting]:
                 "value": self.plugin_verbosity == "Verbose",
                 "type": "boolean",
             },
+            {
+                "group": "General",
+                "key": "hidden_devices",
+                "title": "Hidden Devices",
+                "description": "Select the Arlo devices to hide in this plugin. Hidden devices will be removed from Scrypted and will "
+                               "not be re-added when the plugin reloads.",
+                "value": self.hidden_devices,
+                "multiple": True,
+                "choices": [id for id in self.all_device_ids],
+            },
         ])
 
         return results
@@ -573,6 +601,11 @@ async def putSetting(self, key: str, value: SettingValue) -> None:
             elif key.startswith("imap_mfa"):
                 self.initialize_imap()
                 skip_arlo_client = True
+            elif key == "hidden_devices":
+                if self._arlo is not None and self._arlo.logged_in:
+                    self._arlo.Unsubscribe()
+                    await self.do_arlo_setup()
+                skip_arlo_client = True
             else:
                 # force arlo client to be invalidated and reloaded
                 self.invalidate_arlo_client()
@@ -618,12 +651,13 @@ async def discover_devices(self) -> None:
             return await self.discover_devices_impl()
 
     async def discover_devices_impl(self) -> None:
-        if not self.arlo:
+        if not self._arlo or not self._arlo.logged_in:
             raise Exception("Arlo client not connected, cannot discover devices")
 
         self.logger.info("Discovering devices...")
         self.arlo_cameras = {}
         self.arlo_basestations = {}
+        self.all_device_ids = set()
         self.scrypted_devices = {}
 
         camera_devices = []
@@ -632,13 +666,20 @@ async def discover_devices_impl(self) -> None:
         basestations = self.arlo.GetDevices(['basestation', 'siren'])
         for basestation in basestations:
             nativeId = basestation["deviceId"]
+            self.all_device_ids.add(f"{basestation['deviceName']} ({nativeId})")
+
             self.logger.debug(f"Adding {nativeId}")
 
             if nativeId in self.arlo_basestations:
                 self.logger.info(f"Skipping basestation {nativeId} ({basestation['modelId']}) as it has already been added")
                 continue
+
             self.arlo_basestations[nativeId] = basestation
 
+            if nativeId in self.hidden_device_ids:
+                self.logger.info(f"Skipping manifest for basestation {nativeId} ({basestation['modelId']}) as it is hidden")
+                continue
+
             device = await self.getDevice_impl(nativeId)
             scrypted_interfaces = device.get_applicable_interfaces()
             manifest = device.get_device_manifest()
@@ -657,11 +698,13 @@ async def discover_devices_impl(self) -> None:
                 await scrypted_sdk.deviceManager.onDeviceDiscovered(child_manifest)
                 provider_to_device_map.setdefault(child_manifest["providerNativeId"], []).append(child_manifest)
 
-        self.logger.info(f"Discovered {len(basestations)} basestations")
+        self.logger.info(f"Discovered {len(self.arlo_basestations)} basestations")
 
         cameras = self.arlo.GetDevices(['camera', "arloq", "arloqs", "doorbell"])
         for camera in cameras:
             nativeId = camera["deviceId"]
+            self.all_device_ids.add(f"{camera['deviceName']} ({nativeId})")
+
             self.logger.debug(f"Adding {nativeId}")
 
             if camera["deviceId"] != camera["parentId"] and camera["parentId"] not in self.arlo_basestations:
@@ -671,6 +714,11 @@ async def discover_devices_impl(self) -> None:
             if nativeId in self.arlo_cameras:
                 self.logger.info(f"Skipping camera {nativeId} ({camera['modelId']}) as it has already been added")
                 continue
+
+            if nativeId in self.hidden_device_ids:
+                self.logger.info(f"Skipping camera {camera['deviceId']} ({camera['modelId']}) because it is hidden")
+                continue
+ 
             self.arlo_cameras[nativeId] = camera
 
             if camera["deviceId"] == camera["parentId"]:
@@ -683,7 +731,7 @@ async def discover_devices_impl(self) -> None:
             manifest = device.get_device_manifest()
             self.logger.debug(f"Interfaces for {nativeId} ({camera['modelId']} parent {camera['parentId']}): {scrypted_interfaces}")
 
-            if camera["deviceId"] == camera["parentId"]:
+            if camera["deviceId"] == camera["parentId"] or camera["parentId"] in self.hidden_device_ids:
                 provider_to_device_map.setdefault(None, []).append(manifest)
             else:
                 provider_to_device_map.setdefault(camera["parentId"], []).append(manifest)
@@ -701,7 +749,9 @@ async def discover_devices_impl(self) -> None:
 
         if len(cameras) != len(camera_devices):
             self.logger.info(f"Discovered {len(cameras)} cameras, but only {len(camera_devices)} are usable")
-            self.logger.info(f"Are all cameras shared with admin permissions?")
+            self.logger.info("This could be because some cameras are hidden.")
+            self.logger.info("If a camera is not hidden but is still missing, ensure all cameras shared with "
+                             "admin permissions in the Arlo app.")
         else:
             self.logger.info(f"Discovered {len(cameras)} cameras")
 
@@ -726,7 +776,11 @@ async def discover_devices_impl(self) -> None:
         })
         self.logger.debug("Done discovering devices")
 
+        # force a settings refresh so the hidden devices list can be updated
+        await self.onDeviceEvent(ScryptedInterface.Settings.value, None)
+
     async def getDevice(self, nativeId: str) -> ArloDeviceBase:
+        self.logger.debug(f"Scrypted requested to load device {nativeId}")
         async with self.device_discovery_lock:
             return await self.getDevice_impl(nativeId)