mirror of
https://github.com/home-assistant/core.git
synced 2025-07-22 20:57:21 +00:00
Add Tasmota fan (#43353)
* Add Tasmota fan * Bump hatasmota to 0.1.0 * Apply suggestions from code review
This commit is contained in:
Erik Montnemery
GitHub
parent
ac551179ae
commit
314497d013
@ -10,6 +10,7 @@ DOMAIN = "tasmota"
|
||||
|
||||
PLATFORMS = [
|
||||
"binary_sensor",
|
||||
"fan",
|
||||
"light",
|
||||
"sensor",
|
||||
"switch",
|
||||
|
||||
88
homeassistant/components/tasmota/fan.py
Normal file
88
homeassistant/components/tasmota/fan.py
Normal file
@ -0,0 +1,88 @@
|
||||
"""Support for Tasmota fans."""
|
||||
|
||||
from hatasmota import const as tasmota_const
|
||||
|
||||
from homeassistant.components import fan
|
||||
from homeassistant.components.fan import FanEntity
|
||||
from homeassistant.core import callback
|
||||
from homeassistant.helpers.dispatcher import async_dispatcher_connect
|
||||
|
||||
from .const import DATA_REMOVE_DISCOVER_COMPONENT, DOMAIN as TASMOTA_DOMAIN
|
||||
from .discovery import TASMOTA_DISCOVERY_ENTITY_NEW
|
||||
from .mixins import TasmotaAvailability, TasmotaDiscoveryUpdate
|
||||
|
||||
HA_TO_TASMOTA_SPEED_MAP = {
|
||||
fan.SPEED_OFF: tasmota_const.FAN_SPEED_OFF,
|
||||
fan.SPEED_LOW: tasmota_const.FAN_SPEED_LOW,
|
||||
fan.SPEED_MEDIUM: tasmota_const.FAN_SPEED_MEDIUM,
|
||||
fan.SPEED_HIGH: tasmota_const.FAN_SPEED_HIGH,
|
||||
}
|
||||
|
||||
TASMOTA_TO_HA_SPEED_MAP = {v: k for k, v in HA_TO_TASMOTA_SPEED_MAP.items()}
|
||||
|
||||
|
||||
async def async_setup_entry(hass, config_entry, async_add_entities):
|
||||
"""Set up Tasmota fan dynamically through discovery."""
|
||||
|
||||
@callback
|
||||
def async_discover(tasmota_entity, discovery_hash):
|
||||
"""Discover and add a Tasmota fan."""
|
||||
async_add_entities(
|
||||
[TasmotaFan(tasmota_entity=tasmota_entity, discovery_hash=discovery_hash)]
|
||||
)
|
||||
|
||||
hass.data[
|
||||
DATA_REMOVE_DISCOVER_COMPONENT.format(fan.DOMAIN)
|
||||
] = async_dispatcher_connect(
|
||||
hass,
|
||||
TASMOTA_DISCOVERY_ENTITY_NEW.format(fan.DOMAIN, TASMOTA_DOMAIN),
|
||||
async_discover,
|
||||
)
|
||||
|
||||
|
||||
class TasmotaFan(
|
||||
TasmotaAvailability,
|
||||
TasmotaDiscoveryUpdate,
|
||||
FanEntity,
|
||||
):
|
||||
"""Representation of a Tasmota fan."""
|
||||
|
||||
def __init__(self, **kwds):
|
||||
"""Initialize the Tasmota fan."""
|
||||
self._state = None
|
||||
|
||||
super().__init__(
|
||||
discovery_update=self.discovery_update,
|
||||
**kwds,
|
||||
)
|
||||
|
||||
@property
|
||||
def speed(self):
|
||||
"""Return the current speed."""
|
||||
return TASMOTA_TO_HA_SPEED_MAP.get(self._state)
|
||||
|
||||
@property
|
||||
def speed_list(self):
|
||||
"""Get the list of available speeds."""
|
||||
return list(HA_TO_TASMOTA_SPEED_MAP.keys())
|
||||
|
||||
@property
|
||||
def supported_features(self):
|
||||
"""Flag supported features."""
|
||||
return fan.SUPPORT_SET_SPEED
|
||||
|
||||
async def async_set_speed(self, speed):
|
||||
"""Set the speed of the fan."""
|
||||
if speed == fan.SPEED_OFF:
|
||||
await self.async_turn_off()
|
||||
else:
|
||||
self._tasmota_entity.set_speed(HA_TO_TASMOTA_SPEED_MAP[speed])
|
||||
|
||||
async def async_turn_on(self, speed=None, **kwargs):
|
||||
"""Turn the fan on."""
|
||||
# Tasmota does not support turning a fan on with implicit speed
|
||||
await self.async_set_speed(speed or fan.SPEED_MEDIUM)
|
||||
|
||||
async def async_turn_off(self, **kwargs):
|
||||
"""Turn the fan off."""
|
||||
self._tasmota_entity.set_speed(tasmota_const.FAN_SPEED_OFF)
|
||||
255
tests/components/tasmota/test_fan.py
Normal file
255
tests/components/tasmota/test_fan.py
Normal file
@ -0,0 +1,255 @@
|
||||
"""The tests for the Tasmota fan platform."""
|
||||
import copy
|
||||
import json
|
||||
|
||||
from hatasmota.utils import (
|
||||
get_topic_stat_result,
|
||||
get_topic_tele_state,
|
||||
get_topic_tele_will,
|
||||
)
|
||||
|
||||
from homeassistant.components import fan
|
||||
from homeassistant.components.tasmota.const import DEFAULT_PREFIX
|
||||
from homeassistant.const import ATTR_ASSUMED_STATE, STATE_OFF, STATE_ON
|
||||
|
||||
from .test_common import (
|
||||
DEFAULT_CONFIG,
|
||||
help_test_availability,
|
||||
help_test_availability_discovery_update,
|
||||
help_test_availability_poll_state,
|
||||
help_test_availability_when_connection_lost,
|
||||
help_test_discovery_device_remove,
|
||||
help_test_discovery_removal,
|
||||
help_test_discovery_update_unchanged,
|
||||
help_test_entity_id_update_discovery_update,
|
||||
help_test_entity_id_update_subscriptions,
|
||||
)
|
||||
|
||||
from tests.async_mock import patch
|
||||
from tests.common import async_fire_mqtt_message
|
||||
from tests.components.fan import common
|
||||
|
||||
|
||||
async def test_controlling_state_via_mqtt(hass, mqtt_mock, setup_tasmota):
|
||||
"""Test state update via MQTT."""
|
||||
config = copy.deepcopy(DEFAULT_CONFIG)
|
||||
config["if"] = 1
|
||||
mac = config["mac"]
|
||||
|
||||
async_fire_mqtt_message(
|
||||
hass,
|
||||
f"{DEFAULT_PREFIX}/{mac}/config",
|
||||
json.dumps(config),
|
||||
)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
state = hass.states.get("fan.tasmota")
|
||||
assert state.state == "unavailable"
|
||||
assert not state.attributes.get(ATTR_ASSUMED_STATE)
|
||||
|
||||
async_fire_mqtt_message(hass, "tasmota_49A3BC/tele/LWT", "Online")
|
||||
state = hass.states.get("fan.tasmota")
|
||||
assert state.state == STATE_OFF
|
||||
assert state.attributes["speed"] is None
|
||||
assert state.attributes["speed_list"] == ["off", "low", "medium", "high"]
|
||||
assert state.attributes["supported_features"] == fan.SUPPORT_SET_SPEED
|
||||
assert not state.attributes.get(ATTR_ASSUMED_STATE)
|
||||
|
||||
async_fire_mqtt_message(hass, "tasmota_49A3BC/tele/STATE", '{"FanSpeed":1}')
|
||||
state = hass.states.get("fan.tasmota")
|
||||
assert state.state == STATE_ON
|
||||
assert state.attributes["speed"] == "low"
|
||||
|
||||
async_fire_mqtt_message(hass, "tasmota_49A3BC/tele/STATE", '{"FanSpeed":2}')
|
||||
state = hass.states.get("fan.tasmota")
|
||||
assert state.state == STATE_ON
|
||||
assert state.attributes["speed"] == "medium"
|
||||
|
||||
async_fire_mqtt_message(hass, "tasmota_49A3BC/tele/STATE", '{"FanSpeed":3}')
|
||||
state = hass.states.get("fan.tasmota")
|
||||
assert state.state == STATE_ON
|
||||
assert state.attributes["speed"] == "high"
|
||||
|
||||
async_fire_mqtt_message(hass, "tasmota_49A3BC/tele/STATE", '{"FanSpeed":0}')
|
||||
state = hass.states.get("fan.tasmota")
|
||||
assert state.state == STATE_OFF
|
||||
assert state.attributes["speed"] == "off"
|
||||
|
||||
async_fire_mqtt_message(hass, "tasmota_49A3BC/stat/RESULT", '{"FanSpeed":1}')
|
||||
state = hass.states.get("fan.tasmota")
|
||||
assert state.state == STATE_ON
|
||||
assert state.attributes["speed"] == "low"
|
||||
|
||||
async_fire_mqtt_message(hass, "tasmota_49A3BC/stat/RESULT", '{"FanSpeed":0}')
|
||||
state = hass.states.get("fan.tasmota")
|
||||
assert state.state == STATE_OFF
|
||||
assert state.attributes["speed"] == "off"
|
||||
|
||||
|
||||
async def test_sending_mqtt_commands(hass, mqtt_mock, setup_tasmota):
|
||||
"""Test the sending MQTT commands."""
|
||||
config = copy.deepcopy(DEFAULT_CONFIG)
|
||||
config["if"] = 1
|
||||
mac = config["mac"]
|
||||
|
||||
async_fire_mqtt_message(
|
||||
hass,
|
||||
f"{DEFAULT_PREFIX}/{mac}/config",
|
||||
json.dumps(config),
|
||||
)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
async_fire_mqtt_message(hass, "tasmota_49A3BC/tele/LWT", "Online")
|
||||
state = hass.states.get("fan.tasmota")
|
||||
assert state.state == STATE_OFF
|
||||
await hass.async_block_till_done()
|
||||
await hass.async_block_till_done()
|
||||
mqtt_mock.async_publish.reset_mock()
|
||||
|
||||
# Turn the fan on and verify MQTT message is sent
|
||||
await common.async_turn_on(hass, "fan.tasmota")
|
||||
mqtt_mock.async_publish.assert_called_once_with(
|
||||
"tasmota_49A3BC/cmnd/FanSpeed", "2", 0, False
|
||||
)
|
||||
mqtt_mock.async_publish.reset_mock()
|
||||
|
||||
# Tasmota is not optimistic, the state should still be off
|
||||
state = hass.states.get("fan.tasmota")
|
||||
assert state.state == STATE_OFF
|
||||
|
||||
# Turn the fan off and verify MQTT message is sent
|
||||
await common.async_turn_off(hass, "fan.tasmota")
|
||||
mqtt_mock.async_publish.assert_called_once_with(
|
||||
"tasmota_49A3BC/cmnd/FanSpeed", "0", 0, False
|
||||
)
|
||||
mqtt_mock.async_publish.reset_mock()
|
||||
|
||||
# Set speed and verify MQTT message is sent
|
||||
await common.async_set_speed(hass, "fan.tasmota", fan.SPEED_OFF)
|
||||
mqtt_mock.async_publish.assert_called_once_with(
|
||||
"tasmota_49A3BC/cmnd/FanSpeed", "0", 0, False
|
||||
)
|
||||
mqtt_mock.async_publish.reset_mock()
|
||||
|
||||
# Set speed and verify MQTT message is sent
|
||||
await common.async_set_speed(hass, "fan.tasmota", fan.SPEED_LOW)
|
||||
mqtt_mock.async_publish.assert_called_once_with(
|
||||
"tasmota_49A3BC/cmnd/FanSpeed", "1", 0, False
|
||||
)
|
||||
mqtt_mock.async_publish.reset_mock()
|
||||
|
||||
# Set speed and verify MQTT message is sent
|
||||
await common.async_set_speed(hass, "fan.tasmota", fan.SPEED_MEDIUM)
|
||||
mqtt_mock.async_publish.assert_called_once_with(
|
||||
"tasmota_49A3BC/cmnd/FanSpeed", "2", 0, False
|
||||
)
|
||||
mqtt_mock.async_publish.reset_mock()
|
||||
|
||||
# Set speed and verify MQTT message is sent
|
||||
await common.async_set_speed(hass, "fan.tasmota", fan.SPEED_HIGH)
|
||||
mqtt_mock.async_publish.assert_called_once_with(
|
||||
"tasmota_49A3BC/cmnd/FanSpeed", "3", 0, False
|
||||
)
|
||||
|
||||
|
||||
async def test_availability_when_connection_lost(
|
||||
hass, mqtt_client_mock, mqtt_mock, setup_tasmota
|
||||
):
|
||||
"""Test availability after MQTT disconnection."""
|
||||
config = copy.deepcopy(DEFAULT_CONFIG)
|
||||
config["dn"] = "Test"
|
||||
config["if"] = 1
|
||||
await help_test_availability_when_connection_lost(
|
||||
hass, mqtt_client_mock, mqtt_mock, fan.DOMAIN, config
|
||||
)
|
||||
|
||||
|
||||
async def test_availability(hass, mqtt_mock, setup_tasmota):
|
||||
"""Test availability."""
|
||||
config = copy.deepcopy(DEFAULT_CONFIG)
|
||||
config["dn"] = "Test"
|
||||
config["if"] = 1
|
||||
await help_test_availability(hass, mqtt_mock, fan.DOMAIN, config)
|
||||
|
||||
|
||||
async def test_availability_discovery_update(hass, mqtt_mock, setup_tasmota):
|
||||
"""Test availability discovery update."""
|
||||
config = copy.deepcopy(DEFAULT_CONFIG)
|
||||
config["dn"] = "Test"
|
||||
config["if"] = 1
|
||||
await help_test_availability_discovery_update(hass, mqtt_mock, fan.DOMAIN, config)
|
||||
|
||||
|
||||
async def test_availability_poll_state(
|
||||
hass, mqtt_client_mock, mqtt_mock, setup_tasmota
|
||||
):
|
||||
"""Test polling after MQTT connection (re)established."""
|
||||
config = copy.deepcopy(DEFAULT_CONFIG)
|
||||
config["if"] = 1
|
||||
poll_topic = "tasmota_49A3BC/cmnd/STATE"
|
||||
await help_test_availability_poll_state(
|
||||
hass, mqtt_client_mock, mqtt_mock, fan.DOMAIN, config, poll_topic, ""
|
||||
)
|
||||
|
||||
|
||||
async def test_discovery_removal_fan(hass, mqtt_mock, caplog, setup_tasmota):
|
||||
"""Test removal of discovered fan."""
|
||||
config1 = copy.deepcopy(DEFAULT_CONFIG)
|
||||
config1["dn"] = "Test"
|
||||
config1["if"] = 1
|
||||
config2 = copy.deepcopy(DEFAULT_CONFIG)
|
||||
config2["dn"] = "Test"
|
||||
config2["if"] = 0
|
||||
|
||||
await help_test_discovery_removal(
|
||||
hass, mqtt_mock, caplog, fan.DOMAIN, config1, config2
|
||||
)
|
||||
|
||||
|
||||
async def test_discovery_update_unchanged_fan(hass, mqtt_mock, caplog, setup_tasmota):
|
||||
"""Test update of discovered fan."""
|
||||
config = copy.deepcopy(DEFAULT_CONFIG)
|
||||
config["dn"] = "Test"
|
||||
config["if"] = 1
|
||||
with patch(
|
||||
"homeassistant.components.tasmota.fan.TasmotaFan.discovery_update"
|
||||
) as discovery_update:
|
||||
await help_test_discovery_update_unchanged(
|
||||
hass, mqtt_mock, caplog, fan.DOMAIN, config, discovery_update
|
||||
)
|
||||
|
||||
|
||||
async def test_discovery_device_remove(hass, mqtt_mock, setup_tasmota):
|
||||
"""Test device registry remove."""
|
||||
config = copy.deepcopy(DEFAULT_CONFIG)
|
||||
config["dn"] = "Test"
|
||||
config["if"] = 1
|
||||
unique_id = f"{DEFAULT_CONFIG['mac']}_fan_fan_ifan"
|
||||
await help_test_discovery_device_remove(
|
||||
hass, mqtt_mock, fan.DOMAIN, unique_id, config
|
||||
)
|
||||
|
||||
|
||||
async def test_entity_id_update_subscriptions(hass, mqtt_mock, setup_tasmota):
|
||||
"""Test MQTT subscriptions are managed when entity_id is updated."""
|
||||
config = copy.deepcopy(DEFAULT_CONFIG)
|
||||
config["dn"] = "Test"
|
||||
config["if"] = 1
|
||||
topics = [
|
||||
get_topic_stat_result(config),
|
||||
get_topic_tele_state(config),
|
||||
get_topic_tele_will(config),
|
||||
]
|
||||
await help_test_entity_id_update_subscriptions(
|
||||
hass, mqtt_mock, fan.DOMAIN, config, topics
|
||||
)
|
||||
|
||||
|
||||
async def test_entity_id_update_discovery_update(hass, mqtt_mock, setup_tasmota):
|
||||
"""Test MQTT discovery update when entity_id is updated."""
|
||||
config = copy.deepcopy(DEFAULT_CONFIG)
|
||||
config["dn"] = "Test"
|
||||
config["if"] = 1
|
||||
await help_test_entity_id_update_discovery_update(
|
||||
hass, mqtt_mock, fan.DOMAIN, config
|
||||
)
|
||||
Loading…
x
Reference in New Issue
Block a user