From de109c230c82dd0c2256058606608582744428c6 Mon Sep 17 00:00:00 2001 From: Eran Date: Thu, 4 Jul 2024 13:18:00 +0300 Subject: [PATCH] change dfu-start docs to fit actual PR #12789 --- third-party/realdds/doc/control.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/third-party/realdds/doc/control.md b/third-party/realdds/doc/control.md index be48c3e9ad..b321417585 100644 --- a/third-party/realdds/doc/control.md +++ b/third-party/realdds/doc/control.md @@ -247,7 +247,18 @@ A device can run the flow when in recovery mode or during normal operation: Starts the DFU process. -The device will subscribe to a `dfu` topic under the topic root (accepting a `blob` message, reliable). Enough memory should be allocated to make sure we're ready to receive the image before a reply is sent. +The device will subscribe to a `dfu` topic under the topic root (accepting a `blob` message, reliable). + +```JSON +{ + "id": "dfu-start", + "size": 2097152, + "crc": 65358876 +} +``` + +- A `size` will be communicated to ensure enough memory is allocated and we're ready to receive the image +- The `crc` is needed to verify the image is intact A reply should indicate the image is ready to be received. @@ -269,14 +280,6 @@ Errors can look like this: ``` If status is not `OK`, then the device is expected to go back to the pre-DFU state and the process needs to start over. -On success, the device may send back a `"crc": ` or `"size": `, to help debug, or any other relevant content: -```JSON -{ - "id": "dfu-ready", - "crc": -} -``` - The `dfu` subscription can be removed at this time. #### `dfu-apply`