Add humidifier device triggers (#36887)
Co-authored-by: Paulus Schoutsen <balloob@gmail.com>
This commit is contained in:
Shulyaka
GitHub
parent
a7dfa60208
commit
9ae08585dc
3 changed files with 484 additions and 0 deletions
126
homeassistant/components/humidifier/device_trigger.py
Normal file
126
homeassistant/components/humidifier/device_trigger.py
Normal file
|
|
@ -0,0 +1,126 @@
|
||||||
|
"""Provides device automations for Climate."""
|
||||||
|
from typing import List
|
||||||
|
|
||||||
|
import voluptuous as vol
|
||||||
|
|
||||||
|
from homeassistant.components.automation import (
|
||||||
|
AutomationActionType,
|
||||||
|
numeric_state as numeric_state_automation,
|
||||||
|
)
|
||||||
|
from homeassistant.components.device_automation import (
|
||||||
|
TRIGGER_BASE_SCHEMA,
|
||||||
|
toggle_entity,
|
||||||
|
)
|
||||||
|
from homeassistant.const import (
|
||||||
|
CONF_ABOVE,
|
||||||
|
CONF_BELOW,
|
||||||
|
CONF_DEVICE_ID,
|
||||||
|
CONF_DOMAIN,
|
||||||
|
CONF_ENTITY_ID,
|
||||||
|
CONF_FOR,
|
||||||
|
CONF_PLATFORM,
|
||||||
|
CONF_TYPE,
|
||||||
|
UNIT_PERCENTAGE,
|
||||||
|
)
|
||||||
|
from homeassistant.core import CALLBACK_TYPE, HomeAssistant
|
||||||
|
from homeassistant.helpers import config_validation as cv, entity_registry
|
||||||
|
from homeassistant.helpers.typing import ConfigType
|
||||||
|
|
||||||
|
from . import DOMAIN
|
||||||
|
|
||||||
|
TARGET_TRIGGER_SCHEMA = vol.All(
|
||||||
|
TRIGGER_BASE_SCHEMA.extend(
|
||||||
|
{
|
||||||
|
vol.Required(CONF_ENTITY_ID): cv.entity_id,
|
||||||
|
vol.Required(CONF_TYPE): "target_humidity_changed",
|
||||||
|
vol.Optional(CONF_BELOW): vol.Any(vol.Coerce(int)),
|
||||||
|
vol.Optional(CONF_ABOVE): vol.Any(vol.Coerce(int)),
|
||||||
|
vol.Optional(CONF_FOR): cv.positive_time_period_dict,
|
||||||
|
}
|
||||||
|
),
|
||||||
|
cv.has_at_least_one_key(CONF_BELOW, CONF_ABOVE),
|
||||||
|
)
|
||||||
|
|
||||||
|
TOGGLE_TRIGGER_SCHEMA = toggle_entity.TRIGGER_SCHEMA.extend(
|
||||||
|
{vol.Required(CONF_DOMAIN): DOMAIN}
|
||||||
|
)
|
||||||
|
|
||||||
|
TRIGGER_SCHEMA = vol.Any(TARGET_TRIGGER_SCHEMA, TOGGLE_TRIGGER_SCHEMA)
|
||||||
|
|
||||||
|
|
||||||
|
async def async_get_triggers(hass: HomeAssistant, device_id: str) -> List[dict]:
|
||||||
|
"""List device triggers for Humidifier devices."""
|
||||||
|
registry = await entity_registry.async_get_registry(hass)
|
||||||
|
triggers = await toggle_entity.async_get_triggers(hass, device_id, DOMAIN)
|
||||||
|
|
||||||
|
# Get all the integrations entities for this device
|
||||||
|
for entry in entity_registry.async_entries_for_device(registry, device_id):
|
||||||
|
if entry.domain != DOMAIN:
|
||||||
|
continue
|
||||||
|
|
||||||
|
triggers.append(
|
||||||
|
{
|
||||||
|
CONF_PLATFORM: "device",
|
||||||
|
CONF_DEVICE_ID: device_id,
|
||||||
|
CONF_DOMAIN: DOMAIN,
|
||||||
|
CONF_ENTITY_ID: entry.entity_id,
|
||||||
|
CONF_TYPE: "target_humidity_changed",
|
||||||
|
}
|
||||||
|
)
|
||||||
|
return triggers
|
||||||
|
|
||||||
|
|
||||||
|
async def async_attach_trigger(
|
||||||
|
hass: HomeAssistant,
|
||||||
|
config: ConfigType,
|
||||||
|
action: AutomationActionType,
|
||||||
|
automation_info: dict,
|
||||||
|
) -> CALLBACK_TYPE:
|
||||||
|
"""Attach a trigger."""
|
||||||
|
trigger_type = config[CONF_TYPE]
|
||||||
|
|
||||||
|
if trigger_type == "target_humidity_changed":
|
||||||
|
numeric_state_config = {
|
||||||
|
numeric_state_automation.CONF_PLATFORM: "numeric_state",
|
||||||
|
numeric_state_automation.CONF_ENTITY_ID: config[CONF_ENTITY_ID],
|
||||||
|
numeric_state_automation.CONF_VALUE_TEMPLATE: "{{ state.attributes.humidity }}",
|
||||||
|
}
|
||||||
|
|
||||||
|
if CONF_ABOVE in config:
|
||||||
|
numeric_state_config[CONF_ABOVE] = config[CONF_ABOVE]
|
||||||
|
if CONF_BELOW in config:
|
||||||
|
numeric_state_config[CONF_BELOW] = config[CONF_BELOW]
|
||||||
|
if CONF_FOR in config:
|
||||||
|
numeric_state_config[CONF_FOR] = config[CONF_FOR]
|
||||||
|
|
||||||
|
numeric_state_config = numeric_state_automation.TRIGGER_SCHEMA(
|
||||||
|
numeric_state_config
|
||||||
|
)
|
||||||
|
return await numeric_state_automation.async_attach_trigger(
|
||||||
|
hass, numeric_state_config, action, automation_info, platform_type="device"
|
||||||
|
)
|
||||||
|
|
||||||
|
return await toggle_entity.async_attach_trigger(
|
||||||
|
hass, config, action, automation_info
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
async def async_get_trigger_capabilities(hass: HomeAssistant, config):
|
||||||
|
"""List trigger capabilities."""
|
||||||
|
trigger_type = config[CONF_TYPE]
|
||||||
|
|
||||||
|
if trigger_type == "target_humidity_changed":
|
||||||
|
return {
|
||||||
|
"extra_fields": vol.Schema(
|
||||||
|
{
|
||||||
|
vol.Optional(
|
||||||
|
CONF_ABOVE, description={"suffix": UNIT_PERCENTAGE}
|
||||||
|
): vol.Coerce(int),
|
||||||
|
vol.Optional(
|
||||||
|
CONF_BELOW, description={"suffix": UNIT_PERCENTAGE}
|
||||||
|
): vol.Coerce(int),
|
||||||
|
vol.Optional(CONF_FOR): cv.positive_time_period_dict,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
||||||
|
return await toggle_entity.async_get_trigger_capabilities(hass, config)
|
||||||
|
|
@ -1,6 +1,11 @@
|
||||||
{
|
{
|
||||||
"title": "Humidifier",
|
"title": "Humidifier",
|
||||||
"device_automation": {
|
"device_automation": {
|
||||||
|
"trigger_type": {
|
||||||
|
"target_humidity_changed": "{entity_name} target humidity changed",
|
||||||
|
"turned_on": "{entity_name} turned on",
|
||||||
|
"turned_off": "{entity_name} turned off"
|
||||||
|
},
|
||||||
"condition_type": {
|
"condition_type": {
|
||||||
"is_mode": "{entity_name} is set to a specific mode",
|
"is_mode": "{entity_name} is set to a specific mode",
|
||||||
"is_on": "{entity_name} is on",
|
"is_on": "{entity_name} is on",
|
||||||
|
|
|
||||||
353
tests/components/humidifier/test_device_trigger.py
Normal file
353
tests/components/humidifier/test_device_trigger.py
Normal file
|
|
@ -0,0 +1,353 @@
|
||||||
|
"""The tests for Humidifier device triggers."""
|
||||||
|
import datetime
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
import voluptuous_serialize
|
||||||
|
|
||||||
|
import homeassistant.components.automation as automation
|
||||||
|
from homeassistant.components.humidifier import DOMAIN, const, device_trigger
|
||||||
|
from homeassistant.const import ATTR_SUPPORTED_FEATURES, STATE_OFF, STATE_ON
|
||||||
|
from homeassistant.helpers import config_validation as cv, device_registry
|
||||||
|
from homeassistant.setup import async_setup_component
|
||||||
|
import homeassistant.util.dt as dt_util
|
||||||
|
|
||||||
|
from tests.common import (
|
||||||
|
MockConfigEntry,
|
||||||
|
assert_lists_same,
|
||||||
|
async_fire_time_changed,
|
||||||
|
async_get_device_automations,
|
||||||
|
async_mock_service,
|
||||||
|
mock_device_registry,
|
||||||
|
mock_registry,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def device_reg(hass):
|
||||||
|
"""Return an empty, loaded, registry."""
|
||||||
|
return mock_device_registry(hass)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def entity_reg(hass):
|
||||||
|
"""Return an empty, loaded, registry."""
|
||||||
|
return mock_registry(hass)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def calls(hass):
|
||||||
|
"""Track calls to a mock service."""
|
||||||
|
return async_mock_service(hass, "test", "automation")
|
||||||
|
|
||||||
|
|
||||||
|
async def test_get_triggers(hass, device_reg, entity_reg):
|
||||||
|
"""Test we get the expected triggers from a humidifier device."""
|
||||||
|
config_entry = MockConfigEntry(domain="test", data={})
|
||||||
|
config_entry.add_to_hass(hass)
|
||||||
|
device_entry = device_reg.async_get_or_create(
|
||||||
|
config_entry_id=config_entry.entry_id,
|
||||||
|
connections={(device_registry.CONNECTION_NETWORK_MAC, "12:34:56:AB:CD:EF")},
|
||||||
|
)
|
||||||
|
entity_reg.async_get_or_create(DOMAIN, "test", "5678", device_id=device_entry.id)
|
||||||
|
entity_id = f"{DOMAIN}.test_5678"
|
||||||
|
hass.states.async_set(
|
||||||
|
entity_id,
|
||||||
|
STATE_ON,
|
||||||
|
{
|
||||||
|
const.ATTR_HUMIDITY: 23,
|
||||||
|
const.ATTR_MODE: "home",
|
||||||
|
const.ATTR_AVAILABLE_MODES: ["home", "away"],
|
||||||
|
ATTR_SUPPORTED_FEATURES: 1,
|
||||||
|
},
|
||||||
|
)
|
||||||
|
expected_triggers = [
|
||||||
|
{
|
||||||
|
"platform": "device",
|
||||||
|
"domain": DOMAIN,
|
||||||
|
"type": "target_humidity_changed",
|
||||||
|
"device_id": device_entry.id,
|
||||||
|
"entity_id": entity_id,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"platform": "device",
|
||||||
|
"domain": DOMAIN,
|
||||||
|
"type": "turned_off",
|
||||||
|
"device_id": device_entry.id,
|
||||||
|
"entity_id": f"{DOMAIN}.test_5678",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"platform": "device",
|
||||||
|
"domain": DOMAIN,
|
||||||
|
"type": "turned_on",
|
||||||
|
"device_id": device_entry.id,
|
||||||
|
"entity_id": f"{DOMAIN}.test_5678",
|
||||||
|
},
|
||||||
|
]
|
||||||
|
triggers = await async_get_device_automations(hass, "trigger", device_entry.id)
|
||||||
|
assert_lists_same(triggers, expected_triggers)
|
||||||
|
|
||||||
|
|
||||||
|
async def test_if_fires_on_state_change(hass, calls):
|
||||||
|
"""Test for turn_on and turn_off triggers firing."""
|
||||||
|
hass.states.async_set(
|
||||||
|
"humidifier.entity",
|
||||||
|
STATE_ON,
|
||||||
|
{
|
||||||
|
const.ATTR_HUMIDITY: 23,
|
||||||
|
const.ATTR_MODE: "home",
|
||||||
|
const.ATTR_AVAILABLE_MODES: ["home", "away"],
|
||||||
|
ATTR_SUPPORTED_FEATURES: 1,
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
assert await async_setup_component(
|
||||||
|
hass,
|
||||||
|
automation.DOMAIN,
|
||||||
|
{
|
||||||
|
automation.DOMAIN: [
|
||||||
|
{
|
||||||
|
"trigger": {
|
||||||
|
"platform": "device",
|
||||||
|
"domain": DOMAIN,
|
||||||
|
"device_id": "",
|
||||||
|
"entity_id": "humidifier.entity",
|
||||||
|
"type": "target_humidity_changed",
|
||||||
|
"below": 20,
|
||||||
|
},
|
||||||
|
"action": {
|
||||||
|
"service": "test.automation",
|
||||||
|
"data_template": {"some": "target_humidity_changed_below"},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"trigger": {
|
||||||
|
"platform": "device",
|
||||||
|
"domain": DOMAIN,
|
||||||
|
"device_id": "",
|
||||||
|
"entity_id": "humidifier.entity",
|
||||||
|
"type": "target_humidity_changed",
|
||||||
|
"above": 30,
|
||||||
|
},
|
||||||
|
"action": {
|
||||||
|
"service": "test.automation",
|
||||||
|
"data_template": {"some": "target_humidity_changed_above"},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"trigger": {
|
||||||
|
"platform": "device",
|
||||||
|
"domain": DOMAIN,
|
||||||
|
"device_id": "",
|
||||||
|
"entity_id": "humidifier.entity",
|
||||||
|
"type": "target_humidity_changed",
|
||||||
|
"above": 30,
|
||||||
|
"for": {"seconds": 5},
|
||||||
|
},
|
||||||
|
"action": {
|
||||||
|
"service": "test.automation",
|
||||||
|
"data_template": {"some": "target_humidity_changed_above_for"},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"trigger": {
|
||||||
|
"platform": "device",
|
||||||
|
"domain": DOMAIN,
|
||||||
|
"device_id": "",
|
||||||
|
"entity_id": "humidifier.entity",
|
||||||
|
"type": "turned_on",
|
||||||
|
},
|
||||||
|
"action": {
|
||||||
|
"service": "test.automation",
|
||||||
|
"data_template": {
|
||||||
|
"some": "turn_on {{ trigger.%s }}"
|
||||||
|
% "}} - {{ trigger.".join(
|
||||||
|
(
|
||||||
|
"platform",
|
||||||
|
"entity_id",
|
||||||
|
"from_state.state",
|
||||||
|
"to_state.state",
|
||||||
|
"for",
|
||||||
|
)
|
||||||
|
)
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"trigger": {
|
||||||
|
"platform": "device",
|
||||||
|
"domain": DOMAIN,
|
||||||
|
"device_id": "",
|
||||||
|
"entity_id": "humidifier.entity",
|
||||||
|
"type": "turned_off",
|
||||||
|
},
|
||||||
|
"action": {
|
||||||
|
"service": "test.automation",
|
||||||
|
"data_template": {
|
||||||
|
"some": "turn_off {{ trigger.%s }}"
|
||||||
|
% "}} - {{ trigger.".join(
|
||||||
|
(
|
||||||
|
"platform",
|
||||||
|
"entity_id",
|
||||||
|
"from_state.state",
|
||||||
|
"to_state.state",
|
||||||
|
"for",
|
||||||
|
)
|
||||||
|
)
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
# Fake that the humidity is changing
|
||||||
|
hass.states.async_set("humidifier.entity", STATE_ON, {const.ATTR_HUMIDITY: 7})
|
||||||
|
await hass.async_block_till_done()
|
||||||
|
assert len(calls) == 1
|
||||||
|
assert calls[0].data["some"] == "target_humidity_changed_below"
|
||||||
|
|
||||||
|
# Fake that the humidity is changing
|
||||||
|
hass.states.async_set("humidifier.entity", STATE_ON, {const.ATTR_HUMIDITY: 37})
|
||||||
|
await hass.async_block_till_done()
|
||||||
|
assert len(calls) == 2
|
||||||
|
assert calls[1].data["some"] == "target_humidity_changed_above"
|
||||||
|
|
||||||
|
# Wait 6 minutes
|
||||||
|
async_fire_time_changed(hass, dt_util.utcnow() + datetime.timedelta(minutes=6))
|
||||||
|
await hass.async_block_till_done()
|
||||||
|
assert len(calls) == 3
|
||||||
|
assert calls[2].data["some"] == "target_humidity_changed_above_for"
|
||||||
|
|
||||||
|
# Fake turn off
|
||||||
|
hass.states.async_set("humidifier.entity", STATE_OFF, {const.ATTR_HUMIDITY: 37})
|
||||||
|
await hass.async_block_till_done()
|
||||||
|
assert len(calls) == 4
|
||||||
|
assert (
|
||||||
|
calls[3].data["some"] == "turn_off device - humidifier.entity - on - off - None"
|
||||||
|
)
|
||||||
|
|
||||||
|
# Fake turn on
|
||||||
|
hass.states.async_set("humidifier.entity", STATE_ON, {const.ATTR_HUMIDITY: 37})
|
||||||
|
await hass.async_block_till_done()
|
||||||
|
assert len(calls) == 5
|
||||||
|
assert (
|
||||||
|
calls[4].data["some"] == "turn_on device - humidifier.entity - off - on - None"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
async def test_invalid_config(hass, calls):
|
||||||
|
"""Test for turn_on and turn_off triggers firing."""
|
||||||
|
hass.states.async_set(
|
||||||
|
"humidifier.entity",
|
||||||
|
STATE_ON,
|
||||||
|
{
|
||||||
|
const.ATTR_HUMIDITY: 23,
|
||||||
|
const.ATTR_MODE: "home",
|
||||||
|
const.ATTR_AVAILABLE_MODES: ["home", "away"],
|
||||||
|
ATTR_SUPPORTED_FEATURES: 1,
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
assert await async_setup_component(
|
||||||
|
hass,
|
||||||
|
automation.DOMAIN,
|
||||||
|
{
|
||||||
|
automation.DOMAIN: [
|
||||||
|
{
|
||||||
|
"trigger": {
|
||||||
|
"platform": "device",
|
||||||
|
"domain": DOMAIN,
|
||||||
|
"device_id": "",
|
||||||
|
"entity_id": "humidifier.entity",
|
||||||
|
"type": "target_humidity_changed",
|
||||||
|
"below": 20,
|
||||||
|
"invalid": "invalid",
|
||||||
|
},
|
||||||
|
"action": {
|
||||||
|
"service": "test.automation",
|
||||||
|
"data_template": {"some": "target_humidity_changed"},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
# Fake that the humidity is changing
|
||||||
|
hass.states.async_set("humidifier.entity", STATE_ON, {const.ATTR_HUMIDITY: 7})
|
||||||
|
await hass.async_block_till_done()
|
||||||
|
# Should not trigger for invalid config
|
||||||
|
assert len(calls) == 0
|
||||||
|
|
||||||
|
|
||||||
|
async def test_get_trigger_capabilities_on(hass):
|
||||||
|
"""Test we get the expected capabilities from a humidifier trigger."""
|
||||||
|
capabilities = await device_trigger.async_get_trigger_capabilities(
|
||||||
|
hass,
|
||||||
|
{
|
||||||
|
"platform": "device",
|
||||||
|
"domain": "humidifier",
|
||||||
|
"type": "turned_on",
|
||||||
|
"entity_id": "humidifier.upstairs",
|
||||||
|
"above": "23",
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
assert capabilities and "extra_fields" in capabilities
|
||||||
|
|
||||||
|
assert voluptuous_serialize.convert(
|
||||||
|
capabilities["extra_fields"], custom_serializer=cv.custom_serializer
|
||||||
|
) == [{"name": "for", "optional": True, "type": "positive_time_period_dict"}]
|
||||||
|
|
||||||
|
|
||||||
|
async def test_get_trigger_capabilities_off(hass):
|
||||||
|
"""Test we get the expected capabilities from a humidifier trigger."""
|
||||||
|
capabilities = await device_trigger.async_get_trigger_capabilities(
|
||||||
|
hass,
|
||||||
|
{
|
||||||
|
"platform": "device",
|
||||||
|
"domain": "humidifier",
|
||||||
|
"type": "turned_off",
|
||||||
|
"entity_id": "humidifier.upstairs",
|
||||||
|
"above": "23",
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
assert capabilities and "extra_fields" in capabilities
|
||||||
|
|
||||||
|
assert voluptuous_serialize.convert(
|
||||||
|
capabilities["extra_fields"], custom_serializer=cv.custom_serializer
|
||||||
|
) == [{"name": "for", "optional": True, "type": "positive_time_period_dict"}]
|
||||||
|
|
||||||
|
|
||||||
|
async def test_get_trigger_capabilities_humidity(hass):
|
||||||
|
"""Test we get the expected capabilities from a humidifier trigger."""
|
||||||
|
capabilities = await device_trigger.async_get_trigger_capabilities(
|
||||||
|
hass,
|
||||||
|
{
|
||||||
|
"platform": "device",
|
||||||
|
"domain": "humidifier",
|
||||||
|
"type": "target_humidity_changed",
|
||||||
|
"entity_id": "humidifier.upstairs",
|
||||||
|
"above": "23",
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
assert capabilities and "extra_fields" in capabilities
|
||||||
|
|
||||||
|
assert voluptuous_serialize.convert(
|
||||||
|
capabilities["extra_fields"], custom_serializer=cv.custom_serializer
|
||||||
|
) == [
|
||||||
|
{
|
||||||
|
"description": {"suffix": "%"},
|
||||||
|
"name": "above",
|
||||||
|
"optional": True,
|
||||||
|
"type": "integer",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"description": {"suffix": "%"},
|
||||||
|
"name": "below",
|
||||||
|
"optional": True,
|
||||||
|
"type": "integer",
|
||||||
|
},
|
||||||
|
{"name": "for", "optional": True, "type": "positive_time_period_dict"},
|
||||||
|
]
|
||||||
Loading…
Add table
Reference in a new issue