mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-09-27 04:13:07 +02:00
79 lines
2.6 KiB
ReStructuredText
79 lines
2.6 KiB
ReStructuredText
Managed Updates via HTTP Request
|
|
================================
|
|
|
|
.. seo::
|
|
:description: Instructions for using ESPHome's http_request update platform to manage updates on your devices.
|
|
:image: system-update.svg
|
|
:keywords: Updates, OTA, ESP32, ESP8266
|
|
|
|
This platform allows you to manage the deployment of updates to your ESPHome devices. It works by reading a
|
|
:ref:`JSON manifest file <update_http_request-manifest_format>` and using it to determine the presence of an update.
|
|
|
|
To use it, the following components are required in your device's configuration:
|
|
|
|
- :doc:`/components/http_request`
|
|
- :doc:`/components/ota/http_request`
|
|
|
|
.. code-block:: yaml
|
|
|
|
# Example configuration entry
|
|
update:
|
|
- platform: http_request
|
|
name: Firmware Update
|
|
source: http://example.com/manifest.json
|
|
|
|
.. _update_http_request-configuration_variables:
|
|
|
|
Configuration variables:
|
|
------------------------
|
|
|
|
- **source** (**Required**, string): The URL of the YAML manifest file containing the firmware metadata.
|
|
- **update_interval** (*Optional*, :ref:`config-time`): The interval at which to check for (**not install**) updates.
|
|
Defaults to 6 hours.
|
|
- All other options from :ref:`Update <config-update>`.
|
|
|
|
.. _update_http_request-manifest_format:
|
|
|
|
Update Manifest Format
|
|
----------------------
|
|
|
|
This component expects the `ESP-Web-Tools manifest <https://github.com/esphome/esp-web-tools>`__ with an extension in
|
|
the ``ota`` block that is structured as follows:
|
|
|
|
.. code-block:: json
|
|
|
|
{
|
|
"name": "My ESPHome Project",
|
|
"version": "2024.6.1",
|
|
"builds": [
|
|
{
|
|
"chipFamily": "ESP32-C3",
|
|
"ota": {
|
|
"md5": "1234567890abcdef1234567890abcdef",
|
|
"path": "/local/esp32c3/firmware.bin",
|
|
"release_url": "http://example.com/releases/10",
|
|
"summary": "Another update",
|
|
}
|
|
}
|
|
]
|
|
}
|
|
|
|
While ``release_url`` and ``summary`` are optional, all other fields shown here are required.
|
|
|
|
If ``path`` begins with:
|
|
|
|
- ``http`` or ``https``: ``path`` is treated as full URL which will be used to obtain the firmware binary.
|
|
- A forward slash (``/``): ``path`` will be appended to the hostname (an "absolute" path) specified for ``source`` (as above).
|
|
- Any other character: ``path`` will be appended to ``source`` (as specified above) after trimming the manifest file name.
|
|
|
|
Note that there may be multiple ``builds`` specified within a single JSON file.
|
|
|
|
See Also
|
|
--------
|
|
|
|
- :doc:`http_request`
|
|
- :doc:`/components/ota/http_request`
|
|
- :doc:`/components/ota/index`
|
|
- :apiref:`update/update_entity.h`
|
|
- :ghedit:`Edit`
|