Skip to content

Commit ad8b72b

Browse files
committed
Refining OTA documentation
1 parent ce6ed29 commit ad8b72b

File tree

5 files changed

+15
-148
lines changed

5 files changed

+15
-148
lines changed

sld407-matter-ota/02-ota-software-update.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This page outlines the steps for a scenario that demonstrates the Over The Air (OTA) Software Update functionality in Matter.
44

5-
The Over The Air (OTA) Software Update functionality is enabled by default for all Silicon Labs example applications. Its inclusion in an application is controlled by the OTA Requestor component in a Matter project in Simplicity Studio.
5+
The Over The Air (OTA) Software Update functionality is enabled by default for all Silicon Labs example applications. It's inclusion in an application is controlled by the OTA Requestor component in a Matter project in Simplicity Studio.
66

77
## Overview
88

@@ -174,17 +174,18 @@ For more information, see the documentation for the ota-provider-app example in
174174
175175
## Multi-Chip OTA Images
176176
177-
Multi-Chip OTA is implemented for EFR32 and SiWx917 NCP/SoC devices. Multi-chip OTA uses an enhanced script, ota_multi_image_tool.py, which creates .ota files that contain additional TLV headers. These TLV headers describe the binaries to be sent over the air. The enhanced script is located here. It is a wrapper to the original src/app/ota_image_tool.py. Multiple binaries can be packaged in the .ota file. Some tags are reserved for specific Silicon Labs binaries, and other tags are available to be used for arbitrary TLVs. The payloads can be encrypted.
177+
Multi-Chip OTA is implemented for EFR32 and SiWx917 NCP/SoC devices. Multi-Chip OTA uses an enhanced script, ota_multi_image_tool.py, which creates .ota files that contain additional TLV headers. These TLV headers describe the binaries to be sent over the air. The enhanced script is located here. It is a wrapper to the original src/app/ota_image_tool.py. Multiple binaries can be packaged in the .ota file. Some tags are reserved for specific Silicon Labs binaries, and other tags are available to be used for arbitrary TLVs. The payloads can be encrypted.
178178
179179
The script can be obtained from the Matter Extension github repository.
180180
181181
For more information on creating a Multi-Chip .ota file, see the [README.md](https://github.com/project-chip/connectedhomeip/blob/master/scripts/tools/silabs/ota/README.md).
182182
183-
Applications must be built with the OTA Multi Image Requestor component added to the project in Simplicity Studio to enable them to process the TLVs.
183+
Applications must be built with the Multi-Chip OTA Image Requestor component added to the project in Simplicity Studio to enable them to process the TLVs.
184184
185-
The OTA Multi Image Requestor Encryption component should be added to the project if the requestor is meant to process encrypted payloads.
185+
The Multi-Chip OTA Image Requestor Encryption component should be added to the project if the requestor is meant to process encrypted payloads.
186186
187-
**Combined OTA images are also supported:**
187+
**Combined OTA Images in Regular and Multi-Chip OTA Implementations:**
188+
Combined OTA images are supported in both regular OTA and Multi-Chip OTA implementations. These images can contain the bootloader, application, or both, depending on your upgrade scenario.
188189
189190
1. Bootloader + application upgrade. This requires a combined image.
190191
@@ -237,7 +238,7 @@ BootloaderInformation_t info
237238
Then, in the beginning of [OTAImageProcessorImpl::IsFirstImageRun](https://github.com/SiliconLabsSoftware/matter_sdk/blob/01a2d4aafaa0b124123caac067831809a1a86720/src/platform/silabs/efr32/OTAImageProcessorImpl.cpp#L115), add:
238239
239240
```c++
240-
bootloader_getInfo(&info); // LINE ADDED: for Multi-OTA test
241+
bootloader_getInfo(&info); // LINE ADDED: for Multi-Chip OTA test
241242
ChipLogProgress(SoftwareUpdate, "Bootloader version: 0x%lx\n", info.version);
242243
ChipLogProgress(SoftwareUpdate, "Bootloader type: %d\n", info.type);
243244
```

sld407-matter-ota/03-firmware-upgrades.md

Lines changed: 0 additions & 134 deletions
This file was deleted.

sld407-matter-ota/04-ota-software-update-soc.md renamed to sld407-matter-ota/03-ota-software-update-soc.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -143,15 +143,15 @@ Before running **ota-requestor** app, flash the **OTA-A** application(M4) and Wi
143143
./chip-tool basicinformation read software-version 1 0
144144
```
145145

146-
### Multi-OTA images for SiWx917 NCP/SoC
146+
### Multi-Chip OTA images for SiWx917 NCP/SoC
147147

148-
Multi-OTA images can be created using `ota_multi_image_tool.py` which creates .ota files that contain additional TLV headers.
148+
Multi-Chip OTA images can be created using `ota_multi_image_tool.py` which creates .ota files that contain additional TLV headers.
149149

150150
>**Note**: SiWN917 NCP uses TLV tag 4 for Wi-Fi(TA) image upgrade.
151151

152-
#### Multi-OTA image creation on SiWN917 NCP
152+
#### Multi-Chip OTA image creation on SiWN917 NCP
153153

154-
Multi-OTA on SiWN917 NCP supports application image upgrade, Wi-Fi(TA) image upgrade and combined image upgrade.
154+
Multi-Chip OTA on SiWN917 NCP supports application image upgrade, Wi-Fi(TA) image upgrade and combined image upgrade.
155155

156156
**Application Image Upgrade**
157157

@@ -177,7 +177,7 @@ commander gbl create SiWx917-lock-example.gbl --app SiWx917-lock-example.s37 --c
177177
./scripts/tools/silabs/ota/ota_multi_image_tool.py create -v 0xFFF1 -p 0x8005 -vn 2 -vs "2.0" -da sha256 --app-input-file SiWx917-lock-example.gbl --wifi_ta_input_file SiWG917-B.2.14.5.0.0.10.rps combined_image.ota
178178
```
179179

180-
#### Multi-OTA image creation on SiWG917 SoC
180+
#### Multi-Chip OTA image creation on SiWG917 SoC
181181

182182
>**Note**: SiWG917 SoC uses TLV tag 1 for all image upgrades M4 alone, TA alone and combined image upgrade.
183183

sld407-matter-ota/05-build-ota-application-using-studio.md renamed to sld407-matter-ota/04-build-ota-application-using-studio.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Building Matter applications for OTA Software Update
1+
# Getting Started with OTA Updates in Matter Applications Using Simplicity Studio
22

33
In the Matter OTA Software Update scenario, the running image (OTA-A) and the update image (OTA-B) are regular Matter application images and are built using the standard procedure. The only additional configuration required is the use of a higher software version in the update image. This page provides information about creation of OTA-A and OTA-B application for EFR32 and SiWx917 SOC Boards.
44

sld407-matter-ota/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@ The Over The Air (OTA) Software Update functionality is enabled by default for a
44

55
- [**Matter OTA Bootloader**](./01-ota-bootloader.md)
66
- [**Matter OTA Software Update**](./02-ota-software-update.md)
7-
- [**Matter 917 SOC OTA Software Update**](./04-ota-software-update-soc.md)
8-
- [**Matter OTA WiFi Project**](./05-build-ota-application-using-studio.md)
7+
- [**Matter 917 SOC OTA Software Update**](./03-ota-software-update-soc.md)
8+
- [**Wi-Fi-Based Matter OTA Project in Simplicity Studio**](./04-build-ota-application-using-studio.md)

0 commit comments

Comments
 (0)