Skip to content

Commit 2516016

Browse files
markaj-nordicpull[bot]
markaj-nordic
authored and
pull[bot]
committed
[nrfconnect] Update factory data guide with additional rotating id info (#27209)
* Adapt docs to the changed chip-tool command naming. Recently the otasoftwareupdaterequestor attributes' and commands' names have been slightly modified in chip-tool but it looks like the correlated documentation has not been synced. Also fixed spell checker errors. Signed-off-by: Marcin Kajor <marcin.kajor@nordicsemi.no> * Update the nrfconnect Factory Data docs with extended rd_uid info. Also aligned the related json schema with the docs. Signed-off-by: Marcin Kajor <marcin.kajor@nordicsemi.no> --------- Signed-off-by: Marcin Kajor <marcin.kajor@nordicsemi.no>
1 parent b53a8a5 commit 2516016

File tree

26 files changed

+57
-56
lines changed

26 files changed

+57
-56
lines changed

‎.github/.wordlist.txt

+1
Original file line numberDiff line numberDiff line change
@@ -979,6 +979,7 @@ otaissues
979979
OTAProvider
980980
OTAProviderIpAddress
981981
OTAProviderNodeId
982+
otaproviders
982983
OTAProviderSerialPort
983984
OTARequesterImpl
984985
OTARequestorDriver

‎docs/guides/esp32/ota.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,15 @@ control list.
3535

3636
### Using Console
3737

38-
After commissioning is successful, read the default-ota-providers list of
38+
After commissioning is successful, read the default-otaproviders list of
3939
requestor using the command below.
4040

4141
```
4242
./out/debug/chip-tool otasoftwareupdaterequestor read default-otaproviders <REQUESTOR NODE ID> 0
4343
```
4444

45-
If the list does not have your provider, write into default-ota-providers list
46-
of requestor using the command below.
45+
If the list does not have your provider, write into default-otaproviders list of
46+
requestor using the command below.
4747

4848
```
4949
./out/debug/chip-tool otasoftwareupdaterequestor write default-otaproviders '[{"fabricIndex": 1, "providerNodeID": <PROVIDER_NODE_ID_1>, "endpoint": 0}, {"fabricIndex": 1, "providerNodeID": <PROVIDER_NODE_ID_2>, "endpoint": 0}]' <REQUESTOR_NODE_ID> 0
@@ -65,7 +65,7 @@ After commissioning is successful, announce OTA provider's presence using
6565
chip-tool. On receiving this command OTA requestor will query for OTA image.
6666

6767
```
68-
./out/debug/chip-tool otasoftwareupdaterequestor announce-ota-provider <PROVIDER NODE ID> 0 0 0 <REQUESTOR NODE ID> 0
68+
./out/debug/chip-tool otasoftwareupdaterequestor announce-otaprovider <PROVIDER NODE ID> 0 0 0 <REQUESTOR NODE ID> 0
6969
```
7070

7171
## Encrypted OTA

‎docs/guides/infineon_psoc6_software_update.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Infineon PSoC6 example applications by passing the
6969
* Once the commissioning process completes enter:
7070

7171
```
72-
./out/chip-tool otasoftwareupdaterequestor announce-ota-provider 1 0 0 0 2 0
72+
./out/chip-tool otasoftwareupdaterequestor announce-otaprovider 1 0 0 0 2 0
7373
```
7474

7575
* The application device will connect to the Provider and start the image

‎docs/guides/nrfconnect_examples_software_update.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ To test the DFU over Matter, you need to complete the following steps:
8181
Requestor Endpoint ID, respectively):
8282
8383
```
84-
./out/chiptool/chip-tool otasoftwareupdaterequestor write default-ota-providers '[{"fabricIndex": 1, "providerNodeID": 1, "endpoint": 0}]' 2 0
84+
./out/chiptool/chip-tool otasoftwareupdaterequestor write default-otaproviders '[{"fabricIndex": 1, "providerNodeID": 1, "endpoint": 0}]' 2 0
8585
```
8686
8787
9. Configure the OTA Provider with the access control list (ACL) that grants
@@ -109,7 +109,7 @@ To test the DFU over Matter, you need to complete the following steps:
109109
Requestor Endpoint ID, respectively):
110110
111111
```
112-
./out/chiptool/chip-tool otasoftwareupdaterequestor announce-ota-provider 1 0 0 0 2 0
112+
./out/chiptool/chip-tool otasoftwareupdaterequestor announce-otaprovider 1 0 0 0 2 0
113113
```
114114
115115
Once the device is made aware of the OTA Provider node, it automatically

‎docs/guides/nrfconnect_factory_data_configuration.md

+22-22
Large diffs are not rendered by default.

‎docs/guides/silabs_efr32_software_update.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ where operationalDataset is obtained from the OpenThread Border Router.
6161

6262
- Once the commissioning process completes enter:
6363

64-
./out/chip-tool otasoftwareupdaterequestor announce-ota-provider 1 0 0 0 2 0
64+
./out/chip-tool otasoftwareupdaterequestor announce-otaprovider 1 0 0 0 2 0
6565

6666
- The application device will connect to the Provider and start the image
6767
download. Once the image is downloaded the device will reboot into the

‎examples/all-clusters-app/telink/Readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ Usage of OTA:
163163
- Use the chip-tool to announce the ota-provider-app to start the OTA process
164164
165165
```
166-
./chip-tool otasoftwareupdaterequestor announce-ota-provider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
166+
./chip-tool otasoftwareupdaterequestor announce-otaprovider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
167167
```
168168
169169
here:

‎examples/all-clusters-minimal-app/telink/Readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ Usage of OTA:
146146
- Use the chip-tool to announce the ota-provider-app to start the OTA process
147147

148148
```
149-
./chip-tool otasoftwareupdaterequestor announce-ota-provider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
149+
./chip-tool otasoftwareupdaterequestor announce-otaprovider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
150150
```
151151

152152
here:

‎examples/bridge-app/telink/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,7 @@ Usage of OTA:
308308
- Use the chip-tool to announce the ota-provider-app to start the OTA process
309309
310310
```
311-
./chip-tool otasoftwareupdaterequestor announce-ota-provider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
311+
./chip-tool otasoftwareupdaterequestor announce-otaprovider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
312312
```
313313
314314
here:

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -642,7 +642,7 @@ user@computer1:~/connectedhomeip$ : ./out/chip-tool-app/chip-tool pairing ble-th
642642
Start the OTA process:
643643
644644
```
645-
user@computer1:~/connectedhomeip$ : ./out/chip-tool-app/chip-tool otasoftwareupdaterequestor announce-ota-provider 1 0 0 0 2 0
645+
user@computer1:~/connectedhomeip$ : ./out/chip-tool-app/chip-tool otasoftwareupdaterequestor announce-otaprovider 1 0 0 0 2 0
646646
```
647647
648648
### Known issues ota

‎examples/contact-sensor-app/telink/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ Usage of OTA:
165165
- Use the chip-tool to announce the ota-provider-app to start the OTA process
166166
167167
```
168-
./chip-tool otasoftwareupdaterequestor announce-ota-provider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
168+
./chip-tool otasoftwareupdaterequestor announce-otaprovider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
169169
```
170170
171171
here:

‎examples/light-switch-app/telink/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -286,7 +286,7 @@ Usage of OTA:
286286
- Use the chip-tool to announce the ota-provider-app to start the OTA process
287287

288288
```
289-
./chip-tool otasoftwareupdaterequestor announce-ota-provider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
289+
./chip-tool otasoftwareupdaterequestor announce-otaprovider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
290290
```
291291

292292
here:

‎examples/lighting-app/nxp/k32w/k32w0/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -655,7 +655,7 @@ user@computer1:~/connectedhomeip$ : ./out/chip-tool-app/chip-tool pairing ble-th
655655
Start the OTA process:
656656

657657
```
658-
user@computer1:~/connectedhomeip$ : ./out/chip-tool-app/chip-tool otasoftwareupdaterequestor announce-ota-provider 1 0 0 0 2 0
658+
user@computer1:~/connectedhomeip$ : ./out/chip-tool-app/chip-tool otasoftwareupdaterequestor announce-otaprovider 1 0 0 0 2 0
659659
```
660660

661661
## Known issues ota

‎examples/lighting-app/telink/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ Usage of OTA:
251251
- Use the chip-tool to announce the ota-provider-app to start the OTA process
252252
253253
```
254-
./chip-tool otasoftwareupdaterequestor announce-ota-provider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
254+
./chip-tool otasoftwareupdaterequestor announce-otaprovider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
255255
```
256256
257257
here:

‎examples/lock-app/telink/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ Usage of OTA:
168168
- Use the chip-tool to announce the ota-provider-app to start the OTA process
169169
170170
```
171-
./chip-tool otasoftwareupdaterequestor announce-ota-provider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
171+
./chip-tool otasoftwareupdaterequestor announce-otaprovider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
172172
```
173173
174174
here:

‎examples/ota-requestor-app/ameba/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -53,15 +53,15 @@ A prototype application that demonstrates OTA Requestor capabilities.
5353

5454
4. Write the Default OTA providers into Ameba
5555

56-
$ ./chip-tool otasoftwareupdaterequestor write default-ota-providers '[{"fabricIndex": 1, "providerNodeID": 2, "endpoint": 0}]' 1 0
56+
$ ./chip-tool otasoftwareupdaterequestor write default-otaproviders '[{"fabricIndex": 1, "providerNodeID": 2, "endpoint": 0}]' 1 0
5757

5858
5. Configure the ACL of the ota-provider-app to allow access for Ameba
5959

6060
$ ./chip-tool accesscontrol write acl '[{"fabricIndex": 1, "privilege": 3, "authMode": 2, "subjects": null, "targets": [{"cluster": 41, "endpoint": null, "deviceType": null}]}]' 1235 0
6161

6262
6. Use the chip-tool to announce the ota-provider-app to start the OTA process
6363

64-
$ ./chip-tool otasoftwareupdaterequestor announce-ota-provider 1 0 0 0 2 0
64+
$ ./chip-tool otasoftwareupdaterequestor announce-otaprovider 1 0 0 0 2 0
6565

6666
7. The OTA process should include downloading the image, verification of image
6767
header, erasing upgraded flash partition, writing to flash and checksum

‎examples/ota-requestor-app/esp32/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ After commissioning is successful, announce OTA provider's presence using
2828
chip-tool. On receiving this command OTA requestor will query for OTA image.
2929

3030
```
31-
./out/debug/chip-tool otasoftwareupdaterequestor announce-ota-provider <PROVIDER NODE ID> 0 0 0 <REQUESTOR NODE ID> 0
31+
./out/debug/chip-tool otasoftwareupdaterequestor announce-otaprovider <PROVIDER NODE ID> 0 0 0 <REQUESTOR NODE ID> 0
3232
```
3333

3434
Once the transfer is complete, OTA requestor sends ApplyUpdateRequest command to

‎examples/ota-requestor-app/infineon/cyw30739/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -135,5 +135,5 @@ Put the CYW30739 in to the recovery mode before running the flash script.
135135
chip-tool pairing onnetwork-vendor 4321 20202021 9050
136136
137137
# Announce the OTA provider to the requestor
138-
chip-tool otasoftwareupdaterequestor announce-ota-provider 4321 9 0 0 1234 0
138+
chip-tool otasoftwareupdaterequestor announce-otaprovider 4321 9 0 0 1234 0
139139
```

‎examples/ota-requestor-app/linux/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -306,7 +306,7 @@ out/chip-tool pairing onnetwork-long 0x1234567890 20202021 18
306306
**Write to the DefaultOTAProviders attribute**
307307

308308
```
309-
out/chip-tool otasoftwareupdaterequestor write default-ota-providers '[{"providerNodeID": 3735928559, "endpoint": 0}]' 0x1234567890 0
309+
out/chip-tool otasoftwareupdaterequestor write default-otaproviders '[{"providerNodeID": 3735928559, "endpoint": 0}]' 0x1234567890 0
310310
```
311311

312312
Every 60 seconds from when the OTA Requestor application has launched, the OTA
@@ -400,15 +400,15 @@ out/chip-tool pairing onnetwork-long 0xB0B 20202021 18 --commissioner-name beta
400400
**Write/Read DefaultOTAProviders on the first fabric (alpha)**
401401

402402
```
403-
out/chip-tool otasoftwareupdaterequestor write default-ota-providers '[{"providerNodeID": 12648430, "endpoint": 0}]' 0xDEB 0
404-
out/chip-tool otasoftwareupdaterequestor read default-ota-providers 0xDEB 0
403+
out/chip-tool otasoftwareupdaterequestor write default-otaproviders '[{"providerNodeID": 12648430, "endpoint": 0}]' 0xDEB 0
404+
out/chip-tool otasoftwareupdaterequestor read default-otaproviders 0xDEB 0
405405
```
406406

407407
**Write/Read DefaultOTAProviders on second fabric (beta)**
408408

409409
```
410-
out/chip-tool otasoftwareupdaterequestor write default-ota-providers '[{"providerNodeID": 45242, "endpoint": 0}]' 0xB0B 0 --commissioner-name beta
411-
out/chip-tool otasoftwareupdaterequestor read default-ota-providers 0xB0B 0 --commissioner-name beta
410+
out/chip-tool otasoftwareupdaterequestor write default-otaproviders '[{"providerNodeID": 45242, "endpoint": 0}]' 0xB0B 0 --commissioner-name beta
411+
out/chip-tool otasoftwareupdaterequestor read default-otaproviders 0xB0B 0 --commissioner-name beta
412412
```
413413

414414
**Write ACL for the first OTA Provider application**

‎examples/ota-requestor-app/telink/Readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ Usage of OTA:
154154
- Use the chip-tool to announce the ota-provider-app to start the OTA process
155155
156156
```
157-
./chip-tool otasoftwareupdaterequestor announce-ota-provider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
157+
./chip-tool otasoftwareupdaterequestor announce-otaprovider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
158158
```
159159
160160
here:

‎examples/pump-app/telink/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ Usage of OTA:
169169
- Use the chip-tool to announce the ota-provider-app to start the OTA process
170170
171171
```
172-
./chip-tool otasoftwareupdaterequestor announce-ota-provider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
172+
./chip-tool otasoftwareupdaterequestor announce-otaprovider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
173173
```
174174
175175
here:

‎examples/pump-controller-app/telink/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ Usage of OTA:
170170
- Use the chip-tool to announce the ota-provider-app to start the OTA process
171171
172172
```
173-
./chip-tool otasoftwareupdaterequestor announce-ota-provider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
173+
./chip-tool otasoftwareupdaterequestor announce-otaprovider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
174174
```
175175
176176
here:

‎examples/temperature-measurement-app/telink/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ Usage of OTA:
150150
- Use the chip-tool to announce the ota-provider-app to start the OTA process
151151

152152
```
153-
./chip-tool otasoftwareupdaterequestor announce-ota-provider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
153+
./chip-tool otasoftwareupdaterequestor announce-otaprovider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
154154
```
155155

156156
here:

‎examples/thermostat/telink/Readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ Usage of OTA:
161161
- Use the chip-tool to announce the ota-provider-app to start the OTA process
162162
163163
```
164-
./chip-tool otasoftwareupdaterequestor announce-ota-provider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
164+
./chip-tool otasoftwareupdaterequestor announce-otaprovider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
165165
```
166166
167167
here:

‎examples/window-app/telink/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ Usage of OTA:
232232
- Use the chip-tool to announce the ota-provider-app to start the OTA process
233233
234234
```
235-
./chip-tool otasoftwareupdaterequestor announce-ota-provider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
235+
./chip-tool otasoftwareupdaterequestor announce-otaprovider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
236236
```
237237
238238
here:

‎scripts/tools/nrfconnect/nrfconnect_factory_data.schema

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
"description": "Current version of the factory data set",
2727
"type": "integer",
2828
"minimum": 0,
29-
"maximum": 255
29+
"maximum": 65535
3030
},
3131
"sn": {
3232
"description": "Serial number of device",
@@ -82,7 +82,7 @@
8282
"description": "Hardware version - integer",
8383
"type": "integer",
8484
"minimum": 0,
85-
"maximum": 65536
85+
"maximum": 65535
8686
},
8787
"hw_ver_str": {
8888
"description": "A string representation of hardware version",

0 commit comments

Comments
 (0)