jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-08 09:56:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rename LockDevice to LockEntity (#478)

Browse Source
This commit is contained in:
Erik Montnemery 2020-04-25 18:22:34 +02:00 committed by GitHub
parent 33028ce8f0
commit e8e5b9da98
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/entity_lock.md
View File

@ -3,7 +3,7 @@ title: Lock Entity
sidebar_label: Lock sidebar_label: Lock
--- ---
A lock entity is a device which is able to lock and unlock. Locking and unlocking can optionally be secured with a user code. Some locks also allow for opening of latches, this may also be secured with a user code. A lock entity is able to be locked and unlocked. Locking and unlocking can optionally be secured with a user code. Some locks also allow for opening of latches, this may also be secured with a user code. Derive a platform entity from [`homeassistant.components.lock.LockEntity`](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/lock/__init__.py).
## Properties ## Properties
@ -30,7 +30,7 @@ Supported features constants are combined using the bitwise or (`|`) operator.
### Lock ### Lock
```python ```python
class MyLock(LockDevice): class MyLock(LockEntity):
def lock(self, **kwargs): def lock(self, **kwargs):
"""Lock all or specified locks. A code to lock the lock with may optionally be specified.""" """Lock all or specified locks. A code to lock the lock with may optionally be specified."""
@ -42,7 +42,7 @@ class MyLock(LockDevice):
### Unlock ### Unlock
```python ```python
class MyLock(LockDevice): class MyLock(LockEntity):
def unlock(self, **kwargs): def unlock(self, **kwargs):
"""Unlock all or specified locks. A code to unlock the lock with may optionally be specified.""" """Unlock all or specified locks. A code to unlock the lock with may optionally be specified."""
@ -56,7 +56,7 @@ class MyLock(LockDevice):
Only implement this method if the flag `SUPPORT_OPEN` is set. Only implement this method if the flag `SUPPORT_OPEN` is set.
```python ```python
class MyLock(LockDevice): class MyLock(LockEntity):
def open(self, **kwargs): def open(self, **kwargs):
"""Open (unlatch) all or specified locks. A code to open the lock with may optionally be specified.""" """Open (unlatch) all or specified locks. A code to open the lock with may optionally be specified."""