Add support for fan night light in VeSync (#140637)

* style: rename humidifier night const

* fix: separate night light for fan and humidifier

Check for the presence of set_night_light_brightness and
set_night_light to indentify humidifier and fan devices.

set_night_light is defined on VeSyncAirBypass and
set_night_light_brightness is defined on VeSyncHumid200300S.

update test

homeassistant/components/vesync/const.py

@@ -30,9 +30,13 @@ VS_HUMIDIFIER_MODE_HUMIDITY = "humidity"
 VS_HUMIDIFIER_MODE_MANUAL = "manual"
 VS_HUMIDIFIER_MODE_SLEEP = "sleep"
 
-NIGHT_LIGHT_LEVEL_BRIGHT = "bright"
+FAN_NIGHT_LIGHT_LEVEL_DIM = "dim"
-NIGHT_LIGHT_LEVEL_DIM = "dim"
+FAN_NIGHT_LIGHT_LEVEL_OFF = "off"
-NIGHT_LIGHT_LEVEL_OFF = "off"
+FAN_NIGHT_LIGHT_LEVEL_ON = "on"
+
+HUMIDIFIER_NIGHT_LIGHT_LEVEL_BRIGHT = "bright"
+HUMIDIFIER_NIGHT_LIGHT_LEVEL_DIM = "dim"
+HUMIDIFIER_NIGHT_LIGHT_LEVEL_OFF = "off"
 
 VeSyncHumidifierDevice = VeSyncHumid200300S | VeSyncSuperior6000S
 """Humidifier device types"""

homeassistant/components/vesync/select.py

@@ -15,9 +15,12 @@ from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
 from .common import rgetattr
 from .const import (
     DOMAIN,
-    NIGHT_LIGHT_LEVEL_BRIGHT,
+    FAN_NIGHT_LIGHT_LEVEL_DIM,
-    NIGHT_LIGHT_LEVEL_DIM,
+    FAN_NIGHT_LIGHT_LEVEL_OFF,
-    NIGHT_LIGHT_LEVEL_OFF,
+    FAN_NIGHT_LIGHT_LEVEL_ON,
+    HUMIDIFIER_NIGHT_LIGHT_LEVEL_BRIGHT,
+    HUMIDIFIER_NIGHT_LIGHT_LEVEL_DIM,
+    HUMIDIFIER_NIGHT_LIGHT_LEVEL_OFF,
     VS_COORDINATOR,
     VS_DEVICES,
     VS_DISCOVERY,
@@ -27,14 +30,14 @@ from .entity import VeSyncBaseEntity
 
 _LOGGER = logging.getLogger(__name__)
 
-VS_TO_HA_NIGHT_LIGHT_LEVEL_MAP = {
+VS_TO_HA_HUMIDIFIER_NIGHT_LIGHT_LEVEL_MAP = {
-    100: NIGHT_LIGHT_LEVEL_BRIGHT,
+    100: HUMIDIFIER_NIGHT_LIGHT_LEVEL_BRIGHT,
-    50: NIGHT_LIGHT_LEVEL_DIM,
+    50: HUMIDIFIER_NIGHT_LIGHT_LEVEL_DIM,
-    0: NIGHT_LIGHT_LEVEL_OFF,
+    0: HUMIDIFIER_NIGHT_LIGHT_LEVEL_OFF,
 }
 
-HA_TO_VS_NIGHT_LIGHT_LEVEL_MAP = {
+HA_TO_VS_HUMIDIFIER_NIGHT_LIGHT_LEVEL_MAP = {
-    v: k for k, v in VS_TO_HA_NIGHT_LIGHT_LEVEL_MAP.items()
+    v: k for k, v in VS_TO_HA_HUMIDIFIER_NIGHT_LIGHT_LEVEL_MAP.items()
 }
 
 
@@ -48,20 +51,39 @@ class VeSyncSelectEntityDescription(SelectEntityDescription):
 
 
 SELECT_DESCRIPTIONS: list[VeSyncSelectEntityDescription] = [
+    # night_light for humidifier
     VeSyncSelectEntityDescription(
         key="night_light_level",
         translation_key="night_light_level",
-        options=list(VS_TO_HA_NIGHT_LIGHT_LEVEL_MAP.values()),
+        options=list(VS_TO_HA_HUMIDIFIER_NIGHT_LIGHT_LEVEL_MAP.values()),
         icon="mdi:brightness-6",
-        exists_fn=lambda device: rgetattr(device, "night_light"),
+        exists_fn=lambda device: rgetattr(device, "set_night_light_brightness"),
         # The select_option service framework ensures that only options specified are
         # accepted. ServiceValidationError gets raised for invalid value.
         select_option_fn=lambda device, value: device.set_night_light_brightness(
-            HA_TO_VS_NIGHT_LIGHT_LEVEL_MAP.get(value, 0)
+            HA_TO_VS_HUMIDIFIER_NIGHT_LIGHT_LEVEL_MAP.get(value, 0)
         ),
         # Reporting "off" as the choice for unhandled level.
-        current_option_fn=lambda device: VS_TO_HA_NIGHT_LIGHT_LEVEL_MAP.get(
+        current_option_fn=lambda device: VS_TO_HA_HUMIDIFIER_NIGHT_LIGHT_LEVEL_MAP.get(
-            device.details.get("night_light_brightness"), NIGHT_LIGHT_LEVEL_OFF
+            device.details.get("night_light_brightness"),
+            HUMIDIFIER_NIGHT_LIGHT_LEVEL_OFF,
+        ),
+    ),
+    # night_light for fan devices based on pyvesync.VeSyncAirBypass
+    VeSyncSelectEntityDescription(
+        key="night_light_level",
+        translation_key="night_light_level",
+        options=[
+            FAN_NIGHT_LIGHT_LEVEL_OFF,
+            FAN_NIGHT_LIGHT_LEVEL_DIM,
+            FAN_NIGHT_LIGHT_LEVEL_ON,
+        ],
+        icon="mdi:brightness-6",
+        exists_fn=lambda device: rgetattr(device, "set_night_light"),
+        select_option_fn=lambda device, value: device.set_night_light(value),
+        current_option_fn=lambda device: VS_TO_HA_HUMIDIFIER_NIGHT_LIGHT_LEVEL_MAP.get(
+            device.details.get("night_light"),
+            FAN_NIGHT_LIGHT_LEVEL_OFF,
         ),
     ),
 ]

homeassistant/components/vesync/strings.json

@@ -71,7 +71,8 @@
         "state": {
           "bright": "Bright",
           "dim": "Dim",
-          "off": "[%key:common::state::off%]"
+          "off": "[%key:common::state::off%]",
+          "on": "[%key:common::state::on%]"
         }
       }
     },

tests/components/vesync/test_select.py

@@ -7,8 +7,10 @@ from homeassistant.components.select import (
     DOMAIN as SELECT_DOMAIN,
     SERVICE_SELECT_OPTION,
 )
-from homeassistant.components.vesync.const import NIGHT_LIGHT_LEVEL_DIM
+from homeassistant.components.vesync.const import HUMIDIFIER_NIGHT_LIGHT_LEVEL_DIM
-from homeassistant.components.vesync.select import HA_TO_VS_NIGHT_LIGHT_LEVEL_MAP
+from homeassistant.components.vesync.select import (
+    HA_TO_VS_HUMIDIFIER_NIGHT_LIGHT_LEVEL_MAP,
+)
 from homeassistant.const import ATTR_ENTITY_ID
 from homeassistant.core import HomeAssistant
 
@@ -18,24 +20,24 @@ from .common import ENTITY_HUMIDIFIER_300S_NIGHT_LIGHT_SELECT
 @pytest.mark.parametrize(
     "install_humidifier_device", ["humidifier_300s"], indirect=True
 )
-async def test_set_nightlight_level(
+async def test_humidifier_set_nightlight_level(
     hass: HomeAssistant, manager, humidifier_300s, install_humidifier_device
 ) -> None:
-    """Test set of night light level."""
+    """Test set of humidifier night light level."""
 
     await hass.services.async_call(
         SELECT_DOMAIN,
         SERVICE_SELECT_OPTION,
         {
             ATTR_ENTITY_ID: ENTITY_HUMIDIFIER_300S_NIGHT_LIGHT_SELECT,
-            ATTR_OPTION: NIGHT_LIGHT_LEVEL_DIM,
+            ATTR_OPTION: HUMIDIFIER_NIGHT_LIGHT_LEVEL_DIM,
         },
         blocking=True,
     )
 
     # Assert that setter API was invoked with the expected translated value
     humidifier_300s.set_night_light_brightness.assert_called_once_with(
-        HA_TO_VS_NIGHT_LIGHT_LEVEL_MAP[NIGHT_LIGHT_LEVEL_DIM]
+        HA_TO_VS_HUMIDIFIER_NIGHT_LIGHT_LEVEL_MAP[HUMIDIFIER_NIGHT_LIGHT_LEVEL_DIM]
     )
     # Assert that devices were refreshed
     manager.update_all_devices.assert_called_once()
@@ -44,11 +46,13 @@ async def test_set_nightlight_level(
 @pytest.mark.parametrize(
     "install_humidifier_device", ["humidifier_300s"], indirect=True
 )
-async def test_nightlight_level(hass: HomeAssistant, install_humidifier_device) -> None:
+async def test_humidifier_nightlight_level(
-    """Test the state of night light level select entity."""
+    hass: HomeAssistant, install_humidifier_device
+) -> None:
+    """Test the state of humidifier night light level select entity."""
 
     # The mocked device has night_light_brightness=50 which is "dim"
     assert (
         hass.states.get(ENTITY_HUMIDIFIER_300S_NIGHT_LIGHT_SELECT).state
-        == NIGHT_LIGHT_LEVEL_DIM
+        == HUMIDIFIER_NIGHT_LIGHT_LEVEL_DIM
     )