integration inputs

This commit is contained in:
Tim
2021-11-11 22:46:55 +10:30
parent 1c2f4ba084
commit e8aa5ac9a8
3 changed files with 123 additions and 87 deletions

View File

@@ -40,6 +40,9 @@ CONF_FAN_ORDERED_LIST = "fan_speed_ordered_list"
CONF_FAN_DIRECTION = "fan_direction" CONF_FAN_DIRECTION = "fan_direction"
CONF_FAN_DIRECTION_FWD = "fan_direction_forward" CONF_FAN_DIRECTION_FWD = "fan_direction_forward"
CONF_FAN_DIRECTION_REV = "fan_direction_reverse" CONF_FAN_DIRECTION_REV = "fan_direction_reverse"
CONF_FAN_SPEED_DPS_TYPE = "fan_speed_dps_type"
CONF_FAN_PRESET_CONTROL = "fan_preset_control"
CONF_FAN_PRESET_LIST = "fan_preset_list"
# sensor # sensor
CONF_SCALING = "scaling" CONF_SCALING = "scaling"

View File

@@ -1,56 +1,63 @@
"""Platform to locally control Tuya-based fan devices.""" """Platform to locally control Tuya-based fan devices."""
import logging import logging
import math
from functools import partial from functools import partial
import math
import homeassistant.helpers.config_validation as cv import homeassistant.helpers.config_validation as cv
import voluptuous as vol import voluptuous as vol
from homeassistant.components.fan import ( from homeassistant.components.fan import (
DOMAIN,
DIRECTION_FORWARD, DIRECTION_FORWARD,
DIRECTION_REVERSE, DIRECTION_REVERSE,
DOMAIN,
SUPPORT_DIRECTION, SUPPORT_DIRECTION,
SUPPORT_OSCILLATE, SUPPORT_OSCILLATE,
SUPPORT_SET_SPEED, SUPPORT_SET_SPEED,
SUPPORT_PRESET_MODE,
FanEntity, FanEntity,
) )
from homeassistant.util.percentage import (
int_states_in_range,
ordered_list_item_to_percentage,
percentage_to_ordered_list_item,
percentage_to_ranged_value,
ranged_value_to_percentage,
)
from .common import LocalTuyaEntity, async_setup_entry from .common import LocalTuyaEntity, async_setup_entry
from .const import ( from .const import (
CONF_FAN_OSCILLATING_CONTROL,
CONF_FAN_SPEED_CONTROL,
CONF_FAN_PRESET_CONTROL,
CONF_FAN_DIRECTION, CONF_FAN_DIRECTION,
CONF_FAN_DIRECTION_FWD, CONF_FAN_DIRECTION_FWD,
CONF_FAN_DIRECTION_REV, CONF_FAN_DIRECTION_REV,
CONF_FAN_ORDERED_LIST,
CONF_FAN_OSCILLATING_CONTROL,
CONF_FAN_SPEED_CONTROL,
CONF_FAN_SPEED_MAX,
CONF_FAN_SPEED_MIN, CONF_FAN_SPEED_MIN,
CONF_FAN_SPEED_MAX,
CONF_FAN_ORDERED_LIST,
CONF_FAN_SPEED_DPS_TYPE,
CONF_FAN_PRESET_LIST
)
from homeassistant.util.percentage import (
ordered_list_item_to_percentage,
percentage_to_ordered_list_item,
percentage_to_ranged_value,
ranged_value_to_percentage,
int_states_in_range
) )
_LOGGER = logging.getLogger(__name__) _LOGGER = logging.getLogger(__name__)
def flow_schema(dps): def flow_schema(dps):
"""Return schema used in config flow.""" """Return schema used in config flow."""
return { return {
vol.Optional(CONF_FAN_SPEED_CONTROL): vol.In(dps), vol.Optional(CONF_FAN_SPEED_CONTROL): vol.In(dps),
vol.Optional(CONF_FAN_OSCILLATING_CONTROL): vol.In(dps), vol.Optional(CONF_FAN_OSCILLATING_CONTROL): vol.In(dps),
vol.Optional(CONF_FAN_DIRECTION): vol.In(dps), vol.Optional(CONF_FAN_DIRECTION): vol.In(dps),
vol.Optional(CONF_FAN_PRESET_CONTROL): vol.In(dps),
vol.Optional(CONF_FAN_DIRECTION_FWD, default="forward"): cv.string, vol.Optional(CONF_FAN_DIRECTION_FWD, default="forward"): cv.string,
vol.Optional(CONF_FAN_DIRECTION_REV, default="reverse"): cv.string, vol.Optional(CONF_FAN_DIRECTION_REV, default="reverse"): cv.string,
vol.Optional(CONF_FAN_SPEED_MIN, default=1): cv.positive_int, vol.Optional(CONF_FAN_SPEED_MIN, default=1): cv.positive_int,
vol.Optional(CONF_FAN_SPEED_MAX, default=9): cv.positive_int, vol.Optional(CONF_FAN_SPEED_MAX, default=9): cv.positive_int,
vol.Optional(CONF_FAN_ORDERED_LIST, default="disabled"): cv.string, vol.Optional(CONF_FAN_ORDERED_LIST): cv.string,
vol.Optional(CONF_FAN_PRESET_LIST): cv.string,
vol.Optional(CONF_FAN_SPEED_DPS_TYPE, default="string"): vol.In(
["string", "integer", "list"]),
} }
class LocaltuyaFan(LocalTuyaEntity, FanEntity): class LocaltuyaFan(LocalTuyaEntity, FanEntity):
"""Representation of a Tuya fan.""" """Representation of a Tuya fan."""
@@ -67,24 +74,22 @@ class LocaltuyaFan(LocalTuyaEntity, FanEntity):
self._oscillating = None self._oscillating = None
self._direction = None self._direction = None
self._percentage = None self._percentage = None
self._preset = None
self._speed_range = ( self._speed_range = (
self._config.get(CONF_FAN_SPEED_MIN), self._config.get(CONF_FAN_SPEED_MIN),
self._config.get(CONF_FAN_SPEED_MAX), self._config.get(CONF_FAN_SPEED_MAX),
) )
self._ordered_list = self._config.get(CONF_FAN_ORDERED_LIST).split(",") self._ordered_list = self._config.get(CONF_FAN_ORDERED_LIST).replace(" ","").split(",")
self._ordered_list_mode = None self._preset_list = self._config.get(CONF_FAN_PRESET_LIST).replace(" ","").split(",")
self._ordered_speed_dps_type = self._config.get(CONF_FAN_SPEED_DPS_TYPE)
if isinstance(self._ordered_list, list) and len(self._ordered_list) > 1:
self._use_ordered_list = True if (self._ordered_speed_dps_type == "list"
_LOGGER.debug( and isinstance(self._ordered_list, list)
"Fan _use_ordered_list: %s > %s", and len(self._ordered_list) > 1):
self._use_ordered_list, _LOGGER.debug("Fan _use_ordered_list: %s", self._ordered_list)
self._ordered_list,
)
else: else:
self._use_ordered_list = False _LOGGER.debug("Fan _use_ordered_list: Not a valid list")
_LOGGER.debug("Fan _use_ordered_list: %s", self._use_ordered_list)
@property @property
def oscillating(self): def oscillating(self):
"""Return current oscillating status.""" """Return current oscillating status."""
@@ -105,13 +110,12 @@ class LocaltuyaFan(LocalTuyaEntity, FanEntity):
"""Return the current percentage.""" """Return the current percentage."""
return self._percentage return self._percentage
async def async_turn_on(self, percentage: str = None, async def async_turn_on(self, percentage: str = None, **kwargs) -> None:
preset_mode: str = None, **kwargs) -> None:
"""Turn on the entity.""" """Turn on the entity."""
_LOGGER.debug("Fan async_turn_on") _LOGGER.debug("Fan async_turn_on")
await self._device.set_dp(True, self._dp_id) await self._device.set_dp(True, self._dp_id)
if percentage is not None: if percentage is not None:
await self.async_set_percentage(percentage) await self.async_set_percentage(speed)
else: else:
self.schedule_update_ha_state() self.schedule_update_ha_state()
@@ -124,42 +128,44 @@ class LocaltuyaFan(LocalTuyaEntity, FanEntity):
async def async_set_percentage(self, percentage): async def async_set_percentage(self, percentage):
"""Set the speed of the fan.""" """Set the speed of the fan."""
_LOGGER.debug("Fan async_set_percentage: %s", percentage)
_LOGGER.debug("Fan async_set_percentage: %s", percentage)
if percentage is not None: if percentage is not None:
if percentage == 0: if percentage == 0:
return await self.async_turn_off() return await self.async_turn_off()
elif not self.is_on:
if not self.is_on:
await self.async_turn_on() await self.async_turn_on()
if self._use_ordered_list:
if self._ordered_speed_dps_type == "string":
send_speed = str(math.ceil(
percentage_to_ranged_value(self._speed_range, percentage)))
await self._device.set_dp( await self._device.set_dp(
str( send_speed, self._config.get(CONF_FAN_SPEED_CONTROL))
percentage_to_ordered_list_item(self._ordered_list, percentage) _LOGGER.debug("Fan async_set_percentage: %s > %s",
), percentage, send_speed)
self._config.get(CONF_FAN_SPEED_CONTROL),
) elif self._ordered_speed_dps_type == "integer":
_LOGGER.debug( send_speed = int(math.ceil(
"Fan async_set_percentage: %s > %s", percentage_to_ranged_value(self._speed_range, percentage)))
percentage, await self._device.set_dp(
percentage_to_ordered_list_item(self._ordered_list, percentage), send_speed, self._config.get(CONF_FAN_SPEED_CONTROL))
) _LOGGER.debug("Fan async_set_percentage: %s > %s",
percentage, send_speed)
else: elif self._ordered_speed_dps_type == "list":
await self._device.set_dp( send_speed = str(
str( percentage_to_ordered_list_item(self._ordered_list, percentage)
math.ceil(
percentage_to_ranged_value(self._speed_range, percentage)
) )
), await self._device.set_dp(
self._config.get(CONF_FAN_SPEED_CONTROL), send_speed, self._config.get(CONF_FAN_SPEED_CONTROL))
) _LOGGER.debug("Fan async_set_percentage: %s > %s",
_LOGGER.debug( percentage, send_speed)
"Fan async_set_percentage: %s > %s",
percentage,
percentage_to_ranged_value(self._speed_range, percentage),
)
self.schedule_update_ha_state() self.schedule_update_ha_state()
async def async_oscillate(self, oscillating: bool) -> None: async def async_oscillate(self, oscillating: bool) -> None:
"""Set oscillation.""" """Set oscillation."""
_LOGGER.debug("Fan async_oscillate: %s", oscillating) _LOGGER.debug("Fan async_oscillate: %s", oscillating)
@@ -174,10 +180,21 @@ class LocaltuyaFan(LocalTuyaEntity, FanEntity):
if direction == DIRECTION_FORWARD: if direction == DIRECTION_FORWARD:
value = self._config.get(CONF_FAN_DIRECTION_FWD) value = self._config.get(CONF_FAN_DIRECTION_FWD)
if direction == DIRECTION_REVERSE: if direction == DIRECTION_REVERSE:
value = self._config.get(CONF_FAN_DIRECTION_REV) value = self._config.get(CONF_FAN_DIRECTION_REV)
await self._device.set_dp(value, self._config.get(CONF_FAN_DIRECTION))
await self._device.set_dp(
value, self._config.get(CONF_FAN_DIRECTION)
)
self.schedule_update_ha_state()
async def async_set_preset_mode(self, preset_mode: str) -> None:
"""Set the preset mode of the fan."""
_LOGGER.debug("Fan set preset: %s", preset_mode)
await self._device.set_dp(
preset_mode, self._config.get(CONF_FAN_PRESET_CONTROL)
)
self.schedule_update_ha_state() self.schedule_update_ha_state()
@property @property
@@ -194,8 +211,11 @@ class LocaltuyaFan(LocalTuyaEntity, FanEntity):
if self.has_config(CONF_FAN_DIRECTION): if self.has_config(CONF_FAN_DIRECTION):
features |= SUPPORT_DIRECTION features |= SUPPORT_DIRECTION
return features if self.has_config(CONF_FAN_PRESET_CONTROL):
features |= SUPPORT_PRESET_MODE
return features
@property @property
def speed_count(self) -> int: def speed_count(self) -> int:
"""Speed count for the fan.""" """Speed count for the fan."""
@@ -203,34 +223,41 @@ class LocaltuyaFan(LocalTuyaEntity, FanEntity):
_LOGGER.debug("Fan speed_count: %s", speed_count) _LOGGER.debug("Fan speed_count: %s", speed_count)
return speed_count return speed_count
def status_updated(self): def status_updated(self):
"""Get state of Tuya fan.""" """Get state of Tuya fan."""
self._is_on = self.dps(self._dp_id) self._is_on = self.dps(self._dp_id)
if self.has_config(CONF_FAN_PRESET_CONTROL):
current_preset = self.dps_conf(CONF_FAN_PRESET_CONTROL)
if current_preset is not None and current_preset in self._preset_list:
_LOGGER.debug("Fan current_preset in preset list: %s from %s",
current_preset, self._preset_list)
self._preset = current_preset
current_speed = self.dps_conf(CONF_FAN_SPEED_CONTROL) current_speed = self.dps_conf(CONF_FAN_SPEED_CONTROL)
if self._use_ordered_list: if current_speed is not None:
_LOGGER.debug(
"Fan current_speed ordered_list_item_to_percentage: %s from %s",
current_speed,
self._ordered_list,
)
if current_speed is not None:
self._percentage = ordered_list_item_to_percentage(
self._ordered_list, current_speed
)
else: if (self.has_config(CONF_FAN_PRESET_CONTROL)
_LOGGER.debug( and (CONF_FAN_SPEED_CONTROL == CONF_FAN_PRESET_CONTROL)
"Fan current_speed ranged_value_to_percentage: %s from %s", and (current_speed in self._preset_list)):
current_speed, _LOGGER.debug("Fan current_speed in preset list: %s from %s",
self._speed_range, current_speed, self._preset_list)
) self._preset = current_speed
if current_speed is not None:
self._percentage = ranged_value_to_percentage(
self._speed_range, int(current_speed)
)
_LOGGER.debug("Fan current_percentage: %s", self._percentage) elif self._ordered_speed_dps_type == "list":
_LOGGER.debug("Fan current_speed ordered_list_item_to_percentage: %s from %s",
current_speed, self._ordered_list)
self._percentage = ordered_list_item_to_percentage(self._ordered_list, current_speed)
elif self._ordered_speed_dps_type == "string" or self._ordered_speed_dps_type == "integer" :
_LOGGER.debug("Fan current_speed ranged_value_to_percentage: %s from %s",
current_speed, self._speed_range)
self._percentage = ranged_value_to_percentage(self._speed_range, int(current_speed))
_LOGGER.debug("Fan current_percentage: %s", self._percentage)
_LOGGER.debug("Fan current_preset: %s", self._preset)
if self.has_config(CONF_FAN_OSCILLATING_CONTROL): if self.has_config(CONF_FAN_OSCILLATING_CONTROL):
self._oscillating = self.dps_conf(CONF_FAN_OSCILLATING_CONTROL) self._oscillating = self.dps_conf(CONF_FAN_OSCILLATING_CONTROL)
@@ -241,10 +268,10 @@ class LocaltuyaFan(LocalTuyaEntity, FanEntity):
if value is not None: if value is not None:
if value == self._config.get(CONF_FAN_DIRECTION_FWD): if value == self._config.get(CONF_FAN_DIRECTION_FWD):
self._direction = DIRECTION_FORWARD self._direction = DIRECTION_FORWARD
if value == self._config.get(CONF_FAN_DIRECTION_REV): if value == self._config.get(CONF_FAN_DIRECTION_REV):
self._direction = DIRECTION_REVERSE self._direction = DIRECTION_REVERSE
_LOGGER.debug("Fan current_direction : %s > %s", value, self._direction) _LOGGER.debug("Fan current_direction : %s > %s", value, self._direction)
async_setup_entry = partial(async_setup_entry, DOMAIN, LocaltuyaFan, flow_schema) async_setup_entry = partial(async_setup_entry, DOMAIN, LocaltuyaFan, flow_schema)

View File

@@ -77,7 +77,10 @@
"fan_speed_ordered_list": "Fan speed modes list (overrides speed min/max)", "fan_speed_ordered_list": "Fan speed modes list (overrides speed min/max)",
"fan_direction":"fan direction dps", "fan_direction":"fan direction dps",
"fan_direction_forward": "forward dps string", "fan_direction_forward": "forward dps string",
"fan_direction_reverse": "reverse dps string" "fan_direction_reverse": "reverse dps string",
"fan_speed_dps_type": "type of speed dps control. integer/string/list",
"fan_preset_control": "Fan preset dps. Can be the same as speed",
"fan_preset_list": "Fan preset list. Comma separated"
} }
} }
} }
@@ -132,7 +135,10 @@
"fan_speed_ordered_list": "Fan speed modes list (overrides speed min/max)", "fan_speed_ordered_list": "Fan speed modes list (overrides speed min/max)",
"fan_direction":"fan direction dps", "fan_direction":"fan direction dps",
"fan_direction_forward": "forward dps string", "fan_direction_forward": "forward dps string",
"fan_direction_reverse": "reverse dps string" "fan_direction_reverse": "reverse dps string",
"fan_speed_dps_type": "type of speed dps control. integer/string/list",
"fan_preset_control": "Fan preset dps. CAn be the same as speed",
"fan_preset_list": "Fan preset list. Comma separated"
} }
}, },
"yaml_import": { "yaml_import": {