diff --git a/source/_integrations/lock.template.markdown b/source/_integrations/lock.template.markdown index e89cb65ab98..74e67c1a2ee 100644 --- a/source/_integrations/lock.template.markdown +++ b/source/_integrations/lock.template.markdown @@ -22,6 +22,7 @@ In optimistic mode, the lock will immediately change state after every command. To enable Template Locks in your installation, add the following to your `configuration.yaml` file: {% raw %} + ```yaml # Example configuration.yaml entry lock: @@ -37,6 +38,7 @@ lock: data: entity_id: switch.door ``` + {% endraw %} {% configuration %} @@ -49,7 +51,12 @@ lock: description: Defines a template to set the state of the lock. required: true type: template - lock: + availability_template: + description: Defines a template to get the `available` state of the component. If the template returns `true`, the device is `available`. If the template returns any other value, the device will be `unavailable`. If `availability_template` is not configured, the component will always be `available`. + required: false + type: template + default: true + lock: description: Defines an action to run when the lock is locked. required: true type: action @@ -77,6 +84,7 @@ In this section, you find some real-life examples of how to use this lock. This example shows a lock that copies data from a switch. {% raw %} + ```yaml lock: - platform: template @@ -91,6 +99,7 @@ lock: data: entity_id: switch.source ``` + {% endraw %} ### Optimistic Mode @@ -98,6 +107,7 @@ lock: This example shows a lock in optimistic mode. This lock will immediately change state after command and will not wait for state update from the sensor. {% raw %} + ```yaml lock: - platform: template @@ -113,6 +123,7 @@ lock: data: entity_id: switch.source ``` + {% endraw %} ### Sensor and Two Switches @@ -120,6 +131,7 @@ lock: This example shows a lock that takes its state from a sensor, and uses two momentary switches to control a device. {% raw %} + ```yaml lock: - platform: template @@ -134,4 +146,5 @@ lock: data: entity_id: switch.skylight_close ``` + {% endraw %}