jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-28 11:47:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation for template.button platform (#20717)

Browse Source
This commit is contained in:
Raman Gupta 2022-01-03 04:57:59 -05:00 committed by GitHub
parent 635a6ecff9
commit 7dbd4467f8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
source/_integrations/template.markdown
View File

@ -15,6 +15,7 @@ ha_domain: template
ha_platforms: ha_platforms:
- alarm_control_panel - alarm_control_panel
- binary_sensor - binary_sensor
- button
- cover - cover
- fan - fan
- light - light
@ -29,7 +30,7 @@ ha_platforms:
The `template` integration allows creating entities which derive their values from other data. This is done by specifying [templates](/docs/configuration/templating/) for properties of an entity, like the name or the state. The `template` integration allows creating entities which derive their values from other data. This is done by specifying [templates](/docs/configuration/templating/) for properties of an entity, like the name or the state.
Sensors, binary (on/off) sensors, numbers and selects are covered on this page. For other types, please see the specific pages: Sensors, binary (on/off) sensors, buttons, numbers and selects are covered on this page. For other types, please see the specific pages:
- [Alarm Control Panel](/integrations/alarm_control_panel.template/) - [Alarm Control Panel](/integrations/alarm_control_panel.template/)
- [Cover](/integrations/cover.template/) - [Cover](/integrations/cover.template/)
@ -40,7 +41,7 @@ Sensors, binary (on/off) sensors, numbers and selects are covered on this page.
- [Vacuum](/integrations/vacuum.template/) - [Vacuum](/integrations/vacuum.template/)
- [Weather](/integrations/weather.template/) - [Weather](/integrations/weather.template/)
Sensor, binary sensor, number and select template entities are defined in your YAML configuration files, directly under the `template:` key and cannot be configured via the UI. You can define multiple configuration blocks as a list. Each block defines sensor/binary sensor/number/select entities and can contain an optional update trigger. Sensor, binary sensor, button, number and select template entities are defined in your YAML configuration files, directly under the `template:` key and cannot be configured via the UI. You can define multiple configuration blocks as a list. Each block defines sensor/binary sensor/number/select entities and can contain an optional update trigger.
_For old sensor/binary sensor configuration format, [see below](#legacy-binary-sensor-configuration-format)._ _For old sensor/binary sensor configuration format, [see below](#legacy-binary-sensor-configuration-format)._
@ -218,8 +219,17 @@ select:
required: false required: false
type: boolean type: boolean
default: false default: false
"[all sensor, binary sensor, number, select entities]": button:
description: Fields that can be used above for sensors, binary sensors, numbers, and selects. description: List of buttons
required: true
type: map
keys:
press:
description: Defines actions to run to press the button.
required: true
type: action
"[all sensor, binary sensor, button, number, select entities]":
description: Fields that can be used above for sensors, binary sensors, buttons, numbers, and selects.
required: false required: false
type: map type: map
keys: keys: