Skip to content

Commit 47726da

Browse files
committed
Update readmes
1 parent 4c0d7ea commit 47726da

File tree

2 files changed

+22
-10
lines changed

2 files changed

+22
-10
lines changed

examples/arduino-ota/README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ How to build PlatformIO based project
88

99
```shell
1010
# Change directory to example
11-
$ cd platform-raspberrypi/examples/arduino-blink
11+
$ cd platform-raspberrypi/examples/arduino-ota
1212

1313
# Build project
1414
$ pio run
@@ -22,8 +22,12 @@ $ pio run --target clean
2222

2323
## Notes
2424

25-
For Raspberry Pi Pico devices, two Arduino cores exist:
26-
* https://github.com/arduino/ArduinoCore-mbed
27-
* https://github.com/earlephilhower/arduino-pico
25+
This examples showcases the usage of Over-The-Air (OTA) updates with the Raspberry Pi Pico W.
2826

29-
This examples showcases how to use both of these cores in the `platformio.ini`.
27+
For more details, see the [documentation](https://arduino-pico.readthedocs.io/en/latest/ota.html).
28+
29+
For the initial firmware update, use the `rpipicow_via_usb` environment.
30+
31+
Then, open the serial monitor and note down the IP of the Pico that it outputs.
32+
33+
Use this IP as the `upload_port` in the `rpipicow_via_ota` environment and use the "Upload" project task there.

examples/arduino-signed-ota/README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ How to build PlatformIO based project
88

99
```shell
1010
# Change directory to example
11-
$ cd platform-raspberrypi/examples/arduino-blink
11+
$ cd platform-raspberrypi/examples/arduino-signed-ota
1212

1313
# Build project
1414
$ pio run
@@ -22,8 +22,16 @@ $ pio run --target clean
2222

2323
## Notes
2424

25-
For Raspberry Pi Pico devices, two Arduino cores exist:
26-
* https://github.com/arduino/ArduinoCore-mbed
27-
* https://github.com/earlephilhower/arduino-pico
25+
This examples showcases the usage of **signed** Over-The-Air (OTA) updates with the Raspberry Pi Pico W.
2826

29-
This examples showcases how to use both of these cores in the `platformio.ini`.
27+
The difference to regular OTA updates is that update binaries are signed using the `private.key` to produce a `firmware.bin.signed` file.
28+
29+
The firmware then uses the `public.key` file to verify the signature on the binary it receives in an OTA update. It will reject OTA update binaries that were not properly signed.
30+
31+
For more details, see the [documentation](https://arduino-pico.readthedocs.io/en/latest/ota.html).
32+
33+
For the initial firmware update, use the `rpipicow_via_usb` environment.
34+
35+
Then, open the serial monitor and note down the IP of the Pico that it outputs.
36+
37+
Use this IP as the `upload_port` in the `rpipicow_via_ota` environment and use the "Upload" project task there.

0 commit comments

Comments
 (0)