From 47726da601eb7c123a5c088828606023d646ddb0 Mon Sep 17 00:00:00 2001 From: unknown Date: Mon, 22 Aug 2022 01:05:09 +0200 Subject: [PATCH] Update readmes --- examples/arduino-ota/README.md | 14 +++++++++----- examples/arduino-signed-ota/README.md | 18 +++++++++++++----- 2 files changed, 22 insertions(+), 10 deletions(-) diff --git a/examples/arduino-ota/README.md b/examples/arduino-ota/README.md index 938e48b..c54cab0 100644 --- a/examples/arduino-ota/README.md +++ b/examples/arduino-ota/README.md @@ -8,7 +8,7 @@ How to build PlatformIO based project ```shell # Change directory to example -$ cd platform-raspberrypi/examples/arduino-blink +$ cd platform-raspberrypi/examples/arduino-ota # Build project $ pio run @@ -22,8 +22,12 @@ $ pio run --target clean ## Notes -For Raspberry Pi Pico devices, two Arduino cores exist: -* https://github.com/arduino/ArduinoCore-mbed -* https://github.com/earlephilhower/arduino-pico +This examples showcases the usage of Over-The-Air (OTA) updates with the Raspberry Pi Pico W. -This examples showcases how to use both of these cores in the `platformio.ini`. \ No newline at end of file +For more details, see the [documentation](https://arduino-pico.readthedocs.io/en/latest/ota.html). + +For the initial firmware update, use the `rpipicow_via_usb` environment. + +Then, open the serial monitor and note down the IP of the Pico that it outputs. + +Use this IP as the `upload_port` in the `rpipicow_via_ota` environment and use the "Upload" project task there. \ No newline at end of file diff --git a/examples/arduino-signed-ota/README.md b/examples/arduino-signed-ota/README.md index 938e48b..9d83acf 100644 --- a/examples/arduino-signed-ota/README.md +++ b/examples/arduino-signed-ota/README.md @@ -8,7 +8,7 @@ How to build PlatformIO based project ```shell # Change directory to example -$ cd platform-raspberrypi/examples/arduino-blink +$ cd platform-raspberrypi/examples/arduino-signed-ota # Build project $ pio run @@ -22,8 +22,16 @@ $ pio run --target clean ## Notes -For Raspberry Pi Pico devices, two Arduino cores exist: -* https://github.com/arduino/ArduinoCore-mbed -* https://github.com/earlephilhower/arduino-pico +This examples showcases the usage of **signed** Over-The-Air (OTA) updates with the Raspberry Pi Pico W. -This examples showcases how to use both of these cores in the `platformio.ini`. \ No newline at end of file +The difference to regular OTA updates is that update binaries are signed using the `private.key` to produce a `firmware.bin.signed` file. + +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. + +For more details, see the [documentation](https://arduino-pico.readthedocs.io/en/latest/ota.html). + +For the initial firmware update, use the `rpipicow_via_usb` environment. + +Then, open the serial monitor and note down the IP of the Pico that it outputs. + +Use this IP as the `upload_port` in the `rpipicow_via_ota` environment and use the "Upload" project task there. \ No newline at end of file