From 0693d8a064633135a19c21138fd81c7364e2b2fa Mon Sep 17 00:00:00 2001 From: "J. Nick Koston" Date: Thu, 28 Jan 2021 03:15:24 -0600 Subject: [PATCH] Update zwave_js to use new fan entity model (#45543) --- homeassistant/components/zwave_js/fan.py | 68 ++++++++---------------- tests/components/zwave_js/test_fan.py | 2 +- 2 files changed, 22 insertions(+), 48 deletions(-) diff --git a/homeassistant/components/zwave_js/fan.py b/homeassistant/components/zwave_js/fan.py index 29a93b38b8c..6e62869f749 100644 --- a/homeassistant/components/zwave_js/fan.py +++ b/homeassistant/components/zwave_js/fan.py @@ -7,16 +7,16 @@ from zwave_js_server.client import Client as ZwaveClient from homeassistant.components.fan import ( DOMAIN as FAN_DOMAIN, - SPEED_HIGH, - SPEED_LOW, - SPEED_MEDIUM, - SPEED_OFF, SUPPORT_SET_SPEED, FanEntity, ) from homeassistant.config_entries import ConfigEntry from homeassistant.core import HomeAssistant, callback from homeassistant.helpers.dispatcher import async_dispatcher_connect +from homeassistant.util.percentage import ( + percentage_to_ranged_value, + ranged_value_to_percentage, +) from .const import DATA_CLIENT, DATA_UNSUBSCRIBE, DOMAIN from .discovery import ZwaveDiscoveryInfo @@ -26,10 +26,7 @@ _LOGGER = logging.getLogger(__name__) SUPPORTED_FEATURES = SUPPORT_SET_SPEED -# Value will first be divided to an integer -VALUE_TO_SPEED = {0: SPEED_OFF, 1: SPEED_LOW, 2: SPEED_MEDIUM, 3: SPEED_HIGH} -SPEED_TO_VALUE = {SPEED_OFF: 0, SPEED_LOW: 1, SPEED_MEDIUM: 50, SPEED_HIGH: 99} -SPEED_LIST = [*SPEED_TO_VALUE] +SPEED_RANGE = (1, 99) # off is not included async def async_setup_entry( @@ -57,28 +54,20 @@ async def async_setup_entry( class ZwaveFan(ZWaveBaseEntity, FanEntity): """Representation of a Z-Wave fan.""" - def __init__( - self, config_entry: ConfigEntry, client: ZwaveClient, info: ZwaveDiscoveryInfo - ) -> None: - """Initialize the fan.""" - super().__init__(config_entry, client, info) - self._previous_speed: Optional[str] = None - - async def async_set_speed(self, speed: str) -> None: - """Set the speed of the fan.""" - if speed not in SPEED_TO_VALUE: - raise ValueError(f"Invalid speed received: {speed}") - self._previous_speed = speed + async def async_set_percentage(self, percentage: Optional[int]) -> None: + """Set the speed percentage of the fan.""" target_value = self.get_zwave_value("targetValue") - await self.info.node.async_set_value(target_value, SPEED_TO_VALUE[speed]) - # - # The fan entity model has changed to use percentages and preset_modes - # instead of speeds. - # - # Please review - # https://developers.home-assistant.io/docs/core/entity/fan/ - # + if percentage is None: + # Value 255 tells device to return to previous value + zwave_speed = 255 + elif percentage == 0: + zwave_speed = 0 + else: + zwave_speed = math.ceil(percentage_to_ranged_value(SPEED_RANGE, percentage)) + + await self.info.node.async_set_value(target_value, zwave_speed) + async def async_turn_on( self, speed: Optional[str] = None, @@ -87,12 +76,7 @@ class ZwaveFan(ZWaveBaseEntity, FanEntity): **kwargs: Any, ) -> None: """Turn the device on.""" - if speed is None: - # Value 255 tells device to return to previous value - target_value = self.get_zwave_value("targetValue") - await self.info.node.async_set_value(target_value, 255) - else: - await self.async_set_speed(speed) + await self.async_set_percentage(percentage) async def async_turn_off(self, **kwargs: Any) -> None: """Turn the device off.""" @@ -105,19 +89,9 @@ class ZwaveFan(ZWaveBaseEntity, FanEntity): return bool(self.info.primary_value.value > 0) @property - def speed(self) -> Optional[str]: - """Return the current speed. - - The Z-Wave speed value is a byte 0-255. 255 means previous value. - The normal range of the speed is 0-99. 0 means off. - """ - value = math.ceil(self.info.primary_value.value * 3 / 100) - return VALUE_TO_SPEED.get(value, self._previous_speed) - - @property - def speed_list(self) -> List[str]: - """Get the list of available speeds.""" - return SPEED_LIST + def percentage(self) -> int: + """Return the current speed percentage.""" + return ranged_value_to_percentage(SPEED_RANGE, self.info.primary_value.value) @property def supported_features(self) -> int: diff --git a/tests/components/zwave_js/test_fan.py b/tests/components/zwave_js/test_fan.py index 5b726179ac9..a817a551f9b 100644 --- a/tests/components/zwave_js/test_fan.py +++ b/tests/components/zwave_js/test_fan.py @@ -43,7 +43,7 @@ async def test_fan(hass, client, in_wall_smart_fan_control, integration): "label": "Target value", }, } - assert args["value"] == 50 + assert args["value"] == 66 client.async_send_command.reset_mock()