Add lock support to Switchbot Cloud (#148310)

homeassistant/components/switchbot_cloud/lock.py

@@ -2,14 +2,14 @@
 
 from typing import Any
 
-from switchbot_api import LockCommands
+from switchbot_api import Device, LockCommands, LockV2Commands, Remote, SwitchBotAPI
 
-from homeassistant.components.lock import LockEntity
+from homeassistant.components.lock import LockEntity, LockEntityFeature
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
 
-from . import SwitchbotCloudData
+from . import SwitchbotCloudData, SwitchBotCoordinator
 from .const import DOMAIN
 from .entity import SwitchBotCloudEntity
 
@@ -32,10 +32,22 @@ class SwitchBotCloudLock(SwitchBotCloudEntity, LockEntity):
 
     _attr_name = None
 
+    def __init__(
+        self,
+        api: SwitchBotAPI,
+        device: Device | Remote,
+        coordinator: SwitchBotCoordinator,
+    ) -> None:
+        """Init devices."""
+        super().__init__(api, device, coordinator)
+        self.__model = device.device_type
+
     def _set_attributes(self) -> None:
         """Set attributes from coordinator data."""
         if coord_data := self.coordinator.data:
             self._attr_is_locked = coord_data["lockState"] == "locked"
+        if self.__model in LockV2Commands.get_supported_devices():
+            self._attr_supported_features = LockEntityFeature.OPEN
 
     async def async_lock(self, **kwargs: Any) -> None:
         """Lock the lock."""
@@ -45,7 +57,12 @@ class SwitchBotCloudLock(SwitchBotCloudEntity, LockEntity):
 
     async def async_unlock(self, **kwargs: Any) -> None:
         """Unlock the lock."""
-
         await self.send_api_command(LockCommands.UNLOCK)
         self._attr_is_locked = False
         self.async_write_ha_state()
+
+    async def async_open(self, **kwargs: Any) -> None:
+        """Latch open the lock."""
+        await self.send_api_command(LockV2Commands.DEADBOLT)
+        self._attr_is_locked = False
+        self.async_write_ha_state()

tests/components/switchbot_cloud/test_lock.py

@@ -7,7 +7,12 @@ from switchbot_api import Device
 from homeassistant.components.lock import DOMAIN as LOCK_DOMAIN, LockState
 from homeassistant.components.switchbot_cloud import SwitchBotAPI
 from homeassistant.config_entries import ConfigEntryState
-from homeassistant.const import ATTR_ENTITY_ID, SERVICE_LOCK, SERVICE_UNLOCK
+from homeassistant.const import (
+    ATTR_ENTITY_ID,
+    SERVICE_LOCK,
+    SERVICE_OPEN,
+    SERVICE_UNLOCK,
+)
 from homeassistant.core import HomeAssistant
 
 from . import configure_integration
@@ -45,3 +50,33 @@ async def test_lock(hass: HomeAssistant, mock_list_devices, mock_get_status) ->
             LOCK_DOMAIN, SERVICE_LOCK, {ATTR_ENTITY_ID: lock_id}, blocking=True
         )
     assert hass.states.get(lock_id).state == LockState.LOCKED
+
+
+async def test_lock_open(
+    hass: HomeAssistant, mock_list_devices, mock_get_status
+) -> None:
+    """Test lock open."""
+    mock_list_devices.return_value = [
+        Device(
+            version="V1.0",
+            deviceId="lock-id-1",
+            deviceName="lock-1",
+            deviceType="Smart Lock Pro",
+            hubDeviceId="test-hub-id",
+        ),
+    ]
+
+    mock_get_status.return_value = {"lockState": "locked"}
+
+    entry = await configure_integration(hass)
+
+    assert entry.state is ConfigEntryState.LOADED
+
+    lock_id = "lock.lock_1"
+    assert hass.states.get(lock_id).state == LockState.LOCKED
+
+    with patch.object(SwitchBotAPI, "send_command"):
+        await hass.services.async_call(
+            LOCK_DOMAIN, SERVICE_OPEN, {ATTR_ENTITY_ID: lock_id}, blocking=True
+        )
+    assert hass.states.get(lock_id).state == LockState.UNLOCKED