Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2024-11-10 10:11:29 +01:00
Code Issues Projects Releases Wiki Activity

[lock] Tidy up name/id (#4146)

Browse Source
This commit is contained in:
Jesse Hills 2024-08-14 14:38:52 +12:00 committed by GitHub
parent f6b565de76
commit 3b59f2c847
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 2 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
components/lock/index.rst
View File

@ -21,7 +21,8 @@ Base Lock Configuration
Configuration variables:
- **name** (**Required**, string): The name of the lock.
- **id** (*Optional*, string): Manually specify the ID for code generation. At least one of **id** and **name** must be specified.
- **name** (*Optional*, string): The name of the lock. At least one of **id** and **name** must be specified.
.. note::

2
components/lock/output.rst
View File

@ -27,8 +27,6 @@ Configuration variables:
------------------------
- **output** (**Required**, :ref:`config-id`): The ID of the output component to use.
- **name** (**Required**, string): The name for the lock.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Lock <config-lock>`.
See Also

2
components/lock/template.rst
View File

@ -45,7 +45,6 @@ Possible return values for the optional lambda:
Configuration variables:
------------------------
- **name** (**Required**, string): The name of the lock.
- **lambda** (*Optional*, :ref:`lambda <config-lambda>`):
Lambda to be evaluated repeatedly to get the current state of the lock.
- **lock_action** (*Optional*, :ref:`Action <config-action>`): The action that should
@ -58,7 +57,6 @@ Configuration variables:
- **assumed_state** (*Optional*, boolean): Whether the true state of the lock is not known.
This will make the Home Assistant frontend show buttons for both LOCK and UNLOCK actions, instead
of hiding one of them when the lock is LOCKED/UNLOCKED. Defaults to ``false``.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Lock <config-lock>`.
.. _lock-template-publish_action: