jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-26 22:57:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Only accept valid hvac actions sent via mqtt (#59919)

Browse Source 
* Only accept valid hvac actions sent via mqtt

* Only accept valid hvac actions sent via mqtt

* Fix existing action test and remove old one

* Remote None as valid hvac action being accepted

* Change loglevel of wrong hvac action received
This commit is contained in:
Till Skrodzki 2021-11-25 15:53:34 +01:00 committed by GitHub
parent 4c0d90ed41
commit 635d875b1d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 36 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
homeassistant/components/mqtt/climate.py
View File

@ -13,6 +13,7 @@ from homeassistant.components.climate.const import (
ATTR_HVAC_MODE, ATTR_HVAC_MODE,
ATTR_TARGET_TEMP_HIGH, ATTR_TARGET_TEMP_HIGH,
ATTR_TARGET_TEMP_LOW, ATTR_TARGET_TEMP_LOW,
CURRENT_HVAC_ACTIONS,
DEFAULT_MAX_TEMP, DEFAULT_MAX_TEMP,
DEFAULT_MIN_TEMP, DEFAULT_MIN_TEMP,
FAN_AUTO, FAN_AUTO,
@ -405,9 +406,15 @@ class MqttClimate(MqttEntity, ClimateEntity):
def handle_action_received(msg): def handle_action_received(msg):
"""Handle receiving action via MQTT.""" """Handle receiving action via MQTT."""
payload = render_template(msg, CONF_ACTION_TEMPLATE) payload = render_template(msg, CONF_ACTION_TEMPLATE)
if payload in CURRENT_HVAC_ACTIONS:
self._action = payload self._action = payload
self.async_write_ha_state() self.async_write_ha_state()
else:
_LOGGER.warning(
"Invalid %s action: %s",
CURRENT_HVAC_ACTIONS,
payload,
)
add_subscription(topics, CONF_ACTION_TOPIC, handle_action_received) add_subscription(topics, CONF_ACTION_TOPIC, handle_action_received)

43
tests/components/mqtt/test_climate.py
View File

@ -8,6 +8,8 @@ import voluptuous as vol
from homeassistant.components.climate import DEFAULT_MAX_TEMP, DEFAULT_MIN_TEMP from homeassistant.components.climate import DEFAULT_MAX_TEMP, DEFAULT_MIN_TEMP
from homeassistant.components.climate.const import ( from homeassistant.components.climate.const import (
ATTR_HVAC_ACTION,
CURRENT_HVAC_ACTIONS,
DOMAIN as CLIMATE_DOMAIN, DOMAIN as CLIMATE_DOMAIN,
HVAC_MODE_AUTO, HVAC_MODE_AUTO,
HVAC_MODE_COOL, HVAC_MODE_COOL,
@ -432,6 +434,28 @@ async def test_receive_mqtt_temperature(hass, mqtt_mock):
assert state.attributes.get("current_temperature") == 47 assert state.attributes.get("current_temperature") == 47
async def test_handle_action_received(hass, mqtt_mock):
"""Test getting the action received via MQTT."""
config = copy.deepcopy(DEFAULT_CONFIG)
config["climate"]["action_topic"] = "action"
assert await async_setup_component(hass, CLIMATE_DOMAIN, config)
await hass.async_block_till_done()
# Cycle through valid modes and also check for wrong input such as "None" (str(None))
async_fire_mqtt_message(hass, "action", "None")
state = hass.states.get(ENTITY_CLIMATE)
hvac_action = state.attributes.get(ATTR_HVAC_ACTION)
assert hvac_action is None
# Redefine actions according to https://developers.home-assistant.io/docs/core/entity/climate/#hvac-action
actions = ["off", "heating", "cooling", "drying", "idle", "fan"]
assert all(elem in actions for elem in CURRENT_HVAC_ACTIONS)
for action in actions:
async_fire_mqtt_message(hass, "action", action)
state = hass.states.get(ENTITY_CLIMATE)
hvac_action = state.attributes.get(ATTR_HVAC_ACTION)
assert hvac_action == action
async def test_set_away_mode_pessimistic(hass, mqtt_mock): async def test_set_away_mode_pessimistic(hass, mqtt_mock):
"""Test setting of the away mode.""" """Test setting of the away mode."""
config = copy.deepcopy(DEFAULT_CONFIG) config = copy.deepcopy(DEFAULT_CONFIG)
@ -492,21 +516,6 @@ async def test_set_away_mode(hass, mqtt_mock):
assert state.attributes.get("preset_mode") == "away" assert state.attributes.get("preset_mode") == "away"
async def test_set_hvac_action(hass, mqtt_mock):
"""Test setting of the HVAC action."""
config = copy.deepcopy(DEFAULT_CONFIG)
config["climate"]["action_topic"] = "action"
assert await async_setup_component(hass, CLIMATE_DOMAIN, config)
await hass.async_block_till_done()
state = hass.states.get(ENTITY_CLIMATE)
assert state.attributes.get("hvac_action") is None
async_fire_mqtt_message(hass, "action", "cool")
state = hass.states.get(ENTITY_CLIMATE)
assert state.attributes.get("hvac_action") == "cool"
async def test_set_hold_pessimistic(hass, mqtt_mock): async def test_set_hold_pessimistic(hass, mqtt_mock):
"""Test setting the hold mode in pessimistic mode.""" """Test setting the hold mode in pessimistic mode."""
config = copy.deepcopy(DEFAULT_CONFIG) config = copy.deepcopy(DEFAULT_CONFIG)
@ -779,9 +788,9 @@ async def test_get_with_templates(hass, mqtt_mock, caplog):
assert state.attributes.get("current_temperature") == 74656 assert state.attributes.get("current_temperature") == 74656
# Action # Action
async_fire_mqtt_message(hass, "action", '"cool"') async_fire_mqtt_message(hass, "action", '"cooling"')
state = hass.states.get(ENTITY_CLIMATE) state = hass.states.get(ENTITY_CLIMATE)
assert state.attributes.get("hvac_action") == "cool" assert state.attributes.get("hvac_action") == "cooling"
async def test_set_with_templates(hass, mqtt_mock, caplog): async def test_set_with_templates(hass, mqtt_mock, caplog):