Skip to content

Commit c8b62e9

Browse files
[k32w0] Add OTA encryption info in contact sensor README
Contact sensor uses some gn args to enable OTA encryption. This means that an upcoming OTA image must be encrypted with the same key provided by chip_with_ota_key. Signed-off-by: marius-alex-tache <marius.tache@nxp.com>
1 parent fbb44ea commit c8b62e9

File tree

1 file changed

+42
-37
lines changed
  • examples/contact-sensor-app/nxp/k32w/k32w0

1 file changed

+42
-37
lines changed

examples/contact-sensor-app/nxp/k32w/k32w0/README.md

+42-37
Original file line numberDiff line numberDiff line change
@@ -14,42 +14,42 @@ network.
1414

1515
<hr>
1616

17-
- [CHIP K32W061 Contact Sensor Example Application](#chip-k32w061-contact-sensor-example-application)
18-
- [Introduction](#introduction)
19-
- [SE051H Secure Element](#se051h-secure-element)
20-
- [Bluetooth LE Advertising](#bluetooth-le-advertising)
21-
- [LIT ICD Active Mode](#lit-icd-active-mode)
22-
- [Bluetooth LE Rendezvous](#bluetooth-le-rendezvous)
23-
- [Thread Provisioning](#thread-provisioning)
24-
- [Device UI](#device-ui)
25-
- [No expansion board](#no-expansion-board)
26-
- [Building](#building)
27-
- [Long Idle Time ICD Support](#long-idle-time-icd-support)
28-
- [Overwrite board config files](#overwrite-board-config-files)
29-
- [Known issues building](#known-issues-building)
30-
- [Rotating device id](#rotating-device-id)
31-
- [Manufacturing data](#manufacturing-data)
32-
- [Flashing and debugging](#flashing-and-debugging)
33-
- [Pigweed tokenizer](#pigweed-tokenizer)
34-
- [Detokenizer script](#detokenizer-script)
35-
- [Notes](#notes)
36-
- [Known issues tokenizer](#known-issues-tokenizer)
37-
- [NXP Ultrafast P256 ECC Library](#nxp-ultrafast-p256-ecc-library)
38-
- [Building steps](#building-steps)
39-
- [Tinycrypt ECC library](#tinycrypt-ecc-library)
40-
- [Building steps](#building-steps-1)
41-
- [OTA](#ota)
42-
- [Writing the SSBL](#writing-the-ssbl)
43-
- [Features](#features)
44-
- [Multi image](#multi-image)
45-
- [Simple hash verification](#simple-hash-verification)
46-
- [Writing the PSECT](#writing-the-psect)
47-
- [Writing the application](#writing-the-application)
48-
- [OTA Testing](#ota-testing)
49-
- [Known issues ota](#known-issues-ota)
50-
- [Low power](#low-power)
51-
- [Known issues low power](#known-issues-low-power)
52-
- [Removing SSBL Upgrade Region](#removing-ssbl-upgrade-region)
17+
- [CHIP K32W061 Contact Sensor Example Application](#chip-k32w061-contact-sensor-example-application)
18+
- [Introduction](#introduction)
19+
- [SE051H Secure Element](#se051h-secure-element)
20+
- [Bluetooth LE Advertising](#bluetooth-le-advertising)
21+
- [LIT ICD Active Mode](#lit-icd-active-mode)
22+
- [Bluetooth LE Rendezvous](#bluetooth-le-rendezvous)
23+
- [Thread Provisioning](#thread-provisioning)
24+
- [Device UI](#device-ui)
25+
- [No expansion board](#no-expansion-board)
26+
- [Building](#building)
27+
- [Long Idle Time ICD Support](#long-idle-time-icd-support)
28+
- [Overwrite board config files](#overwrite-board-config-files)
29+
- [Known issues building](#known-issues-building)
30+
- [Rotating device id](#rotating-device-id)
31+
- [Manufacturing data](#manufacturing-data)
32+
- [Flashing and debugging](#flashing-and-debugging)
33+
- [Pigweed tokenizer](#pigweed-tokenizer)
34+
- [Detokenizer script](#detokenizer-script)
35+
- [Notes](#notes)
36+
- [Known issues tokenizer](#known-issues-tokenizer)
37+
- [NXP Ultrafast P256 ECC Library](#nxp-ultrafast-p256-ecc-library)
38+
- [Building steps](#building-steps)
39+
- [Tinycrypt ECC library](#tinycrypt-ecc-library)
40+
- [Building steps](#building-steps-1)
41+
- [OTA](#ota)
42+
- [Writing the SSBL](#writing-the-ssbl)
43+
- [Features](#features)
44+
- [Multi image](#multi-image)
45+
- [Simple hash verification](#simple-hash-verification)
46+
- [Writing the PSECT](#writing-the-psect)
47+
- [Writing the application](#writing-the-application)
48+
- [OTA Testing](#ota-testing)
49+
- [Known issues ota](#known-issues-ota)
50+
- [Low power](#low-power)
51+
- [Known issues low power](#known-issues-low-power)
52+
- [Removing SSBL Upgrade Region](#removing-ssbl-upgrade-region)
5353

5454
## Introduction
5555

@@ -730,9 +730,14 @@ Please see more in the
730730
Here is an example that generates an OTA image with application update TLV:
731731

732732
```
733-
./scripts/tools/nxp/ota/ota_image_tool.py create -v 0xDEAD -p 0xBEEF -vn 42021 -vs "1.0" -da sha256 --app-input-file chip-k32w0x-contact-example.bin chip-k32w0x-contact-example.ota
733+
./scripts/tools/nxp/ota/ota_image_tool.py create -v 0xDEAD -p 0xBEEF -vn 2 -vs "2.0" -da sha256 --enc_enable --input_ota_key "1234567890ABCDEFA1B2C3D4E5F6F1B4" --app-input-file chip-k32w0x-contact-example.bin chip-k32w0x-contact-example.ota
734734
```
735735

736+
Please note the two options `--enc_enable` and `--input_ota_key`, which are
737+
mandatory when `chip_with_ota_encryption=1`. The value of `--input_ota_key` must
738+
match the value of `chip_with_ota_key`. See `args.gni` for the default gn
739+
configuration.
740+
736741
A note regarding OTA image header version (`-vn` option). An application binary
737742
has its own software version, given by
738743
`CHIP_DEVICE_CONFIG_DEVICE_SOFTWARE_VERSION` (`42020` by default), which can be

0 commit comments

Comments
 (0)