mirror of
https://github.com/home-assistant/core
synced 2024-08-02 23:40:32 +02:00
119 lines
3.4 KiB
Python
119 lines
3.4 KiB
Python
"""Demo lock platform that has two fake locks."""
|
|
from __future__ import annotations
|
|
|
|
import asyncio
|
|
from typing import Any
|
|
|
|
from homeassistant.components.lock import LockEntity, LockEntityFeature
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.const import (
|
|
STATE_JAMMED,
|
|
STATE_LOCKED,
|
|
STATE_LOCKING,
|
|
STATE_UNLOCKED,
|
|
STATE_UNLOCKING,
|
|
)
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
|
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
|
|
|
|
LOCK_UNLOCK_DELAY = 2 # Used to give a realistic lock/unlock experience in frontend
|
|
|
|
|
|
async def async_setup_platform(
|
|
hass: HomeAssistant,
|
|
config: ConfigType,
|
|
async_add_entities: AddEntitiesCallback,
|
|
discovery_info: DiscoveryInfoType | None = None,
|
|
) -> None:
|
|
"""Set up the Demo lock platform."""
|
|
async_add_entities(
|
|
[
|
|
DemoLock("Front Door", STATE_LOCKED),
|
|
DemoLock("Kitchen Door", STATE_UNLOCKED),
|
|
DemoLock("Poorly Installed Door", STATE_UNLOCKED, False, True),
|
|
DemoLock("Openable Lock", STATE_LOCKED, True),
|
|
]
|
|
)
|
|
|
|
|
|
async def async_setup_entry(
|
|
hass: HomeAssistant,
|
|
config_entry: ConfigEntry,
|
|
async_add_entities: AddEntitiesCallback,
|
|
) -> None:
|
|
"""Set up the Demo config entry."""
|
|
await async_setup_platform(hass, {}, async_add_entities)
|
|
|
|
|
|
class DemoLock(LockEntity):
|
|
"""Representation of a Demo lock."""
|
|
|
|
_attr_should_poll = False
|
|
|
|
def __init__(
|
|
self,
|
|
name: str,
|
|
state: str,
|
|
openable: bool = False,
|
|
jam_on_operation: bool = False,
|
|
) -> None:
|
|
"""Initialize the lock."""
|
|
self._attr_name = name
|
|
if openable:
|
|
self._attr_supported_features = LockEntityFeature.OPEN
|
|
self._state = state
|
|
self._openable = openable
|
|
self._jam_on_operation = jam_on_operation
|
|
|
|
@property
|
|
def is_locking(self) -> bool:
|
|
"""Return true if lock is locking."""
|
|
return self._state == STATE_LOCKING
|
|
|
|
@property
|
|
def is_unlocking(self) -> bool:
|
|
"""Return true if lock is unlocking."""
|
|
return self._state == STATE_UNLOCKING
|
|
|
|
@property
|
|
def is_jammed(self) -> bool:
|
|
"""Return true if lock is jammed."""
|
|
return self._state == STATE_JAMMED
|
|
|
|
@property
|
|
def is_locked(self) -> bool:
|
|
"""Return true if lock is locked."""
|
|
return self._state == STATE_LOCKED
|
|
|
|
async def async_lock(self, **kwargs: Any) -> None:
|
|
"""Lock the device."""
|
|
self._state = STATE_LOCKING
|
|
self.async_write_ha_state()
|
|
await asyncio.sleep(LOCK_UNLOCK_DELAY)
|
|
if self._jam_on_operation:
|
|
self._state = STATE_JAMMED
|
|
else:
|
|
self._state = STATE_LOCKED
|
|
self.async_write_ha_state()
|
|
|
|
async def async_unlock(self, **kwargs: Any) -> None:
|
|
"""Unlock the device."""
|
|
self._state = STATE_UNLOCKING
|
|
self.async_write_ha_state()
|
|
await asyncio.sleep(LOCK_UNLOCK_DELAY)
|
|
self._state = STATE_UNLOCKED
|
|
self.async_write_ha_state()
|
|
|
|
async def async_open(self, **kwargs: Any) -> None:
|
|
"""Open the door latch."""
|
|
self._state = STATE_UNLOCKED
|
|
self.async_write_ha_state()
|
|
|
|
@property
|
|
def supported_features(self) -> int:
|
|
"""Flag supported features."""
|
|
if self._openable:
|
|
return LockEntityFeature.OPEN
|
|
return 0
|