mirror of
https://github.com/home-assistant/core
synced 2024-08-02 23:40:32 +02:00
c85bb27d0d
* Teach state trigger about entity registry ids * Tweak * Add tests * Tweak tests * Fix tests * Resolve entity ids during config validation * Update device_triggers * Fix mistake * Tweak trigger validator to ensure we don't modify the original config * Add index from entry id to entry * Update scaffold * Pre-compile UUID regex * Address review comment * Tweak mock_registry * Tweak * Apply suggestion from code review
99 lines
2.8 KiB
Python
99 lines
2.8 KiB
Python
"""Provides device automations for Vacuum."""
|
|
from __future__ import annotations
|
|
|
|
from typing import Any
|
|
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.automation import (
|
|
AutomationActionType,
|
|
AutomationTriggerInfo,
|
|
)
|
|
from homeassistant.components.device_automation import DEVICE_TRIGGER_BASE_SCHEMA
|
|
from homeassistant.components.homeassistant.triggers import state as state_trigger
|
|
from homeassistant.const import (
|
|
CONF_DEVICE_ID,
|
|
CONF_DOMAIN,
|
|
CONF_ENTITY_ID,
|
|
CONF_FOR,
|
|
CONF_PLATFORM,
|
|
CONF_TYPE,
|
|
)
|
|
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, STATE_CLEANING, STATE_DOCKED
|
|
|
|
TRIGGER_TYPES = {"cleaning", "docked"}
|
|
|
|
TRIGGER_SCHEMA = DEVICE_TRIGGER_BASE_SCHEMA.extend(
|
|
{
|
|
vol.Required(CONF_ENTITY_ID): cv.entity_id,
|
|
vol.Required(CONF_TYPE): vol.In(TRIGGER_TYPES),
|
|
vol.Optional(CONF_FOR): cv.positive_time_period_dict,
|
|
}
|
|
)
|
|
|
|
|
|
async def async_get_triggers(
|
|
hass: HomeAssistant, device_id: str
|
|
) -> list[dict[str, Any]]:
|
|
"""List device triggers for Vacuum devices."""
|
|
registry = await entity_registry.async_get_registry(hass)
|
|
triggers = []
|
|
|
|
# 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 += [
|
|
{
|
|
CONF_PLATFORM: "device",
|
|
CONF_DEVICE_ID: device_id,
|
|
CONF_DOMAIN: DOMAIN,
|
|
CONF_ENTITY_ID: entry.entity_id,
|
|
CONF_TYPE: trigger,
|
|
}
|
|
for trigger in TRIGGER_TYPES
|
|
]
|
|
|
|
return triggers
|
|
|
|
|
|
async def async_get_trigger_capabilities(
|
|
hass: HomeAssistant, config: ConfigType
|
|
) -> dict[str, vol.Schema]:
|
|
"""List trigger capabilities."""
|
|
return {
|
|
"extra_fields": vol.Schema(
|
|
{vol.Optional(CONF_FOR): cv.positive_time_period_dict}
|
|
)
|
|
}
|
|
|
|
|
|
async def async_attach_trigger(
|
|
hass: HomeAssistant,
|
|
config: ConfigType,
|
|
action: AutomationActionType,
|
|
automation_info: AutomationTriggerInfo,
|
|
) -> CALLBACK_TYPE:
|
|
"""Attach a trigger."""
|
|
if config[CONF_TYPE] == "cleaning":
|
|
to_state = STATE_CLEANING
|
|
else:
|
|
to_state = STATE_DOCKED
|
|
|
|
state_config = {
|
|
CONF_PLATFORM: "state",
|
|
CONF_ENTITY_ID: config[CONF_ENTITY_ID],
|
|
state_trigger.CONF_TO: to_state,
|
|
}
|
|
if CONF_FOR in config:
|
|
state_config[CONF_FOR] = config[CONF_FOR]
|
|
state_config = await state_trigger.async_validate_trigger_config(hass, state_config)
|
|
return await state_trigger.async_attach_trigger(
|
|
hass, state_config, action, automation_info, platform_type="device"
|
|
)
|