Skip to content

Rename LockDevice to LockEntity #478

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MartinHjelmare merged 3 commits into from
Apr 25, 2020
Merged

Rename LockDevice to LockEntity #478

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3b53e7a
Rename LockDevice to LockEntity
emontnemery Apr 25, 2020
a66aad1
Add link to base class
emontnemery Apr 25, 2020
93c9f31
Wording
MartinHjelmare Apr 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/entity_lock.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Lock Entity
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

Expand All @@ -30,7 +30,7 @@ Supported features constants are combined using the bitwise or (`|`) operator.
### Lock

```python
class MyLock(LockDevice):
class MyLock(LockEntity):

def lock(self, **kwargs):
"""Lock all or specified locks. A code to lock the lock with may optionally be specified."""
Expand All @@ -42,7 +42,7 @@ class MyLock(LockDevice):
### Unlock

```python
class MyLock(LockDevice):
class MyLock(LockEntity):

def unlock(self, **kwargs):
"""Unlock all or specified locks. A code to unlock the lock with may optionally be specified."""
Expand All @@ -56,7 +56,7 @@ class MyLock(LockDevice):
Only implement this method if the flag `SUPPORT_OPEN` is set.

```python
class MyLock(LockDevice):
class MyLock(LockEntity):

def open(self, **kwargs):
"""Open (unlatch) all or specified locks. A code to open the lock with may optionally be specified."""
Expand Down