Skip to content

Commit

Permalink
change dfu-start docs to fit actual PR IntelRealSense#12789
Browse files Browse the repository at this point in the history
  • Loading branch information
maloel committed Jul 7, 2024
1 parent b274cdb commit de109c2
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions third-party/realdds/doc/control.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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": <crc32-value>` or `"size": <number-of-bytes>`, to help debug, or any other relevant content:
```JSON
{
"id": "dfu-ready",
"crc": <value>
}
```

The `dfu` subscription can be removed at this time.

#### `dfu-apply`
Expand Down

0 comments on commit de109c2

Please sign in to comment.