Introduction

This workshop demonstrates how to use the SimpleLink™ Wi-Fi® Over-The-Air (OTA) library. The library can be used to wirelessly load and install software updates from a cloud server. A software update may contain any combination of application code, firmware, and user files.

This workshop will start with an overview of the OTA mechanism and then walk through the bring up of two OTA examples:

  1. Using the Cloud OTA example to load and update a pre-built image
  2. Preparing an OTA update, uploading it to the cloud, and loading it with the Cloud OTA example.

At the end of this training, the audience should be able to:

  • Understand the OTA process and the SimpleLink Wi-Fi solution
  • Configure, build, and execute the SimpleLink cloud_ota application and OTA library (ota) on the CC32xx LaunchPad
  • Create an OTA update image and upload it to a CDN (Content Delivery Network) Server

Prerequisites

Completed material

Software

  • Code Composer Studio v10.1 or newer
    • SimpleLink Wi-Fi CC32xx Wireless MCUs support installed
    • Make sure that CCS is using the latest updates: Help → Check for Updates
  • CC32xx SDK v4.30 or newer
  • UniFlash v6.1 or newer
  • Terminal emulator program such as TeraTerm or PuTTY

Hardware

OTA Overview

OTA Concept

  • OTA (Over-The-Air) update is an efficient way of wirelessly distributing firmware updates or application upgrades.
  • An OTA Update mechanism enables users to easily and securely update the software on their device using Wi-Fi. This involves two simple procedures:
    • A vendor stores an OTA update on a CDN (Content Delivery Network) server.
    • The endpoint devices with an OTA-enabled application load and install the new update.
  • An OTA-enabled application must support all of the following actions:
    • Polling the CDN (Content Delivery Network) server for new updates
    • Downloading the new image
    • Installing the image on the flash file system in a secured and fail-safe manner (the new image becomes a "candidate")
    • Committing the image after it is validated (making it "operational")
  • The SimpleLink OTA library offloads the above OTA actions and provides a simple API for the application.

OTA System Diagram

API: Application Program Interface
CDN: Content Delivery Network
MCU: Microcontroller Unit
NWP: Network Processor
OTA: Over The Air
PCB: Printed Circuit Board

  • CDN (Content Delivery Network): Globally distributed network of proxy servers deployed in multiple data centers. The goal of a CDN is to serve content to end-users with high availability and high performance. Examples would be Dropbox or GitHub.
  • OTA library: Offloads the OTA actions (such as polling the server, downloading the updates and installing them in the local flash) while exposing a simple API.
  • OTA-enabled Application: Triggers the OTA library and respond to OTA events. The application will take decisions whether to accept or decline an update (usually based on timestamp) and whether to commit or rollback the already installed image (based on a sanity check).

SimpleLink OTA Library (ota)

  • The OTA library implements a simple HTTP client that connects to CDN server (through CdnVendor and OtaHttpClient modules).
  • The HTTP client can be configured as:
    • Non Secured (connects to CDN running HTTP Server)
    • Secured (HTTPS server) using server authentication (by default)
    • Domain Name verification (default) or without server authentication.
  • The OTA library supports the following cloud CDN vendors:
    • Github (demonstrated in the first demo)
    • Dropbox (demonstrated in the second demo)
    • Custom
  • The library defines a structure for the OTA image in a tar file. The UniFlash ImageCreator tool can be used to create an OTA tar file so that the OTA library will be able to parse the loaded content and install it on local flash file system in secure and fail-safe manner (through the OtaArchive and OtaJson modules)
  • The OTA library is provided as a static library project with full source code to enable user customizations.

OTA Library API

The OTA library exposes very simple API set:

  • OTA_init(): Initializes the OTA library. The host application should define a global buffer for the use of the OTA library and provide this buffer while it initiates the OTA.
  • OTA_set(): Sets an OTA library parameter. Used to set CDN Server information and to update the status of the loaded image (DECLINE, ACCEPT, COMMIT or ROLLBACK).
  • OTA_get(): Retrieves an OTA library parameters, e.g. IS_ACTIVE or VERSIONS info (current image version and new update version).
  • OTA_run(): Trigger the OTA library state machine. This will trigger OTA polling, download, etc. It should be called repeatedly until it gets the DOWNLOAD_DONE return code.

This API set is compatible with both non-OS and OS-based platforms.

OTA Sample Application

  • The first role of an OTA-enabled application is to verify and commit a "candidate" image that was previously installed to local flash.
    • Once the device is connected to the network and can successfully PING to the local gateway, the application assumes the image is okay.
    • If the OTA state is PENDING_COMMIT, the application will commit the image.
  • The second role of the application is to look for a new update.
    • Server info is defined in compile time (in otauser.h).
    • App repeatedly calls OtaRun() until OTA process is completed.
    • App decides to accept or decline a new update based on its timestamp.
    • An accepted update will be written to flash as a "candidate" which will be verified after the MCU gets reset.

Loading A Pre-Built OTA Image

The following section will walk you through the steps needed to run the cloud_ota sample application using the CC32xx LaunchPad. This example is run using the cloud_ota_CC3220SF_LAUNCHXL_tirtos_ccs source code example found within the CC32xx SDK. These instructions should work for the FreeRTOS example as well. This demonstration uses the OTA sample application to load and install a pre-built image that is located on a Github CDN server. It focuses on the configuration of the OTA application.

Task 1: Preparing the OTA application

  1. In CCS, import the Cloud OTA example for your device and desired RTOS. This lab will demonstrate using the cloud_ota_CC3220SF_LAUNCHXL_tirtos_ccs example (simplelink_cc32xx_sdk_x_xx_xx_xx/examples/rtos/CC3220SF_LAUNCHXL/demos/cloud_ota/tirtos/ccs).

  2. You also must import the ota project found in simplelink_cc32xx_sdk_x_xx_xx_xx/source/ti/net/ota/ccs. This is the supporting OTA library that works for all device types and RTOS. Be sure you UNCHECK Copy projects into workspace.

    Warning icons for CdnVendors files

    If you do not uncheck Copy projects into workspace when you import the ota library, you will see yellow warning icons in the OTA/CdnVendors/ folder of your ota project. Due to GenLibs requirements, please delete this local project and reimport with the Copy Projects into Workspace unchecked.

  3. In otauser.h of the ota project, update the CDN server parameters:

    • Use the following parameters for accessing the pre-defined image on the Github server:
      • #define OTA_SERVER_TYPE   OTA_SERVER_GITHUB
      • Choose the folder with your device variant for #define OTA_VENDOR_DIR
        • "SEC_OTA_CC3220S"
        • "SEC_OTA_CC3220SF"
        • "SEC_OTA_CC3235S"
        • "SEC_OTA_CC3235SF"
    • The following definitions are under GITHUB section:
      • #define OTA_VENDOR_ROOT_DIR   "/repos/SimpleLink/CC3X20"
      • #define OTA_VENDOR_TOKEN   "SimpleLink"
    • We will learn how to find the correct value for OTA_SERVER_ROOT_CA_CERT in the next task. For now, set it to any of the root CA certificates programmed onto your serial flash (e.g. dummy-root-ca-cert).

    • Optionally, you may uncomment the following definition to enable the OTA library traces:

      • #define SL_ENABLE_OTA_DEBUG_TRACES

  4. Update the JSON buffer size for storing the long GitHub URL. In the ota project, open the OtaJson.c file and update the MAX_METADATA_FILENAME definition to reserve room for the long Github URL name.

  5. Rebuild the ota project then rebuild the cloud_ota project.

    Rebuilding the OTA library

    You will need to rebuild the ota library and cloud_ota example after every change to otauser.h.

    In your cloud_ota project, you can add a dependency on the ota project. This will automatically rebuild the ota library every time you rebuild cloud_ota.

Task 2: Finding a Root Certificate

  1. In this step, we will find the Certificate Common Name necessary to pass GitHub's SSL authentication. We will install this certificate (in DER format) as a user file in the device flash. To find the most up-to-date Root CA certificate, add the following code in the else-if statement of SimpleLinkSockEventHandler in cloud_ota.c.

     switch (pSock->SocketAsyncEvent.SockAsyncData.Type)
 {
     case SL_SSL_NOTIFICATION_WRONG_ROOT_CA:
         /* on socket error Restart OTA */
         UART_PRINT("SL_SOCKET_ASYNC_EVENT: ERROR - WRONG ROOT CA\n\r"); 
         UART_PRINT("Please install the following Root Certificate:\n\r");
         UART_PRINT("  %s\n\r", pSock->SocketAsyncEvent.SockAsyncData.pExtraInfo);
         SignalEvent(APP_EVENT_RESTART);
         break;

     default:
         /* on socket error Restart OTA */
         UART_PRINT("SL_SOCKET_ASYNC_EVENT socket event %d, do restart\n\r", pSock->Event);
         SignalEvent(APP_EVENT_RESTART);
         break;
 }

    cloud_ota.c :: SimpleLinkSockEventHandler() - Else-if statement

    It should now look like this:

  2. Open a terminal emulation program and select the XDS110 Class Application/User UART port.

    UART Configuration
    Baud rate: 115200
    Data: 8 bit
    Parity: None
    Stop: 1 bit
    Flow control: None

  3. Rebuild the ota project and rebuild the cloud_ota project. Run the cloud_ota application using the CCS Debugger. You do not need to flash the device for this step.

    DAP issues with CCS Debugger

    Your device will need to be in development mode to use the CCS debugger. If you are unfamiliar with the UniFlash ImageCreator tool or how to put the LaunchPad in development mode, please see the UniFlash ImageCreator Basics lecture.

  4. The example begins by starting the device in station mode and looks for an available network. If the device cannot find a known Access Point, it enters provisioning mode. For complete steps on provisioning, see the Wi-Fi Provisioning training.

    After the device is successfully provisioned, it will ping the gateway until it receives the OTA command.

  5. Once the application can successfully ping the gateway, press button 2 (SW2) on the LaunchPad to trigger the OTA process.

    You should see an error message similar to the following screenshot. Make note of the complete name of the suggested Root Certificate.

    This log was taken after SL_ENABLE_OTA_DEBUG_TRACES was enabled (in ota/ota_user.h), so it includes extra debug messages.

    Error code -688

    In the case you do not have the correct CA certificate (or use a different CDN server), the HTTPS connection setup will fail. If the HTTPS connection to the CDN server fails due to an incorrect root certificate, the return value will be -688. You will need to find and install the right certificate.

    Error code -101

    If error -101 occurs during OtaJson_getMetadataFileName, it indicates that the buffer allocated for storing the file name in the OTA library is not large enough. Please return to task 1, step 4 and increase MAX_METADATA_FILENAME. Then rebuild the ota and the cloud_ota project.

  6. Search this certificate name online and download it, or you can find it in your browser if you have previously navigated to github.com. For example in Chrome, go to Settings → Advanced → Privacy and security → Manage Certificates → Trusted Root Certification Authorities. Search in the list for this certificate name and export it in DER format.

  7. Update the OTA_SERVER_ROOT_CA_CERT definition in ota/otauser.h. This is similar to the step we completed in task 1, step 3.

Task 3: Complete an OTA Update

  1. Create a new UniFlash ImageCreator project and set the CC32xx to development mode. Add the "dummy" root CA certificate (dummy-root-ca-cert), playground Trusted Root-Certificate Catalog, and latest service pack.

  2. Add the cloud root CA certificate that we found in task 2. This will be a user file.

  3. Add the demo OTA public key certificate (dummy_ota_vendor_cert.der) as a user file. This is available in simplelink_cc32xx_sdk_x_xx_xx_xx/tools/cc32xx_tools/ota-example-cert/. This certificate will be used to authenticate the pre-built secure OTA image for this exercise.

    We will learn more about this key pair and signing the OTA image in the next section of this lab.

  4. Rebuild the ota project and the cloud_ota project. Add the MCU image from your CCS workspace (workspace/cloud_ota_CC3220SF_LAUNCHXL_tirtos_ccs/Debug/cloud_ota_CC3220SF_LAUNCHXL_tirtos_ccs.bin).

  5. Connect the LaunchPad and program the image.

  6. Reset the LaunchPad to start the application. You will have to provision the device again (after flashing a new image) and press SW2 to trigger the OTA update.

  7. You should see OTA messages handling the CDN server connection, downloading content, parsing and installing it. The log below shows the flash programming messages, the platform reset, and the activation of the newly programmed image. The application commits the temporary image after a successful sanity check (pinging the gateway).

    Results

    • The OTA tar file name contains the timestamp (date and hour) of its creation. Only an update with a newer timestamp than the one currently stored in flash will be loaded and installed.

    • The first OTA update after using UniFlash ImageCreator will always work since the timestamp of previous OTA updates are saved in a file that is overwritten during flashing.

Preparing An OTA Image

The following section will discuss the steps needed to run the Cloud OTA sample application using the CC32xx LaunchPad. This example is run using the cloud_ota_CC3220SF_LAUNCHXL_tirtos_ccs source code example. This demonstration is focused on creation of an OTA image.

  • Compiling an MCU image and packaging it within an OTA update (tar file)
  • Uploading OTA content to user account on a CDN server (DropBox)
  • Configuring the cloud_ota with the user account parameters

Task 4: Compiling and Creating the OTA Image

This task focuses on the generation of an OTA image. The image will contain an updated MCU application which will be based on the cloud_ota application.

  1. In cloud_ota.h, update the APPLICATION_NAME definition to "OTA APP (EX-2 Image)" as shown below and rebuild the project. We will only change the application name (the name will help us differentiate between the current app and the updated one).

  2. Create a new UniFlash ImageCreator project and set the CC32xx to development mode. Add the "dummy" root CA certificate (dummy-root-ca-cert), playground Trusted Root-Certificate Catalog, and latest service pack.

  3. Add the demo OTA public key certificate (dummy_ota_vendor_cert.der) as a user file. This is available in simplelink_cc32xx_sdk_x_xx_xx_xx/tools/cc32xx_tools/ota-example-cert/. This certificate will be used to authenticate the secure OTA image.

  4. Add your newly compiled binary (cloud_ota_CC3220SF_LAUNCHXL_tirtos_ccs.bin) as an MCU image. You can find this binary in your workspace (workspace/cloud_ota_CC3220SF_LAUNCHXL_tirtos_ccs/Debug/cloud_ota_CC3220SF_LAUNCHXL_tirtos_ccs.bin)

  5. Go to Generate Image and select Create OTA.

    You will need to select a OTA Private Key File Name. This private key will be used to sign the image. For this exercise, use the demo-only private key available in the SDK: simplelink_cc32xx_sdk_x_xx_xx_xx\tools\cc32xx_tools\ota-example-cert\dummy_ota_vendor_key.der.

    Alternatively, you can create your own private and public key that uses elliptic curve cryptography (ECDSA SECP256R1). This can be done using the following openssl commands:

    Generate the private key

    openssl ecparam -name prime256v1 -genkey -out ota_vendor_key.pem

    Generate the public certifcate

    openssl req -new -x509 -key ota_vendor_key.pem -out ota_vendor_cert.pem -days 730

    You may answer the Certificate Signing Request (CSR) questions or simply choose the defaults.

    The tool will sign the binary image and will generate a TAR file in a format defined by the OTA library. The timestamp for the image will be automatically generated as the TAR file name.

Task 5: Creating and Configuring the CDN server

  1. You will need a CDN account to store the new OTA file, and we will be using DropBox for this demo. Open the DropBox Developers tab from the main page or go to dropbox.com/developers and select Create app.

  2. Choose a Dropbox API with App folder access. You can choose any app name.

  3. Generate an access token and save it.

  4. Navigate to your Dropbox files home → Apps → your newly created apps folder. In this folder, create a directory OTA_R2_MCU_FLASH. Locate the OTA image you created in Task 4 and place it into the OTA_R2_MCU_FLASH directory.

  5. In ota/otauser.h, update the CDN server parameter.

    • Use the following CDN server parameters:

      • #define OTA_SERVER_TYPE   OTA_SERVER_DROPBOX_V2
      • #define OTA_VENDOR_DIR   "OTA_R2_MCU_FLASH"

    • Add the access token we generated. The following is defined under the DROPBOX section:

      • #define OTA_VENDOR_TOKEN   "<Dropbox generated access token>"

    • Set OTA_SERVER_ROOT_CA_CERT. (See task 2. You may have to run the same debug session to find the new root CA certificate for Dropbox.)

      Using a custom CDN Server

      The cloud_ota demo supports Github and Dropbox. A custom vendor can also be used by defining OTA_SERVER_TYPE in ota/otauser.h as OTA_SERVER_CUSTOM.

      For more information, please see the OTA Application Report.

Task 6: Running the OTA Application

  1. Before rebuilding the application, change the APPLICATION_NAME in cloud_ota.h back to OTA APP (see task 4, step 1).

  2. Rebuild the cloud_ota project, and add your new binary as an MCU image and program it to the LaunchPad.

  3. Open a terminal emulation program such as TeraTerm and select the XDS110 Class Application/User UART port.

    UART Configuration
    Baud rate: 115200
    Data: 8 bit
    Parity: None
    Stop: 1 bit
    Flow control: None

  4. Reset the LaunchPad and verify the successful execution on the terminal.

    Note that after a successful OTA sequence the new image should be triggered. You can verify this by looking at the application name.

Further Reading

After experiencing the OTA application, see the following resources for further assistance in development:

  • CC3x20, CC3x3x Network Processor Programmer's Guide: This guide contains information on how to use the SimpleLink API for writing WLAN-enabled applications. Please refer to chapter 8 (File System) for important details on the OTA image bundle attributes.
  • CC3x20, CC3x3x OTA Application Report: This document describes the OTA library for the SimpleLink Wireless MCUs, and explains how to prepare a new cloud-ready update to be downloaded by the OTA library.
  • UniFlash ImageCreator User's Guide: The Imaging tool manually stores files on the external serial flash. It is also includes the capability of creating an OTA image (in a TAR file) that is ready to be stored in a CDN. Image may include the SimpleLink firmware patch file and any configuration files, security certificates, web pages, and so forth.

Technical support

For any questions, please search on the TI SimpleLink Wi-Fi E2E Forum

Creative Commons License
This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.