diff --git a/.github/.wordlist.txt b/.github/.wordlist.txt index 56205d3eb1c6e1..a8451a47a81dfa 100644 --- a/.github/.wordlist.txt +++ b/.github/.wordlist.txt @@ -54,6 +54,7 @@ ApplicationId ApplicationIdentifier ApplicationLauncher ApplyUpdateRequest +ApplyUpdateResponse approver appspot aps @@ -280,6 +281,7 @@ debianutils DEDEDEDE deepnote DelayedActionTime +delayedActionTimeSec demangle deployable depottools @@ -855,6 +857,7 @@ QRCodeUrl QSPI QueryImage QueryImageResponse +queryImageStatus qvCHIP RADVD raspberryPi @@ -966,6 +969,7 @@ SoftDevice softmmu SoftwareDiagnostics SoftwareVersion +softwareVersionStr SoftwareVersionString softwareVersionValid SPI @@ -1085,12 +1089,16 @@ UniFlash unpair unprovisioned untrusted +updateAvailable +updateNotAvailable UpdateTokens upstreamed URI usbmodem USBtoUART uscif +UserConsentNeeded +userConsentState userguide USERINTERFACE UserLabel diff --git a/examples/ota-provider-app/linux/README.md b/examples/ota-provider-app/linux/README.md index dc6459b1782e5b..1c580c22b16979 100644 --- a/examples/ota-provider-app/linux/README.md +++ b/examples/ota-provider-app/linux/README.md @@ -1,61 +1,52 @@ # ota-provider-app -This is a reference application that implements an example of an OTA Provider -Cluster Server. +This is a reference application that implements an example of an OTA Provider Cluster Server. ## Building Suggest doing the following: -`scripts/examples/gn_build_example.sh examples/ota-provider-app/linux out/debug chip_config_network_layer_ble=false` +``` +scripts/examples/gn_build_example.sh examples/ota-provider-app/linux out/debug chip_config_network_layer_ble=false +``` ## Usage -`./ota-provider-app [-f/--filepath \] [-o/--otaImageList \]` - -If `--filepath` is supplied, `ota-provider-app` will automatically serve that -file to the OTA Requestor (SoftwareVersion will be Requester version + 1). - -If `--otaImageList` is supplied, `ota-provider-app` will parse the JSON file and -extract all required data. Then the most recent, valid software version will be -selected and the corresponding ota-file will be sent to the OTA Requestor. - -Here's an example of the otaImageList file contents: - -{ "foo": 1, // ignored by parser "deviceSoftwareVersionModel": [ { "vendorId": -1, "productId": 1, "softwareVersion": 10, "softwareVersionString": "1.0.0", -"cDVersionNumber": 18, "softwareVersionValid": true, -"minApplicableSoftwareVersion": 0, "maxApplicableSoftwareVersion": 100, -"otaURL": "/tmp/ota.txt" }, { "vendorId": 1, "productId": 1, "softwareVersion": -20, "softwareVersionString": "1.0.1", "cDVersionNumber": 18, -"softwareVersionValid": false, "minApplicableSoftwareVersion": 0, -"maxApplicableSoftwareVersion": 100, "otaURL": "/tmp/ota.txt" }, { "vendorId": -1, "productId": 1, "softwareVersion": 30, "softwareVersionString": "1.0.2", -"cDVersionNumber": 18, "softwareVersionValid": true, -"minApplicableSoftwareVersion": 0, "maxApplicableSoftwareVersion": 100, -"otaURL": "/tmp/ota.txt" }, { "vendorId": 1, "productId": 1, "softwareVersion": -40, "softwareVersionString": "1.1.0", "cDVersionNumber": 18, -"softwareVersionValid": true, "minApplicableSoftwareVersion": 0, -"maxApplicableSoftwareVersion": 100, "otaURL": "/tmp/ota.txt" }, { "vendorId": -1, "productId": 1, "softwareVersion": 50, "softwareVersionString": "1.1.1", -"cDVersionNumber": 18, "softwareVersionValid": false, -"minApplicableSoftwareVersion": 0, "maxApplicableSoftwareVersion": 100, -"otaURL": "/tmp/ota.txt" } ] } - -If neither `--filepath` nor `--otaImageList` are supplied, `ota-provider-app` -will respond to `QueryImage` with `NotAvailable` status. - -## Current Features/Limitations - -### Features - -- can provide local filepath to serve as OTA image -- can complete full BDX transfer -- supports variable-length / startoffset for BDX transfer - -### Limitations: +| Command Line Options | Description | +| --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| -f/--filepath | Path to a file containing an OTA image | +| -o/--otaImageList | Path to a file containing a list of OTA images | +| -q/--queryImageStatus | Value for the Status field in the QueryImageResponse | +| -t/--delayedActionTimeSec