Skip to content

Commit 0622a62

Browse files
committed
Remove OTA related instructions from README.md
1 parent da16b7e commit 0622a62

File tree

1 file changed

+1
-45
lines changed

1 file changed

+1
-45
lines changed

README.md

Lines changed: 1 addition & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,6 @@
5252
* [Configuring the S3 demos](#configuring-the-s3-demos)
5353
* [Setup for AWS IoT Jobs demo](#setup-for-aws-iot-jobs-demo)
5454
* [Setup for the Greengrass local auth demo](#setup-for-the-greengrass-local-auth-demo)
55-
* [Prerequisites for the AWS Over-The-Air Update (OTA) demos](#prerequisites-for-the-aws-over-the-air-update-ota-demos)
56-
* [Scheduling an OTA Update Job](#scheduling-an-ota-update-job)
5755
* [Building and Running Demos](#building-and-running-demos)
5856
* [Build a single demo](#build-a-single-demo)
5957
* [Build all configured demos](#build-all-configured-demos)
@@ -139,14 +137,6 @@ The AWS IoT Device Defender library has no dependencies on additional libraries
139137

140138
See memory requirements for the latest release [here](https://aws.github.io/aws-iot-device-sdk-embedded-C/202211.00/libraries/aws/device-defender-for-aws-iot-embedded-sdk/docs/doxygen/output/html/index.html#defender_memory_requirements).
141139

142-
#### AWS IoT Over-the-air Update
143-
144-
The [AWS IoT Over-the-air Update](https://github.com/aws/ota-for-aws-iot-embedded-sdk) (OTA) library enables you to manage the notification of a newly available update, download the update, and perform cryptographic verification of the firmware update. Using the OTA library, you can logically separate firmware updates from the application running on your devices. You can also use the library to send other files (e.g. images, certificates) to one or more devices registered with AWS IoT. More details about OTA library can be found in [AWS IoT Over-the-air Update documentation](https://docs.aws.amazon.com/freertos/latest/userguide/freertos-ota-dev.html).
145-
146-
The AWS IoT Over-the-air Update library has a dependency on [coreJSON](https://github.com/FreeRTOS/coreJSON) for parsing of JSON job document and [tinyCBOR](https://github.com/intel/tinycbor.git) for decoding encoded data streams, other than the standard C library. It can be used with any MQTT library, HTTP library, and operating system (e.g. Linux, FreeRTOS).
147-
148-
See memory requirements for the latest release [here](https://aws.github.io/aws-iot-device-sdk-embedded-C/202211.00/libraries/aws/ota-for-aws-iot-embedded-sdk/docs/doxygen/output/html/index.html#ota_memory_requirements).
149-
150140
#### AWS IoT Fleet Provisioning
151141

152142
The [AWS IoT Fleet Provisioning](https://github.com/aws/fleet-provisioning-for-aws-iot-embedded-sdk) library enables you to interact with the [AWS IoT Fleet Provisioning MQTT APIs](https://docs.aws.amazon.com/iot/latest/developerguide/fleet-provision-api.html) in order to provison IoT devices without preexisting device certificates. With AWS IoT Fleet Provisioning, devices can securely receive unique device certificates from AWS IoT when they connect for the first time. For an overview of all provisioning options offered by AWS IoT, see [device provisioning documentation](https://docs.aws.amazon.com/iot/latest/developerguide/iot-provision.html). For details about Fleet Provisioning, refer to the [AWS IoT Fleet Provisioning documentation](https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html).
@@ -297,10 +287,6 @@ Guide for porting AWS IoT Device Shadow library is available [here](https://aws.
297287

298288
Guide for porting AWS IoT Device Defender library is available [here](https://aws.github.io/aws-iot-device-sdk-embedded-C/202211.00/libraries/aws/device-defender-for-aws-iot-embedded-sdk/docs/doxygen/output/html/defender_porting.html).
299289

300-
### Porting AWS IoT Over-the-air Update
301-
302-
Guide for porting OTA library to your platform is available [here](https://aws.github.io/aws-iot-device-sdk-embedded-C/202211.00/libraries/aws/ota-for-aws-iot-embedded-sdk/docs/doxygen/output/html/ota_porting.html).
303-
304290
## Migration guide from v3.1.5 to 202009.00 and newer releases
305291

306292
### MQTT Migration
@@ -379,8 +365,7 @@ Dependency | Version | Usage
379365

380366
#### AWS IoT Account Setup
381367

382-
You need to setup an AWS account and access the AWS IoT console for running the AWS IoT Device Shadow library, AWS IoT Device Defender library, AWS IoT Jobs library,
383-
AWS IoT OTA library and coreHTTP S3 download demos.
368+
You need to setup an AWS account and access the AWS IoT console for running the AWS IoT Device Shadow library, AWS IoT Device Defender library, AWS IoT Jobs library, and coreHTTP S3 download demos.
384369
Also, the AWS account can be used for running the MQTT mutual auth demo against AWS IoT broker.
385370
Note that running the AWS IoT Device Defender, AWS IoT Jobs and AWS IoT Device Shadow library demos require the setup of a Thing resource for the device running the demo.
386371
Follow the links to:
@@ -526,33 +511,6 @@ Note: Replace the placeholders in angle brackets with your specific information.
526511

527512
For setting up the Greengrass local auth demo, see [the README in the demo folder](./demos/greengrass/greengrass_demo_local_auth/README.md).
528513

529-
#### Prerequisites for the AWS Over-The-Air Update (OTA) demos
530-
531-
1. To perform a successful OTA update, you need to complete the prerequisites mentioned [here](https://docs.aws.amazon.com/freertos/latest/userguide/ota-prereqs.html).
532-
1. A code signing certificate is required to authenticate the update. A code signing certificate based on the SHA-256 ECDSA algorithm will work with the current demos. An example of how to generate this kind of certificate can be found [here](https://docs.aws.amazon.com/freertos/latest/userguide/ota-code-sign-cert-esp.html).
533-
1. The code signing certificate can be either baked into firmware as a string, or stored as a file.
534-
1. For baked in certificate method, copy the certificate to signingcredentialSIGNING_CERTIFICATE_PEM in [ota_pal_posix.c](https://github.com/aws/aws-iot-device-sdk-embedded-C/blob/main/platform/posix/ota_pal/source/ota_pal_posix.c).
535-
2. For file storage method, store the certificate as a file and supply the file path in "Path name of code signing certificate on device" field when creating the OTA job in AWS IoT Console.
536-
537-
#### Scheduling an OTA Update Job
538-
539-
After you build and run the initial executable you will have to create another executable and schedule an OTA update job with this image.
540-
1. Increase the version of the application by setting macro `APP_VERSION_BUILD` in `demos/ota/ota_demo_core_[mqtt/http]/demo_config.h` to a different version than what is running.
541-
1. Rebuild the application using the [build steps](#building-and-running-demos) below into a different directory, say `build-dir-2`.
542-
1. Rename the demo executable to reflect the change, e.g. `mv ota_demo_core_mqtt ota_demo_core_mqtt2`
543-
1. Create an OTA job:
544-
1. Go to the [AWS IoT Core console](https://console.aws.amazon.com/iot/).
545-
1. Manage → Jobs → Create → Create a FreeRTOS OTA update job → Select the corresponding name for your device from the thing list.
546-
1. Sign a new firmware → Create a new profile → Select any SHA-ECDSA signing platform → Upload the code signing certificate(from prerequisites) and provide its path on the device.
547-
1. Select the image → Select the bucket you created during the [prerequisite steps](#prerequisites-for-the-aws-over-the-air-update-ota-demos) → Upload the binary `build-dir-2/bin/ota_demo2`.
548-
1. The path on device should be the absolute path to place the executable and the binary name: e.g. `/home/ubuntu/aws-iot-device-sdk-embedded-C-staging/build-dir/bin/ota_demo_core_mqtt2`.
549-
1. Select the IAM role created during the [prerequisite steps](#prerequisites-for-the-aws-over-the-air-update-ota-demos).
550-
1. Create the Job.
551-
1. Run the initial executable again with the following command: `sudo ./ota_demo_core_mqtt` or `sudo ./ota_demo_core_http`.
552-
1. After the initial executable has finished running, go to the directory where the downloaded firmware image resides which is the path name used when creating an OTA job.
553-
1. Change the permissions of the downloaded firmware to make it executable, as it may be downloaded with read (user default) permissions only: `chmod 775 ota_demo_core_mqtt2`
554-
1. Run the downloaded firmware image with the following command: `sudo ./ota_demo_core_mqtt2`
555-
556514
### Building and Running Demos
557515

558516
Before building the demos, ensure you have installed the [prerequisite software](#prerequisites). On Ubuntu 18.04 and 20.04, `gcc`, `cmake`, and OpenSSL can be installed with:
@@ -579,8 +537,6 @@ mqtt_demo_mutual_auth
579537
mqtt_demo_plaintext
580538
mqtt_demo_serializer
581539
mqtt_demo_subscription_manager
582-
ota_demo_core_http
583-
ota_demo_core_mqtt
584540
pkcs11_demo_management_and_rng
585541
pkcs11_demo_mechanisms_and_digests
586542
pkcs11_demo_objects

0 commit comments

Comments
 (0)