mirror of
https://github.com/home-assistant/core.git
synced 2025-07-24 21:57:51 +00:00
Add humidifier device actions (#36854)
This commit is contained in:
Shulyaka
GitHub
parent
1b3e5460a9
commit
cf6480cda0
121
homeassistant/components/humidifier/device_action.py
Normal file
121
homeassistant/components/humidifier/device_action.py
Normal file
@ -0,0 +1,121 @@
|
|||||||
|
"""Provides device actions for Humidifier."""
|
||||||
|
from typing import List, Optional
|
||||||
|
|
||||||
|
import voluptuous as vol
|
||||||
|
|
||||||
|
from homeassistant.components.device_automation import toggle_entity
|
||||||
|
from homeassistant.const import (
|
||||||
|
ATTR_ENTITY_ID,
|
||||||
|
CONF_DEVICE_ID,
|
||||||
|
CONF_DOMAIN,
|
||||||
|
CONF_ENTITY_ID,
|
||||||
|
CONF_TYPE,
|
||||||
|
)
|
||||||
|
from homeassistant.core import Context, HomeAssistant
|
||||||
|
from homeassistant.helpers import entity_registry
|
||||||
|
import homeassistant.helpers.config_validation as cv
|
||||||
|
|
||||||
|
from . import DOMAIN, const
|
||||||
|
|
||||||
|
SET_HUMIDITY_SCHEMA = cv.DEVICE_ACTION_BASE_SCHEMA.extend(
|
||||||
|
{
|
||||||
|
vol.Required(CONF_TYPE): "set_humidity",
|
||||||
|
vol.Required(CONF_ENTITY_ID): cv.entity_domain(DOMAIN),
|
||||||
|
vol.Required(const.ATTR_HUMIDITY): vol.Coerce(int),
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
SET_MODE_SCHEMA = cv.DEVICE_ACTION_BASE_SCHEMA.extend(
|
||||||
|
{
|
||||||
|
vol.Required(CONF_TYPE): "set_mode",
|
||||||
|
vol.Required(CONF_ENTITY_ID): cv.entity_domain(DOMAIN),
|
||||||
|
vol.Required(const.ATTR_MODE): cv.string,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
ONOFF_SCHEMA = toggle_entity.ACTION_SCHEMA.extend({vol.Required(CONF_DOMAIN): DOMAIN})
|
||||||
|
|
||||||
|
ACTION_SCHEMA = vol.Any(SET_HUMIDITY_SCHEMA, SET_MODE_SCHEMA, ONOFF_SCHEMA)
|
||||||
|
|
||||||
|
|
||||||
|
async def async_get_actions(hass: HomeAssistant, device_id: str) -> List[dict]:
|
||||||
|
"""List device actions for Humidifier devices."""
|
||||||
|
registry = await entity_registry.async_get_registry(hass)
|
||||||
|
actions = await toggle_entity.async_get_actions(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
|
||||||
|
|
||||||
|
state = hass.states.get(entry.entity_id)
|
||||||
|
|
||||||
|
actions.append(
|
||||||
|
{
|
||||||
|
CONF_DEVICE_ID: device_id,
|
||||||
|
CONF_DOMAIN: DOMAIN,
|
||||||
|
CONF_ENTITY_ID: entry.entity_id,
|
||||||
|
CONF_TYPE: "set_humidity",
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
# We need a state or else we can't populate the available modes.
|
||||||
|
if state is None:
|
||||||
|
continue
|
||||||
|
|
||||||
|
if state.attributes["supported_features"] & const.SUPPORT_MODES:
|
||||||
|
actions.append(
|
||||||
|
{
|
||||||
|
CONF_DEVICE_ID: device_id,
|
||||||
|
CONF_DOMAIN: DOMAIN,
|
||||||
|
CONF_ENTITY_ID: entry.entity_id,
|
||||||
|
CONF_TYPE: "set_mode",
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
return actions
|
||||||
|
|
||||||
|
|
||||||
|
async def async_call_action_from_config(
|
||||||
|
hass: HomeAssistant, config: dict, variables: dict, context: Optional[Context]
|
||||||
|
) -> None:
|
||||||
|
"""Execute a device action."""
|
||||||
|
config = ACTION_SCHEMA(config)
|
||||||
|
|
||||||
|
service_data = {ATTR_ENTITY_ID: config[CONF_ENTITY_ID]}
|
||||||
|
|
||||||
|
if config[CONF_TYPE] == "set_humidity":
|
||||||
|
service = const.SERVICE_SET_HUMIDITY
|
||||||
|
service_data[const.ATTR_HUMIDITY] = config[const.ATTR_HUMIDITY]
|
||||||
|
elif config[CONF_TYPE] == "set_mode":
|
||||||
|
service = const.SERVICE_SET_MODE
|
||||||
|
service_data[const.ATTR_MODE] = config[const.ATTR_MODE]
|
||||||
|
else:
|
||||||
|
return await toggle_entity.async_call_action_from_config(
|
||||||
|
hass, config, variables, context, DOMAIN
|
||||||
|
)
|
||||||
|
|
||||||
|
await hass.services.async_call(
|
||||||
|
DOMAIN, service, service_data, blocking=True, context=context
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
async def async_get_action_capabilities(hass, config):
|
||||||
|
"""List action capabilities."""
|
||||||
|
state = hass.states.get(config[CONF_ENTITY_ID])
|
||||||
|
action_type = config[CONF_TYPE]
|
||||||
|
|
||||||
|
fields = {}
|
||||||
|
|
||||||
|
if action_type == "set_humidity":
|
||||||
|
fields[vol.Required(const.ATTR_HUMIDITY)] = vol.Coerce(int)
|
||||||
|
elif action_type == "set_mode":
|
||||||
|
if state:
|
||||||
|
available_modes = state.attributes.get(const.ATTR_AVAILABLE_MODES, [])
|
||||||
|
else:
|
||||||
|
available_modes = []
|
||||||
|
fields[vol.Required(const.ATTR_MODE)] = vol.In(available_modes)
|
||||||
|
else:
|
||||||
|
return {}
|
||||||
|
|
||||||
|
return {"extra_fields": vol.Schema(fields)}
|
||||||
18
homeassistant/components/humidifier/strings.json
Normal file
18
homeassistant/components/humidifier/strings.json
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
{
|
||||||
|
"title": "Humidifier",
|
||||||
|
"device_automation": {
|
||||||
|
"action_type": {
|
||||||
|
"set_humidity": "Set humidity for {entity_name}",
|
||||||
|
"set_mode": "Change mode on {entity_name}",
|
||||||
|
"toggle": "Toggle {entity_name}",
|
||||||
|
"turn_on": "Turn on {entity_name}",
|
||||||
|
"turn_off": "Turn off {entity_name}"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"state": {
|
||||||
|
"_": {
|
||||||
|
"off": "[%key:common::state::off%]",
|
||||||
|
"on": "[%key:common::state::on%]"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
358
tests/components/humidifier/test_device_action.py
Normal file
358
tests/components/humidifier/test_device_action.py
Normal file
@ -0,0 +1,358 @@
|
|||||||
|
"""The tests for Humidifier device actions."""
|
||||||
|
import pytest
|
||||||
|
import voluptuous_serialize
|
||||||
|
|
||||||
|
import homeassistant.components.automation as automation
|
||||||
|
from homeassistant.components.humidifier import DOMAIN, const, device_action
|
||||||
|
from homeassistant.const import STATE_ON
|
||||||
|
from homeassistant.helpers import config_validation as cv, device_registry
|
||||||
|
from homeassistant.setup import async_setup_component
|
||||||
|
|
||||||
|
from tests.common import (
|
||||||
|
MockConfigEntry,
|
||||||
|
assert_lists_same,
|
||||||
|
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)
|
||||||
|
|
||||||
|
|
||||||
|
async def test_get_actions(hass, device_reg, entity_reg):
|
||||||
|
"""Test we get the expected actions from a humidifier."""
|
||||||
|
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)
|
||||||
|
hass.states.async_set("humidifier.test_5678", STATE_ON, {})
|
||||||
|
hass.states.async_set(
|
||||||
|
"humidifier.test_5678", "attributes", {"supported_features": 1}
|
||||||
|
)
|
||||||
|
expected_actions = [
|
||||||
|
{
|
||||||
|
"domain": DOMAIN,
|
||||||
|
"type": "turn_on",
|
||||||
|
"device_id": device_entry.id,
|
||||||
|
"entity_id": "humidifier.test_5678",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"domain": DOMAIN,
|
||||||
|
"type": "turn_off",
|
||||||
|
"device_id": device_entry.id,
|
||||||
|
"entity_id": "humidifier.test_5678",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"domain": DOMAIN,
|
||||||
|
"type": "toggle",
|
||||||
|
"device_id": device_entry.id,
|
||||||
|
"entity_id": "humidifier.test_5678",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"domain": DOMAIN,
|
||||||
|
"type": "set_humidity",
|
||||||
|
"device_id": device_entry.id,
|
||||||
|
"entity_id": "humidifier.test_5678",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"domain": DOMAIN,
|
||||||
|
"type": "set_mode",
|
||||||
|
"device_id": device_entry.id,
|
||||||
|
"entity_id": "humidifier.test_5678",
|
||||||
|
},
|
||||||
|
]
|
||||||
|
actions = await async_get_device_automations(hass, "action", device_entry.id)
|
||||||
|
assert_lists_same(actions, expected_actions)
|
||||||
|
|
||||||
|
|
||||||
|
async def test_get_action_no_modes(hass, device_reg, entity_reg):
|
||||||
|
"""Test we get the expected actions from a humidifier."""
|
||||||
|
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)
|
||||||
|
hass.states.async_set("humidifier.test_5678", STATE_ON, {})
|
||||||
|
hass.states.async_set(
|
||||||
|
"humidifier.test_5678", "attributes", {"supported_features": 0}
|
||||||
|
)
|
||||||
|
expected_actions = [
|
||||||
|
{
|
||||||
|
"domain": DOMAIN,
|
||||||
|
"type": "turn_on",
|
||||||
|
"device_id": device_entry.id,
|
||||||
|
"entity_id": "humidifier.test_5678",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"domain": DOMAIN,
|
||||||
|
"type": "turn_off",
|
||||||
|
"device_id": device_entry.id,
|
||||||
|
"entity_id": "humidifier.test_5678",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"domain": DOMAIN,
|
||||||
|
"type": "toggle",
|
||||||
|
"device_id": device_entry.id,
|
||||||
|
"entity_id": "humidifier.test_5678",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"domain": DOMAIN,
|
||||||
|
"type": "set_humidity",
|
||||||
|
"device_id": device_entry.id,
|
||||||
|
"entity_id": "humidifier.test_5678",
|
||||||
|
},
|
||||||
|
]
|
||||||
|
actions = await async_get_device_automations(hass, "action", device_entry.id)
|
||||||
|
assert_lists_same(actions, expected_actions)
|
||||||
|
|
||||||
|
|
||||||
|
async def test_get_action_no_state(hass, device_reg, entity_reg):
|
||||||
|
"""Test we get the expected actions from a humidifier."""
|
||||||
|
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)
|
||||||
|
expected_actions = [
|
||||||
|
{
|
||||||
|
"domain": DOMAIN,
|
||||||
|
"type": "turn_on",
|
||||||
|
"device_id": device_entry.id,
|
||||||
|
"entity_id": "humidifier.test_5678",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"domain": DOMAIN,
|
||||||
|
"type": "turn_off",
|
||||||
|
"device_id": device_entry.id,
|
||||||
|
"entity_id": "humidifier.test_5678",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"domain": DOMAIN,
|
||||||
|
"type": "toggle",
|
||||||
|
"device_id": device_entry.id,
|
||||||
|
"entity_id": "humidifier.test_5678",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"domain": DOMAIN,
|
||||||
|
"type": "set_humidity",
|
||||||
|
"device_id": device_entry.id,
|
||||||
|
"entity_id": "humidifier.test_5678",
|
||||||
|
},
|
||||||
|
]
|
||||||
|
actions = await async_get_device_automations(hass, "action", device_entry.id)
|
||||||
|
assert_lists_same(actions, expected_actions)
|
||||||
|
|
||||||
|
|
||||||
|
async def test_action(hass):
|
||||||
|
"""Test for actions."""
|
||||||
|
hass.states.async_set(
|
||||||
|
"humidifier.entity",
|
||||||
|
STATE_ON,
|
||||||
|
{const.ATTR_AVAILABLE_MODES: [const.MODE_HOME, const.MODE_AWAY]},
|
||||||
|
)
|
||||||
|
|
||||||
|
assert await async_setup_component(
|
||||||
|
hass,
|
||||||
|
automation.DOMAIN,
|
||||||
|
{
|
||||||
|
automation.DOMAIN: [
|
||||||
|
{
|
||||||
|
"trigger": {
|
||||||
|
"platform": "event",
|
||||||
|
"event_type": "test_event_turn_off",
|
||||||
|
},
|
||||||
|
"action": {
|
||||||
|
"domain": DOMAIN,
|
||||||
|
"device_id": "abcdefgh",
|
||||||
|
"entity_id": "humidifier.entity",
|
||||||
|
"type": "turn_off",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"trigger": {
|
||||||
|
"platform": "event",
|
||||||
|
"event_type": "test_event_turn_on",
|
||||||
|
},
|
||||||
|
"action": {
|
||||||
|
"domain": DOMAIN,
|
||||||
|
"device_id": "abcdefgh",
|
||||||
|
"entity_id": "humidifier.entity",
|
||||||
|
"type": "turn_on",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"trigger": {"platform": "event", "event_type": "test_event_toggle"},
|
||||||
|
"action": {
|
||||||
|
"domain": DOMAIN,
|
||||||
|
"device_id": "abcdefgh",
|
||||||
|
"entity_id": "humidifier.entity",
|
||||||
|
"type": "toggle",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"trigger": {
|
||||||
|
"platform": "event",
|
||||||
|
"event_type": "test_event_set_humidity",
|
||||||
|
},
|
||||||
|
"action": {
|
||||||
|
"domain": DOMAIN,
|
||||||
|
"device_id": "abcdefgh",
|
||||||
|
"entity_id": "humidifier.entity",
|
||||||
|
"type": "set_humidity",
|
||||||
|
"humidity": 35,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"trigger": {
|
||||||
|
"platform": "event",
|
||||||
|
"event_type": "test_event_set_mode",
|
||||||
|
},
|
||||||
|
"action": {
|
||||||
|
"domain": DOMAIN,
|
||||||
|
"device_id": "abcdefgh",
|
||||||
|
"entity_id": "humidifier.entity",
|
||||||
|
"type": "set_mode",
|
||||||
|
"mode": const.MODE_AWAY,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
set_humidity_calls = async_mock_service(hass, "humidifier", "set_humidity")
|
||||||
|
set_mode_calls = async_mock_service(hass, "humidifier", "set_mode")
|
||||||
|
turn_on_calls = async_mock_service(hass, "humidifier", "turn_on")
|
||||||
|
turn_off_calls = async_mock_service(hass, "humidifier", "turn_off")
|
||||||
|
toggle_calls = async_mock_service(hass, "humidifier", "toggle")
|
||||||
|
|
||||||
|
assert len(set_humidity_calls) == 0
|
||||||
|
assert len(set_mode_calls) == 0
|
||||||
|
assert len(turn_on_calls) == 0
|
||||||
|
assert len(turn_off_calls) == 0
|
||||||
|
assert len(toggle_calls) == 0
|
||||||
|
|
||||||
|
hass.bus.async_fire("test_event_set_humidity")
|
||||||
|
await hass.async_block_till_done()
|
||||||
|
assert len(set_humidity_calls) == 1
|
||||||
|
assert len(set_mode_calls) == 0
|
||||||
|
assert len(turn_on_calls) == 0
|
||||||
|
assert len(turn_off_calls) == 0
|
||||||
|
assert len(toggle_calls) == 0
|
||||||
|
|
||||||
|
hass.bus.async_fire("test_event_set_mode")
|
||||||
|
await hass.async_block_till_done()
|
||||||
|
assert len(set_humidity_calls) == 1
|
||||||
|
assert len(set_mode_calls) == 1
|
||||||
|
assert len(turn_on_calls) == 0
|
||||||
|
assert len(turn_off_calls) == 0
|
||||||
|
assert len(toggle_calls) == 0
|
||||||
|
|
||||||
|
hass.bus.async_fire("test_event_turn_off")
|
||||||
|
await hass.async_block_till_done()
|
||||||
|
assert len(set_humidity_calls) == 1
|
||||||
|
assert len(set_mode_calls) == 1
|
||||||
|
assert len(turn_on_calls) == 0
|
||||||
|
assert len(turn_off_calls) == 1
|
||||||
|
assert len(toggle_calls) == 0
|
||||||
|
|
||||||
|
hass.bus.async_fire("test_event_turn_on")
|
||||||
|
await hass.async_block_till_done()
|
||||||
|
assert len(set_humidity_calls) == 1
|
||||||
|
assert len(set_mode_calls) == 1
|
||||||
|
assert len(turn_on_calls) == 1
|
||||||
|
assert len(turn_off_calls) == 1
|
||||||
|
assert len(toggle_calls) == 0
|
||||||
|
|
||||||
|
hass.bus.async_fire("test_event_toggle")
|
||||||
|
await hass.async_block_till_done()
|
||||||
|
assert len(set_humidity_calls) == 1
|
||||||
|
assert len(set_mode_calls) == 1
|
||||||
|
assert len(turn_on_calls) == 1
|
||||||
|
assert len(turn_off_calls) == 1
|
||||||
|
assert len(toggle_calls) == 1
|
||||||
|
|
||||||
|
|
||||||
|
async def test_capabilities(hass):
|
||||||
|
"""Test getting capabilities."""
|
||||||
|
# Test capabililities without state
|
||||||
|
capabilities = await device_action.async_get_action_capabilities(
|
||||||
|
hass,
|
||||||
|
{
|
||||||
|
"domain": DOMAIN,
|
||||||
|
"device_id": "abcdefgh",
|
||||||
|
"entity_id": "humidifier.entity",
|
||||||
|
"type": "set_mode",
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
assert capabilities and "extra_fields" in capabilities
|
||||||
|
|
||||||
|
assert voluptuous_serialize.convert(
|
||||||
|
capabilities["extra_fields"], custom_serializer=cv.custom_serializer
|
||||||
|
) == [{"name": "mode", "options": [], "required": True, "type": "select"}]
|
||||||
|
|
||||||
|
# Set state
|
||||||
|
hass.states.async_set(
|
||||||
|
"humidifier.entity",
|
||||||
|
STATE_ON,
|
||||||
|
{const.ATTR_AVAILABLE_MODES: [const.MODE_HOME, const.MODE_AWAY]},
|
||||||
|
)
|
||||||
|
|
||||||
|
# Set humidity
|
||||||
|
capabilities = await device_action.async_get_action_capabilities(
|
||||||
|
hass,
|
||||||
|
{
|
||||||
|
"domain": DOMAIN,
|
||||||
|
"device_id": "abcdefgh",
|
||||||
|
"entity_id": "humidifier.entity",
|
||||||
|
"type": "set_humidity",
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
assert capabilities and "extra_fields" in capabilities
|
||||||
|
|
||||||
|
assert voluptuous_serialize.convert(
|
||||||
|
capabilities["extra_fields"], custom_serializer=cv.custom_serializer
|
||||||
|
) == [{"name": "humidity", "required": True, "type": "integer"}]
|
||||||
|
|
||||||
|
# Set mode
|
||||||
|
capabilities = await device_action.async_get_action_capabilities(
|
||||||
|
hass,
|
||||||
|
{
|
||||||
|
"domain": DOMAIN,
|
||||||
|
"device_id": "abcdefgh",
|
||||||
|
"entity_id": "humidifier.entity",
|
||||||
|
"type": "set_mode",
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
assert capabilities and "extra_fields" in capabilities
|
||||||
|
|
||||||
|
assert voluptuous_serialize.convert(
|
||||||
|
capabilities["extra_fields"], custom_serializer=cv.custom_serializer
|
||||||
|
) == [
|
||||||
|
{
|
||||||
|
"name": "mode",
|
||||||
|
"options": [("home", "home"), ("away", "away")],
|
||||||
|
"required": True,
|
||||||
|
"type": "select",
|
||||||
|
}
|
||||||
|
]
|
||||||
Loading…
x
Reference in New Issue
Block a user