You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Allows to manually trigger a re-configure of the device. Should only be used when the device is not working as expected (e.g. not reporting certain values), not all devices can be configured (only when the definition has a `configure` in its [definition](https://github.com/Koenkk/zigbee-herdsman-converters/blob/master/devices)). Allowed payloads are `{"id": "deviceID"}` or `deviceID` where deviceID can be the `ieee_address` or `friendly_name` of the device. Example; request: `{"id": "my_remote"}` or `my_remote`, response: `{"data":{"id": "my_remote"},"status":"ok"}`.
Copy file name to clipboardExpand all lines: docs/guide/usage/ota_updates.md
+23Lines changed: 23 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -42,6 +42,10 @@ ota:
42
42
disable_automatic_update_check: true
43
43
```
44
44
45
+
:::tip TIP
46
+
Disabling automatic update checks does not disable [scheduling](#scheduling-update-on-next-device-request).
47
+
:::
48
+
45
49
## Manually check if an update is available
46
50
47
51
To check if an upgrade is available for your device send a message to `zigbee2mqtt/bridge/request/device/ota_update/check` with payload `{"id": "deviceID"}` or `deviceID` where deviceID can be the `ieee_address` or `friendly_name` of the device. Example; request: `{"id": "my_remote"}` or `my_remote`, response: `{"data":{"id": "my_remote","update_available":true},"status":"ok"}`. For battery powered end-devices you may need to trigger them by e.g. pushing a button right before checking for an OTA.
@@ -62,6 +66,25 @@ An update typically takes 10-20 minutes (although some devices may take a lot lo
62
66
63
67
Same as above but send the message to `zigbee2mqtt/bridge/request/device/ota_update/update/downgrade` instead.
64
68
69
+
### Scheduling update on next device request
70
+
71
+
:::tip TIP
72
+
This can help for battery-powered devices that will usually fail to respond to [manual update requests](#update-firmware) unless physically woken up right before triggering.
73
+
:::
74
+
75
+
You can schedule an update for when the device next requests a check for OTA update.
76
+
Send a message to `zigbee2mqtt/bridge/request/device/ota_update/schedule` with payload `{"id": "deviceID"}` or `deviceID` where deviceID can be the `ieee_address` or `friendly_name` of the device, example request: `{"id": "my_remote"}` or `my_remote`. The same applies for downgrade with topic `zigbee2mqtt/bridge/request/device/ota_update/schedule/downgrade`.
77
+
78
+
To unschedule, send the same payload, but with the topic `zigbee2mqtt/bridge/request/device/ota_update/unschedule`.
79
+
80
+
Any new schedule request for the same device will automatically unschedule the previous (if any). For e.g. sending a downgrade schedule request while an upgrade is already scheduled will result in downgrade being scheduled, and upgrade being unscheduled.
81
+
82
+
Any [manual update request](#update-firmware) will automatically unschedule any existing schedule for the device.
83
+
84
+
If a scheduled update fails, it will be automatically rescheduled (after the failure has been _effectively_ reported).
85
+
86
+
If no image is available when a scheduled update triggers, the device is informed of that fact and the scheduling is simply removed.
87
+
65
88
## Local OTA index and firmware files
66
89
67
90
An OTA index file is a list of firmware images available in designated locations. When checking if an update is available, Zigbee2MQTT determines current hardware and firmware version for a particular device, and then searches for a suitable upgrade image in the index file. Zigbee2MQTT uses the [Zigbee-OTA](https://github.com/Koenkk/zigbee-OTA) firmware repository with contains the [upgrade index file](https://github.com/Koenkk/zigbee-OTA/blob/master/index.json), and the [downgrade index file](https://github.com/Koenkk/zigbee-OTA/blob/master/index1.json).
0 commit comments