Skip to content

Commit d5b0d83

Browse files
authored
Update README.md
1 parent fe196a0 commit d5b0d83

File tree

1 file changed

+15
-16
lines changed

1 file changed

+15
-16
lines changed

README.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,44 +5,43 @@ MySensors bootloader supporting over-the-air firmware updates
55
All initialization the bootloader does (finding parent / requesting nodeId on first start) uses the same packets as a normal MySensors sketch. There is no need for the controller to distinguish between packets from the bootloader and packets from normal sketch execution. The controller only needs to care about two additional request/response communications. All communication is binary.
66
<h2>FirmwareConfig</h2>
77
<ul>
8-
<li>the bootloader sends a FirmwareConfigRequest packet to the gateway to request information about the firmware it should execute:
8+
<li>the bootloader sends a RequestFirmwareConfig packet to the gateway to request information about the firmware it should execute:
99
<p>
10-
typedef struct<br/>
11-
{<br/>
10+
typedef struct {<br/>
1211
&nbsp;uint16_t type;<br/>
1312
&nbsp;uint16_t version;<br/>
14-
} FirmwareConfigRequest;
13+
&nbsp;uint16_t blocks;<br/>
14+
&nbsp;uint16_t crc;<br/>
15+
&nbsp;uint16_t BLVersion;<br/>
16+
} RequestFirmwareConfig;<br/>
1517
</p>
16-
<li>the gateway (the controller) responds with a FirmwareConfigResponse including details about the firmware the sensor should execute:
18+
<li>the gateway (the controller) responds with a NodeFirmwareConfig including details about the firmware the sensor should execute:
1719
<p>
18-
typedef struct<br/>
19-
{<br/>
20+
typedef struct {<br/>
2021
&nbsp;uint16_t type;<br/>
2122
&nbsp;uint16_t version;<br/>
2223
&nbsp;uint16_t blocks;<br/>
2324
&nbsp;uint16_t crc;<br/>
24-
} FirmwareConfigResponse;
25+
} NodeFirmwareConfig;<br/>
2526
</p>
2627
</ul>
2728
<h2>Firmware</h2>
2829
<ul>
29-
<li>the bootloader sends a FirmwareRequest packet to the gateway to request a specific subset (block) of the compiled firmware:
30+
<li>the bootloader sends a RequestFirmwareBlock packet to the gateway to request a specific subset (block) of the compiled firmware:
3031
<p>
31-
typedef struct<br/>
32-
{<br/>
32+
typedef struct {<br/>
3333
&nbsp;uint16_t type;<br/>
3434
&nbsp;uint16_t version;<br/>
3535
&nbsp;uint16_t block;<br/>
36-
} FirmwareRequest;
36+
} RequestFirmwareBlock;<br/>
3737
</p>
38-
<li>the gateway (the controller) responds with a FirmwareResponse including the specific block of the compiled firmware:
38+
<li>the gateway (the controller) responds with a ResponseFirmwareBlock including the specific block of the compiled firmware:
3939
</ul>
4040
<p>
41-
typedef struct<br/>
42-
{<br/>
41+
typedef struct {<br/>
4342
&nbsp;uint16_t type;<br/>
4443
&nbsp;uint16_t version;<br/>
4544
&nbsp;uint16_t block;<br/>
4645
&nbsp;uint8_t data[FIRMWARE_BLOCK_SIZE];<br/>
47-
} FirmwareResponse;
46+
} ResponseFirmwareBlock;<br/>
4847
</p>

0 commit comments

Comments
 (0)