Update UI enums: enhance documentation, reorder values, and add missing widgets

Author: iMicknl

pyoverkiz/enums/ui.py

@@ -1,4 +1,8 @@
-"""UI enums for classes and widgets used to interpret device UI metadata."""
+"""UI enums for classes and widgets used to interpret device UI metadata.
+
+THIS FILE IS AUTO-GENERATED. DO NOT EDIT MANUALLY.
+Run `uv run utils/generate_enums.py` to regenerate.
+"""
 
 # ruff: noqa: S105
 # Enum values contain "PASS" in API names (e.g. PassAPC), not passwords
@@ -12,15 +16,16 @@
 class UIClass(UnknownEnumMixin, StrEnum):
     """Enumeration of UI classes used to describe device categories and behaviors."""
 
-    # A list of all defined UI classes from /reference/ui/classes
+    UNKNOWN = "unknown"
+
     ADJUSTABLE_SLATS_ROLLER_SHUTTER = "AdjustableSlatsRollerShutter"
     AIR_SENSOR = "AirSensor"
     ALARM = "Alarm"
     AWNING = "Awning"
     BALLAST = "Ballast"
     CAMERA = "Camera"
-    CARBON_DIOXIDE_SENSOR = "CarbonDioxideSensor"
     CAR_BUTTON_SENSOR = "CarButtonSensor"
+    CARBON_DIOXIDE_SENSOR = "CarbonDioxideSensor"
     CIRCUIT_BREAKER = "CircuitBreaker"
     CONFIGURATION_COMPONENT = "ConfigurationComponent"
     CONSUMPTION_SENSOR = "ConsumptionSensor"
@@ -48,8 +53,8 @@ class UIClass(UnknownEnumMixin, StrEnum):
     LIGHT = "Light"
     LIGHT_SENSOR = "LightSensor"
     MUSIC_PLAYER = "MusicPlayer"
-    NOISE_SENSOR = "NoiseSensor"
     NETWORK_COMPONENT = "NetworkComponent"
+    NOISE_SENSOR = "NoiseSensor"
     OCCUPANCY_SENSOR = "OccupancySensor"
     ON_OFF = "OnOff"
     OVEN = "Oven"
@@ -59,6 +64,8 @@ class UIClass(UnknownEnumMixin, StrEnum):
     RAIN_SENSOR = "RainSensor"
     REMOTE_CONTROLLER = "RemoteController"
     ROLLER_SHUTTER = "RollerShutter"
+    SCENE = "Scene"
+    SCENE_LAUNCHER_CONTROLLER = "SceneLauncherController"
     SCREEN = "Screen"
     SHUTTER = "Shutter"
     SIREN = "Siren"
@@ -67,11 +74,12 @@ class UIClass(UnknownEnumMixin, StrEnum):
     SUN_SENSOR = "SunSensor"
     SWIMMING_POOL = "SwimmingPool"
     SWINGING_SHUTTER = "SwingingShutter"
+    SWITCH = "Switch"
     TEMPERATURE_SENSOR = "TemperatureSensor"
     THERMAL_ENERGY_SENSOR = "ThermalEnergySensor"
     THIRD_PARTY_GATEWAY = "ThirdPartyGateway"
     VENETIAN_BLIND = "VenetianBlind"
-    VENTILATION_SYTEM = "VentilationSystem"
+    VENTILATION_SYSTEM = "VentilationSystem"
     WASHING_MACHINE = "WashingMachine"
     WATER_HEATING_SYSTEM = "WaterHeatingSystem"
     WATER_SENSOR = "WaterSensor"
@@ -81,14 +89,13 @@ class UIClass(UnknownEnumMixin, StrEnum):
     WINDOW = "Window"
     WINDOW_HANDLE = "WindowHandle"
 
-    UNKNOWN = "unknown"
-
 
 @unique
 class UIWidget(UnknownEnumMixin, StrEnum):
     """Enumeration of UI widgets used by Overkiz for device presentation."""
 
-    # A list of all defined UI widgets from /reference/ui/widgets
+    UNKNOWN = "unknown"
+
     AIR_FLOW_SENSOR = "AirFlowSensor"
     AIR_QUALITY_SENSOR = "AirQualitySensor"
     ALARM_PANEL_CONTROLLER = "AlarmPanelController"
@@ -116,10 +123,13 @@ class UIWidget(UnknownEnumMixin, StrEnum):
     BIOCLIMATIC_PERGOLA = "BioclimaticPergola"
     CO2_SENSOR = "CO2Sensor"
     CO_SENSOR = "COSensor"
+    CAMERA = "Camera"
     CAR_BUTTON_SENSOR = "CarButtonSensor"
     CAR_LOCK = "CarLock"
     CARD_SWITCH = "CardSwitch"
     CIRCUIT_BREAKER = "CircuitBreaker"
+    CIRCUIT_BREAKER_PEAK_AND_OFF_PEAK = "CircuitBreakerPeakAndOffPeak"
+    CONFIGURATION_SENSOR = "ConfigurationSensor"
     CONTACT_SENSOR = "ContactSensor"
     COTHERM_THERMOSTAT = "CothermThermostat"
     CUMULATIVE_ELECTRIC_POWER_CONSUMPTION_SENSOR = (
@@ -154,26 +164,35 @@ class UIWidget(UnknownEnumMixin, StrEnum):
     DIMMER_LIGHT = "DimmerLight"
     DIMMER_ON_OFF = "DimmerOnOff"
     DIMMER_ON_OFF_LIGHT = "DimmerOnOffLight"
-    DIMMER_RGBCOLOURED_LIGHT = "DimmerRGBColouredLight"
+    DIMMER_RGB_COLOURED_LIGHT = "DimmerRGBColouredLight"
     DIMPLEX_VENTILATION_INLET_OUTLET = "DimplexVentilationInletOutlet"
     DISCRETE_EXTERIOR_HEATING = "DiscreteExteriorHeating"
     DISCRETE_GATE_WITH_PEDESTRIAN_POSITION = "DiscreteGateWithPedestrianPosition"
     DISCRETE_POSITIONABLE_GARAGE_DOOR = "DiscretePositionableGarageDoor"
     DISCRETE_POSITIONABLE_GATE = "DiscretePositionableGate"
     DOCK = "Dock"
     DOMESTIC_HOT_WATER_PRODUCTION = "DomesticHotWaterProduction"
+    DOMESTIC_HOT_WATER_PRODUCTION_PEAK_AND_OFF_PEAK = (
+        "DomesticHotWaterProductionPeakAndOffPeak"
+    )
     DOMESTIC_HOT_WATER_TANK = "DomesticHotWaterTank"
     DOOR_LOCK = "DoorLock"
     DROP_ARM_AWNING = "DropArmAwning"
+    DYNAMIC_AIR_SENSOR = "DynamicAirSensor"
     DYNAMIC_AIR_VENT = "DynamicAirVent"
     DYNAMIC_ALARM = "DynamicAlarm"
+    DYNAMIC_AMBIENT_NOISE_SENSOR = "DynamicAmbientNoiseSensor"
     DYNAMIC_AUDIO_PLAYER = "DynamicAudioPlayer"
     DYNAMIC_AWNING = "DynamicAwning"
     DYNAMIC_BRIDGE = "DynamicBridge"
+    DYNAMIC_CARBON_DIOXIDE_SENSOR = "DynamicCarbonDioxideSensor"
     DYNAMIC_CIRCUIT_BREAKER = "DynamicCircuitBreaker"
     DYNAMIC_CURTAIN = "DynamicCurtain"
     DYNAMIC_DOMESTIC_HOT_WATER_PRODUCTION = "DynamicDomesticHotWaterProduction"
+    DYNAMIC_ELECTRICITY_CONSUMPTION_SENSOR = "DynamicElectricityConsumptionSensor"
+    DYNAMIC_EXTERIOR_VENETIAN_BLIND = "DynamicExteriorVenetianBlind"
     DYNAMIC_GARAGE_DOOR = "DynamicGarageDoor"
+    DYNAMIC_GAS_MEASUREMENT_SENSOR = "DynamicGasMeasurementSensor"
     DYNAMIC_GATE = "DynamicGate"
     DYNAMIC_GATEWAY = "DynamicGateway"
     DYNAMIC_HEATER = "DynamicHeater"
@@ -189,15 +208,20 @@ class UIWidget(UnknownEnumMixin, StrEnum):
     DYNAMIC_OVEN = "DynamicOven"
     DYNAMIC_PERGOLA = "DynamicPergola"
     DYNAMIC_RAIN_SENSOR = "DynamicRainSensor"
+    DYNAMIC_REMOTE_CONTROLLER = "DynamicRemoteController"
     DYNAMIC_ROLLER_SHUTTER = "DynamicRollerShutter"
+    DYNAMIC_SCENE = "DynamicScene"
+    DYNAMIC_SCENE_LAUNCHER_CONTROLLER = "DynamicSceneLauncherController"
     DYNAMIC_SCREEN = "DynamicScreen"
     DYNAMIC_SHUTTER = "DynamicShutter"
+    DYNAMIC_SWITCH = "DynamicSwitch"
     DYNAMIC_TEMPERATURE_SENSOR = "DynamicTemperatureSensor"
     DYNAMIC_THERMOSTAT = "DynamicThermostat"
     DYNAMIC_THIRD_PARTY_GATEWAY = "DynamicThirdPartyGateway"
     DYNAMIC_VENETIAN_BLIND = "DynamicVenetianBlind"
     DYNAMIC_VENTILATION = "DynamicVentilation"
     DYNAMIC_WASHING_MACHINE = "DynamicWashingMachine"
+    DYNAMIC_WATER_MEASUREMENT_SENSOR = "DynamicWaterMeasurementSensor"
     DYNAMIC_WEATHER_STATION = "DynamicWeatherStation"
     DYNAMIC_WIND_SENSOR = "DynamicWindSensor"
     DYNAMIC_WINDOW = "DynamicWindow"
@@ -210,15 +234,16 @@ class UIWidget(UnknownEnumMixin, StrEnum):
     EN_OCEAN_GENERIC_ELECTRIC_COUNTER = "EnOceanGenericElectricCounter"
     EN_OCEAN_TRANSCEIVER = "EnOceanTransceiver"
     EVO_HOME_CONTROLLER = "EvoHomeController"
-    EWATTCH_TICCOUNTER = "EwattchTICCounter"
+    EWATTCH_TIC_COUNTER = "EwattchTICCounter"
     EXTERIOR_VENETIAN_BLIND = "ExteriorVenetianBlind"
     FLOOR_HEATING = "FloorHeating"
     GAS_DHW_CONSUMPTION_SENSOR = "GasDHWConsumptionSensor"
     GAS_HEATER_CONSUMPTION_SENSOR = "GasHeaterConsumptionSensor"
-    GENERIC_16_CHANNELS_COUNTER = "Generic16ChannelsCounter"
-    GENERIC_1_CHANNEL_COUNTER = "Generic1ChannelCounter"
+    GENERIC16_CHANNELS_COUNTER = "Generic16ChannelsCounter"
+    GENERIC1_CHANNEL_COUNTER = "Generic1ChannelCounter"
     GENERIC_CAMERA = "GenericCamera"
     GROUP_CONFIGURATION = "GroupConfiguration"
+    HLRR_WIFI_BRIDGE = "HLRRWifiBridge"
     HEAT_DETECTION_SENSOR = "HeatDetectionSensor"
     HEAT_PUMP = "HeatPump"
     HEATING_SET_POINT = "HeatingSetPoint"
@@ -229,13 +254,12 @@ class UIWidget(UnknownEnumMixin, StrEnum):
     HITACHI_DHW = "HitachiDHW"
     HITACHI_SWIMMING_POOL = "HitachiSwimmingPool"
     HITACHI_THERMOSTAT = "HitachiThermostat"
-    HLRR_WIFI_BRIDGE = "HLRRWifiBridge"
     HOMEKIT_STACK = "HomekitStack"
     HUE_BRIDGE = "HueBridge"
-    IOGENERIC = "IOGeneric"
-    IOSIREN = "IOSiren"
-    IOSTACK = "IOStack"
-    IRBLASTER = "IRBlaster"
+    IO_GENERIC = "IOGeneric"
+    IO_SIREN = "IOSiren"
+    IO_STACK = "IOStack"
+    IR_BLASTER = "IRBlaster"
     IMHOTEP_HEATING_TEMPERATURE_INTERFACE = "ImhotepHeatingTemperatureInterface"
     INSTANT_ELECTRIC_CURRENT_CONSUMPTION_SENSOR = (
         "InstantElectricCurrentConsumptionSensor"
@@ -245,7 +269,7 @@ class UIWidget(UnknownEnumMixin, StrEnum):
     INTRUSION_EVENT_SENSOR = "IntrusionEventSensor"
     INTRUSION_SENSOR = "IntrusionSensor"
     INVALID = "Invalid"
-    JSWCAMERA = "JSWCamera"
+    JSW_CAMERA = "JSWCamera"
     KIZ_OTHERM_BRIDGE = "KizOThermBridge"
     KIZ_OTHERM_V2_BRIDGE = "KizOThermV2Bridge"
     LOCK_UNLOCK_DOOR_LOCK_WITH_UNKNOWN_POSITION = (
@@ -254,31 +278,38 @@ class UIWidget(UnknownEnumMixin, StrEnum):
     LUMINANCE_SENSOR = "LuminanceSensor"
     MEDIA_RENDERER = "MediaRenderer"
     MOTION_SENSOR = "MotionSensor"
+    MULTI_GATEWAY = "MultiGateway"
     MULTI_METER_ELECTRIC_SENSOR = "MultiMeterElectricSensor"
     MY_FOX_ALARM_CONTROLLER = "MyFoxAlarmController"
     MY_FOX_CAMERA = "MyFoxCamera"
     MY_FOX_SECURITY_CAMERA = "MyFoxSecurityCamera"
-    NODE = "Node"
     NETATMO_CONFIGURATION_COMPONENT = "NetatmoConfigurationComponent"
     NETATMO_GATEWAY = "NetatmoGateway"
+    NETATMO_HEATING_TEMPERATURE_INTERFACE = "NetatmoHeatingTemperatureInterface"
     NETATMO_HOME = "NetatmoHome"
+    NETATMO_HOME_COACH_CONFIGURATION = "NetatmoHomeCoachConfiguration"
     NETATMO_WEATHER_STATION_CONFIGURATION = "NetatmoWeatherStationConfiguration"
+    NEXELEC_AIR_QUALITY_CONFIGURATION_TOOL = "NexelecAirQualityConfigurationTool"
+    NODE = "Node"
     NOISE_SENSOR = "NoiseSensor"
-    OVPGENERIC = "OVPGeneric"
+    OVP_GENERIC = "OVPGeneric"
     OCCUPANCY_SENSOR = "OccupancySensor"
+    ON_OFF_COOKING = "OnOffCooking"
     ON_OFF_HEATING_SYSTEM = "OnOffHeatingSystem"
+    ON_OFF_HEATING_SYSTEM_PILOT_WIRE = "OnOffHeatingSystemPilotWire"
     ON_OFF_LIGHT = "OnOffLight"
     ON_OFF_REMOTECONTROLLER = "OnOffRemotecontroller"
+    ON_OFF_VENTILATION_SPEED = "OnOffVentilationSpeed"
     OPEN_CLOSE_GATE = "OpenCloseGate"
-    OPEN_CLOSE_GATE_4T = "OpenCloseGate4T"
+    OPEN_CLOSE_GATE4_T = "OpenCloseGate4T"
     OPEN_CLOSE_GATE_WITH_PEDESTRIAN_POSITION = "OpenCloseGateWithPedestrianPosition"
     OPEN_CLOSE_SLIDING_GARAGE_DOOR = "OpenCloseSlidingGarageDoor"
-    OPEN_CLOSE_SLIDING_GARAGE_DOOR_4T = "OpenCloseSlidingGarageDoor4T"
+    OPEN_CLOSE_SLIDING_GARAGE_DOOR4_T = "OpenCloseSlidingGarageDoor4T"
     OPEN_CLOSE_SLIDING_GARAGE_DOOR_WITH_PEDESTRIAN_POSITION = (
         "OpenCloseSlidingGarageDoorWithPedestrianPosition"
     )
     OPEN_CLOSE_SLIDING_GATE = "OpenCloseSlidingGate"
-    OPEN_CLOSE_SLIDING_GATE_4T = "OpenCloseSlidingGate4T"
+    OPEN_CLOSE_SLIDING_GATE4_T = "OpenCloseSlidingGate4T"
     OPEN_CLOSE_SLIDING_GATE_WITH_PEDESTRIAN_POSITION = (
         "OpenCloseSlidingGateWithPedestrianPosition"
     )
@@ -336,16 +367,16 @@ class UIWidget(UnknownEnumMixin, StrEnum):
     RTD_INDOOR_SIREN = "RTDIndoorSiren"
     RTD_OUTDOOR_SIREN = "RTDOutdoorSiren"
     RTS_GENERIC = "RTSGeneric"
-    RTS_GENERIC_4T = "RTSGeneric4T"
+    RTS_GENERIC4_T = "RTSGeneric4T"
     RTS_THERMOSTAT = "RTSThermostat"
     RAIN_SENSOR = "RainSensor"
     RELATIVE_HUMIDITY_SENSOR = "RelativeHumiditySensor"
     REMOTE_CONTROLLER_ONE_WAY = "RemoteControllerOneWay"
     REPEATER = "Repeater"
     ROCKER_SWITCH_AUTO_MANU_UP_DOWN_CONTROLLER = "RockerSwitchAutoManuUpDownController"
-    ROCKER_SWITCHX_1_CONTROLLER = "RockerSwitchx1Controller"
-    ROCKER_SWITCHX_2_CONTROLLER = "RockerSwitchx2Controller"
-    ROCKER_SWITCHX_4_CONTROLLER = "RockerSwitchx4Controller"
+    ROCKER_SWITCHX1_CONTROLLER = "RockerSwitchx1Controller"
+    ROCKER_SWITCHX2_CONTROLLER = "RockerSwitchx2Controller"
+    ROCKER_SWITCHX4_CONTROLLER = "RockerSwitchx4Controller"
     SCENE_CONTROLLER = "SceneController"
     SCHNEIDER_SWITCH_CONFIGURATION = "SchneiderSwitchConfiguration"
     SIREN_STATUS = "SirenStatus"
@@ -362,32 +393,38 @@ class UIWidget(UnknownEnumMixin, StrEnum):
     STATEFUL_ALARM_CONTROLLER = "StatefulAlarmController"
     STATEFUL_ON_OFF = "StatefulOnOff"
     STATEFUL_ON_OFF_LIGHT = "StatefulOnOffLight"
+    STATEFUL_ON_OFF_PEAK_AND_OFF_PEAK = "StatefulOnOffPeakAndOffPeak"
+    STATEFUL_VENETIAN_SLATS = "StatefulVenetianSlats"
     STATELESS_ALARM_CONTROLLER = "StatelessAlarmController"
     STATELESS_EXTERIOR_HEATING = "StatelessExteriorHeating"
     STATELESS_ON_OFF = "StatelessOnOff"
     SUN_ENERGY_SENSOR = "SunEnergySensor"
     SUN_INTENSITY_SENSOR = "SunIntensitySensor"
     SWIMMING_POOL = "SwimmingPool"
     SWINGING_SHUTTER = "SwingingShutter"
-    TSKALARM_CONTROLLER = "TSKAlarmController"
+    TSK_ALARM_CONTROLLER = "TSKAlarmController"
     TEMPERATURE_SENSOR = "TemperatureSensor"
+    THERMOSTAT_DUAL_MODE_AND_FAN = "ThermostatDualModeAndFan"
     THERMOSTAT_HEATING_TEMPERATURE_INTERFACE = "ThermostatHeatingTemperatureInterface"
     THERMOSTAT_SET_POINT = "ThermostatSetPoint"
     THERMOSTAT_ZONES_CONTROLLER = "ThermostatZonesController"
     THREE_WAY_WINDOW_HANDLE = "ThreeWayWindowHandle"
     TILT_ONLY_VENETIAN_BLIND = "TiltOnlyVenetianBlind"
     TIMED_ON_OFF = "TimedOnOff"
     TIMED_ON_OFF_LIGHT = "TimedOnOffLight"
+    TOP_DOWN_BOTTOM_UP_SCREEN = "TopDownBottomUpScreen"
     UNIVERSAL_SENSOR = "UniversalSensor"
     UNTYPED = "Untyped"
     UP_DOWN_BIOCLIMATIC_PERGOLA = "UpDownBioclimaticPergola"
+    UP_DOWN_BOTTOM_UP_SCREEN = "UpDownBottomUpScreen"
     UP_DOWN_CELLULAR_SCREEN = "UpDownCellularScreen"
     UP_DOWN_CURTAIN = "UpDownCurtain"
+    UP_DOWN_DROP_ARM_AWNING = "UpDownDropArmAwning"
     UP_DOWN_DUAL_CURTAIN = "UpDownDualCurtain"
     UP_DOWN_EXTERIOR_SCREEN = "UpDownExteriorScreen"
     UP_DOWN_EXTERIOR_VENETIAN_BLIND = "UpDownExteriorVenetianBlind"
     UP_DOWN_GARAGE_DOOR = "UpDownGarageDoor"
-    UP_DOWN_GARAGE_DOOR_4T = "UpDownGarageDoor4T"
+    UP_DOWN_GARAGE_DOOR4_T = "UpDownGarageDoor4T"
     UP_DOWN_GARAGE_DOOR_WITH_VENTILATION_POSITION = (
         "UpDownGarageDoorWithVentilationPosition"
     )
@@ -396,32 +433,32 @@ class UIWidget(UnknownEnumMixin, StrEnum):
     UP_DOWN_SCREEN = "UpDownScreen"
     UP_DOWN_SHEER_SCREEN = "UpDownSheerScreen"
     UP_DOWN_SWINGING_SHUTTER = "UpDownSwingingShutter"
+    UP_DOWN_TOP_DOWN_SCREEN = "UpDownTopDownScreen"
     UP_DOWN_VENETIAN_BLIND = "UpDownVenetianBlind"
     UP_DOWN_WINDOW = "UpDownWindow"
     UP_DOWN_ZEBRA_SCREEN = "UpDownZebraScreen"
-    VOCSENSOR = "VOCSensor"
+    VOC_SENSOR = "VOCSensor"
     VALVE_HEATING_TEMPERATURE_INTERFACE = "ValveHeatingTemperatureInterface"
+    VENETIAN_SLATS = "VenetianSlats"
     VENTILATION_INLET = "VentilationInlet"
     VENTILATION_OUTLET = "VentilationOutlet"
     VENTILATION_TRANSFER = "VentilationTransfer"
     WATER_DETECTION_SENSOR = "WaterDetectionSensor"
     WEATHER_FORECAST_SENSOR = "WeatherForecastSensor"
     WIFI = "Wifi"
-    WIND_SPEED_SENSOR = "WindSpeedSensor"
     WIND_SPEED_AND_DIRECTION_SENSOR = "WindSpeedAndDirectionSensor"
+    WIND_SPEED_SENSOR = "WindSpeedSensor"
     WINDOW_LOCK = "WindowLock"
     WINDOW_WITH_TILT_SENSOR = "WindowWithTiltSensor"
     ZWAVE_AEOTEC_CONFIGURATION = "ZWaveAeotecConfiguration"
     ZWAVE_CONFIGURATION = "ZWaveConfiguration"
-    ZWAVE_DANFOSS_RSLINK = "ZWaveDanfossRSLink"
+    ZWAVE_DANFOSS_RS_LINK = "ZWaveDanfossRSLink"
     ZWAVE_DOOR_LOCK_CONFIGURATION = "ZWaveDoorLockConfiguration"
     ZWAVE_FIBARO_ROLLER_SHUTTER_CONFIGURATION = "ZWaveFibaroRollerShutterConfiguration"
     ZWAVE_HEATIT_THERMOSTAT_CONFIGURATION = "ZWaveHeatitThermostatConfiguration"
     ZWAVE_NODON_CONFIGURATION = "ZWaveNodonConfiguration"
     ZWAVE_QUBINO_CONFIGURATION = "ZWaveQubinoConfiguration"
-    ZWAVE_SEDEVICE_CONFIGURATION = "ZWaveSEDeviceConfiguration"
+    ZWAVE_SE_DEVICE_CONFIGURATION = "ZWaveSEDeviceConfiguration"
     ZWAVE_TRANSCEIVER = "ZWaveTransceiver"
     ZIGBEE_NETWORK = "ZigbeeNetwork"
     ZIGBEE_STACK = "ZigbeeStack"
-
-    UNKNOWN = "unknown"