wyzeapy 0.5.27__py3-none-any.whl → 0.5.29__py3-none-any.whl

wyzeapy/services/base_service.py

@@ -12,49 +12,160 @@ from typing import List, Tuple, Any, Dict, Optional
 import aiohttp
 
 from .update_manager import DeviceUpdater, UpdateManager
-from ..const import PHONE_SYSTEM_TYPE, APP_VERSION, APP_VER, PHONE_ID, APP_NAME, OLIVE_APP_ID, APP_INFO, SC, SV, APP_PLATFORM, SOURCE
+from ..const import (
+    PHONE_SYSTEM_TYPE,
+    APP_VERSION,
+    APP_VER,
+    PHONE_ID,
+    APP_NAME,
+    OLIVE_APP_ID,
+    APP_INFO,
+    SC,
+    SV,
+    APP_PLATFORM,
+    SOURCE,
+)
 from ..crypto import olive_create_signature
-from ..payload_factory import olive_create_hms_patch_payload, olive_create_hms_payload, \
-    olive_create_hms_get_payload, ford_create_payload, olive_create_get_payload, olive_create_post_payload, \
-    olive_create_user_info_payload, devicemgmt_create_capabilities_payload, devicemgmt_get_iot_props_list
+from ..payload_factory import (
+    olive_create_hms_patch_payload,
+    olive_create_hms_payload,
+    olive_create_hms_get_payload,
+    ford_create_payload,
+    olive_create_get_payload,
+    olive_create_post_payload,
+    olive_create_user_info_payload,
+    devicemgmt_create_capabilities_payload,
+    devicemgmt_get_iot_props_list,
+)
 from ..types import PropertyIDs, Device, DeviceMgmtToggleType
-from ..utils import check_for_errors_standard, check_for_errors_hms, check_for_errors_lock, \
-    check_for_errors_iot, wyze_encrypt, check_for_errors_devicemgmt
+from ..utils import (
+    check_for_errors_standard,
+    check_for_errors_hms,
+    check_for_errors_lock,
+    check_for_errors_iot,
+    wyze_encrypt,
+    check_for_errors_devicemgmt,
+)
 from ..wyze_auth_lib import WyzeAuthLib
 
+"""
+BaseService provides shared functionality for Wyze device services,
+including authentication, device discovery, and automatic updates.
+"""
+
 _LOGGER = logging.getLogger(__name__)
 
 
 class BaseService:
+    """Base service class providing common functionality for all Wyze device services.
+
+    This abstract base class provides shared infrastructure for interacting with Wyze devices
+    including authentication, API communication, device discovery, and automatic updates.
+    All device-specific service classes (BulbService, SwitchService, etc.) inherit from this class.
+
+    **Key Features:**
+    * Device discovery and caching via `get_object_list()`
+    * Automatic device updates with configurable intervals
+    * Authentication token management and refresh
+    * Common API endpoint wrappers for device properties and actions
+    * Error handling and validation for API responses
+    * Support for both cloud and local device communication
+
+    **Common Usage Patterns:**
+    ```python
+    # Device services inherit from BaseService
+    bulb_service = await wyze.bulb_service
+
+    # Get all devices (cached after first call)
+    devices = await bulb_service.get_object_list()
+
+    # Register for automatic updates
+    bulb_service.register_updater(device, interval=30)
+    ```
+
+    **Note:** This class is not meant to be instantiated directly - use device-specific services instead.
+    """
+
     _devices: Optional[List[Device]] = None
-    _last_updated_time: time = 0  # preload a value of 0 so that comparison will succeed on the first run
+    _last_updated_time: time = (
+        0  # preload a value of 0 so that comparison will succeed on the first run
+    )
     _min_update_time = 1200  # lets let the device_params update every 20 minutes for now. This could probably reduced signicficantly.
-    _update_lock: asyncio.Lock = asyncio.Lock() # fmt: skip
+    _update_lock: asyncio.Lock = asyncio.Lock()  # fmt: skip
     _update_manager: UpdateManager = UpdateManager()
     _update_loop = None
     _updater: DeviceUpdater = None
     _updater_dict = {}
 
     def __init__(self, auth_lib: WyzeAuthLib):
+        """Initialize the base service with authentication.
+
+        **Args:**
+        * `auth_lib` (WyzeAuthLib): The authentication library for API access
+        """
         self._auth_lib = auth_lib
 
     @staticmethod
     async def start_update_manager():
+        """Start the global update manager for automatic device state updates.
+
+        This initializes the background update system that handles periodic
+        device state refreshes for all registered devices.
+
+        **Example:**
+        ```python
+        await BaseService.start_update_manager()
+        ```
+        """
         if BaseService._update_loop is None:
             BaseService._update_loop = asyncio.get_event_loop()
-            BaseService._update_loop.create_task(BaseService._update_manager.update_next())
+            BaseService._update_loop.create_task(
+                BaseService._update_manager.update_next()
+            )
 
     def register_updater(self, device: Device, interval):
+        """Register a device for automatic status updates at a specified interval.
+
+        This enables automatic background updates for a device, periodically refreshing
+        its state from the Wyze servers. Useful for keeping device status current.
+
+        **Args:**
+        * `device` (Device): The device to register for automatic updates
+        * `interval` (int): Update interval in seconds
+
+        **Example:**
+        ```python
+        # Update device state every 30 seconds
+        service.register_updater(device, 30)
+        ```
+        """
         self._updater = DeviceUpdater(self, device, interval)
         BaseService._update_manager.add_updater(self._updater)
         self._updater_dict[self._updater.device] = self._updater
 
     def unregister_updater(self, device: Device):
+        """Stop automatic updates for a device.
+
+        This removes a device from the automatic update system to stop
+        background status refreshes.
+
+        **Args:**
+        * `device` (Device): The device to stop updating automatically
+
+        **Example:**
+        ```python
+        service.unregister_updater(device)
+        ```
+        """
         if self._updater:
             BaseService._update_manager.del_updater(self._updater_dict[device])
             del self._updater_dict[device]
 
-    async def set_push_info(self, on: bool) -> None:
+    async def set_push_info(self, on: bool):
+        """Set push info for the user.
+
+        :param on: Whether to enable or disable push notifications.
+        """
         await self._auth_lib.refresh_if_should()
 
         url = "https://api.wyzecam.com/app/user/set_push_info"
@@ -68,7 +179,7 @@ class BaseService:
             "sv": SV,
             "access_token": self._auth_lib.token.access_token,
             "phone_id": PHONE_ID,
-            "app_name": APP_NAME
+            "app_name": APP_NAME,
         }
 
         response_json = await self._auth_lib.post(url, json=payload)
@@ -76,31 +187,49 @@ class BaseService:
         check_for_errors_standard(self, response_json)
 
     async def get_user_profile(self) -> Dict[Any, Any]:
+        """Get user profile.
+
+        :return: User profile.
+        """
         await self._auth_lib.refresh_if_should()
 
         payload = olive_create_user_info_payload()
         signature = olive_create_signature(payload, self._auth_lib.token.access_token)
         headers = {
-            'Accept-Encoding': 'gzip',
-            'User-Agent': 'myapp',
-            'appid': OLIVE_APP_ID,
-            'appinfo': APP_INFO,
-            'phoneid': PHONE_ID,
-            'access_token': self._auth_lib.token.access_token,
-            'signature2': signature
+            "Accept-Encoding": "gzip",
+            "User-Agent": "myapp",
+            "appid": OLIVE_APP_ID,
+            "appinfo": APP_INFO,
+            "phoneid": PHONE_ID,
+            "access_token": self._auth_lib.token.access_token,
+            "signature2": signature,
         }
 
-        url = 'https://wyze-platform-service.wyzecam.com/app/v2/platform/get_user_profile'
+        url = (
+            "https://wyze-platform-service.wyzecam.com/app/v2/platform/get_user_profile"
+        )
 
         response_json = await self._auth_lib.get(url, headers=headers, params=payload)
 
         return response_json
 
     async def get_object_list(self) -> List[Device]:
-        """
-        Wraps the api.wyzecam.com/app/v2/home_page/get_object_list endpoint
+        """Discover and retrieve all devices associated with the Wyze account.
+
+        This method fetches all devices from the Wyze API and caches them for
+        efficient subsequent access. Results are shared across all service instances.
+
+        **Returns:**
+        * `List[Device]`: List of all discovered Wyze devices
 
-        :return: List of devices
+        **Example:**
+        ```python
+        devices = await service.get_object_list()
+        for device in devices:
+            print(f"Device: {device.nickname} ({device.product_model})")
+        ```
+
+        **Note:** Results are cached and shared across all BaseService instances
         """
         await self._auth_lib.refresh_if_should()
 
@@ -113,19 +242,29 @@ class BaseService:
             "sv": "9d74946e652647e9b6c9d59326aef104",
             "access_token": self._auth_lib.token.access_token,
             "phone_id": PHONE_ID,
-            "app_name": APP_NAME
+            "app_name": APP_NAME,
         }
 
-        response_json = await self._auth_lib.post("https://api.wyzecam.com/app/v2/home_page/get_object_list",
-                                                  json=payload)
+        response_json = await self._auth_lib.post(
+            "https://api.wyzecam.com/app/v2/home_page/get_object_list", json=payload
+        )
 
         check_for_errors_standard(self, response_json)
         # Cache the devices so that update calls can pull more recent device_params
-        BaseService._devices = [Device(device) for device in response_json['data']['device_list']]
+        BaseService._devices = [
+            Device(device) for device in response_json["data"]["device_list"]
+        ]
 
         return BaseService._devices
 
-    async def get_updated_params(self, device_mac: str = None) -> Dict[str, Optional[Any]]:
+    async def get_updated_params(
+        self, device_mac: str = None
+    ) -> Dict[str, Optional[Any]]:
+        """Get updated params for a device.
+
+        :param device_mac: The device mac to get updated params for.
+        :return: Updated params for the device.
+        """
         if time.time() - BaseService._last_updated_time >= BaseService._min_update_time:
             await self.get_object_list()
             BaseService._last_updated_time = time.time()
@@ -136,8 +275,7 @@ class BaseService:
         return ret_params
 
     async def _get_property_list(self, device: Device) -> List[Tuple[PropertyIDs, Any]]:
-        """
-        Wraps the api.wyzecam.com/app/v2/device/get_property_list endpoint
+        """Wraps the api.wyzecam.com/app/v2/device/get_property_list endpoint
 
         :param device: Device to get properties for
         :return: List of PropertyIDs and values
@@ -157,34 +295,30 @@ class BaseService:
             "app_name": APP_NAME,
             "device_model": device.product_model,
             "device_mac": device.mac,
-            "target_pid_list": []
+            "target_pid_list": [],
         }
 
-        response_json = await self._auth_lib.post("https://api.wyzecam.com/app/v2/device/get_property_list",
-                                                  json=payload)
+        response_json = await self._auth_lib.post(
+            "https://api.wyzecam.com/app/v2/device/get_property_list", json=payload
+        )
 
         check_for_errors_standard(self, response_json)
-        properties = response_json['data']['property_list']
+        properties = response_json["data"]["property_list"]
         property_list = []
         for prop in properties:
             try:
-                property_id = PropertyIDs(prop['pid'])
-                property_list.append((
-                    property_id,
-                    prop['value']
-                ))
+                property_id = PropertyIDs(prop["pid"])
+                property_list.append((property_id, prop["value"]))
             except ValueError:
                 pass
 
         return property_list
 
-    async def _set_property_list(self, device: Device, plist: List[Dict[str, str]]) -> None:
-        """
-        Wraps the api.wyzecam.com/app/v2/device/set_property_list endpoint
+    async def _set_property_list(self, device: Device, plist: List[Dict[str, str]]):
+        """Wraps the api.wyzecam.com/app/v2/device/set_property_list endpoint
 
         :param device: The device for which to set the property(ies)
         :param plist: A list of properties [{"pid": pid, "pvalue": pvalue},...]
-        :return:
         """
 
         await self._auth_lib.refresh_if_should()
@@ -201,17 +335,17 @@ class BaseService:
             "app_name": APP_NAME,
             "property_list": plist,
             "device_model": device.product_model,
-            "device_mac": device.mac
+            "device_mac": device.mac,
         }
 
-        response_json = await self._auth_lib.post("https://api.wyzecam.com/app/v2/device/set_property_list",
-                                                  json=payload)
+        response_json = await self._auth_lib.post(
+            "https://api.wyzecam.com/app/v2/device/set_property_list", json=payload
+        )
 
         check_for_errors_standard(self, response_json)
 
-    async def _run_action_list(self, device: Device, plist: List[Dict[Any, Any]]) -> None:
-        """
-        Wraps the api.wyzecam.com/app/v2/auto/run_action_list endpoint
+    async def _run_action_list(self, device: Device, plist: List[Dict[Any, Any]]):
+        """Wraps the api.wyzecam.com/app/v2/auto/run_action_list endpoint
 
         :param device: The device for which to run the action list
         :param plist: A list of properties [{"pid": pid, "pvalue": pvalue},...]
@@ -231,31 +365,24 @@ class BaseService:
             "action_list": [
                 {
                     "instance_id": device.mac,
-                    "action_params": {
-                        "list": [
-                            {
-                                "mac": device.mac,
-                                "plist": plist
-                            }
-                        ]
-                    },
+                    "action_params": {"list": [{"mac": device.mac, "plist": plist}]},
                     "provider_key": device.product_model,
-                    "action_key": "set_mesh_property"
+                    "action_key": "set_mesh_property",
                 }
-            ]
+            ],
         }
 
-        response_json = await self._auth_lib.post("https://api.wyzecam.com/app/v2/auto/run_action_list",
-                                                  json=payload)
+        response_json = await self._auth_lib.post(
+            "https://api.wyzecam.com/app/v2/auto/run_action_list", json=payload
+        )
 
         check_for_errors_standard(self, response_json)
 
     async def _get_event_list(self, count: int) -> Dict[Any, Any]:
-        """
-        Wraps the api.wyzecam.com/app/v2/device/get_event_list endpoint
+        """Wraps the api.wyzecam.com/app/v2/device/get_event_list endpoint
 
         :param count: Number of events to gather
-        :return: Response from the server
+        :return: Response from the server after being validated
         """
 
         await self._auth_lib.refresh_if_should()
@@ -268,12 +395,7 @@ class BaseService:
             "count": count,
             "app_version": APP_VERSION,
             "order_by": 2,
-            "event_value_list": [
-                "1",
-                "13",
-                "10",
-                "12"
-            ],
+            "event_value_list": ["1", "13", "10", "12"],
             "sc": "9f275790cab94a72bd206c8876429f3c",
             "device_mac_list": [],
             "event_tag_list": [],
@@ -283,22 +405,21 @@ class BaseService:
             "app_ver": APP_VER,
             "ts": 1623612037763,
             "device_mac": "",
-            "access_token": self._auth_lib.token.access_token
+            "access_token": self._auth_lib.token.access_token,
         }
 
-        response_json = await self._auth_lib.post("https://api.wyzecam.com/app/v2/device/get_event_list",
-                                                  json=payload)
+        response_json = await self._auth_lib.post(
+            "https://api.wyzecam.com/app/v2/device/get_event_list", json=payload
+        )
 
         check_for_errors_standard(self, response_json)
         return response_json
 
-    async def _run_action(self, device: Device, action: str) -> None:
-        """
-        Wraps the api.wyzecam.com/app/v2/auto/run_action endpoint
+    async def _run_action(self, device: Device, action: str):
+        """Wraps the api.wyzecam.com/app/v2/auto/run_action endpoint
 
         :param device: The device for which to run the action
         :param action: The action to run
-        :return:
         """
 
         await self._auth_lib.refresh_if_should()
@@ -320,18 +441,18 @@ class BaseService:
             "custom_string": "",
         }
 
-        response_json = await self._auth_lib.post("https://api.wyzecam.com/app/v2/auto/run_action",
-                                                  json=payload)
+        response_json = await self._auth_lib.post(
+            "https://api.wyzecam.com/app/v2/auto/run_action", json=payload
+        )
 
         check_for_errors_standard(self, response_json)
-    
-    async def _run_action_devicemgmt(self, device: Device, type: str, value: str) -> None:
-        """
-        Wraps the devicemgmt-service-beta.wyze.com/device-management/api/action/run_action endpoint
+
+    async def _run_action_devicemgmt(self, device: Device, type: str, value: str):
+        """Wraps the devicemgmt-service-beta.wyze.com/device-management/api/action/run_action endpoint
 
         :param device: The device for which to run the action
-        :param state: on or off
-        :return:
+        :param type: The type of action to run
+        :param value: The value of the action to run
         """
 
         await self._auth_lib.refresh_if_should()
@@ -339,30 +460,32 @@ class BaseService:
         capabilities = devicemgmt_create_capabilities_payload(type, value)
 
         payload = {
-            "capabilities": [
-                capabilities
-            ],
+            "capabilities": [capabilities],
             "nonce": int(time.time() * 1000),
             "targetInfo": {
                 "id": device.mac,
                 "productModel": device.product_model,
-                "type": "DEVICE"
+                "type": "DEVICE",
             },
-            "transactionId": "0a5b20591fedd4du1b93f90743ba0csd" # OG cam needs this (doesn't matter what the value is)
+            "transactionId": "0a5b20591fedd4du1b93f90743ba0csd",  # OG cam needs this (doesn't matter what the value is)
         }
 
         headers = {
             "authorization": self._auth_lib.token.access_token,
         }
 
-        response_json = await self._auth_lib.post("https://devicemgmt-service-beta.wyze.com/device-management/api/action/run_action",
-                                                  json=payload, headers=headers)
+        response_json = await self._auth_lib.post(
+            "https://devicemgmt-service-beta.wyze.com/device-management/api/action/run_action",
+            json=payload,
+            headers=headers,
+        )
 
         check_for_errors_iot(self, response_json)
-    
-    async def _set_toggle(self, device: Device, toggleType: DeviceMgmtToggleType, state: str) -> None:
-        """
-        Wraps the ai-subscription-service-beta.wyzecam.com/v4/subscription-service/toggle-management endpoint
+
+    async def _set_toggle(
+        self, device: Device, toggleType: DeviceMgmtToggleType, state: str
+    ):
+        """Wraps the ai-subscription-service-beta.wyzecam.com/v4/subscription-service/toggle-management endpoint
 
         :param device: The device for which to get the state
         :param toggleType: Enum for the toggle type
@@ -377,21 +500,15 @@ class BaseService:
                     "device_firmware": "1234567890",
                     "device_id": device.mac,
                     "device_model": device.product_model,
-                    "page_id": [
-                        toggleType.pageId
-                    ],
+                    "page_id": [toggleType.pageId],
                     "toggle_update": [
-                        {
-                            "toggle_id": toggleType.toggleId,
-                            "toggle_status": state
-                        }
-                    ]
+                        {"toggle_id": toggleType.toggleId, "toggle_status": state}
+                    ],
                 }
             ],
-            "nonce": str(int(time.time() * 1000))
+            "nonce": str(int(time.time() * 1000)),
         }
 
-
         signature = olive_create_signature(payload, self._auth_lib.token.access_token)
         headers = {
             "access_token": self._auth_lib.token.access_token,
@@ -401,20 +518,22 @@ class BaseService:
             "signature2": signature,
             "appplatform": APP_PLATFORM,
             "appversion": APP_VERSION,
-            "requestid": "35374158s4s313b9a2be7c057f2da5d1"
+            "requestid": "35374158s4s313b9a2be7c057f2da5d1",
         }
 
-        response_json = await self._auth_lib.put("https://ai-subscription-service-beta.wyzecam.com/v4/subscription-service/toggle-management",
-                                                  json=payload, headers=headers)
-        
+        response_json = await self._auth_lib.put(
+            "https://ai-subscription-service-beta.wyzecam.com/v4/subscription-service/toggle-management",
+            json=payload,
+            headers=headers,
+        )
+
         check_for_errors_devicemgmt(self, response_json)
-    
+
     async def _get_iot_prop_devicemgmt(self, device: Device) -> Dict[str, Any]:
-        """
-        Wraps the devicemgmt-service-beta.wyze.com/device-management/api/device-property/get_iot_prop endpoint
+        """Wraps the devicemgmt-service-beta.wyze.com/device-management/api/device-property/get_iot_prop endpoint
 
         :param device: The device for which to get the state
-        :return:
+        :return: Response from the server after being validated
         """
 
         await self._auth_lib.refresh_if_should()
@@ -425,24 +544,26 @@ class BaseService:
             "targetInfo": {
                 "id": device.mac,
                 "productModel": device.product_model,
-                "type": "DEVICE"
-            }
+                "type": "DEVICE",
+            },
         }
 
         headers = {
             "authorization": self._auth_lib.token.access_token,
         }
 
-        response_json = await self._auth_lib.post("https://devicemgmt-service-beta.wyze.com/device-management/api/device-property/get_iot_prop",
-                                                  json=payload, headers=headers)
-        
+        response_json = await self._auth_lib.post(
+            "https://devicemgmt-service-beta.wyze.com/device-management/api/device-property/get_iot_prop",
+            json=payload,
+            headers=headers,
+        )
+
         check_for_errors_iot(self, response_json)
 
         return response_json
 
-    async def _set_property(self, device: Device, pid: str, pvalue: str) -> None:
-        """
-        Wraps the api.wyzecam.com/app/v2/device/set_property endpoint
+    async def _set_property(self, device: Device, pid: str, pvalue: str):
+        """Wraps the api.wyzecam.com/app/v2/device/set_property endpoint
 
         :param device: The device for which to set the property
         :param pid: The property id
@@ -463,22 +584,21 @@ class BaseService:
             "pvalue": pvalue,
             "pid": pid,
             "device_model": device.product_model,
-            "device_mac": device.mac
+            "device_mac": device.mac,
         }
 
-        response_json = await self._auth_lib.post("https://api.wyzecam.com/app/v2/device/set_property",
-                                                  json=payload)
+        response_json = await self._auth_lib.post(
+            "https://api.wyzecam.com/app/v2/device/set_property", json=payload
+        )
 
         check_for_errors_standard(self, response_json)
 
-    async def _monitoring_profile_active(self, hms_id: str, home: int, away: int) -> None:
-        """
-        Wraps the hms.api.wyze.com/api/v1/monitoring/v1/profile/active endpoint
+    async def _monitoring_profile_active(self, hms_id: str, home: int, away: int):
+        """Wraps the hms.api.wyze.com/api/v1/monitoring/v1/profile/active endpoint
 
         :param hms_id: The hms id
         :param home: 1 for home 0 for not
         :param away: 1 for away 0 for not
-        :return:
         """
         await self._auth_lib.refresh_if_should()
 
@@ -486,31 +606,23 @@ class BaseService:
         query = olive_create_hms_patch_payload(hms_id)
         signature = olive_create_signature(query, self._auth_lib.token.access_token)
         headers = {
-            'Accept-Encoding': 'gzip',
-            'User-Agent': 'myapp',
-            'appid': OLIVE_APP_ID,
-            'appinfo': APP_INFO,
-            'phoneid': PHONE_ID,
-            'access_token': self._auth_lib.token.access_token,
-            'signature2': signature,
-            'Authorization': self._auth_lib.token.access_token
+            "Accept-Encoding": "gzip",
+            "User-Agent": "myapp",
+            "appid": OLIVE_APP_ID,
+            "appinfo": APP_INFO,
+            "phoneid": PHONE_ID,
+            "access_token": self._auth_lib.token.access_token,
+            "signature2": signature,
+            "Authorization": self._auth_lib.token.access_token,
         }
-        payload = [
-            {
-                "state": "home",
-                "active": home
-            },
-            {
-                "state": "away",
-                "active": away
-            }
-        ]
-        response_json = await self._auth_lib.patch(url, headers=headers, params=query, json=payload)
+        payload = [{"state": "home", "active": home}, {"state": "away", "active": away}]
+        response_json = await self._auth_lib.patch(
+            url, headers=headers, params=query, json=payload
+        )
         check_for_errors_hms(self, response_json)
 
     async def _get_plan_binding_list_by_user(self) -> Dict[Any, Any]:
-        """
-        Wraps the wyze-membership-service.wyzecam.com/platform/v2/membership/get_plan_binding_list_by_user endpoint
+        """Wraps the wyze-membership-service.wyzecam.com/platform/v2/membership/get_plan_binding_list_by_user endpoint
 
         :return: The response to gathering the plan for the current user
         """
@@ -522,13 +634,13 @@ class BaseService:
         payload = olive_create_hms_payload()
         signature = olive_create_signature(payload, self._auth_lib.token.access_token)
         headers = {
-            'Accept-Encoding': 'gzip',
-            'User-Agent': 'myapp',
-            'appid': OLIVE_APP_ID,
-            'appinfo': APP_INFO,
-            'phoneid': PHONE_ID,
-            'access_token': self._auth_lib.token.access_token,
-            'signature2': signature
+            "Accept-Encoding": "gzip",
+            "User-Agent": "myapp",
+            "appid": OLIVE_APP_ID,
+            "appinfo": APP_INFO,
+            "phoneid": PHONE_ID,
+            "access_token": self._auth_lib.token.access_token,
+            "signature2": signature,
         }
 
         response_json = await self._auth_lib.get(url, headers=headers, params=payload)
@@ -544,13 +656,8 @@ class BaseService:
         await self._auth_lib.refresh_if_should()
 
         url = "https://hms.api.wyze.com/api/v1/reme-alarm"
-        payload = {
-            "hms_id": hms_id,
-            "remediation_id": "emergency"
-        }
-        headers = {
-            "Authorization": self._auth_lib.token.access_token
-        }
+        payload = {"hms_id": hms_id, "remediation_id": "emergency"}
+        headers = {"Authorization": self._auth_lib.token.access_token}
 
         response_json = await self._auth_lib.delete(url, headers=headers, json=payload)
 
@@ -570,14 +677,14 @@ class BaseService:
         query = olive_create_hms_get_payload(hms_id)
         signature = olive_create_signature(query, self._auth_lib.token.access_token)
         headers = {
-            'User-Agent': 'myapp',
-            'appid': OLIVE_APP_ID,
-            'appinfo': APP_INFO,
-            'phoneid': PHONE_ID,
-            'access_token': self._auth_lib.token.access_token,
-            'signature2': signature,
-            'Authorization': self._auth_lib.token.access_token,
-            'Content-Type': "application/json"
+            "User-Agent": "myapp",
+            "appid": OLIVE_APP_ID,
+            "appinfo": APP_INFO,
+            "phoneid": PHONE_ID,
+            "access_token": self._auth_lib.token.access_token,
+            "signature2": signature,
+            "Authorization": self._auth_lib.token.access_token,
+            "Content-Type": "application/json",
         }
 
         response_json = await self._auth_lib.get(url, headers=headers, params=query)
@@ -594,9 +701,11 @@ class BaseService:
 
         payload = {
             "uuid": device_uuid,
-            "action": action  # "remoteLock" or "remoteUnlock"
+            "action": action,  # "remoteLock" or "remoteUnlock"
         }
-        payload = ford_create_payload(self._auth_lib.token.access_token, payload, url_path, "post")
+        payload = ford_create_payload(
+            self._auth_lib.token.access_token, payload, url_path, "post"
+        )
 
         url = "https://yd-saas-toc.wyzecam.com/openapi/lock/v1/control"
 
@@ -611,12 +720,11 @@ class BaseService:
 
         device_uuid = device.mac.split(".")[-1]
 
-        payload = {
-            "uuid": device_uuid,
-            "with_keypad": "1"
-        }
+        payload = {"uuid": device_uuid, "with_keypad": "1"}
 
-        payload = ford_create_payload(self._auth_lib.token.access_token, payload, url_path, "get")
+        payload = ford_create_payload(
+            self._auth_lib.token.access_token, payload, url_path, "get"
+        )
 
         url = "https://yd-saas-toc.wyzecam.com/openapi/lock/v1/info"
 
@@ -626,6 +734,25 @@ class BaseService:
 
         return response_json
 
+    async def _get_lock_ble_token(self, device: Device) -> Dict[str, Optional[Any]]:
+        await self._auth_lib.refresh_if_should()
+
+        url_path = "/openapi/lock/v1/ble/token"
+
+        payload = {"uuid": device.mac}
+
+        payload = ford_create_payload(
+            self._auth_lib.token.access_token, payload, url_path, "get"
+        )
+
+        url = f"https://yd-saas-toc.wyzecam.com{url_path}"
+
+        response_json = await self._auth_lib.get(url, params=payload)
+
+        check_for_errors_lock(self, response_json)
+
+        return response_json
+
     async def _get_device_info(self, device: Device) -> Dict[Any, Any]:
         await self._auth_lib.refresh_if_should()
 
@@ -640,29 +767,32 @@ class BaseService:
             "sv": "c86fa16fc99d4d6580f82ef3b942e586",
             "access_token": self._auth_lib.token.access_token,
             "phone_id": PHONE_ID,
-            "app_name": APP_NAME
+            "app_name": APP_NAME,
         }
 
-        response_json = await self._auth_lib.post("https://api.wyzecam.com/app/v2/device/get_device_Info",
-                                                  json=payload)
+        response_json = await self._auth_lib.post(
+            "https://api.wyzecam.com/app/v2/device/get_device_Info", json=payload
+        )
 
         check_for_errors_standard(self, response_json)
 
         return response_json
 
-    async def _get_iot_prop(self, url: str, device: Device, keys: str) -> Dict[Any, Any]:
+    async def _get_iot_prop(
+        self, url: str, device: Device, keys: str
+    ) -> Dict[Any, Any]:
         await self._auth_lib.refresh_if_should()
 
         payload = olive_create_get_payload(device.mac, keys)
         signature = olive_create_signature(payload, self._auth_lib.token.access_token)
         headers = {
-            'Accept-Encoding': 'gzip',
-            'User-Agent': 'myapp',
-            'appid': OLIVE_APP_ID,
-            'appinfo': APP_INFO,
-            'phoneid': PHONE_ID,
-            'access_token': self._auth_lib.token.access_token,
-            'signature2': signature
+            "Accept-Encoding": "gzip",
+            "User-Agent": "myapp",
+            "appid": OLIVE_APP_ID,
+            "appinfo": APP_INFO,
+            "phoneid": PHONE_ID,
+            "access_token": self._auth_lib.token.access_token,
+            "signature2": signature,
         }
 
         response_json = await self._auth_lib.get(url, headers=headers, params=payload)
@@ -671,26 +801,34 @@ class BaseService:
 
         return response_json
 
-    async def _set_iot_prop(self, url: str, device: Device, prop_key: str, value: Any) -> None:
+    async def _set_iot_prop(
+        self, url: str, device: Device, prop_key: str, value: Any
+    ) -> None:
         await self._auth_lib.refresh_if_should()
 
-        payload = olive_create_post_payload(device.mac, device.product_model, prop_key, value)
-        signature = olive_create_signature(json.dumps(payload, separators=(',', ':')),
-                                           self._auth_lib.token.access_token)
+        payload = olive_create_post_payload(
+            device.mac, device.product_model, prop_key, value
+        )
+        signature = olive_create_signature(
+            json.dumps(payload, separators=(",", ":")),
+            self._auth_lib.token.access_token,
+        )
         headers = {
-            'Accept-Encoding': 'gzip',
-            'Content-Type': 'application/json',
-            'User-Agent': 'myapp',
-            'appid': OLIVE_APP_ID,
-            'appinfo': APP_INFO,
-            'phoneid': PHONE_ID,
-            'access_token': self._auth_lib.token.access_token,
-            'signature2': signature
+            "Accept-Encoding": "gzip",
+            "Content-Type": "application/json",
+            "User-Agent": "myapp",
+            "appid": OLIVE_APP_ID,
+            "appinfo": APP_INFO,
+            "phoneid": PHONE_ID,
+            "access_token": self._auth_lib.token.access_token,
+            "signature2": signature,
         }
 
-        payload_str = json.dumps(payload, separators=(',', ':'))
+        payload_str = json.dumps(payload, separators=(",", ":"))
 
-        response_json = await self._auth_lib.post(url, headers=headers, data=payload_str)
+        response_json = await self._auth_lib.post(
+            url, headers=headers, data=payload_str
+        )
 
         check_for_errors_iot(self, response_json)
 
@@ -701,20 +839,20 @@ class BaseService:
             "mac": bulb.mac.upper(),
             "index": "1",
             "ts": str(int(time.time_ns() // 1000000)),
-            "plist": plist
+            "plist": plist,
         }
 
-        characteristics_str = json.dumps(characteristics, separators=(',', ':'))
+        characteristics_str = json.dumps(characteristics, separators=(",", ":"))
         characteristics_enc = wyze_encrypt(bulb.enr, characteristics_str)
 
         payload = {
             "request": "set_status",
             "isSendQueue": 0,
-            "characteristics": characteristics_enc
+            "characteristics": characteristics_enc,
         }
 
         # JSON likes to add a second \ so we have to remove it for the bulb to be happy
-        payload_str = json.dumps(payload, separators=(',', ':')).replace('\\\\', '\\')
+        payload_str = json.dumps(payload, separators=(",", ":")).replace("\\\\", "\\")
 
         url = "http://%s:88/device_request" % bulb.ip
 
@@ -723,7 +861,9 @@ class BaseService:
                 async with session.post(url, data=payload_str) as response:
                     print(await response.text())
         except aiohttp.ClientConnectionError:
-            _LOGGER.warning("Failed to connect to bulb %s, reverting to cloud." % bulb.mac)
+            _LOGGER.warning(
+                "Failed to connect to bulb %s, reverting to cloud." % bulb.mac
+            )
             await self._run_action_list(bulb, plist)
             bulb.cloud_fallback = True