[nrfconnect] Update factory data guide with additional rotating id in…

…fo (#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 <[email protected]> * 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 <[email protected]> --------- Signed-off-by: Marcin Kajor <[email protected]>
project-chip · Sep 12, 2023 · 6619501 · 6619501
1 parent 433323d
commit 6619501
Show file tree

Hide file tree

Showing 26 changed files with 57 additions and 56 deletions.
diff --git a/.github/.wordlist.txt b/.github/.wordlist.txt
@@ -979,6 +979,7 @@ otaissues
 OTAProvider
 OTAProviderIpAddress
 OTAProviderNodeId
+otaproviders
 OTAProviderSerialPort
 OTARequesterImpl
 OTARequestorDriver

diff --git a/docs/guides/esp32/ota.md b/docs/guides/esp32/ota.md
@@ -35,15 +35,15 @@ control list.
 
 ### Using Console
 
-After commissioning is successful, read the default-ota-providers list of
+After commissioning is successful, read the default-otaproviders list of
 requestor using the command below.
 
 ```
 ./out/debug/chip-tool otasoftwareupdaterequestor read default-otaproviders <REQUESTOR NODE ID> 0
 ```
 
-If the list does not have your provider, write into default-ota-providers list
-of requestor using the command below.
+If the list does not have your provider, write into default-otaproviders list of
+requestor using the command below.
 
 ```
 ./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
 chip-tool. On receiving this command OTA requestor will query for OTA image.
 
 ```
-./out/debug/chip-tool otasoftwareupdaterequestor announce-ota-provider <PROVIDER NODE ID> 0 0 0 <REQUESTOR NODE ID> 0
+./out/debug/chip-tool otasoftwareupdaterequestor announce-otaprovider <PROVIDER NODE ID> 0 0 0 <REQUESTOR NODE ID> 0
 ```
 
 ## Encrypted OTA

diff --git a/docs/guides/infineon_psoc6_software_update.md b/docs/guides/infineon_psoc6_software_update.md
@@ -69,7 +69,7 @@ Infineon PSoC6 example applications by passing the
 *   Once the commissioning process completes enter:
 
            ```
-           ./out/chip-tool otasoftwareupdaterequestor announce-ota-provider 1 0 0 0 2 0
+           ./out/chip-tool otasoftwareupdaterequestor announce-otaprovider 1 0 0 0 2 0
            ```
 
 *   The application device will connect to the Provider and start the image

diff --git a/docs/guides/nrfconnect_examples_software_update.md b/docs/guides/nrfconnect_examples_software_update.md
@@ -81,7 +81,7 @@ To test the DFU over Matter, you need to complete the following steps:
     Requestor Endpoint ID, respectively):
 
     ```
-    ./out/chiptool/chip-tool otasoftwareupdaterequestor write default-ota-providers '[{"fabricIndex": 1, "providerNodeID": 1, "endpoint": 0}]' 2 0
+    ./out/chiptool/chip-tool otasoftwareupdaterequestor write default-otaproviders '[{"fabricIndex": 1, "providerNodeID": 1, "endpoint": 0}]' 2 0
     ```
 
 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:
         Requestor Endpoint ID, respectively):
 
         ```
-        ./out/chiptool/chip-tool otasoftwareupdaterequestor announce-ota-provider 1 0 0 0 2 0
+        ./out/chiptool/chip-tool otasoftwareupdaterequestor announce-otaprovider 1 0 0 0 2 0
         ```
 
         Once the device is made aware of the OTA Provider node, it automatically

diff --git a/docs/guides/nrfconnect_factory_data_configuration.md b/docs/guides/nrfconnect_factory_data_configuration.md
diff --git a/docs/guides/silabs_efr32_software_update.md b/docs/guides/silabs_efr32_software_update.md
@@ -61,7 +61,7 @@ where operationalDataset is obtained from the OpenThread Border Router.
 
 -   Once the commissioning process completes enter:
 
-           ./out/chip-tool otasoftwareupdaterequestor announce-ota-provider 1 0 0 0 2 0
+           ./out/chip-tool otasoftwareupdaterequestor announce-otaprovider 1 0 0 0 2 0
 
 -   The application device will connect to the Provider and start the image
     download. Once the image is downloaded the device will reboot into the

diff --git a/examples/all-clusters-app/telink/Readme.md b/examples/all-clusters-app/telink/Readme.md
@@ -163,7 +163,7 @@ Usage of OTA:
 -   Use the chip-tool to announce the ota-provider-app to start the OTA process
 
     ```
-    ./chip-tool otasoftwareupdaterequestor announce-ota-provider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
+    ./chip-tool otasoftwareupdaterequestor announce-otaprovider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
     ```
 
     here:

diff --git a/examples/all-clusters-minimal-app/telink/Readme.md b/examples/all-clusters-minimal-app/telink/Readme.md
@@ -146,7 +146,7 @@ Usage of OTA:
 -   Use the chip-tool to announce the ota-provider-app to start the OTA process
 
     ```
-    ./chip-tool otasoftwareupdaterequestor announce-ota-provider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
+    ./chip-tool otasoftwareupdaterequestor announce-otaprovider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
     ```
 
     here:

diff --git a/examples/bridge-app/telink/README.md b/examples/bridge-app/telink/README.md
@@ -308,7 +308,7 @@ Usage of OTA:
 -   Use the chip-tool to announce the ota-provider-app to start the OTA process
 
     ```
-    ./chip-tool otasoftwareupdaterequestor announce-ota-provider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
+    ./chip-tool otasoftwareupdaterequestor announce-otaprovider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
     ```
 
     here:

diff --git a/examples/contact-sensor-app/nxp/k32w/k32w0/README.md b/examples/contact-sensor-app/nxp/k32w/k32w0/README.md
@@ -642,7 +642,7 @@ user@computer1:~/connectedhomeip$ : ./out/chip-tool-app/chip-tool pairing ble-th
 Start the OTA process:
 
 ```
-user@computer1:~/connectedhomeip$ : ./out/chip-tool-app/chip-tool otasoftwareupdaterequestor announce-ota-provider 1 0 0 0 2 0
+user@computer1:~/connectedhomeip$ : ./out/chip-tool-app/chip-tool otasoftwareupdaterequestor announce-otaprovider 1 0 0 0 2 0
 ```
 
 ### Known issues ota

diff --git a/examples/contact-sensor-app/telink/README.md b/examples/contact-sensor-app/telink/README.md
@@ -165,7 +165,7 @@ Usage of OTA:
 -   Use the chip-tool to announce the ota-provider-app to start the OTA process
 
     ```
-    ./chip-tool otasoftwareupdaterequestor announce-ota-provider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
+    ./chip-tool otasoftwareupdaterequestor announce-otaprovider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
     ```
 
     here:

diff --git a/examples/light-switch-app/telink/README.md b/examples/light-switch-app/telink/README.md
@@ -286,7 +286,7 @@ Usage of OTA:
 -   Use the chip-tool to announce the ota-provider-app to start the OTA process
 
     ```
-    ./chip-tool otasoftwareupdaterequestor announce-ota-provider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
+    ./chip-tool otasoftwareupdaterequestor announce-otaprovider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
     ```
 
     here:

diff --git a/examples/lighting-app/nxp/k32w/k32w0/README.md b/examples/lighting-app/nxp/k32w/k32w0/README.md
@@ -655,7 +655,7 @@ user@computer1:~/connectedhomeip$ : ./out/chip-tool-app/chip-tool pairing ble-th
 Start the OTA process:
 
 ```
-user@computer1:~/connectedhomeip$ : ./out/chip-tool-app/chip-tool otasoftwareupdaterequestor announce-ota-provider 1 0 0 0 2 0
+user@computer1:~/connectedhomeip$ : ./out/chip-tool-app/chip-tool otasoftwareupdaterequestor announce-otaprovider 1 0 0 0 2 0
 ```
 
 ## Known issues ota

diff --git a/examples/lighting-app/telink/README.md b/examples/lighting-app/telink/README.md
@@ -251,7 +251,7 @@ Usage of OTA:
 -   Use the chip-tool to announce the ota-provider-app to start the OTA process
 
     ```
-    ./chip-tool otasoftwareupdaterequestor announce-ota-provider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
+    ./chip-tool otasoftwareupdaterequestor announce-otaprovider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
     ```
 
     here:

diff --git a/examples/lock-app/telink/README.md b/examples/lock-app/telink/README.md
@@ -168,7 +168,7 @@ Usage of OTA:
 -   Use the chip-tool to announce the ota-provider-app to start the OTA process
 
     ```
-    ./chip-tool otasoftwareupdaterequestor announce-ota-provider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
+    ./chip-tool otasoftwareupdaterequestor announce-otaprovider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
     ```
 
     here:

diff --git a/examples/ota-requestor-app/ameba/README.md b/examples/ota-requestor-app/ameba/README.md
@@ -53,15 +53,15 @@ A prototype application that demonstrates OTA Requestor capabilities.
 
 4.  Write the Default OTA providers into Ameba
 
-          $ ./chip-tool otasoftwareupdaterequestor write default-ota-providers '[{"fabricIndex": 1, "providerNodeID": 2, "endpoint": 0}]' 1 0
+          $ ./chip-tool otasoftwareupdaterequestor write default-otaproviders '[{"fabricIndex": 1, "providerNodeID": 2, "endpoint": 0}]' 1 0
 
 5.  Configure the ACL of the ota-provider-app to allow access for Ameba
 
           $ ./chip-tool accesscontrol write acl '[{"fabricIndex": 1, "privilege": 3, "authMode": 2, "subjects": null, "targets": [{"cluster": 41, "endpoint": null, "deviceType": null}]}]' 1235 0
 
 6.  Use the chip-tool to announce the ota-provider-app to start the OTA process
 
-          $ ./chip-tool otasoftwareupdaterequestor announce-ota-provider 1 0 0 0 2 0
+          $ ./chip-tool otasoftwareupdaterequestor announce-otaprovider 1 0 0 0 2 0
 
 7.  The OTA process should include downloading the image, verification of image
     header, erasing upgraded flash partition, writing to flash and checksum

diff --git a/examples/ota-requestor-app/esp32/README.md b/examples/ota-requestor-app/esp32/README.md
@@ -28,7 +28,7 @@ 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 <PROVIDER NODE ID> 0 0 0 <REQUESTOR NODE ID> 0
+./out/debug/chip-tool otasoftwareupdaterequestor announce-otaprovider <PROVIDER NODE ID> 0 0 0 <REQUESTOR NODE ID> 0
 ```
 
 Once the transfer is complete, OTA requestor sends ApplyUpdateRequest command to

diff --git a/examples/ota-requestor-app/infineon/cyw30739/README.md b/examples/ota-requestor-app/infineon/cyw30739/README.md
@@ -135,5 +135,5 @@ Put the CYW30739 in to the recovery mode before running the flash script.
         chip-tool pairing onnetwork-vendor 4321 20202021 9050
 
         # Announce the OTA provider to the requestor
-        chip-tool otasoftwareupdaterequestor announce-ota-provider 4321 9 0 0 1234 0
+        chip-tool otasoftwareupdaterequestor announce-otaprovider 4321 9 0 0 1234 0
         ```
diff --git a/examples/ota-requestor-app/linux/README.md b/examples/ota-requestor-app/linux/README.md
@@ -306,7 +306,7 @@ out/chip-tool pairing onnetwork-long 0x1234567890 20202021 18
 **Write to the DefaultOTAProviders attribute**
 
 ```
-out/chip-tool otasoftwareupdaterequestor write default-ota-providers '[{"providerNodeID": 3735928559, "endpoint": 0}]' 0x1234567890 0
+out/chip-tool otasoftwareupdaterequestor write default-otaproviders '[{"providerNodeID": 3735928559, "endpoint": 0}]' 0x1234567890 0
 ```
 
 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
 **Write/Read DefaultOTAProviders on the first fabric (alpha)**
 
 ```
-out/chip-tool otasoftwareupdaterequestor write default-ota-providers '[{"providerNodeID": 12648430, "endpoint": 0}]' 0xDEB 0
-out/chip-tool otasoftwareupdaterequestor read default-ota-providers 0xDEB 0
+out/chip-tool otasoftwareupdaterequestor write default-otaproviders '[{"providerNodeID": 12648430, "endpoint": 0}]' 0xDEB 0
+out/chip-tool otasoftwareupdaterequestor read default-otaproviders 0xDEB 0
 ```
 
 **Write/Read DefaultOTAProviders on second fabric (beta)**
 
 ```
-out/chip-tool otasoftwareupdaterequestor write default-ota-providers '[{"providerNodeID": 45242, "endpoint": 0}]' 0xB0B 0 --commissioner-name beta
-out/chip-tool otasoftwareupdaterequestor read default-ota-providers 0xB0B 0 --commissioner-name beta
+out/chip-tool otasoftwareupdaterequestor write default-otaproviders '[{"providerNodeID": 45242, "endpoint": 0}]' 0xB0B 0 --commissioner-name beta
+out/chip-tool otasoftwareupdaterequestor read default-otaproviders 0xB0B 0 --commissioner-name beta
 ```
 
 **Write ACL for the first OTA Provider application**

diff --git a/examples/ota-requestor-app/telink/Readme.md b/examples/ota-requestor-app/telink/Readme.md
@@ -154,7 +154,7 @@ Usage of OTA:
 -   Use the chip-tool to announce the ota-provider-app to start the OTA process
 
     ```
-    ./chip-tool otasoftwareupdaterequestor announce-ota-provider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
+    ./chip-tool otasoftwareupdaterequestor announce-otaprovider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
     ```
 
     here:

diff --git a/examples/pump-app/telink/README.md b/examples/pump-app/telink/README.md
@@ -169,7 +169,7 @@ Usage of OTA:
 -   Use the chip-tool to announce the ota-provider-app to start the OTA process
 
     ```
-    ./chip-tool otasoftwareupdaterequestor announce-ota-provider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
+    ./chip-tool otasoftwareupdaterequestor announce-otaprovider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
     ```
 
     here:

diff --git a/examples/pump-controller-app/telink/README.md b/examples/pump-controller-app/telink/README.md
@@ -170,7 +170,7 @@ Usage of OTA:
 -   Use the chip-tool to announce the ota-provider-app to start the OTA process
 
     ```
-    ./chip-tool otasoftwareupdaterequestor announce-ota-provider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
+    ./chip-tool otasoftwareupdaterequestor announce-otaprovider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
     ```
 
     here:

diff --git a/examples/temperature-measurement-app/telink/README.md b/examples/temperature-measurement-app/telink/README.md
@@ -150,7 +150,7 @@ Usage of OTA:
 -   Use the chip-tool to announce the ota-provider-app to start the OTA process
 
     ```
-    ./chip-tool otasoftwareupdaterequestor announce-ota-provider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
+    ./chip-tool otasoftwareupdaterequestor announce-otaprovider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
     ```
 
     here:

diff --git a/examples/thermostat/telink/Readme.md b/examples/thermostat/telink/Readme.md
@@ -161,7 +161,7 @@ Usage of OTA:
 -   Use the chip-tool to announce the ota-provider-app to start the OTA process
 
     ```
-    ./chip-tool otasoftwareupdaterequestor announce-ota-provider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
+    ./chip-tool otasoftwareupdaterequestor announce-otaprovider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
     ```
 
     here:

diff --git a/examples/window-app/telink/README.md b/examples/window-app/telink/README.md
@@ -232,7 +232,7 @@ Usage of OTA:
 -   Use the chip-tool to announce the ota-provider-app to start the OTA process
 
     ```
-    ./chip-tool otasoftwareupdaterequestor announce-ota-provider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
+    ./chip-tool otasoftwareupdaterequestor announce-otaprovider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
     ```
 
     here:

diff --git a/scripts/tools/nrfconnect/nrfconnect_factory_data.schema b/scripts/tools/nrfconnect/nrfconnect_factory_data.schema
@@ -26,7 +26,7 @@
             "description": "Current version of the factory data set",
             "type": "integer",
             "minimum": 0,
-            "maximum": 255
+            "maximum": 65535
         },
         "sn": {
             "description": "Serial number of device",
@@ -82,7 +82,7 @@
             "description": "Hardware version - integer",
             "type": "integer",
             "minimum": 0,
-            "maximum": 65536
+            "maximum": 65535
         },
         "hw_ver_str": {
             "description": "A string representation of hardware version",
-Original file line number
+Diff line change
@@ Expand Up / @@ -163,7 +163,7 @@ Usage of OTA: @@
     -   Use the chip-tool to announce the ota-provider-app to start the OTA process
         ```
-        ./chip-tool otasoftwareupdaterequestor announce-ota-provider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
+        ./chip-tool otasoftwareupdaterequestor announce-otaprovider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
         ```
         here:
@@ Expand Down @@