pydiagral 1.5.0b2__tar.gz → 1.5.0b4__tar.gz

{pydiagral-1.5.0b2 → pydiagral-1.5.0b4}/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [1.5.0-beta.4](https://github.com/mguyard/pydiagral/compare/v1.5.0-beta.3...v1.5.0-beta.4) (2025-02-28)
+
+
+### Bug Fixes
+
+* **api:** 🔧 Update log message for alarm name retrieval ([fca40e4](https://github.com/mguyard/pydiagral/commit/fca40e44bccd59f6399ae2b89a29c2b4fcc80172))
+
+# [1.5.0-beta.3](https://github.com/mguyard/pydiagral/compare/v1.5.0-beta.2...v1.5.0-beta.3) (2025-02-28)
+
+
+### Features
+
+* **api:** 🚀 Add `get_alarm_name` method and log alarm name in tests ([96e727f](https://github.com/mguyard/pydiagral/commit/96e727fe851a1086d8689c6fb7204efdb702938d))
+
 # [1.5.0-beta.2](https://github.com/mguyard/pydiagral/compare/v1.5.0-beta.1...v1.5.0-beta.2) (2025-02-28)
 
 

{pydiagral-1.5.0b2 → pydiagral-1.5.0b4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pydiagral
-Version: 1.5.0b2
+Version: 1.5.0b4
 Summary: A Python library for interacting with Diagral systems
 Project-URL: Homepage, https://github.com/mguyard/pydiagral
 Project-URL: Documentation, https://github.com/mguyard/pydiagral

{pydiagral-1.5.0b2 → pydiagral-1.5.0b4}/example_code.py

@@ -239,6 +239,9 @@ async def test_diagral_api() -> None:  # noqa: D103,C901
                 stop_result = await alarm.stop_system()
                 _LOGGER.info("Stop System with result: %s", stop_result)
 
+            alarm_name: str = await alarm.get_alarm_name()  # Get the alarm name
+            _LOGGER.info("Alarm Name is: %s", alarm_name)
+
             if (
                 APIKEY_DELETION and APIKEY_CREATION
             ):  # Only when the API key has been created

{pydiagral-1.5.0b2 → pydiagral-1.5.0b4}/src/pydiagral/api.py

@@ -400,7 +400,7 @@ class DiagralAPI:
             self.__apikey = None
             self.__secret_key = None
 
-    async def try_connection(self, ephemeral: bool = True) -> bool:
+    async def try_connection(self, ephemeral: bool = True) -> TryConnectResult:
         """Test connection with the Diagral system.
 
         This method tests the connection by either using provided API credentials or generating
@@ -489,6 +489,28 @@ class DiagralAPI:
         )
         return self.alarm_configuration
 
+    async def get_alarm_name(self) -> str:
+        """Get the name of the alarm from the configuration.
+
+        Returns:
+            str: The name of the alarm from the configuration.
+
+        Raises:
+            ConfigurationError: If unable to retrieve the alarm configuration.
+
+        Note:
+            This method will attempt to fetch the configuration if it hasn't been loaded yet.
+
+        """
+
+        if not self.alarm_configuration:
+            await self.get_configuration()
+
+        if not self.alarm_configuration:
+            raise ConfigurationError("Failed to retrieve alarm configuration")
+
+        return self.alarm_configuration.alarm.name
+
     async def get_devices_info(self) -> DeviceList:
         """Asynchronously retrieves information about various device types from the alarm configuration.