CHIP ESP32 OTA Requestor Example

A prototype application that demonstrates OTA Requestor capabilities.

Prerequisite

Before moving ahead, make sure you have OTA Provider is commissioned and running.

Supported Devices

• This example supports ESP32 and ESP32C3. For details please check here.

Building the Example Application

• If you are building for the first time please check Building the Example Application guide.
• Otherwise, idf.py build works!

Flashing the Example Application

idf.py -p <OTARequestorSerialPort> flash monitor

Commissioning over BLE using chip-tool

• Please build the standalone chip-tool as described here
• Commissioning the OTA Requestor

./out/debug/chip-tool pairing ble-wifi 12346 <ssid> <passphrase> 20202021 3840

Query for an OTA Image

After commissioning is successful, announce OTA provider's presence using chip-tool. On receiving this command OTA requestor will query for OTA image.

./out/debug/chip-tool otasoftwareupdaterequestor announce-ota-provider 12345 0 0 0 12346 0

Apply update

Once the transfer is complete, OTA requestor sends ApplyUpdateRequest command to OTA provider for applying the image. Device will restart on successful application of OTA image.

ESP32 OTA Requestor with Linux OTA Provider

• Build the Linux OTA Provider
• Run the Linux OTA Provider with OTA image.

./out/debug/chip-ota-provider-app -f hello-world.bin

• Provision the Linux OTA Provider using chip-tool

./out/debug/chip-tool pairing onnetwork 12345 20202021

Generate OTA image

User can generate the Matter OTA image by simply enabling CONFIG_CHIP_OTA_IMAGE_BUILD config option. OTA image is generated in build directory with name <project name>-ota.bin. This image then can be used with OTA Provider Application.

Please make sure that version number is set to correct value. Use CONFIG_DEVICE_SOFTWARE_VERSION and CONFIG_DEVICE_SOFTWARE_VERSION_NUMBER config options for setting software version.

Matter OTA image can also be generated using ota_image_tool.py script.

Using the RPC console

Enable RPCs in the build using menuconfig:

$ idf.py menuconfig

Enable the RPC library:

Component config → CHIP Core → General Options → Enable Pigweed PRC library

After flashing a build with RPCs enabled you can use the rpc console to send commands to the device.

Build or install the rpc console

• Start the console

    chip-console --device /dev/ttyUSB0

• From within the console you can then invoke rpcs:

    rpcs.chip.rpc.Device.TriggerOta()