lock.py

Go to the documentation of this file.

"""Platform allowing several locks to be grouped into one lock."""
 
from __future__ import annotations
 
import logging
from typing import Any
 
import voluptuous as vol
 
from homeassistant.components.lock import (
    DOMAIN as LOCK_DOMAIN,
    PLATFORM_SCHEMA as LOCK_PLATFORM_SCHEMA,
    LockEntity,
    LockEntityFeature,
    LockState,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import (
    ATTR_ENTITY_ID,
    CONF_ENTITIES,
    CONF_NAME,
    CONF_UNIQUE_ID,
    SERVICE_LOCK,
    SERVICE_OPEN,
    SERVICE_UNLOCK,
    STATE_UNAVAILABLE,
    STATE_UNKNOWN,
)
from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers import config_validation as cv, entity_registry as er
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
 
from .entity import GroupEntity
 
DEFAULT_NAME = "Lock Group"
 
# No limit on parallel updates to enable a group calling another group
PARALLEL_UPDATES = 0
 
PLATFORM_SCHEMA = LOCK_PLATFORM_SCHEMA.extend(
    {
        vol.Required(CONF_ENTITIES): cv.entities_domain(LOCK_DOMAIN),
        vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
        vol.Optional(CONF_UNIQUE_ID): cv.string,
    }
)
 
_LOGGER = logging.getLogger(__name__)
 
 
async def async_setup_platform(
    hass: HomeAssistant,
    config: ConfigType,
    async_add_entities: AddEntitiesCallback,
    discovery_info: DiscoveryInfoType | None = None,
) -> None:
    """Set up the Lock Group platform."""
    async_add_entities(
        [
            LockGroup(
                config.get(CONF_UNIQUE_ID),
                config[CONF_NAME],
                config[CONF_ENTITIES],
            )
        ]
    )
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    config_entry: ConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Initialize Lock Group config entry."""
    registry = er.async_get(hass)
    entities = er.async_validate_entity_ids(
        registry, config_entry.options[CONF_ENTITIES]
    )
    async_add_entities(
        [
            LockGroup(
                config_entry.entry_id,
                config_entry.title,
                entities,
            )
        ]
    )
 
 
@callback
def async_create_preview_lock(
    hass: HomeAssistant, name: str, validated_config: dict[str, Any]
) -> LockGroup:
    """Create a preview sensor."""
    return LockGroup(
        None,
        name,
        validated_config[CONF_ENTITIES],
    )
 
 
class LockGroup(GroupEntity, LockEntity):
    """Representation of a lock group."""
 
    _attr_available = False
    _attr_should_poll = False
 
    def __init__(
        self,
        unique_id: str | None,
        name: str,
        entity_ids: list[str],
    ) -> None:
        """Initialize a lock group."""
        self._entity_ids_entity_ids = entity_ids
        self._attr_supported_features_attr_supported_features = LockEntityFeature.OPEN
 
        self._attr_name_attr_name = name
        self._attr_extra_state_attributes_attr_extra_state_attributes = {ATTR_ENTITY_ID: entity_ids}
        self._attr_unique_id_attr_unique_id = unique_id
 
    async def async_lock(self, **kwargs: Any) -> None:
        """Forward the lock command to all locks in the group."""
        data = {ATTR_ENTITY_ID: self._entity_ids_entity_ids}
        _LOGGER.debug("Forwarded lock command: %s", data)
 
        await self.hasshass.services.async_call(
            LOCK_DOMAIN,
            SERVICE_LOCK,
            data,
            blocking=True,
            context=self._context_context,
        )
 
    async def async_unlock(self, **kwargs: Any) -> None:
        """Forward the unlock command to all locks in the group."""
        data = {ATTR_ENTITY_ID: self._entity_ids_entity_ids}
        await self.hasshass.services.async_call(
            LOCK_DOMAIN,
            SERVICE_UNLOCK,
            data,
            blocking=True,
            context=self._context_context,
        )
 
    async def async_open(self, **kwargs: Any) -> None:
        """Forward the open command to all locks in the group."""
        data = {ATTR_ENTITY_ID: self._entity_ids_entity_ids}
        await self.hasshass.services.async_call(
            LOCK_DOMAIN,
            SERVICE_OPEN,
            data,
            blocking=True,
            context=self._context_context,
        )
 
    @callback
    def async_update_group_state(self) -> None:
        """Query all members and determine the lock group state."""
        states = [
            state.state
            for entity_id in self._entity_ids_entity_ids
            if (state := self.hasshass.states.get(entity_id)) is not None
        ]
 
        valid_state = any(
            state not in (STATE_UNKNOWN, STATE_UNAVAILABLE) for state in states
        )
 
        if not valid_state:
            # Set as unknown if any member is unknown or unavailable
            self._attr_is_jammed_attr_is_jammed = None
            self._attr_is_locking_attr_is_locking = None
            self._attr_is_opening_attr_is_opening = None
            self._attr_is_open_attr_is_open = None
            self._attr_is_unlocking_attr_is_unlocking = None
            self._attr_is_locked_attr_is_locked = None
        else:
            # Set attributes based on member states and let the lock entity sort out the correct state
            self._attr_is_jammed_attr_is_jammed = LockState.JAMMED in states
            self._attr_is_locking_attr_is_locking = LockState.LOCKING in states
            self._attr_is_opening_attr_is_opening = LockState.OPENING in states
            self._attr_is_open_attr_is_open = LockState.OPEN in states
            self._attr_is_unlocking_attr_is_unlocking = LockState.UNLOCKING in states
            self._attr_is_locked_attr_is_locked = all(state == LockState.LOCKED for state in states)
 
        self._attr_available_attr_available_attr_available = any(state != STATE_UNAVAILABLE for state in states)