wyzeapy 0.5.30__py3-none-any.whl → 0.5.31__py3-none-any.whl

wyzeapy/__init__.py

@@ -443,7 +443,7 @@ class Wyzeapy:
         if self._sensor_service is None:
             self._sensor_service = SensorService(self._auth_lib)
         return self._sensor_service
-    
+
     @property
     async def irrigation_service(self) -> IrrigationService:
         """Returns an instance of the irrigation service"""

wyzeapy/payload_factory.py

@@ -51,37 +51,41 @@ def olive_create_get_payload(device_mac: str, keys: str) -> Dict[str, Any]:
 
     return {"keys": keys, "did": device_mac, "nonce": nonce}
 
+
 def olive_create_get_payload_irrigation(device_mac: str) -> Dict[str, Any]:
     nonce = int(time.time() * 1000)
 
-    return {
-        'device_id': device_mac,
-        'nonce': str(nonce)
-    }
+    return {"device_id": device_mac, "nonce": str(nonce)}
 
-def olive_create_post_payload_irrigation_stop(device_mac: str, action: str) -> Dict[str, Any]:
+
+def olive_create_post_payload_irrigation_stop(
+    device_mac: str, action: str
+) -> Dict[str, Any]:
     nonce = int(time.time() * 1000)
 
-    return {
-        'device_id': device_mac,
-        'nonce': str(nonce),
-        "action": action
-    }
+    return {"device_id": device_mac, "nonce": str(nonce), "action": action}
 
-def olive_create_post_payload_irrigation_quickrun(device_mac: str, zone_number: int, duration: int) -> Dict[str, Any]:
+
+def olive_create_post_payload_irrigation_quickrun(
+    device_mac: str, zone_number: int, duration: int
+) -> Dict[str, Any]:
     nonce = int(time.time() * 1000)
 
     return {
-        'device_id': device_mac,
-        'nonce': str(nonce),
-        "zone_runs": [
-            {
-                "zone_number": zone_number,
-                "duration": duration
-            }
-        ]
+        "device_id": device_mac,
+        "nonce": str(nonce),
+        "zone_runs": [{"zone_number": zone_number, "duration": duration}],
     }
 
+
+def olive_create_get_payload_irrigation_schedule_runs(
+    device_mac: str,
+) -> Dict[str, Any]:
+    nonce = int(time.time() * 1000)
+
+    return {"device_id": device_mac, "nonce": str(nonce)}
+
+
 def olive_create_post_payload(
     device_mac: str, device_model: str, prop_key: str, value: Any
 ) -> Dict[str, Any]:

wyzeapy/services/base_service.py

@@ -39,6 +39,7 @@ from ..payload_factory import (
     olive_create_get_payload_irrigation,
     olive_create_post_payload_irrigation_stop,
     olive_create_post_payload_irrigation_quickrun,
+    olive_create_get_payload_irrigation_schedule_runs,
 )
 from ..types import PropertyIDs, Device, DeviceMgmtToggleType
 from ..utils import (
@@ -906,13 +907,13 @@ class BaseService:
         payload = olive_create_get_payload_irrigation(device.mac)
         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)
@@ -921,50 +922,87 @@ class BaseService:
 
         return response_json
 
-
-    async def _stop_running_schedule(self, url: str, device: Device, action: str) -> Dict[Any, Any]:
+    async def _stop_running_schedule(
+        self, url: str, device: Device, action: str
+    ) -> Dict[Any, Any]:
         await self._auth_lib.refresh_if_should()
 
         payload = olive_create_post_payload_irrigation_stop(device.mac, action)
-        signature = olive_create_signature(json.dumps(payload, separators=(',', ':')),
-                                           self._auth_lib.token.access_token)
+        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=(',', ':'))
-        response_json = await self._auth_lib.post(url, headers=headers, data=payload_str)
+        payload_str = json.dumps(payload, separators=(",", ":"))
+        response_json = await self._auth_lib.post(
+            url, headers=headers, data=payload_str
+        )
 
         check_for_errors_iot(self, response_json)
 
         return response_json
 
-    async def _start_zone(self, url: str, device: Device, zone_number: int, duration: int) -> Dict[Any, Any]:
+    async def _start_zone(
+        self, url: str, device: Device, zone_number: int, duration: int
+    ) -> Dict[Any, Any]:
         await self._auth_lib.refresh_if_should()
 
-        payload = olive_create_post_payload_irrigation_quickrun(device.mac, zone_number, duration)
-        signature = olive_create_signature(json.dumps(payload, separators=(',', ':')),
-                                           self._auth_lib.token.access_token)
+        payload = olive_create_post_payload_irrigation_quickrun(
+            device.mac, zone_number, duration
+        )
+        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=(',', ':'))
-        response_json = await self._auth_lib.post(url, headers=headers, data=payload_str)
+        payload_str = json.dumps(payload, separators=(",", ":"))
+        response_json = await self._auth_lib.post(
+            url, headers=headers, data=payload_str
+        )
+
+        check_for_errors_iot(self, response_json)
+
+        return response_json
+
+    async def _get_schedule_runs(
+        self, url: str, device: Device, limit: int = 2
+    ) -> Dict[Any, Any]:
+        await self._auth_lib.refresh_if_should()
+
+        payload = olive_create_get_payload_irrigation_schedule_runs(device.mac)
+        payload["limit"] = limit
+        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,
+        }
+
+        response_json = await self._auth_lib.get(url, headers=headers, params=payload)
 
         check_for_errors_iot(self, response_json)
 

wyzeapy/services/bulb_service.py

@@ -15,7 +15,20 @@ _LOGGER = logging.getLogger(__name__)
 
 
 class Bulb(Device):
-    """Bulb class for interacting with Wyze bulbs."""
+    """Bulb class for interacting with Wyze bulbs.
+
+    Note: When created via get_bulbs(), bulb properties (brightness, color,
+    color_temp, on) are initialized with default values. Call
+    BulbService.update(bulb) to fetch the actual current values from the
+    Wyze API.
+
+    Example:
+        bulb_service = await client.bulb_service
+        bulbs = await bulb_service.get_bulbs()
+        for bulb in bulbs:
+            bulb = await bulb_service.update(bulb)  # Fetches actual values
+            print(f"Brightness: {bulb.brightness}, Color: {bulb.color}")
+    """
 
     _brightness: int = 0
     _color_temp: int = 1800
@@ -90,10 +103,14 @@ class BulbService(BaseService):
     """Bulb service for interacting with Wyze bulbs."""
 
     async def update(self, bulb: Bulb) -> Bulb:
-        """Update the bulb object with the latest device parameters.
+        """Fetch and update the bulb's current state from the Wyze API.
+
+        This method retrieves the actual values for brightness, color,
+        color_temp, on/off state, and other properties from the Wyze API.
+        Must be called after get_bulbs() to get accurate property values.
 
         :param bulb: Bulb object to update
-        :return: Updated bulb object
+        :return: Updated bulb object with current property values
         """
         # Get updated device_params
         async with BaseService._update_lock:
@@ -131,7 +148,11 @@ class BulbService(BaseService):
     async def get_bulbs(self) -> List[Bulb]:
         """Get a list of all bulbs.
 
-        :return: List of Bulb objects
+        Note: Returned bulbs have default property values (brightness=0,
+        color="000000", etc.). Call update(bulb) on each bulb to fetch
+        the actual current values from the Wyze API.
+
+        :return: List of Bulb objects with default property values
         """
         if self._devices is None:
             self._devices = await self.get_object_list()

wyzeapy/services/irrigation_service.py

@@ -42,29 +42,31 @@ class SlopeType(Enum):
 
 
 class SoilType(Enum):
-    CLAY_LOAM = 'clay_loam'
-    CLAY = 'clay'
-    SILTY_CLAY = 'silty_clay'
-    LOAM = 'loam'
-    SANDY_LOAM = 'sandy_loam'
-    LOAMY_SAND = 'loamy_sand'
-    SAND = 'sand'
+    CLAY_LOAM = "clay_loam"
+    CLAY = "clay"
+    SILTY_CLAY = "silty_clay"
+    LOAM = "loam"
+    SANDY_LOAM = "sandy_loam"
+    LOAMY_SAND = "loamy_sand"
+    SAND = "sand"
 
 
 class Zone:
     """Represents a single irrigation zone."""
+
     def __init__(self, dictionary: Dict[Any, Any]):
-        self.zone_number: int = dictionary.get('zone_number', 1)
-        self.name: str = dictionary.get('name', 'Zone 1')
-        self.enabled: bool = dictionary.get('enabled', True)
-        self.zone_id: str = dictionary.get('zone_id', 'zone_id')
-        self.smart_duration: int = dictionary.get('smart_duration', 600)
-        
+        self.zone_number: int = dictionary.get("zone_number", 1)
+        self.name: str = dictionary.get("name", "Zone 1")
+        self.enabled: bool = dictionary.get("enabled", True)
+        self.zone_id: str = dictionary.get("zone_id", "zone_id")
+        self.smart_duration: int = dictionary.get("smart_duration", 600)
+
         # this quickrun duration is used only for running a zone manually
         # the wyze api has no such value, but takes a duration as part of the api call
         # the default value grabs the wyze smart_duration but all further updates
         # are managed through the home assistant state
-        self.quickrun_duration: int = dictionary.get('smart_duration', 600)
+        self.quickrun_duration: int = dictionary.get("smart_duration", 600)
+
 
 class Irrigation(Device):
     def __init__(self, dictionary: Dict[Any, Any]):
@@ -84,36 +86,40 @@ class IrrigationService(BaseService):
     async def update(self, irrigation: Irrigation) -> Irrigation:
         """Update the irrigation device with latest data from Wyze API."""
         # Get IoT properties
-        properties = (await self.get_iot_prop(irrigation))['data']['props']
-        
+        properties = (await self.get_iot_prop(irrigation))["data"]["props"]
+
         # Update device properties
-        irrigation.RSSI = properties.get('RSSI', -65)
-        irrigation.IP = properties.get('IP', '192.168.1.100')
-        irrigation.sn = properties.get('sn', 'SN123456789')
-        irrigation.ssid = properties.get('ssid', 'ssid')
-        irrigation.available = (properties.get(IrrigationProps.IOT_STATE.value) == "connected")
+        irrigation.RSSI = properties.get("RSSI", -65)
+        irrigation.IP = properties.get("IP", "192.168.1.100")
+        irrigation.sn = properties.get("sn", "SN123456789")
+        irrigation.ssid = properties.get("ssid", "ssid")
+        irrigation.available = (
+            properties.get(IrrigationProps.IOT_STATE.value) == "connected"
+        )
 
         # Get zones
-        zones = (await self.get_zone_by_device(irrigation))['data']['zones']
-        
+        zones = (await self.get_zone_by_device(irrigation))["data"]["zones"]
+
         # Update zones
         irrigation.zones = []
         for zone in zones:
             irrigation.zones.append(Zone(zone))
-        
+
         return irrigation
-    
+
     async def update_device_props(self, irrigation: Irrigation) -> Irrigation:
         """Update the irrigation device with latest data from Wyze API."""
         # Get IoT properties
-        properties = (await self.get_iot_prop(irrigation))['data']['props']
-        
+        properties = (await self.get_iot_prop(irrigation))["data"]["props"]
+
         # Update device properties
-        irrigation.RSSI = properties.get('RSSI')
-        irrigation.IP = properties.get('IP')
-        irrigation.sn = properties.get('sn')
-        irrigation.ssid = properties.get('ssid')
-        irrigation.available = (properties.get(IrrigationProps.IOT_STATE.value) == 'connected')
+        irrigation.RSSI = properties.get("RSSI")
+        irrigation.IP = properties.get("IP")
+        irrigation.sn = properties.get("sn")
+        irrigation.ssid = properties.get("ssid")
+        irrigation.available = (
+            properties.get(IrrigationProps.IOT_STATE.value) == "connected"
+        )
 
         return irrigation
 
@@ -121,18 +127,25 @@ class IrrigationService(BaseService):
         if self._devices is None:
             self._devices = await self.get_object_list()
 
-        irrigations = [device for device in self._devices if device.type == DeviceTypes.IRRIGATION and "BS_WK1" in device.product_model]
+        irrigations = [
+            device
+            for device in self._devices
+            if device.type == DeviceTypes.IRRIGATION
+            and "BS_WK1" in device.product_model
+        ]
 
         return [Irrigation(irrigation.raw_dict) for irrigation in irrigations]
 
-    async def start_zone(self, irrigation: Device, zone_number: int, quickrun_duration: int) -> Dict[Any, Any]:
+    async def start_zone(
+        self, irrigation: Device, zone_number: int, quickrun_duration: int
+    ) -> Dict[Any, Any]:
         """Start a zone with the specified duration.
-        
+
         Args:
             irrigation: The irrigation device
             zone_number: The zone number to start
             quickrun_duration: Duration in seconds to run the zone
-            
+
         Returns:
             Dict containing the API response
         """
@@ -141,20 +154,22 @@ class IrrigationService(BaseService):
 
     async def stop_running_schedule(self, device: Device) -> Dict[Any, Any]:
         """Stop any currently running irrigation schedule.
-        
+
         Args:
             device: The irrigation device
-            
+
         Returns:
             Dict containing the API response
         """
         url = "https://wyze-lockwood-service.wyzecam.com/plugin/irrigation/runningschedule"
-        action = "STOP"    
+        action = "STOP"
         return await self._stop_running_schedule(url, device, action)
 
-    async def set_zone_quickrun_duration(self, irrigation: Irrigation, zone_number: int, duration: int) -> Irrigation:
+    async def set_zone_quickrun_duration(
+        self, irrigation: Irrigation, zone_number: int, duration: int
+    ) -> Irrigation:
         """Set the quickrun duration for a specific zone.
-        
+
         Args:
             irrigation: The irrigation device
             zone_number: The zone number to configure
@@ -164,26 +179,68 @@ class IrrigationService(BaseService):
             if zone.zone_number == zone_number:
                 zone.quickrun_duration = duration
                 break
-        
+
         return irrigation
 
     # Private implementation methods
     async def get_iot_prop(self, device: Device) -> Dict[Any, Any]:
         """Get IoT properties for a device."""
         url = "https://wyze-lockwood-service.wyzecam.com/plugin/irrigation/get_iot_prop"
-        keys = 'zone_state,iot_state,iot_state_update_time,app_version,RSSI,' \
-            'wifi_mac,sn,device_model,ssid,IP'
+        keys = (
+            "zone_state,iot_state,iot_state_update_time,app_version,RSSI,"
+            "wifi_mac,sn,device_model,ssid,IP"
+        )
         return await self._get_iot_prop(url, device, keys)
 
     async def get_device_info(self, device: Device) -> Dict[Any, Any]:
         """Get device info from Wyze API."""
         url = "https://wyze-lockwood-service.wyzecam.com/plugin/irrigation/device_info"
-        keys = 'wiring,sensor,enable_schedules,notification_enable,notification_watering_begins,' \
-            'notification_watering_ends,notification_watering_is_skipped,skip_low_temp,skip_wind,' \
-            'skip_rain,skip_saturation'
+        keys = (
+            "wiring,sensor,enable_schedules,notification_enable,notification_watering_begins,"
+            "notification_watering_ends,notification_watering_is_skipped,skip_low_temp,skip_wind,"
+            "skip_rain,skip_saturation"
+        )
         return await self._irrigation_device_info(url, device, keys)
 
     async def get_zone_by_device(self, device: Device) -> List[Dict[Any, Any]]:
         """Get zones for a device."""
         url = "https://wyze-lockwood-service.wyzecam.com/plugin/irrigation/zone"
         return await self._get_zone_by_device(url, device)
+
+    async def get_schedule_runs(self, device: Device) -> Dict[Any, Any]:
+        """Get schedule runs for an irrigation device.
+
+        Args:
+            device: The irrigation device
+
+        Returns:
+            Dict containing running status and zone information if running
+        """
+        url = (
+            "https://wyze-lockwood-service.wyzecam.com/plugin/irrigation/schedule_runs"
+        )
+        response = await self._get_schedule_runs(url, device, limit=2)
+
+        # Process the response and return simplified payload
+        result = {"running": False}
+
+        if "data" in response and "schedules" in response["data"]:
+            schedules = response["data"]["schedules"]
+            for schedule in schedules:
+                schedule_state = schedule.get("schedule_state")
+
+                if schedule_state == "running":
+                    result["running"] = True
+                    # Get zone information from zone_runs
+                    zone_runs = schedule.get("zone_runs")
+                    # Use the first zone run for zone info
+                    zone_run = zone_runs[0]
+                    result["zone_number"] = zone_run.get("zone_number")
+                    result["zone_name"] = zone_run.get("zone_name")
+                    break  # Found a running schedule, no need to check others
+        else:
+            _LOGGER.warning(
+                "No schedule data found in response for device %s", device.mac
+            )
+
+        return result