Skip to content

Commit e7b1f20

Browse files
authored
fix: add ota abort docs (#5205)
1 parent 5c80869 commit e7b1f20

2 files changed

Lines changed: 8 additions & 3 deletions

File tree

docs/guide/usage/mqtt_topics_and_messages.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -499,6 +499,10 @@ See [OTA updates](./ota_updates.md).
499499
500500
See [OTA updates](./ota_updates.md).
501501
502+
#### zigbee2mqtt/bridge/request/device/ota_update/update/abort
503+
504+
See [OTA updates](./ota_updates.md).
505+
502506
#### zigbee2mqtt/bridge/request/device/ota_update/check/downgrade
503507
504508
See [OTA updates](./ota_updates.md).

docs/guide/usage/ota_updates.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Disabling automatic update checks does not prevent [scheduled OTA](#scheduling-u
5959

6060
### Manual checking
6161

62-
To manually check for **updates**, send a message to `zigbee2mqtt/bridge/request/device/ota_update/check` with payload `{"id":"deviceID"}` where deviceID can be the `ieee_address` or `friendly_name` of the device.
62+
To manually check for **upgrade**, send a message to `zigbee2mqtt/bridge/request/device/ota_update/check` with payload `{"id":"deviceID"}` where deviceID can be the `ieee_address` or `friendly_name` of the device.
6363
To check if a **downgrade** is available, send the message to `zigbee2mqtt/bridge/request/device/ota_update/check/downgrade` instead.
6464

6565
Zigbee2MQTT will request the current firmware information from the device (manufacturer code, image type and installed version). Only after reception, it will look up the OTA index.
@@ -85,14 +85,15 @@ Since updating can drastically change the device behavior, Zigbee2MQTT treats it
8585

8686
### Manual update request
8787

88-
When an **update** is available, start it by sending a message to `zigbee2mqtt/bridge/request/device/ota_update/update` with payload `{"id":"deviceID"}` where deviceID can be the `ieee_address` or `friendly_name` of the device.
88+
When an **upgrade** is available, start it by sending a message to `zigbee2mqtt/bridge/request/device/ota_update/update` with payload `{"id":"deviceID"}` where deviceID can be the `ieee_address` or `friendly_name` of the device.
8989
When a **downgrade** is available, start it by sending the message to `zigbee2mqtt/bridge/request/device/ota_update/update/downgrade` instead.
90+
You can abort a running update by sending a message to `zigbee2mqtt/bridge/request/device/ota_update/update/abort` with payload `{"id":"deviceID"}` (same as above).
9091

9192
If the device does not respond, wake it up (e.g. push a button) right before starting, or [schedule](#scheduling-update-on-next-device-request) the update.
9293
The progress is published to the respective device topic, as described [above](#device-state).
9394

9495
Once the update is completed, a response is sent, example response: `{"data":{"id":"my_remote","from":{"file_version":5,"software_build_id":1,"date_code":"20190101"},"to":{"file_version":10,"software_build_id":2,"date_code":"20190102"}},"status":"ok"}`.
95-
Note that `software_build_id` and `date_code` are optional device attributes.
96+
Note that `software_build_id` and `date_code` are **optional** device attributes, some devices may have them, others not (even same model can differ, since this is firmware-dependent).
9697

9798
### Scheduling update on next device request
9899

0 commit comments

Comments
 (0)