petsafe-api 3.1.2__tar.gz → 3.3.0__tar.gz

{petsafe_api-3.1.2 → petsafe_api-3.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: petsafe-api
-Version: 3.1.2
+Version: 3.3.0
 Summary: Provides ability to connect and control a PetSafe Smart Feed, Scoopfree, and Smart Door devices using the PetSafe API.
 Home-page: https://github.com/ThomasHFWright/petsafe-api
 Author: Jordan Stremming & Dominick Meglio & Thomas Wright
@@ -57,7 +57,7 @@ Thank you to both projects for building the API integrations for existing feeder
 If installing from source code,
 `python setup.py install`
 
-## Local SmartDoor control and provisioning (3.1.0)
+## Local SmartDoor control, management and provisioning (3.3.0)
 
 `LocalPetSafeClient` connects to a compatible local server using its HTTPS origin
 and API token. It does not use a PetSafe vendor login, and returns the same
@@ -77,6 +77,16 @@ async def main() -> None:
         await door.unlock()
         await door.smart_mode()
 
+        async for snapshot in client.iter_events():
+            print(snapshot["revision"], snapshot["door"])
+
+        pet = await client.create_pet({
+            "profile": {"name": "Example pet", "breed": []}, "timezone": "UTC"
+        })
+        async for scan in client.scan_rfid(door.api_name, "PETSAFE_KEY"):
+            if scan["state"] == "captured" and scan["restored"]:
+                await client.assign_rfid_scan(door.api_name, scan["id"], pet["petId"])
+
 
 asyncio.run(main())
 ```
@@ -107,6 +117,10 @@ also requires supported BLE hardware or a nearby proxy and an HTTPS hostname and
 certificate trusted by the SmartDoor; hardware testing used an Amazon-trusted
 certificate. A raw IP address is not a supported or promised substitute.
 
+Local maintenance helpers include allowlisted native command submission and firmware
+inspection, staging, installation, and cancellation. `install_firmware()` is an explicit
+physical-device mutation; returned job state is not a promise of firmware outcome.
+
 ## Cloud login tokens
 You **must** use tokens to interact with the PetSafe Smart-Feed API.  
 There are two methods to retrieve tokens:

{petsafe_api-3.1.2 → petsafe_api-3.3.0}/README.md

@@ -24,7 +24,7 @@ Thank you to both projects for building the API integrations for existing feeder
 If installing from source code,
 `python setup.py install`
 
-## Local SmartDoor control and provisioning (3.1.0)
+## Local SmartDoor control, management and provisioning (3.3.0)
 
 `LocalPetSafeClient` connects to a compatible local server using its HTTPS origin
 and API token. It does not use a PetSafe vendor login, and returns the same
@@ -44,6 +44,16 @@ async def main() -> None:
         await door.unlock()
         await door.smart_mode()
 
+        async for snapshot in client.iter_events():
+            print(snapshot["revision"], snapshot["door"])
+
+        pet = await client.create_pet({
+            "profile": {"name": "Example pet", "breed": []}, "timezone": "UTC"
+        })
+        async for scan in client.scan_rfid(door.api_name, "PETSAFE_KEY"):
+            if scan["state"] == "captured" and scan["restored"]:
+                await client.assign_rfid_scan(door.api_name, scan["id"], pet["petId"])
+
 
 asyncio.run(main())
 ```
@@ -74,6 +84,10 @@ also requires supported BLE hardware or a nearby proxy and an HTTPS hostname and
 certificate trusted by the SmartDoor; hardware testing used an Amazon-trusted
 certificate. A raw IP address is not a supported or promised substitute.
 
+Local maintenance helpers include allowlisted native command submission and firmware
+inspection, staging, installation, and cancellation. `install_firmware()` is an explicit
+physical-device mutation; returned job state is not a promise of firmware outcome.
+
 ## Cloud login tokens
 You **must** use tokens to interact with the PetSafe Smart-Feed API.  
 There are two methods to retrieve tokens:

{petsafe_api-3.1.2 → petsafe_api-3.3.0}/petsafe/devices.py

@@ -705,6 +705,21 @@ class DeviceSmartDoor:
             self.data["schedules"] = schedules
         return schedules
 
+    async def get_schedule(self, schedule_id: str) -> dict:
+        """Return one SmartDoor schedule by identifier."""
+
+        if not schedule_id:
+            raise ValueError("schedule_id must be provided")
+        response = await self.client.api_get(
+            f"smartdoor/product/schedules/{self.api_name}/{schedule_id}"
+        )
+        response.raise_for_status()
+        payload = json.loads(response.content.decode("UTF-8"))
+        data = payload.get("data", payload)
+        if not isinstance(data, dict):
+            raise ValueError("Unexpected response payload for SmartDoor schedule")
+        return data
+
     async def get_override_schedules(self) -> list[dict]:
         """Return override schedules configured for the SmartDoor."""
 
@@ -736,6 +751,15 @@ class DeviceSmartDoor:
             await self.update_data()
         return data
 
+    async def clear_override_schedule(self, *, update_data: bool = True) -> None:
+        """Clear the SmartDoor's temporary access override."""
+
+        await self.client.api_delete(
+            f"smartdoor/product/override/schedules/{self.api_name}"
+        )
+        if update_data:
+            await self.update_data()
+
     async def save_schedule(
         self, schedule: dict, *, update_data: bool = True
     ) -> dict:
@@ -755,6 +779,25 @@ class DeviceSmartDoor:
             await self.update_data()
         return data
 
+    async def update_schedule(
+        self, schedule: dict, *, update_data: bool = True
+    ) -> dict:
+        """Update an existing SmartDoor schedule."""
+
+        if not isinstance(schedule, dict) or not schedule.get("scheduleId"):
+            raise ValueError("schedule with scheduleId must be provided")
+        payload = dict(schedule)
+        payload.setdefault("thingName", self.api_name)
+        response = await self.client.api_put(
+            "smartdoor/product/schedules", data=payload
+        )
+        response.raise_for_status()
+        response_payload = json.loads(response.content.decode("UTF-8"))
+        data = response_payload.get("data", response_payload)
+        if update_data:
+            await self.update_data()
+        return data
+
     async def delete_schedule(
         self, schedule_id: str, *, update_data: bool = True
     ) -> None: