Add UIClassifier enum and update get_reference_ui_classifiers return type to list[str]

Author: iMicknl

pyoverkiz/client.py

@@ -693,7 +693,7 @@ async def get_reference_ui_classes(self) -> list[str]:
         return await self.__get("reference/ui/classes")
 
     @retry_on_auth_error
-    async def get_reference_ui_classifiers(self) -> JSON:
+    async def get_reference_ui_classifiers(self) -> list[str]:
         """Get a list of all defined UI classifiers."""
         return await self.__get("reference/ui/classifiers")
 

pyoverkiz/enums/ui.py

@@ -462,3 +462,16 @@ class UIWidget(UnknownEnumMixin, StrEnum):
     ZWAVE_TRANSCEIVER = "ZWaveTransceiver"
     ZIGBEE_NETWORK = "ZigbeeNetwork"
     ZIGBEE_STACK = "ZigbeeStack"
+
+
+@unique
+class UIClassifier(UnknownEnumMixin, StrEnum):
+    """Enumeration of UI classifiers used to categorize device types."""
+
+    UNKNOWN = "unknown"
+
+    COOLING_SYSTEM = "coolingSystem"
+    EMITTER = "emitter"
+    GENERATOR = "generator"
+    HEATING_SYSTEM = "heatingSystem"
+    SENSOR = "sensor"

utils/generate_enums.py

@@ -202,6 +202,27 @@ def to_enum_name(value: str) -> str:
 
         lines.append("")  # End with newline
 
+        # Fetch and add UI classifiers
+        ui_classifiers = cast(list[str], await client.get_reference_ui_classifiers())
+
+        lines.append("")
+        lines.append("@unique")
+        lines.append("class UIClassifier(UnknownEnumMixin, StrEnum):")
+        lines.append(
+            '    """Enumeration of UI classifiers used to categorize device types."""'
+        )
+        lines.append("")
+        lines.append('    UNKNOWN = "unknown"')
+        lines.append("")
+
+        # Add UI classifiers
+        sorted_classifiers = sorted(ui_classifiers)
+        for ui_classifier in sorted_classifiers:
+            enum_name = to_enum_name(ui_classifier)
+            lines.append(f'    {enum_name} = "{ui_classifier}"')
+
+        lines.append("")  # End with newline
+
         # Write to the ui.py file
         output_path = Path(__file__).parent.parent / "pyoverkiz" / "enums" / "ui.py"
         output_path.write_text("\n".join(lines))
@@ -215,6 +236,7 @@ def to_enum_name(value: str) -> str:
         print(f"✓ Added {len(ui_widgets)} UI widgets from API")
         print(f"✓ Added {additional_widget_count} additional hardcoded UI widgets")
         print(f"✓ Total: {len(sorted_widgets)} UI widgets")
+        print(f"✓ Added {len(sorted_classifiers)} UI classifiers")
 
 
 async def generate_all() -> None: