mirror of
https://github.com/home-assistant/core.git
synced 2025-07-23 13:17:32 +00:00
Add template vacuum modern style (#144843)
* Add template vacuum modern style * address comments and add tests for coverage * address comments * update vacuum and sort domains
This commit is contained in:
Petro31
GitHub
parent
912798ee34
commit
3bf9908789
@ -8,24 +8,25 @@ from typing import Any
|
||||
import voluptuous as vol
|
||||
|
||||
from homeassistant.components.alarm_control_panel import (
|
||||
DOMAIN as ALARM_CONTROL_PANEL_DOMAIN,
|
||||
DOMAIN as DOMAIN_ALARM_CONTROL_PANEL,
|
||||
)
|
||||
from homeassistant.components.binary_sensor import DOMAIN as BINARY_SENSOR_DOMAIN
|
||||
from homeassistant.components.binary_sensor import DOMAIN as DOMAIN_BINARY_SENSOR
|
||||
from homeassistant.components.blueprint import (
|
||||
is_blueprint_instance_config,
|
||||
schemas as blueprint_schemas,
|
||||
)
|
||||
from homeassistant.components.button import DOMAIN as BUTTON_DOMAIN
|
||||
from homeassistant.components.cover import DOMAIN as COVER_DOMAIN
|
||||
from homeassistant.components.fan import DOMAIN as FAN_DOMAIN
|
||||
from homeassistant.components.image import DOMAIN as IMAGE_DOMAIN
|
||||
from homeassistant.components.light import DOMAIN as LIGHT_DOMAIN
|
||||
from homeassistant.components.lock import DOMAIN as LOCK_DOMAIN
|
||||
from homeassistant.components.number import DOMAIN as NUMBER_DOMAIN
|
||||
from homeassistant.components.select import DOMAIN as SELECT_DOMAIN
|
||||
from homeassistant.components.sensor import DOMAIN as SENSOR_DOMAIN
|
||||
from homeassistant.components.switch import DOMAIN as SWITCH_DOMAIN
|
||||
from homeassistant.components.weather import DOMAIN as WEATHER_DOMAIN
|
||||
from homeassistant.components.button import DOMAIN as DOMAIN_BUTTON
|
||||
from homeassistant.components.cover import DOMAIN as DOMAIN_COVER
|
||||
from homeassistant.components.fan import DOMAIN as DOMAIN_FAN
|
||||
from homeassistant.components.image import DOMAIN as DOMAIN_IMAGE
|
||||
from homeassistant.components.light import DOMAIN as DOMAIN_LIGHT
|
||||
from homeassistant.components.lock import DOMAIN as DOMAIN_LOCK
|
||||
from homeassistant.components.number import DOMAIN as DOMAIN_NUMBER
|
||||
from homeassistant.components.select import DOMAIN as DOMAIN_SELECT
|
||||
from homeassistant.components.sensor import DOMAIN as DOMAIN_SENSOR
|
||||
from homeassistant.components.switch import DOMAIN as DOMAIN_SWITCH
|
||||
from homeassistant.components.vacuum import DOMAIN as DOMAIN_VACUUM
|
||||
from homeassistant.components.weather import DOMAIN as DOMAIN_WEATHER
|
||||
from homeassistant.config import async_log_schema_error, config_without_domain
|
||||
from homeassistant.const import (
|
||||
CONF_ACTION,
|
||||
@ -60,6 +61,7 @@ from . import (
|
||||
select as select_platform,
|
||||
sensor as sensor_platform,
|
||||
switch as switch_platform,
|
||||
vacuum as vacuum_platform,
|
||||
weather as weather_platform,
|
||||
)
|
||||
from .const import DOMAIN, PLATFORMS, TemplateConfig
|
||||
@ -98,61 +100,69 @@ CONFIG_SECTION_SCHEMA = vol.All(
|
||||
_backward_compat_schema,
|
||||
vol.Schema(
|
||||
{
|
||||
vol.Optional(CONF_UNIQUE_ID): cv.string,
|
||||
vol.Optional(CONF_TRIGGERS): cv.TRIGGER_SCHEMA,
|
||||
vol.Optional(CONF_CONDITIONS): cv.CONDITIONS_SCHEMA,
|
||||
vol.Optional(CONF_ACTIONS): cv.SCRIPT_SCHEMA,
|
||||
vol.Optional(CONF_VARIABLES): cv.SCRIPT_VARIABLES_SCHEMA,
|
||||
vol.Optional(NUMBER_DOMAIN): vol.All(
|
||||
cv.ensure_list, [number_platform.NUMBER_SCHEMA]
|
||||
),
|
||||
vol.Optional(SENSOR_DOMAIN): vol.All(
|
||||
cv.ensure_list, [sensor_platform.SENSOR_SCHEMA]
|
||||
),
|
||||
vol.Optional(CONF_SENSORS): cv.schema_with_slug_keys(
|
||||
sensor_platform.LEGACY_SENSOR_SCHEMA
|
||||
),
|
||||
vol.Optional(BINARY_SENSOR_DOMAIN): vol.All(
|
||||
cv.ensure_list, [binary_sensor_platform.BINARY_SENSOR_SCHEMA]
|
||||
),
|
||||
vol.Optional(CONF_BINARY_SENSORS): cv.schema_with_slug_keys(
|
||||
binary_sensor_platform.LEGACY_BINARY_SENSOR_SCHEMA
|
||||
),
|
||||
vol.Optional(ALARM_CONTROL_PANEL_DOMAIN): vol.All(
|
||||
vol.Optional(CONF_CONDITIONS): cv.CONDITIONS_SCHEMA,
|
||||
vol.Optional(CONF_SENSORS): cv.schema_with_slug_keys(
|
||||
sensor_platform.LEGACY_SENSOR_SCHEMA
|
||||
),
|
||||
vol.Optional(CONF_TRIGGERS): cv.TRIGGER_SCHEMA,
|
||||
vol.Optional(CONF_UNIQUE_ID): cv.string,
|
||||
vol.Optional(CONF_VARIABLES): cv.SCRIPT_VARIABLES_SCHEMA,
|
||||
vol.Optional(DOMAIN_ALARM_CONTROL_PANEL): vol.All(
|
||||
cv.ensure_list,
|
||||
[alarm_control_panel_platform.ALARM_CONTROL_PANEL_SCHEMA],
|
||||
),
|
||||
vol.Optional(SELECT_DOMAIN): vol.All(
|
||||
cv.ensure_list, [select_platform.SELECT_SCHEMA]
|
||||
vol.Optional(DOMAIN_BINARY_SENSOR): vol.All(
|
||||
cv.ensure_list, [binary_sensor_platform.BINARY_SENSOR_SCHEMA]
|
||||
),
|
||||
vol.Optional(BUTTON_DOMAIN): vol.All(
|
||||
vol.Optional(DOMAIN_BUTTON): vol.All(
|
||||
cv.ensure_list, [button_platform.BUTTON_SCHEMA]
|
||||
),
|
||||
vol.Optional(IMAGE_DOMAIN): vol.All(
|
||||
cv.ensure_list, [image_platform.IMAGE_SCHEMA]
|
||||
),
|
||||
vol.Optional(LIGHT_DOMAIN): vol.All(
|
||||
cv.ensure_list, [light_platform.LIGHT_SCHEMA]
|
||||
),
|
||||
vol.Optional(LOCK_DOMAIN): vol.All(
|
||||
cv.ensure_list, [lock_platform.LOCK_SCHEMA]
|
||||
),
|
||||
vol.Optional(WEATHER_DOMAIN): vol.All(
|
||||
cv.ensure_list, [weather_platform.WEATHER_SCHEMA]
|
||||
),
|
||||
vol.Optional(SWITCH_DOMAIN): vol.All(
|
||||
cv.ensure_list, [switch_platform.SWITCH_SCHEMA]
|
||||
),
|
||||
vol.Optional(COVER_DOMAIN): vol.All(
|
||||
vol.Optional(DOMAIN_COVER): vol.All(
|
||||
cv.ensure_list, [cover_platform.COVER_SCHEMA]
|
||||
),
|
||||
vol.Optional(FAN_DOMAIN): vol.All(
|
||||
vol.Optional(DOMAIN_FAN): vol.All(
|
||||
cv.ensure_list, [fan_platform.FAN_SCHEMA]
|
||||
),
|
||||
vol.Optional(DOMAIN_IMAGE): vol.All(
|
||||
cv.ensure_list, [image_platform.IMAGE_SCHEMA]
|
||||
),
|
||||
vol.Optional(DOMAIN_LIGHT): vol.All(
|
||||
cv.ensure_list, [light_platform.LIGHT_SCHEMA]
|
||||
),
|
||||
vol.Optional(DOMAIN_LOCK): vol.All(
|
||||
cv.ensure_list, [lock_platform.LOCK_SCHEMA]
|
||||
),
|
||||
vol.Optional(DOMAIN_NUMBER): vol.All(
|
||||
cv.ensure_list, [number_platform.NUMBER_SCHEMA]
|
||||
),
|
||||
vol.Optional(DOMAIN_SELECT): vol.All(
|
||||
cv.ensure_list, [select_platform.SELECT_SCHEMA]
|
||||
),
|
||||
vol.Optional(DOMAIN_SENSOR): vol.All(
|
||||
cv.ensure_list, [sensor_platform.SENSOR_SCHEMA]
|
||||
),
|
||||
vol.Optional(DOMAIN_SWITCH): vol.All(
|
||||
cv.ensure_list, [switch_platform.SWITCH_SCHEMA]
|
||||
),
|
||||
vol.Optional(DOMAIN_VACUUM): vol.All(
|
||||
cv.ensure_list, [vacuum_platform.VACUUM_SCHEMA]
|
||||
),
|
||||
vol.Optional(DOMAIN_WEATHER): vol.All(
|
||||
cv.ensure_list, [weather_platform.WEATHER_SCHEMA]
|
||||
),
|
||||
},
|
||||
),
|
||||
ensure_domains_do_not_have_trigger_or_action(
|
||||
ALARM_CONTROL_PANEL_DOMAIN, BUTTON_DOMAIN, COVER_DOMAIN, FAN_DOMAIN, LOCK_DOMAIN
|
||||
DOMAIN_ALARM_CONTROL_PANEL,
|
||||
DOMAIN_BUTTON,
|
||||
DOMAIN_COVER,
|
||||
DOMAIN_FAN,
|
||||
DOMAIN_LOCK,
|
||||
DOMAIN_VACUUM,
|
||||
),
|
||||
)
|
||||
|
||||
@ -247,12 +257,12 @@ async def async_validate_config(hass: HomeAssistant, config: ConfigType) -> Conf
|
||||
for old_key, new_key, transform in (
|
||||
(
|
||||
CONF_SENSORS,
|
||||
SENSOR_DOMAIN,
|
||||
DOMAIN_SENSOR,
|
||||
sensor_platform.rewrite_legacy_to_modern_conf,
|
||||
),
|
||||
(
|
||||
CONF_BINARY_SENSORS,
|
||||
BINARY_SENSOR_DOMAIN,
|
||||
DOMAIN_BINARY_SENSOR,
|
||||
binary_sensor_platform.rewrite_legacy_to_modern_conf,
|
||||
),
|
||||
):
|
||||
|
||||
@ -24,21 +24,27 @@ from homeassistant.components.vacuum import (
|
||||
from homeassistant.const import (
|
||||
CONF_ENTITY_ID,
|
||||
CONF_FRIENDLY_NAME,
|
||||
CONF_NAME,
|
||||
CONF_STATE,
|
||||
CONF_UNIQUE_ID,
|
||||
CONF_VALUE_TEMPLATE,
|
||||
STATE_UNKNOWN,
|
||||
)
|
||||
from homeassistant.core import HomeAssistant, callback
|
||||
from homeassistant.exceptions import TemplateError
|
||||
from homeassistant.helpers import config_validation as cv
|
||||
from homeassistant.helpers import config_validation as cv, template
|
||||
from homeassistant.helpers.entity import async_generate_entity_id
|
||||
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
||||
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
|
||||
|
||||
from .const import DOMAIN
|
||||
from .const import CONF_OBJECT_ID, CONF_PICTURE, DOMAIN
|
||||
from .template_entity import (
|
||||
LEGACY_FIELDS as TEMPLATE_ENTITY_LEGACY_FIELDS,
|
||||
TEMPLATE_ENTITY_ATTRIBUTES_SCHEMA,
|
||||
TEMPLATE_ENTITY_ATTRIBUTES_SCHEMA_LEGACY,
|
||||
TEMPLATE_ENTITY_AVAILABILITY_SCHEMA,
|
||||
TEMPLATE_ENTITY_AVAILABILITY_SCHEMA_LEGACY,
|
||||
TEMPLATE_ENTITY_ICON_SCHEMA,
|
||||
TemplateEntity,
|
||||
rewrite_common_legacy_to_modern_conf,
|
||||
)
|
||||
@ -46,8 +52,10 @@ from .template_entity import (
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
CONF_VACUUMS = "vacuums"
|
||||
CONF_BATTERY_LEVEL = "battery_level"
|
||||
CONF_BATTERY_LEVEL_TEMPLATE = "battery_level_template"
|
||||
CONF_FAN_SPEED_LIST = "fan_speeds"
|
||||
CONF_FAN_SPEED = "fan_speed"
|
||||
CONF_FAN_SPEED_TEMPLATE = "fan_speed_template"
|
||||
|
||||
ENTITY_ID_FORMAT = VACUUM_DOMAIN + ".{}"
|
||||
@ -60,24 +68,55 @@ _VALID_STATES = [
|
||||
VacuumActivity.ERROR,
|
||||
]
|
||||
|
||||
LEGACY_FIELDS = TEMPLATE_ENTITY_LEGACY_FIELDS | {
|
||||
CONF_BATTERY_LEVEL_TEMPLATE: CONF_BATTERY_LEVEL,
|
||||
CONF_FAN_SPEED_TEMPLATE: CONF_FAN_SPEED,
|
||||
CONF_VALUE_TEMPLATE: CONF_STATE,
|
||||
}
|
||||
|
||||
VACUUM_SCHEMA = vol.All(
|
||||
vol.Schema(
|
||||
{
|
||||
vol.Optional(CONF_BATTERY_LEVEL): cv.template,
|
||||
vol.Optional(CONF_ENTITY_ID): cv.entity_ids,
|
||||
vol.Optional(CONF_FAN_SPEED_LIST, default=[]): cv.ensure_list,
|
||||
vol.Optional(CONF_FAN_SPEED): cv.template,
|
||||
vol.Optional(CONF_NAME): cv.template,
|
||||
vol.Optional(CONF_PICTURE): cv.template,
|
||||
vol.Optional(CONF_STATE): cv.template,
|
||||
vol.Optional(CONF_UNIQUE_ID): cv.string,
|
||||
vol.Optional(SERVICE_CLEAN_SPOT): cv.SCRIPT_SCHEMA,
|
||||
vol.Optional(SERVICE_LOCATE): cv.SCRIPT_SCHEMA,
|
||||
vol.Optional(SERVICE_PAUSE): cv.SCRIPT_SCHEMA,
|
||||
vol.Optional(SERVICE_RETURN_TO_BASE): cv.SCRIPT_SCHEMA,
|
||||
vol.Optional(SERVICE_SET_FAN_SPEED): cv.SCRIPT_SCHEMA,
|
||||
vol.Required(SERVICE_START): cv.SCRIPT_SCHEMA,
|
||||
vol.Optional(SERVICE_STOP): cv.SCRIPT_SCHEMA,
|
||||
}
|
||||
)
|
||||
.extend(TEMPLATE_ENTITY_ATTRIBUTES_SCHEMA.schema)
|
||||
.extend(TEMPLATE_ENTITY_AVAILABILITY_SCHEMA.schema)
|
||||
.extend(TEMPLATE_ENTITY_ICON_SCHEMA.schema),
|
||||
)
|
||||
|
||||
LEGACY_VACUUM_SCHEMA = vol.All(
|
||||
cv.deprecated(CONF_ENTITY_ID),
|
||||
vol.Schema(
|
||||
{
|
||||
vol.Optional(CONF_FRIENDLY_NAME): cv.string,
|
||||
vol.Optional(CONF_VALUE_TEMPLATE): cv.template,
|
||||
vol.Optional(CONF_BATTERY_LEVEL_TEMPLATE): cv.template,
|
||||
vol.Optional(CONF_ENTITY_ID): cv.entity_ids,
|
||||
vol.Optional(CONF_FAN_SPEED_LIST, default=[]): cv.ensure_list,
|
||||
vol.Optional(CONF_FAN_SPEED_TEMPLATE): cv.template,
|
||||
vol.Required(SERVICE_START): cv.SCRIPT_SCHEMA,
|
||||
vol.Optional(SERVICE_PAUSE): cv.SCRIPT_SCHEMA,
|
||||
vol.Optional(SERVICE_STOP): cv.SCRIPT_SCHEMA,
|
||||
vol.Optional(SERVICE_RETURN_TO_BASE): cv.SCRIPT_SCHEMA,
|
||||
vol.Optional(CONF_FRIENDLY_NAME): cv.string,
|
||||
vol.Optional(CONF_UNIQUE_ID): cv.string,
|
||||
vol.Optional(CONF_VALUE_TEMPLATE): cv.template,
|
||||
vol.Optional(SERVICE_CLEAN_SPOT): cv.SCRIPT_SCHEMA,
|
||||
vol.Optional(SERVICE_LOCATE): cv.SCRIPT_SCHEMA,
|
||||
vol.Optional(SERVICE_PAUSE): cv.SCRIPT_SCHEMA,
|
||||
vol.Optional(SERVICE_RETURN_TO_BASE): cv.SCRIPT_SCHEMA,
|
||||
vol.Optional(SERVICE_SET_FAN_SPEED): cv.SCRIPT_SCHEMA,
|
||||
vol.Optional(CONF_FAN_SPEED_LIST, default=[]): cv.ensure_list,
|
||||
vol.Optional(CONF_ENTITY_ID): cv.entity_ids,
|
||||
vol.Optional(CONF_UNIQUE_ID): cv.string,
|
||||
vol.Required(SERVICE_START): cv.SCRIPT_SCHEMA,
|
||||
vol.Optional(SERVICE_STOP): cv.SCRIPT_SCHEMA,
|
||||
}
|
||||
)
|
||||
.extend(TEMPLATE_ENTITY_ATTRIBUTES_SCHEMA_LEGACY.schema)
|
||||
@ -85,28 +124,56 @@ VACUUM_SCHEMA = vol.All(
|
||||
)
|
||||
|
||||
PLATFORM_SCHEMA = cv.PLATFORM_SCHEMA.extend(
|
||||
{vol.Required(CONF_VACUUMS): vol.Schema({cv.slug: VACUUM_SCHEMA})}
|
||||
{vol.Required(CONF_VACUUMS): cv.schema_with_slug_keys(LEGACY_VACUUM_SCHEMA)}
|
||||
)
|
||||
|
||||
|
||||
async def _async_create_entities(hass: HomeAssistant, config: ConfigType):
|
||||
"""Create the Template Vacuums."""
|
||||
def rewrite_legacy_to_modern_conf(
|
||||
hass: HomeAssistant, config: dict[str, dict]
|
||||
) -> list[dict]:
|
||||
"""Rewrite legacy switch configuration definitions to modern ones."""
|
||||
vacuums = []
|
||||
|
||||
for object_id, entity_config in config[CONF_VACUUMS].items():
|
||||
entity_config = rewrite_common_legacy_to_modern_conf(hass, entity_config)
|
||||
unique_id = entity_config.get(CONF_UNIQUE_ID)
|
||||
for object_id, entity_conf in config.items():
|
||||
entity_conf = {**entity_conf, CONF_OBJECT_ID: object_id}
|
||||
|
||||
entity_conf = rewrite_common_legacy_to_modern_conf(
|
||||
hass, entity_conf, LEGACY_FIELDS
|
||||
)
|
||||
|
||||
if CONF_NAME not in entity_conf:
|
||||
entity_conf[CONF_NAME] = template.Template(object_id, hass)
|
||||
|
||||
vacuums.append(entity_conf)
|
||||
|
||||
return vacuums
|
||||
|
||||
|
||||
@callback
|
||||
def _async_create_template_tracking_entities(
|
||||
async_add_entities: AddEntitiesCallback,
|
||||
hass: HomeAssistant,
|
||||
definitions: list[dict],
|
||||
unique_id_prefix: str | None,
|
||||
) -> None:
|
||||
"""Create the template switches."""
|
||||
vacuums = []
|
||||
|
||||
for entity_conf in definitions:
|
||||
unique_id = entity_conf.get(CONF_UNIQUE_ID)
|
||||
|
||||
if unique_id and unique_id_prefix:
|
||||
unique_id = f"{unique_id_prefix}-{unique_id}"
|
||||
|
||||
vacuums.append(
|
||||
TemplateVacuum(
|
||||
hass,
|
||||
object_id,
|
||||
entity_config,
|
||||
entity_conf,
|
||||
unique_id,
|
||||
)
|
||||
)
|
||||
|
||||
return vacuums
|
||||
async_add_entities(vacuums)
|
||||
|
||||
|
||||
async def async_setup_platform(
|
||||
@ -115,8 +182,22 @@ async def async_setup_platform(
|
||||
async_add_entities: AddEntitiesCallback,
|
||||
discovery_info: DiscoveryInfoType | None = None,
|
||||
) -> None:
|
||||
"""Set up the template vacuums."""
|
||||
async_add_entities(await _async_create_entities(hass, config))
|
||||
"""Set up the Template cover."""
|
||||
if discovery_info is None:
|
||||
_async_create_template_tracking_entities(
|
||||
async_add_entities,
|
||||
hass,
|
||||
rewrite_legacy_to_modern_conf(hass, config[CONF_VACUUMS]),
|
||||
None,
|
||||
)
|
||||
return
|
||||
|
||||
_async_create_template_tracking_entities(
|
||||
async_add_entities,
|
||||
hass,
|
||||
discovery_info["entities"],
|
||||
discovery_info["unique_id"],
|
||||
)
|
||||
|
||||
|
||||
class TemplateVacuum(TemplateEntity, StateVacuumEntity):
|
||||
@ -127,24 +208,22 @@ class TemplateVacuum(TemplateEntity, StateVacuumEntity):
|
||||
def __init__(
|
||||
self,
|
||||
hass: HomeAssistant,
|
||||
object_id,
|
||||
config: ConfigType,
|
||||
unique_id,
|
||||
) -> None:
|
||||
"""Initialize the vacuum."""
|
||||
super().__init__(
|
||||
hass, config=config, fallback_name=object_id, unique_id=unique_id
|
||||
)
|
||||
self.entity_id = async_generate_entity_id(
|
||||
ENTITY_ID_FORMAT, object_id, hass=hass
|
||||
)
|
||||
super().__init__(hass, config=config, fallback_name=None, unique_id=unique_id)
|
||||
if (object_id := config.get(CONF_OBJECT_ID)) is not None:
|
||||
self.entity_id = async_generate_entity_id(
|
||||
ENTITY_ID_FORMAT, object_id, hass=hass
|
||||
)
|
||||
name = self._attr_name
|
||||
if TYPE_CHECKING:
|
||||
assert name is not None
|
||||
|
||||
self._template = config.get(CONF_VALUE_TEMPLATE)
|
||||
self._battery_level_template = config.get(CONF_BATTERY_LEVEL_TEMPLATE)
|
||||
self._fan_speed_template = config.get(CONF_FAN_SPEED_TEMPLATE)
|
||||
self._template = config.get(CONF_STATE)
|
||||
self._battery_level_template = config.get(CONF_BATTERY_LEVEL)
|
||||
self._fan_speed_template = config.get(CONF_FAN_SPEED)
|
||||
self._attr_supported_features = (
|
||||
VacuumEntityFeature.START | VacuumEntityFeature.STATE
|
||||
)
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
Loading…
x
Reference in New Issue
Block a user