Recall that the Matter OTA software update involves two kinds of nodes: OTA Requestor and OTA Provider.
In this exercise, the OTA Requestor role will be run on your Nordic device with the Matter sample application and the OTA Provider role will be run using the OTA Provider tool for Linux.
Our goal will be to perform a software update of the Matter device using the Matter OTA mechanism.
Exercise steps
1. Open the base code for this exercise.
In Visual Studio Code, in the WELCOME panel, select Open an existing application, navigate to the GitHub repository for the course and open the l5/l5_e1 directory. The application should appear under the APPLICATIONS panel.
This application is a copy of the Matter Lock sample, with added instructions for where to input the code snippets from this exercise.
Note: Any Matter sample can be used, as all the Matter samples in the nRF Connect SDK support OTA Requestor role by default.
2. Build and flash the application to your DK.
Build and flash the application to your DK.
3. Modify the Matter Lock sample slightly.
To verify that the software update works, it is necessary to introduce modifications in the application and build the binaries again.
3.1 Add a log line to allow easy verification of software update.
In src/app_task.cpp file, in the StartApp() method, add a new log line to allow easy verification that the software update worked.
Add the following log line
LOG_INF("================ NEW SOFTWARE IMAGE IS WORKING!!! ==============="); 3.2 Modify the VERSION file, by changing the PATCHLEVEL value to any value other one than 0, for example 4.
After the modification, the file should look like this
VERSION_MAJOR = 3
VERSION_MINOR = 2
PATCHLEVEL = 4
VERSION_TWEAK = 0
EXTRAVERSION =3.3 Build the sample again, but do not flash it to your DK.
3.4 Open the serial port of your device and make sure that the logs are visible, as it will be needed to verify that the software update succeeded.
Open the serial port of the board, using a VCOM in the CONNECTED DEVICES panel. Click on the Connect to Serial Port icon to the right of the VCOM.
If no logs from the device are visible, click the RESET button on the nRF54L Series DK.
Note
The nRF54L Series DKs enumerate with two serial ports and their numbers can be different on your PC. Select the VCOM with the greater number, for example, if VCOM0 and VCOM1 are available, use VCOM1.
4. Commission the Matter device using CHIP Tool.
Commission the Matter device using CHIP Tool.
4.1 Ensure the Thread Border Router is still running. If not:
4.1.1 Open a new command-line terminal and run the following command to run the OpenThread Border Router:
Replace the /dev/ttyACM0 with the serial port number that is used by your Thread Coprocessor.
sudo docker run -it --rm --privileged --name otbr --network otbr -p 8080:80 \
--sysctl "net.ipv6.conf.all.disable_ipv6=0 net.ipv4.conf.all.forwarding=1 net.ipv6.conf.all.forwarding=1" \
--volume /dev/ttyACM0:/dev/radio nrfconnect/otbr:fbde28a --radio-url spinel+hdlc+uart:///dev/radio?uart-baudrate=1000000Important
If you get an error like “The container name “/otbr” is already in use by container…, run the following commands
sudo docker kill otbr
sudo ip -6 route del "fd11:22::/64" dev otbr0 via "fd11:db8:1::2"
sudo ip link set dev otbr0 down
sudo docker network rm otbr
4.1.2 Open the http://localhost:8080/ address in a web browser to get access to the OpenThread Border Router graphical user interface.
4.1.3 Navigate to the Form tab from the side panel and make sure that all the inserted data is the same as in the following picture. Then press the FORM button to request from the OpenThread Border Router to form a Thread network and become a Thread leader.
4.1.4 Open a new command-line terminal and check the status of the Thread node running inside the Docker:
sudo docker exec -it otbr sh -c "sudo ot-ctl state"The output should be the following:
leader
Done4.2 Ensure CHIP Tool is still running. If not:
4.2.1 Open a new command-line terminal and run the downloaded binary file you obtained in the previous exercise using the following command:
With PC:
./chip-tool_x64 interactive start
With Raspberry Pi:
./chip-tool_arm64 interactive start
4.3 Commission the device to the network.
4.3.1 Make sure that Matter advertising over Bluetooth LE is running.
The following logs should be visible in the device serial port:
I: 730208 [DL]CHIPoBLE advertising started
I: 730212 [DL]NFC Tag emulation startedNote that the Matter advertising over Bluetooth LE is automatically started for the Matter Template sample, but it timeouts after 1 hour. If the advertising timed out, press BUTTON0 on the Matter device to start it again.
4.3.2 Return to the terminal window running the CHIP Tool application.
Start the commissioning process by running the following command and fill the <thread dataset> argument with your Thread dataset that was obtained in Lesson 2 Exercise 1 and stored on your computer. Replace <your_selected_node_id> with a random node ID that has not been used in other exercises, e.g 7. This same number will be used when sending commands to the device via CHIP Tool.
pairing ble-thread <your_selected_node_id> hex:<thread dataset> 20202021 3840As a result, the Matter device and the CHIP Tool application will start printing many verbose messages in the logs that present the commissioning flow. These are especially useful in case of issues with pairing and allow for troubleshooting the problem.
4.1 Ensure CHIP Tool is still running. If not:
4.1.1 Open a new command line terminal and run the downloaded binary file obtained in the previous exercise using the following command:
With PC:
./chip-tool_x64 interactive start
With Raspberry Pi:
./chip-tool_arm64 interactive start
4.2 Commission the device to the network.
4.2.1 Press BUTTON0 on the Matter device to start Matter advertising over Bluetooth LE.
The following logs should be visible in the device serial port:
I: 730208 [DL]CHIPoBLE advertising started
I: 730212 [DL]NFC Tag emulation started4.2.2 Return to the terminal window running the CHIP Tool application.
Run the following command and fill the <wifi_ssid> and <wifi_password> arguments with your Wi-Fi network data.
Replace <your_selected_node_id> with a random node ID that has not been used in other exercises, e.g 7. This same number will be used when sending commands to the device via CHIP Tool.
pairing ble-wifi <your_selected_node_id> <wifi_ssid> <wifi_password> 20202021 3840As a result, the Matter device and the CHIP Tool application will start printing many verbose messages in the logs that present the commissioning flow. These are especially useful in case of issues with pairing and allow for troubleshooting the problem.
5. Setting up the OTA Provider
5.1 Visit the Matter nRF Connect releases GitHub page to download the executable file for the OTA Provider. Find the release artifacts compatible with the nRF Connect SDK version you are using:
For users running setup on Linux PC, download the chip-ota-provider-app_x64 file.
For users running setup on Raspberry Pi, download the chip-ota-provider-app_arm64 file.
5.2 Run the downloaded binary with <path_to_matter.ota> replaced with the path to the Matter OTA image which you wish to provide to the Matter device.
In our case, it will be <path_to_sample>/build/matter.ota.
Note that the Matter OTA image is, by default, generated in the example’s build directory:
With PC:
./chip-ota-provider-app_x64 -f <path_to_matter.ota>
With Raspberry Pi:
./chip-ota-provider-app_arm64 -f <path_to_matter.ota>
6. Commission the OTA Provider device using CHIP Tool
From the Matter fabric perspective, the OTA Provider device is not much different from your Nordic DK, and it has to be commissioned by the Matter commissioner as well.
Since the Matter Lock was assigned with node ID 1, the OTA Provider is going to be assigned with the node ID 2.
6.1 Start the commissioning process using the terminal window with the CHIP Tool application running.
Run the following command to commission the OTA Provider and assign it with node ID 2:
pairing onnetwork 2 202020217. Configure the connection between the OTA Provider and OTA Requestor, and perform the software update.
All the commands should be run in the CHIP Tool terminal window.
7.1 Configure the Matter device with the default OTA Provider by running the following command.
The last two arguments are the Requestor Node ID and Requestor Endpoint ID, respectively.
otasoftwareupdaterequestor write default-otaproviders '[{"fabricIndex": 1, "providerNodeID": 2, "endpoint": 0}]' 1 07.2 Configure the OTA Provider with the access control list (ACL) that grants Operate privileges to all nodes in the fabric.
This is necessary to allow the nodes to send cluster commands to the OTA Provider:
accesscontrol write acl '[{"fabricIndex": 1, "privilege": 5, "authMode": 2, "subjects": [112233], "targets": null}, {"fabricIndex": 1, "privilege": 3, "authMode": 2, "subjects": null, "targets": null}]' 2 07.3 Send the Announce OTA Provider command to the nRF DK running Matter Door Lock sample.
The numeric arguments are Provider Node ID, Provider Vendor ID, Announcement Reason, Provider Endpoint ID, Requestor Node ID and Requestor Endpoint ID, respectively.
otasoftwareupdaterequestor announce-otaprovider 2 0 0 0 1 0Once the device is made aware of the OTA Provider node, it automatically queries the OTA Provider for a new firmware image. When the firmware image download is complete, the device is automatically rebooted to apply the update.
7.4 Check the logs from your Nordic DK to see whether the software image was updated. The logs should include the following message:
I: 168 [SVR]Server Listening...
I: 171 [DL]Device Configuration:
I: 174 [DL] Serial Number: 11223344556677889900
I: 178 [DL] Vendor Id: 65521 (0xFFF1)
I: 182 [DL] Product Id: 32774 (0x8006)
I: 185 [DL] Product Name: Matter Door Lock
I: 189 [DL] Hardware Version: 0
I: 192 [DL] Setup Pin Code (0 for UNKNOWN/ERROR): 20202021
I: 197 [DL] Setup Discriminator (0xFFFF for UNKNOWN/ERROR): 3840 (0xF00)
I: 204 [DL] Manufacturing Date: 2022-01-01
I: 208 [DL] Device Type: 65535 (0xFFFF)
I: 211 [SVR]SetupQRCode: [MT:8IXS142C00KA0648G00]
I: 216 [SVR]Copy/paste the below URL in a browser to see the QR Code:
I: 222 [SVR]https://project-chip.github.io/connectedhomeip/qrcode.html?data=MT%3A8IXS142C00KA0648G00
I: 230 [SVR]Manual pairing code: [34970112332]
I: ================ NEW SOFTWARE IMAGE IS WORKING!!! ===============
E: 241 [DL]Long dispatch time: 187 ms, for event type 2The logs show that the software update using Matter OTA was successful.
