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

[update] Add automation documentation (#4098)

Browse Source 
* [update] Add automation documentation

* Fix underline

* Fix
This commit is contained in:
Jesse Hills 2024-07-31 16:16:30 +12:00 committed by GitHub
parent 838ade7afa
commit 67e2b0b31b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
components/update/index.rst
View File

@ -33,6 +33,31 @@ Configuration variables:
- **internal** (*Optional*, boolean): Mark this component as internal. Internal components will
not be exposed to the frontend (like Home Assistant). Specifying an ``id`` without a ``name`` will
implicitly set this to true.
- **on_update_available** (*Optional*, :ref:`Action <config-action>`): An automation to perform when an update is available.
Automations
-----------
``update.perform`` Action
~~~~~~~~~~~~~~~~~~~~~~~~~
This action allows you to trigger the update entity to start the update process.
Configuration variables:
- **id** (**Required**, :ref:`config-id`): The ID of the update entity.
- **force_update** (*Optional*, boolean): Perform the update even if the device is already running the same version.
Defaults to ``false``.
``update.is_available`` Condition
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This condition checks if an update is available for the device.
Configuration variables:
- **id** (**Required**, :ref:`config-id`): The ID of the update entity.
See Also
--------