Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[OTA] Update README for OTA Requestor application #15064

Merged
merged 1 commit into from
Feb 11, 2022
Merged

[OTA] Update README for OTA Requestor application #15064

merged 1 commit into from
Feb 11, 2022

Conversation

carol-apple
Copy link
Contributor

Problem

With #14931, the application now uses AppMain for most initialization on bootup. The instructions in the README do not reflect this change.

Change overview

  • Remove discriminator and UDP port command line options as this is generically supported by the Linux platform
  • Align the command line option casing so all options are consistent
  • Update help text for the command line options
  • Update the README on application usage

Testing

Verified that the happy path still works (file transfers successfully)

  • In terminal 1:
rm /tmp/chip*
out/apps/ota-provider/chip-ota-provider-app --discriminator 10 --KVS /tmp/chip_kvs_provider --filepath ~/Downloads/test-with-header.bin
  • In terminal 2:
out/apps/ota-requestor/chip-ota-requestor-app --discriminator 30 --secured-device-port 5560 --KVS /tmp/chip_kvs_requestor
  • In terminal 3:
out/apps/chip-tool/chip-tool pairing onnetwork-long 0xDEADBEEF 20202021 10
out/apps/chip-tool/chip-tool pairing onnetwork-long 0x1234567890 20202021 30
out/apps/chip-tool/chip-tool otasoftwareupdaterequestor announce-ota-provider 0x00000000DEADBEEF 0 0 0 0x0000001234567890 0

@carol-apple carol-apple force-pushed the ota_requestor_readme_update branch from ed656ff to b256369 Compare February 11, 2022 05:05
@boring-cyborg boring-cyborg bot added the github label Feb 11, 2022
@carol-apple carol-apple force-pushed the ota_requestor_readme_update branch from b256369 to 7e62b1c Compare February 11, 2022 05:11
@github-actions
Copy link

github-actions bot commented Feb 11, 2022 •
edited
Loading

PR #15064: Size comparison from 6380d38 to 7e62b1c

Full report (34 builds for cyw30739, efr32, esp32, k32w, linux, mbed, nrfconnect, p6, qpg, telink)
platform target config section 6380d38 7e62b1c change % change
cyw30739 light cyw930739m2evb_01 (read/write) 607074 607074 0 0.0
.app_xip_area 508552 508552 0 0.0
.bss 81220 81220 0 0.0
.data 644 644 0 0.0
.rodata 0 0 0 0.0
.text 0 0 0 0.0
lock cyw930739m2evb_01 (read/write) 563778 563778 0 0.0
.app_xip_area 466824 466824 0 0.0
.bss 79692 79692 0 0.0
.data 608 608 0 0.0
.rodata 0 0 0 0.0
.text 0 0 0 0.0
ota-requestor cyw930739m2evb_01 (read/write) 584586 584586 0 0.0
.app_xip_area 478376 478376 0 0.0
.bss 88620 88620 0 0.0
.data 552 552 0 0.0
.rodata 0 0 0 0.0
.text 112 112 0 0.0
efr32 lighting-app BRD4161A (read only) 907648 907648 0 0.0
(read/write) 128976 128976 0 0.0
.bss 126944 126944 0 0.0
.data 2032 2032 0 0.0
.text 907640 907640 0 0.0
BRD4161A+rpc (read only) 895092 895092 0 0.0
(read/write) 145636 145636 0 0.0
.bss 143504 143504 0 0.0
.data 2132 2132 0 0.0
.text 895084 895084 0 0.0
window-app BRD4161A (read only) 842712 842712 0 0.0
(read/write) 127040 127040 0 0.0
.bss 125136 125136 0 0.0
.data 1900 1900 0 0.0
.text 842704 842704 0 0.0
esp32 all-clusters-app c3devkit (read only) 943900 943900 0 0.0
(read/write) 1399738 1399738 0 0.0
.dram0.bss 68000 68000 0 0.0
.dram0.data 14268 14268 0 0.0
.flash.rodata 198576 198576 0 0.0
.flash.text 943900 943900 0 0.0
.iram0.text 62056 62056 0 0.0
m5stack (read only) 993655 993655 0 0.0
(read/write) 465008 465008 0 0.0
.dram0.bss 73144 73144 0 0.0
.dram0.data 34064 34064 0 0.0
.flash.rodata 225672 225672 0 0.0
.flash.text 988271 988271 0 0.0
.iram0.text 123399 123399 0 0.0
k32w light k32w061+release (read/write) 684248 684248 0 0.0
.bss 78248 78248 0 0.0
.data 1904 1904 0 0.0
.text 598296 598296 0 0.0
lock k32w061+release (read/write) 689088 689088 0 0.0
.bss 78640 78640 0 0.0
.data 1948 1948 0 0.0
.text 602700 602700 0 0.0
linux chip-tool-ipv6only arm64 (read only) 8064204 8064204 0 0.0
(read/write) 341185 341185 0 0.0
.bss 51681 51681 0 0.0
.data 1216 1216 0 0.0
.data.rel.ro 235544 235544 0 0.0
.dynamic 560 560 0 0.0
.got 48944 48944 0 0.0
.init 24 24 0 0.0
.init_array 192 192 0 0.0
.rodata 433684 433684 0 0.0
.text 6901220 6901220 0 0.0
thermostat-no-ble arm64 (read only) 2140156 2140156 0 0.0
(read/write) 142209 142209 0 0.0
.bss 59105 59105 0 0.0
.data 1032 1032 0 0.0
.data.rel.ro 74960 74960 0 0.0
.dynamic 560 560 0 0.0
.got 4144 4144 0 0.0
.init 24 24 0 0.0
.init_array 328 328 0 0.0
.rodata 132460 132460 0 0.0
.text 1789584 1789584 0 0.0
mbed all-clusters-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2396832 2396832 0 0.0
.bss 190068 190068 0 0.0
.data 5320 5320 0 0.0
.text 1359432 1359432 0 0.0
lighting-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2358456 2358456 0 0.0
.bss 182680 182680 0 0.0
.data 5624 5624 0 0.0
.text 1321056 1321056 0 0.0
lock-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2321984 2321984 0 0.0
.bss 182568 182568 0 0.0
.data 5600 5600 0 0.0
.text 1284584 1284584 0 0.0
pigweed-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 1139648 1139648 0 0.0
.bss 11756 11756 0 0.0
.data 4368 4368 0 0.0
.text 103032 103032 0 0.0
shell CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2308052 2308052 0 0.0
.bss 179820 179820 0 0.0
.data 5424 5424 0 0.0
.text 1270624 1270624 0 0.0
nrfconnect lighting-app nrf52840dk_nrf52840 (read/write) 1015963 1015963 0 0.0
bss 123004 123004 0 0.0
rodata 119528 119528 0 0.0
text 694536 694536 0 0.0
nrf52840dk_nrf52840+rpc (read/write) 984795 984795 0 0.0
bss 120192 120192 0 0.0
rodata 110896 110896 0 0.0
text 674148 674148 0 0.0
nrf52840dongle_nrf52840 (read/write) 1031791 1031791 0 0.0
bss 124392 124392 0 0.0
rodata 118392 118392 0 0.0
text 699124 699124 0 0.0
nrf5340dk_nrf5340_cpuapp (read/write) 922706 922706 0 0.0
bss 119568 119568 0 0.0
rodata 112772 112772 0 0.0
text 609572 609572 0 0.0
lock-app nrf52840dk_nrf52840 (read/write) 945791 945791 0 0.0
bss 121376 121376 0 0.0
rodata 108276 108276 0 0.0
text 637536 637536 0 0.0
nrf5340dk_nrf5340_cpuapp (read/write) 853266 853266 0 0.0
bss 117968 117968 0 0.0
rodata 101444 101444 0 0.0
text 553344 553344 0 0.0
pigweed-app nrf52840dk_nrf52840 (read/write) 527595 527595 0 0.0
bss 53632 53632 0 0.0
rodata 49976 49976 0 0.0
text 361016 361016 0 0.0
pump-app nrf52840dk_nrf52840 (read/write) 945203 945203 0 0.0
bss 121096 121096 0 0.0
rodata 107632 107632 0 0.0
text 637796 637796 0 0.0
pump-controller-app nrf52840dk_nrf52840 (read/write) 940551 940551 0 0.0
bss 121100 121100 0 0.0
rodata 106924 106924 0 0.0
text 633832 633832 0 0.0
shell nrf52840dk_nrf52840 (read/write) 806223 806223 0 0.0
bss 112376 112376 0 0.0
rodata 78948 78948 0 0.0
text 537320 537320 0 0.0
p6 all-clusters-app default (read/write) 2482288 2482288 0 0.0
.bss 119680 119680 0 0.0
.data 2672 2672 0 0.0
.text 1440552 1440552 0 0.0
light-app default (read/write) 2388616 2388616 0 0.0
.bss 109328 109328 0 0.0
.data 2520 2520 0 0.0
.text 1346880 1346880 0 0.0
lock-app default (read/write) 2352056 2352056 0 0.0
.bss 109048 109048 0 0.0
.data 2480 2480 0 0.0
.text 1310320 1310320 0 0.0
qpg lighting-app qpg6105+debug (read only) 593688 593688 0 0.0
(read/write) 146936 146936 0 0.0
.bss 90520 90520 0 0.0
.data 1108 1108 0 0.0
.text 588368 588368 0 0.0
lock-app qpg6105+debug (read only) 559440 559440 0 0.0
(read/write) 146936 146936 0 0.0
.bss 90504 90504 0 0.0
.data 1060 1060 0 0.0
.text 554120 554120 0 0.0
persistent-storage-app qpg6105+debug (read only) 99520 99520 0 0.0
(read/write) 146940 146940 0 0.0
.bss 24004 24004 0 0.0
.data 176 176 0 0.0
.text 94200 94200 0 0.0
telink lighting-app tlsr9518adk80d (read/write) 874870 874870 0 0.0
bss 90328 90328 0 0.0
noinit 37160 37160 0 0.0
text 613516 613516 0 0.0

@andy31415 andy31415 merged commit 5c57973 into project-chip:master Feb 11, 2022
selissia
selissia reviewed Feb 11, 2022
View reviewed changes
examples/ota-requestor-app/linux/README.md

## Example
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why remove the example?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I reworked the example a bit so it's more generic but still gives you plenty of details

jamesluo11 pushed a commit to jamesluo11/connectedhomeip that referenced this pull request Apr 26, 2022
@carol-apple @fuxingguo16
[OTA] Update README for OTA Requestor application (project-chip#15064)
9992150
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@selissia selissia selissia approved these changes

@bzbarsky-apple bzbarsky-apple bzbarsky-apple approved these changes

@harsha-rajendran harsha-rajendran harsha-rajendran approved these changes

@shubhamdp shubhamdp shubhamdp approved these changes

@andy31415 andy31415 Awaiting requested review from andy31415

@anush-apple anush-apple Awaiting requested review from anush-apple

@austinh0 austinh0 Awaiting requested review from austinh0

@balducci-apple balducci-apple Awaiting requested review from balducci-apple

@Byungjoo-Lee Byungjoo-Lee Awaiting requested review from Byungjoo-Lee

@chrisdecenzo chrisdecenzo Awaiting requested review from chrisdecenzo

@chshu chshu Awaiting requested review from chshu

@chulspro chulspro Awaiting requested review from chulspro

@Damian-Nordic Damian-Nordic Awaiting requested review from Damian-Nordic

@dhrishi dhrishi Awaiting requested review from dhrishi

@electrocucaracha electrocucaracha Awaiting requested review from electrocucaracha

@emargolis emargolis Awaiting requested review from emargolis

@franck-apple franck-apple Awaiting requested review from franck-apple

@gjc13 gjc13 Awaiting requested review from gjc13

@hawk248 hawk248 Awaiting requested review from hawk248

@holbrookt holbrookt Awaiting requested review from holbrookt

@isiu-apple isiu-apple Awaiting requested review from isiu-apple

@jelderton jelderton Awaiting requested review from jelderton

@jepenven-silabs jepenven-silabs Awaiting requested review from jepenven-silabs

@jmartinez-silabs jmartinez-silabs Awaiting requested review from jmartinez-silabs

@kghost kghost Awaiting requested review from kghost

@kpschoedel kpschoedel Awaiting requested review from kpschoedel

@lazarkov lazarkov Awaiting requested review from lazarkov

@LuDuda LuDuda Awaiting requested review from LuDuda

@mlepage-google mlepage-google Awaiting requested review from mlepage-google

@mrjerryjohns mrjerryjohns Awaiting requested review from mrjerryjohns

@msandstedt msandstedt Awaiting requested review from msandstedt

@sagar-apple sagar-apple Awaiting requested review from sagar-apple

@saurabhst saurabhst Awaiting requested review from saurabhst

@tcarmelveilleux tcarmelveilleux Awaiting requested review from tcarmelveilleux

@tecimovic tecimovic Awaiting requested review from tecimovic

@vijs vijs Awaiting requested review from vijs

@vivien-apple vivien-apple Awaiting requested review from vivien-apple

@wbschiller wbschiller Awaiting requested review from wbschiller

@woody-apple woody-apple Awaiting requested review from woody-apple

@xylophone21 xylophone21 Awaiting requested review from xylophone21

@yufengwangca yufengwangca Awaiting requested review from yufengwangca

Assignees
No one assigned
Labels
examples github review - approved
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@carol-apple @shubhamdp @harsha-rajendran @selissia @bzbarsky-apple @andy31415