Add ui_name in generic/subdevices as human readable device type (#8368)

manup · Zehir · web-flow · commit 99604b08bc26 · 2025-10-22T09:31:41.000+02:00
* Add `ui_name` in generic/subdevices for as human readable type string

Historical there are REST-API device types like ZHAWater that can't be changed to stay compatible.
The new `ui_name` key defines a human readable text like "Water leak sensor" which can be displayed in the UI and other things like the compatibility list.

* Trigger validation

---------

Co-authored-by: Zehir &lt;zehir@zorim.fr&gt;
diff --git a/devices/generic/subdevices/air_purifier.json b/devices/generic/subdevices/air_purifier.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_AIR_PURIFIER",
   "name": "ZHAAirPurifier",
+  "ui_name": "Air purifier",
   "restapi": "/sensors",
   "order": 20,
   "uuid": [
diff --git a/devices/generic/subdevices/air_quality_sensor.json b/devices/generic/subdevices/air_quality_sensor.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_AIR_QUALITY_SENSOR",
   "name": "ZHAAirQuality",
+  "ui_name": "Air quality sensor",
   "restapi": "/sensors",
   "order": 20,
   "uuid": [
diff --git a/devices/generic/subdevices/alarm_sensor.json b/devices/generic/subdevices/alarm_sensor.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_ALARM_SENSOR",
   "name": "ZHAAlarm",
+  "ui_name": "Alarm sensor",
   "restapi": "/sensors",
   "order": 30,
   "uuid": [
diff --git a/devices/generic/subdevices/ancillary_control.json b/devices/generic/subdevices/ancillary_control.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_ANCILLARY_CONTROL",
   "name": "ZHAAncillaryControl",
+  "ui_name": "Ancillary control",
   "restapi": "/sensors",
   "order": 20,
   "uuid": [
diff --git a/devices/generic/subdevices/battery_sensor.json b/devices/generic/subdevices/battery_sensor.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_BATTERY_SENSOR",
   "name": "ZHABattery",
+  "ui_name": "Battery sensor",
   "restapi": "/sensors",
   "order": 30,
   "uuid": [
diff --git a/devices/generic/subdevices/carbondioxide_sensor.json b/devices/generic/subdevices/carbondioxide_sensor.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_CARBONDIOXIDE_SENSOR",
   "name": "ZHACarbonDioxide",
+  "ui_name": "Carbon dioxide sensor",
   "restapi": "/sensors",
   "order": 20,
   "uuid": [
diff --git a/devices/generic/subdevices/carbonmonoxide_sensor.json b/devices/generic/subdevices/carbonmonoxide_sensor.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_CARBONMONOXIDE_SENSOR",
   "name": "ZHACarbonMonoxide",
+  "ui_name": "Carbon monoxide sensor",
   "restapi": "/sensors",
   "order": 20,
   "uuid": [
diff --git a/devices/generic/subdevices/color_light.json b/devices/generic/subdevices/color_light.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_COLOR_LIGHT",
   "name": "Color light",
+  "ui_name": "Color light",
   "restapi": "/lights",
   "order": 10,
   "uuid": [
diff --git a/devices/generic/subdevices/color_temperature_light.json b/devices/generic/subdevices/color_temperature_light.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_COLOR_TEMPERATURE_LIGHT",
   "name": "Color temperature light",
+  "ui_name": "Color temperature light",
   "restapi": "/lights",
   "order": 11,
   "uuid": [
diff --git a/devices/generic/subdevices/consumption_sensor.json b/devices/generic/subdevices/consumption_sensor.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_CONSUMPTION_SENSOR",
   "name": "ZHAConsumption",
+  "ui_name": "Consumption sensor",
   "restapi": "/sensors",
   "order": 22,
   "uuid": [
diff --git a/devices/generic/subdevices/dimmable_light.json b/devices/generic/subdevices/dimmable_light.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_DIMMABLE_LIGHT",
   "name": "Dimmable light",
+  "ui_name": "Dimmable light",
   "restapi": "/lights",
   "order": 11,
   "uuid": [
diff --git a/devices/generic/subdevices/dimmable_plugin_unit.json b/devices/generic/subdevices/dimmable_plugin_unit.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_DIMMABLE_PLUGIN_UNIT",
   "name": "Dimmable plug-in unit",
+  "ui_name": "Dimmable plug-in unit",
   "restapi": "/lights",
   "order": 11,
   "uuid": [
diff --git a/devices/generic/subdevices/dimmer_switch.json b/devices/generic/subdevices/dimmer_switch.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_DIMMER_SWITCH",
   "name": "Dimmer switch",
+  "ui_name": "Dimmer switch",
   "restapi": "/lights",
   "order": 11,
   "uuid": [
diff --git a/devices/generic/subdevices/door_lock.json b/devices/generic/subdevices/door_lock.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_DOOR_LOCK",
   "name": "Door Lock",
+  "ui_name": "Door Lock",
   "restapi": "/lights",
   "order": 11,
   "uuid": [
diff --git a/devices/generic/subdevices/door_lock_controller.json b/devices/generic/subdevices/door_lock_controller.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_DOOR_LOCK_CONTROLLER",
   "name": "Door Lock Controller",
+  "ui_name": "Door lock controller",
   "restapi": "/lights",
   "order": 11,
   "uuid": [
diff --git a/devices/generic/subdevices/door_lock_sensor.json b/devices/generic/subdevices/door_lock_sensor.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_DOOR_LOCK_SENSOR",
   "name": "ZHADoorLock",
+  "ui_name": "Door lock sensor",
   "restapi": "/sensors",
   "order": 11,
   "uuid": [
diff --git a/devices/generic/subdevices/extended_color_light.json b/devices/generic/subdevices/extended_color_light.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_EXTENDED_COLOR_LIGHT",
   "name": "Extended color light",
+  "ui_name": "Extended color light",
   "restapi": "/lights",
   "order": 10,
   "uuid": [
diff --git a/devices/generic/subdevices/fire_sensor.json b/devices/generic/subdevices/fire_sensor.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_FIRE_SENSOR",
   "name": "ZHAFire",
+  "ui_name": "Fire sensor",
   "restapi": "/sensors",
   "order": 20,
   "uuid": [
diff --git a/devices/generic/subdevices/formaldehyde_sensor.json b/devices/generic/subdevices/formaldehyde_sensor.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_FORMALDEHYDE_SENSOR",
   "name": "ZHAFormaldehyde",
+  "ui_name": "Formaldehyde sensor",
   "restapi": "/sensors",
   "order": 20,
   "uuid": [
diff --git a/devices/generic/subdevices/humidity_sensor.json b/devices/generic/subdevices/humidity_sensor.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_HUMIDITY_SENSOR",
   "name": "ZHAHumidity",
+  "ui_name": "Humidity sensor",
   "restapi": "/sensors",
   "order": 23,
   "uuid": [
diff --git a/devices/generic/subdevices/level_control_switch.json b/devices/generic/subdevices/level_control_switch.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_LEVEL_CONTROL_SWITCH",
   "name": "Level control switch",
+  "ui_name": "Level control switch",
   "restapi": "/sensors",
   "order": 11,
   "uuid": [
diff --git a/devices/generic/subdevices/light_level_sensor.json b/devices/generic/subdevices/light_level_sensor.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_LIGHT_LEVEL_SENSOR",
   "name": "ZHALightLevel",
+  "ui_name": "Light level sensor",
   "restapi": "/sensors",
   "order": 22,
   "uuid": [
diff --git a/devices/generic/subdevices/moisture_sensor.json b/devices/generic/subdevices/moisture_sensor.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_MOISTURE_SENSOR",
   "name": "ZHAMoisture",
+  "ui_name": "Moisture sensor",
   "restapi": "/sensors",
   "order": 23,
   "uuid": [
diff --git a/devices/generic/subdevices/on_off_light.json b/devices/generic/subdevices/on_off_light.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_ON_OFF_LIGHT",
   "name": "On/Off light",
+  "ui_name": "On/off light",
   "restapi": "/lights",
   "order": 11,
   "uuid": [
diff --git a/devices/generic/subdevices/on_off_output.json b/devices/generic/subdevices/on_off_output.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_ON_OFF_OUTPUT",
   "name": "On/Off output",
+  "ui_name": "On/off output",
   "restapi": "/lights",
   "order": 11,
   "uuid": [
diff --git a/devices/generic/subdevices/on_off_plugin_unit.json b/devices/generic/subdevices/on_off_plugin_unit.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_ON_OFF_PLUGIN_UNIT",
   "name": "On/Off plug-in unit",
+  "ui_name": "On/off plug-in unit",
   "restapi": "/lights",
   "order": 11,
   "uuid": [
diff --git a/devices/generic/subdevices/on_off_switch.json b/devices/generic/subdevices/on_off_switch.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_ON_OFF_SWITCH",
   "name": "On/Off switch",
+  "ui_name": "On/off switch",
   "restapi": "/lights",
   "order": 11,
   "uuid": [
diff --git a/devices/generic/subdevices/open_close_sensor.json b/devices/generic/subdevices/open_close_sensor.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_OPEN_CLOSE_SENSOR",
   "name": "ZHAOpenClose",
+  "ui_name": "Open/close sensor",
   "restapi": "/sensors",
   "order": 20,
   "uuid": [
diff --git a/devices/generic/subdevices/particulatematter_sensor.json b/devices/generic/subdevices/particulatematter_sensor.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_PARTICULATEMATTER_SENSOR",
   "name": "ZHAParticulateMatter",
+  "ui_name": "Particulate matter sensor",
   "restapi": "/sensors",
   "order": 20,
   "uuid": [
diff --git a/devices/generic/subdevices/power_sensor.json b/devices/generic/subdevices/power_sensor.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_POWER_SENSOR",
   "name": "ZHAPower",
+  "ui_name": "Power sensor",
   "restapi": "/sensors",
   "order": 21,
   "uuid": [
diff --git a/devices/generic/subdevices/presence_sensor.json b/devices/generic/subdevices/presence_sensor.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_PRESENCE_SENSOR",
   "name": "ZHAPresence",
+  "ui_name": "Presence sensor",
   "restapi": "/sensors",
   "order": 20,
   "uuid": [
diff --git a/devices/generic/subdevices/pressure_sensor.json b/devices/generic/subdevices/pressure_sensor.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_PRESSURE_SENSOR",
   "name": "ZHAPressure",
+  "ui_name": "Pressure sensor",
   "restapi": "/sensors",
   "order": 24,
   "uuid": [
diff --git a/devices/generic/subdevices/range_extender.json b/devices/generic/subdevices/range_extender.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_RANGE_EXTENDER",
   "name": "Range extender",
+  "ui_name": "Range extender",
   "restapi": "/lights",
   "order": 11,
   "uuid": [
diff --git a/devices/generic/subdevices/relative_rotary.json b/devices/generic/subdevices/relative_rotary.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_RELATIVE_ROTARY",
   "name": "ZHARelativeRotary",
+  "ui_name": "Relative rotary sensor",
   "restapi": "/sensors",
   "order": 20,
   "uuid": [
diff --git a/devices/generic/subdevices/smart_plug.json b/devices/generic/subdevices/smart_plug.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_SMART_PLUG",
   "name": "Smart plug",
+  "ui_name": "Smart plug",
   "restapi": "/lights",
   "order": 11,
   "uuid": [
diff --git a/devices/generic/subdevices/switch.json b/devices/generic/subdevices/switch.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_SWITCH",
   "name": "ZHASwitch",
+  "ui_name": "Switch",
   "restapi": "/sensors",
   "order": 20,
   "uuid": [
diff --git a/devices/generic/subdevices/temperature_sensor.json b/devices/generic/subdevices/temperature_sensor.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_TEMPERATURE_SENSOR",
   "name": "ZHATemperature",
+  "ui_name": "Temperature sensor",
   "restapi": "/sensors",
   "order": 23,
   "uuid": [
diff --git a/devices/generic/subdevices/thermostat.json b/devices/generic/subdevices/thermostat.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_THERMOSTAT",
   "name": "ZHAThermostat",
+  "ui_name": "Thermostat",
   "restapi": "/sensors",
   "order": 20,
   "uuid": [
diff --git a/devices/generic/subdevices/time.json b/devices/generic/subdevices/time.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_TIME",
   "name": "ZHATime",
+  "ui_name": "Time",
   "restapi": "/sensors",
   "order": 20,
   "uuid": [
diff --git a/devices/generic/subdevices/vibration_sensor.json b/devices/generic/subdevices/vibration_sensor.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_VIBRATION_SENSOR",
   "name": "ZHAVibration",
+  "ui_name": "Vibration sensor",
   "restapi": "/sensors",
   "order": 20,
   "uuid": [
diff --git a/devices/generic/subdevices/warning_device.json b/devices/generic/subdevices/warning_device.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_WARNING_DEVICE",
   "name": "Warning device",
+  "ui_name": "Warning device",
   "restapi": "/lights",
   "order": 11,
   "uuid": [
diff --git a/devices/generic/subdevices/water_leak_sensor.json b/devices/generic/subdevices/water_leak_sensor.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_WATER_LEAK_SENSOR",
   "name": "ZHAWater",
+  "ui_name": "Water leak sensor",
   "restapi": "/sensors",
   "order": 20,
   "uuid": [
diff --git a/devices/generic/subdevices/window_covering_device.json b/devices/generic/subdevices/window_covering_device.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_WINDOW_COVERING_DEVICE",
   "name": "Window covering device",
+  "ui_name": "Window covering device",
   "restapi": "/lights",
   "order": 11,
   "uuid": [
diff --git a/devices/generic/subdevices/zgp_switch.json b/devices/generic/subdevices/zgp_switch.json
@@ -2,6 +2,7 @@
   "schema": "subdevice1.schema.json",
   "type": "$TYPE_ZGP_SWITCH",
   "name": "ZGPSwitch",
+  "ui_name": "Switch",
   "restapi": "/sensors",
   "order": 20,
   "uuid": [
