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

[Mbed] Mbed platform documentation #11121

Merged
merged 10 commits into from
Oct 29, 2021
Merged

[Mbed] Mbed platform documentation #11121

merged 10 commits into from
Oct 29, 2021

Conversation

ATmobica
Copy link
Contributor

Problem

Add the necessary documentation related to the Mbed platform.

Change overview

Add Mbed OS guides:

  • platform overview
  • commissioning
  • add a new target

Add README files to all supported examples: lock-app, lighting-app, all-clusters-app, shell, pigweed-app
Add README file to Mbed unit tests application

Testing

Not required

@boring-cyborg boring-cyborg bot added documentation Improvements or additions to documentation examples labels Oct 28, 2021
@restyled-io restyled-io bot mentioned this pull request Oct 28, 2021
Closed
@github-actions
Copy link

PR #11121: Size comparison from 36329e1 to c989948

Full report (5 builds for k32w, p6, telink)
platform target config section 36329e1 c989948 change % change
k32w lock-app k32w061+debug (read/write) 592980 592980 0 0.0
.bss 69172 69172 0 0.0
.data 1864 1864 0 0.0
.text 516144 516144 0 0.0
shell k32w061+debug (read/write) 425252 425252 0 0.0
.bss 63256 63256 0 0.0
.data 672 672 0 0.0
.text 359620 359620 0 0.0
lighting-app k32w061+se05x+release (read/write) 701024 701024 0 0.0
.bss 78688 78688 0 0.0
.data 1900 1900 0 0.0
.text 614636 614636 0 0.0
p6 lock-app default (read/write) 2169096 2169096 0 0.0
.bss 67168 67168 0 0.0
.data 2416 2416 0 0.0
.heap 963760 963760 0 0.0
.text 1127360 1127360 0 0.0
telink lighting-app tlsr9518adk80d (read/write) 664518 664518 0 0.0
bss 69944 69944 0 0.0
noinit 33216 33216 0 0.0
text 458068 458068 0 0.0

@github-actions
Copy link

github-actions bot commented Oct 28, 2021 •
edited
Loading

PR #11121: Size comparison from 36329e1 to 1f81ef1

Full report (37 builds for efr32, esp32, k32w, linux, mbed, nrfconnect, p6, qpg, telink)
platform target config section 36329e1 1f81ef1 change % change
efr32 lighting-app BRD4161A (read only) 737476 737476 0 0.0
(read/write) 115428 115428 0 0.0
.bss 113676 113676 0 0.0
.data 1752 1752 0 0.0
.text 737468 737468 0 0.0
BRD4161A+rpc (read only) 724916 724916 0 0.0
(read/write) 132032 132032 0 0.0
.bss 130180 130180 0 0.0
.data 1852 1852 0 0.0
.text 724908 724908 0 0.0
lock-app BRD4161A (read only) 716756 716756 0 0.0
(read/write) 113244 113244 0 0.0
.bss 111532 111532 0 0.0
.data 1712 1712 0 0.0
.text 716748 716748 0 0.0
window-app BRD4161A (read only) 717660 717660 0 0.0
(read/write) 113568 113568 0 0.0
.bss 111852 111852 0 0.0
.data 1716 1716 0 0.0
.text 717652 717652 0 0.0
esp32 all-clusters-app c3devkit (read only) 875926 875926 0 0.0
(read/write) 1308672 1308672 0 0.0
.dram0.bss 59248 59248 0 0.0
.dram0.data 16448 16448 0 0.0
.flash.rodata 199744 199744 0 0.0
.flash.text 875926 875926 0 0.0
.iram0.text 57554 57554 0 0.0
m5stack (read only) 907187 907187 0 0.0
(read/write) 428460 428460 0 0.0
.dram0.bss 61744 61744 0 0.0
.dram0.data 32084 32084 0 0.0
.flash.rodata 208468 208468 0 0.0
.flash.text 907187 907187 0 0.0
.iram0.text 125115 125115 0 0.0
k32w lighting-app k32w061+se05x+release (read/write) 701024 701024 0 0.0
.bss 78688 78688 0 0.0
.data 1900 1900 0 0.0
.text 614636 614636 0 0.0
lock-app k32w061+debug (read/write) 592980 592980 0 0.0
.bss 69172 69172 0 0.0
.data 1864 1864 0 0.0
.text 516144 516144 0 0.0
shell k32w061+debug (read/write) 425252 425252 0 0.0
.bss 63256 63256 0 0.0
.data 672 672 0 0.0
.text 359620 359620 0 0.0
linux all-clusters-app debug (read only) 1653505 1653505 0 0.0
(read/write) 119136 119136 0 0.0
.bss 51376 51376 0 0.0
.data 978 978 0 0.0
.data.rel.ro 61536 61536 0 0.0
.dynamic 592 592 0 0.0
.got 4088 4088 0 0.0
.init 27 27 0 0.0
.init_array 520 520 0 0.0
.rodata 137845 137845 0 0.0
.text 1383346 1383346 0 0.0
bridge-app debug+rpc (read only) 1282421 1282421 0 0.0
(read/write) 85192 85192 0 0.0
.bss 51856 51856 0 0.0
.data 976 976 0 0.0
.data.rel.ro 27368 27368 0 0.0
.dynamic 592 592 0 0.0
.got 3952 3952 0 0.0
.init 27 27 0 0.0
.init_array 400 400 0 0.0
.rodata 110812 110812 0 0.0
.text 1076245 1076245 0 0.0
chip-tool debug (read only) 4262469 4262469 0 0.0
(read/write) 122208 122208 0 0.0
.bss 17680 17680 0 0.0
.data 1584 1584 0 0.0
.data.rel.ro 97536 97536 0 0.0
.dynamic 592 592 0 0.0
.got 4368 4368 0 0.0
.init 27 27 0 0.0
.init_array 424 424 0 0.0
.rodata 214032 214032 0 0.0
.text 3785589 3785589 0 0.0
lighting-app debug+rpc (read only) 1541401 1541401 0 0.0
(read/write) 102032 102032 0 0.0
.bss 41208 41208 0 0.0
.data 1106 1106 0 0.0
.data.rel.ro 54448 54448 0 0.0
.dynamic 608 608 0 0.0
.got 4112 4112 0 0.0
.init 27 27 0 0.0
.init_array 528 528 0 0.0
.rodata 128977 128977 0 0.0
.text 1279922 1279922 0 0.0
ota-provider-app debug (read only) 1238937 1238937 0 0.0
(read/write) 67904 67904 0 0.0
.bss 37440 37440 0 0.0
.data 752 752 0 0.0
.data.rel.ro 24616 24616 0 0.0
.dynamic 592 592 0 0.0
.got 4016 4016 0 0.0
.init 27 27 0 0.0
.init_array 440 440 0 0.0
.rodata 110984 110984 0 0.0
.text 1031730 1031730 0 0.0
ota-requestor-app debug (read only) 1301033 1301033 0 0.0
(read/write) 76648 76648 0 0.0
.bss 45216 45216 0 0.0
.data 816 816 0 0.0
.data.rel.ro 25496 25496 0 0.0
.dynamic 592 592 0 0.0
.got 3984 3984 0 0.0
.init 27 27 0 0.0
.init_array 512 512 0 0.0
.rodata 127680 127680 0 0.0
.text 1075490 1075490 0 0.0
shell debug (read only) 787361 787361 0 0.0
(read/write) 57792 57792 0 0.0
.bss 16168 16168 0 0.0
.data 242 242 0 0.0
.data.rel.ro 36880 36880 0 0.0
.dynamic 592 592 0 0.0
.got 3528 3528 0 0.0
.init 27 27 0 0.0
.init_array 336 336 0 0.0
.rodata 77519 77519 0 0.0
.text 608258 608258 0 0.0
tv-app debug (read only) 1774529 1774529 0 0.0
(read/write) 289656 289656 0 0.0
.bss 223280 223280 0 0.0
.data 2032 2032 0 0.0
.data.rel.ro 58704 58704 0 0.0
.dynamic 592 592 0 0.0
.got 4408 4408 0 0.0
.init 27 27 0 0.0
.init_array 608 608 0 0.0
.rodata 154776 154776 0 0.0
.text 1477442 1477442 0 0.0
mbed all-clusters-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2290664 2290664 0 0.0
.bss 180620 180620 0 0.0
.data 5192 5192 0 0.0
.heap 850632 850632 0 0.0
.text 1253264 1253264 0 0.0
lighting-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2274992 2274992 0 0.0
.bss 172820 172820 0 0.0
.data 5568 5568 0 0.0
.heap 858056 858056 0 0.0
.text 1237592 1237592 0 0.0
lock-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2252712 2252712 0 0.0
.bss 171724 171724 0 0.0
.data 5552 5552 0 0.0
.heap 859168 859168 0 0.0
.text 1215312 1215312 0 0.0
pigweed-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 1139744 1139744 0 0.0
.bss 11752 11752 0 0.0
.data 4368 4368 0 0.0
.heap 1020328 1020328 0 0.0
.text 103128 103128 0 0.0
shell CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2048984 2048984 0 0.0
.bss 156208 156208 0 0.0
.data 4968 4968 0 0.0
.heap 875272 875272 0 0.0
.text 1011584 1011584 0 0.0
nrfconnect lighting-app nrf52840dk_nrf52840 (read/write) 862911 862911 0 0.0
bss 112132 112132 0 0.0
rodata 97528 97528 0 0.0
text 577624 577624 0 0.0
nrf52840dk_nrf52840+rpc (read/write) 823735 823735 0 0.0
bss 108372 108372 0 0.0
rodata 88304 88304 0 0.0
text 550800 550800 0 0.0
nrf5340dk_nrf5340_cpuapp (read/write) 787902 787902 0 0.0
bss 113504 113504 0 0.0
rodata 92768 92768 0 0.0
text 507092 507092 0 0.0
lock-app nrf52840dk_nrf52840 (read/write) 839583 839583 0 0.0
bss 111168 111168 0 0.0
rodata 93880 93880 0 0.0
text 559108 559108 0 0.0
nrf5340dk_nrf5340_cpuapp (read/write) 764882 764882 0 0.0
bss 112576 112576 0 0.0
rodata 89188 89188 0 0.0
text 488668 488668 0 0.0
pigweed-app nrf52840dk_nrf52840 (read/write) 497323 497323 0 0.0
bss 51824 51824 0 0.0
rodata 45776 45776 0 0.0
text 339436 339436 0 0.0
pump-app nrf52840dk_nrf52840 (read/write) 844287 844287 0 0.0
bss 111304 111304 0 0.0
rodata 95128 95128 0 0.0
text 562320 562320 0 0.0
pump-controller-app nrf52840dk_nrf52840 (read/write) 839575 839575 0 0.0
bss 111200 111200 0 0.0
rodata 93904 93904 0 0.0
text 558952 558952 0 0.0
shell nrf52840dk_nrf52840 (read/write) 776435 776435 0 0.0
bss 109072 109072 0 0.0
rodata 72536 72536 0 0.0
text 520236 520236 0 0.0
nrf5340dk_nrf5340_cpuapp (read/write) 691490 691490 0 0.0
bss 110056 110056 0 0.0
rodata 67180 67180 0 0.0
text 440848 440848 0 0.0
p6 lock-app default (read/write) 2169096 2169096 0 0.0
.bss 67168 67168 0 0.0
.data 2416 2416 0 0.0
.heap 963760 963760 0 0.0
.text 1127360 1127360 0 0.0
qpg lighting-app qpg6100+debug (read only) 491240 491240 0 0.0
(read/write) 114144 114144 0 0.0
.bss 52400 52400 0 0.0
.data 1000 1000 0 0.0
.text 485920 485920 0 0.0
lock-app qpg6100+debug (read only) 467580 467580 0 0.0
(read/write) 114140 114140 0 0.0
.bss 51352 51352 0 0.0
.data 956 956 0 0.0
.text 462260 462260 0 0.0
persistent-storage-app qpg6100+debug (read only) 155244 155244 0 0.0
(read/write) 114140 114140 0 0.0
.bss 27752 27752 0 0.0
.data 372 372 0 0.0
.text 149924 149924 0 0.0
telink lighting-app tlsr9518adk80d (read/write) 664518 664518 0 0.0
bss 69944 69944 0 0.0
noinit 33216 33216 0 0.0
text 458068 458068 0 0.0

electrocucaracha
electrocucaracha previously requested changes Oct 28, 2021
View reviewed changes
Copy link
Collaborator

@electrocucaracha electrocucaracha left a comment

Choose a reason for hiding this comment

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

@ATmobica can you include the missing words into the dictionary?

@boring-cyborg boring-cyborg bot added the github label Oct 28, 2021
@woody-apple
Copy link
Contributor

Fast tracking, given this is platform documentation

@github-actions
Copy link

github-actions bot commented Oct 28, 2021 •
edited
Loading

PR #11121: Size comparison from 3948f4f to e7b17d1

Full report (37 builds for efr32, esp32, k32w, linux, mbed, nrfconnect, p6, qpg, telink)
platform target config section 3948f4f e7b17d1 change % change
efr32 lighting-app BRD4161A (read only) 737476 737476 0 0.0
(read/write) 115428 115428 0 0.0
.bss 113676 113676 0 0.0
.data 1752 1752 0 0.0
.text 737468 737468 0 0.0
BRD4161A+rpc (read only) 724916 724916 0 0.0
(read/write) 132032 132032 0 0.0
.bss 130180 130180 0 0.0
.data 1852 1852 0 0.0
.text 724908 724908 0 0.0
lock-app BRD4161A (read only) 716756 716756 0 0.0
(read/write) 113244 113244 0 0.0
.bss 111532 111532 0 0.0
.data 1712 1712 0 0.0
.text 716748 716748 0 0.0
window-app BRD4161A (read only) 717660 717660 0 0.0
(read/write) 113568 113568 0 0.0
.bss 111852 111852 0 0.0
.data 1716 1716 0 0.0
.text 717652 717652 0 0.0
esp32 all-clusters-app c3devkit (read only) 875926 875926 0 0.0
(read/write) 1308672 1308672 0 0.0
.dram0.bss 59248 59248 0 0.0
.dram0.data 16448 16448 0 0.0
.flash.rodata 199744 199744 0 0.0
.flash.text 875926 875926 0 0.0
.iram0.text 57554 57554 0 0.0
m5stack (read only) 907187 907187 0 0.0
(read/write) 428460 428460 0 0.0
.dram0.bss 61744 61744 0 0.0
.dram0.data 32084 32084 0 0.0
.flash.rodata 208468 208468 0 0.0
.flash.text 907187 907187 0 0.0
.iram0.text 125115 125115 0 0.0
k32w lighting-app k32w061+se05x+release (read/write) 701024 701024 0 0.0
.bss 78688 78688 0 0.0
.data 1900 1900 0 0.0
.text 614636 614636 0 0.0
lock-app k32w061+debug (read/write) 592980 592980 0 0.0
.bss 69172 69172 0 0.0
.data 1864 1864 0 0.0
.text 516144 516144 0 0.0
shell k32w061+debug (read/write) 425252 425252 0 0.0
.bss 63256 63256 0 0.0
.data 672 672 0 0.0
.text 359620 359620 0 0.0
linux all-clusters-app debug (read only) 1653505 1653505 0 0.0
(read/write) 119136 119136 0 0.0
.bss 51376 51376 0 0.0
.data 978 978 0 0.0
.data.rel.ro 61536 61536 0 0.0
.dynamic 592 592 0 0.0
.got 4088 4088 0 0.0
.init 27 27 0 0.0
.init_array 520 520 0 0.0
.rodata 137845 137845 0 0.0
.text 1383346 1383346 0 0.0
bridge-app debug+rpc (read only) 1282421 1282421 0 0.0
(read/write) 85192 85192 0 0.0
.bss 51856 51856 0 0.0
.data 976 976 0 0.0
.data.rel.ro 27368 27368 0 0.0
.dynamic 592 592 0 0.0
.got 3952 3952 0 0.0
.init 27 27 0 0.0
.init_array 400 400 0 0.0
.rodata 110812 110812 0 0.0
.text 1076245 1076245 0 0.0
chip-tool debug (read only) 4262469 4262469 0 0.0
(read/write) 122208 122208 0 0.0
.bss 17680 17680 0 0.0
.data 1584 1584 0 0.0
.data.rel.ro 97536 97536 0 0.0
.dynamic 592 592 0 0.0
.got 4368 4368 0 0.0
.init 27 27 0 0.0
.init_array 424 424 0 0.0
.rodata 214032 214032 0 0.0
.text 3785589 3785589 0 0.0
lighting-app debug+rpc (read only) 1541401 1541401 0 0.0
(read/write) 102032 102032 0 0.0
.bss 41208 41208 0 0.0
.data 1106 1106 0 0.0
.data.rel.ro 54448 54448 0 0.0
.dynamic 608 608 0 0.0
.got 4112 4112 0 0.0
.init 27 27 0 0.0
.init_array 528 528 0 0.0
.rodata 128977 128977 0 0.0
.text 1279922 1279922 0 0.0
ota-provider-app debug (read only) 1238937 1238937 0 0.0
(read/write) 67904 67904 0 0.0
.bss 37440 37440 0 0.0
.data 752 752 0 0.0
.data.rel.ro 24616 24616 0 0.0
.dynamic 592 592 0 0.0
.got 4016 4016 0 0.0
.init 27 27 0 0.0
.init_array 440 440 0 0.0
.rodata 110984 110984 0 0.0
.text 1031730 1031730 0 0.0
ota-requestor-app debug (read only) 1301033 1301033 0 0.0
(read/write) 76648 76648 0 0.0
.bss 45216 45216 0 0.0
.data 816 816 0 0.0
.data.rel.ro 25496 25496 0 0.0
.dynamic 592 592 0 0.0
.got 3984 3984 0 0.0
.init 27 27 0 0.0
.init_array 512 512 0 0.0
.rodata 127680 127680 0 0.0
.text 1075490 1075490 0 0.0
shell debug (read only) 787361 787361 0 0.0
(read/write) 57792 57792 0 0.0
.bss 16168 16168 0 0.0
.data 242 242 0 0.0
.data.rel.ro 36880 36880 0 0.0
.dynamic 592 592 0 0.0
.got 3528 3528 0 0.0
.init 27 27 0 0.0
.init_array 336 336 0 0.0
.rodata 77519 77519 0 0.0
.text 608258 608258 0 0.0
tv-app debug (read only) 1774529 1774529 0 0.0
(read/write) 289656 289656 0 0.0
.bss 223280 223280 0 0.0
.data 2032 2032 0 0.0
.data.rel.ro 58704 58704 0 0.0
.dynamic 592 592 0 0.0
.got 4408 4408 0 0.0
.init 27 27 0 0.0
.init_array 608 608 0 0.0
.rodata 154776 154776 0 0.0
.text 1477442 1477442 0 0.0
mbed all-clusters-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2290664 2290664 0 0.0
.bss 180620 180620 0 0.0
.data 5192 5192 0 0.0
.heap 850632 850632 0 0.0
.text 1253264 1253264 0 0.0
lighting-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2274992 2274992 0 0.0
.bss 172820 172820 0 0.0
.data 5568 5568 0 0.0
.heap 858056 858056 0 0.0
.text 1237592 1237592 0 0.0
lock-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2252712 2252712 0 0.0
.bss 171724 171724 0 0.0
.data 5552 5552 0 0.0
.heap 859168 859168 0 0.0
.text 1215312 1215312 0 0.0
pigweed-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 1139744 1139744 0 0.0
.bss 11752 11752 0 0.0
.data 4368 4368 0 0.0
.heap 1020328 1020328 0 0.0
.text 103128 103128 0 0.0
shell CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2048984 2048984 0 0.0
.bss 156208 156208 0 0.0
.data 4968 4968 0 0.0
.heap 875272 875272 0 0.0
.text 1011584 1011584 0 0.0
nrfconnect lighting-app nrf52840dk_nrf52840 (read/write) 862911 862911 0 0.0
bss 112132 112132 0 0.0
rodata 97528 97528 0 0.0
text 577624 577624 0 0.0
nrf52840dk_nrf52840+rpc (read/write) 823735 823735 0 0.0
bss 108372 108372 0 0.0
rodata 88304 88304 0 0.0
text 550800 550800 0 0.0
nrf5340dk_nrf5340_cpuapp (read/write) 787902 787902 0 0.0
bss 113504 113504 0 0.0
rodata 92768 92768 0 0.0
text 507092 507092 0 0.0
lock-app nrf52840dk_nrf52840 (read/write) 839583 839583 0 0.0
bss 111168 111168 0 0.0
rodata 93880 93880 0 0.0
text 559108 559108 0 0.0
nrf5340dk_nrf5340_cpuapp (read/write) 764882 764882 0 0.0
bss 112576 112576 0 0.0
rodata 89188 89188 0 0.0
text 488668 488668 0 0.0
pigweed-app nrf52840dk_nrf52840 (read/write) 497323 497323 0 0.0
bss 51824 51824 0 0.0
rodata 45776 45776 0 0.0
text 339436 339436 0 0.0
pump-app nrf52840dk_nrf52840 (read/write) 844287 844287 0 0.0
bss 111304 111304 0 0.0
rodata 95128 95128 0 0.0
text 562320 562320 0 0.0
pump-controller-app nrf52840dk_nrf52840 (read/write) 839575 839575 0 0.0
bss 111200 111200 0 0.0
rodata 93904 93904 0 0.0
text 558952 558952 0 0.0
shell nrf52840dk_nrf52840 (read/write) 776435 776435 0 0.0
bss 109072 109072 0 0.0
rodata 72536 72536 0 0.0
text 520236 520236 0 0.0
nrf5340dk_nrf5340_cpuapp (read/write) 691490 691490 0 0.0
bss 110056 110056 0 0.0
rodata 67180 67180 0 0.0
text 440848 440848 0 0.0
p6 lock-app default (read/write) 2169096 2169096 0 0.0
.bss 67168 67168 0 0.0
.data 2416 2416 0 0.0
.heap 963760 963760 0 0.0
.text 1127360 1127360 0 0.0
qpg lighting-app qpg6100+debug (read only) 491224 491224 0 0.0
(read/write) 114144 114144 0 0.0
.bss 51288 51288 0 0.0
.data 1000 1000 0 0.0
.text 485904 485904 0 0.0
lock-app qpg6100+debug (read only) 467556 467556 0 0.0
(read/write) 114140 114140 0 0.0
.bss 50240 50240 0 0.0
.data 956 956 0 0.0
.text 462236 462236 0 0.0
persistent-storage-app qpg6100+debug (read only) 155244 155244 0 0.0
(read/write) 114140 114140 0 0.0
.bss 27752 27752 0 0.0
.data 372 372 0 0.0
.text 149924 149924 0 0.0
telink lighting-app tlsr9518adk80d (read/write) 664518 664518 0 0.0
bss 69944 69944 0 0.0
noinit 33216 33216 0 0.0
text 458068 458068 0 0.0

@andy31415 andy31415 dismissed electrocucaracha’s stale review October 28, 2021 18:05

Dictionary changes should be validated by our linters and were updated.

electrocucaracha
electrocucaracha approved these changes Oct 28, 2021
View reviewed changes
.github/.wordlist.txt Outdated Show resolved Hide resolved
.github/.wordlist.txt Outdated Show resolved Hide resolved
.github/.wordlist.txt Show resolved Hide resolved
@ATmobica
Add Mbed OS guides
df662db 
Add README file to lighting-app and lock-app
@ATmobica
Update the Mbed OS guides
837c950 
Add mbed os guides images
@ATmobica
Update lock and lighting apps README files
12da275
@ATmobica
Add all-clusters-app and pigweed-app README files
b79e5ea 
Small fixes in lock and ligthing app docs
@ATmobica
Add Mbed Unit Tests README file
e81e600 
Docs files restyle
@ATmobica
Add shell example README file
d040d44 
Restyle docs
@ATmobica
Restyle shell doc
41973c6
@ATmobica
Fix spelling
7ffdfaf
@ATmobica
Fix spelling
13c0a4f 
Include the missing words into the dictionary
@ATmobica
Fix wordlist
477968f
@github-actions
Copy link

github-actions bot commented Oct 29, 2021 •
edited
Loading

PR #11121: Size comparison from 1e27d92 to 477968f

Decreases (1 build for esp32)
platform target config section 1e27d92 477968f change % change
esp32 all-clusters-app m5stack (read only) 907747 907659 -88 -0.0
.flash.text 907747 907659 -88 -0.0
Full report (37 builds for efr32, esp32, k32w, linux, mbed, nrfconnect, p6, qpg, telink)
platform target config section 1e27d92 477968f change % change
efr32 lighting-app BRD4161A (read only) 738120 738120 0 0.0
(read/write) 115428 115428 0 0.0
.bss 113676 113676 0 0.0
.data 1752 1752 0 0.0
.text 738112 738112 0 0.0
BRD4161A+rpc (read only) 725560 725560 0 0.0
(read/write) 132036 132036 0 0.0
.bss 130180 130180 0 0.0
.data 1852 1852 0 0.0
.text 725552 725552 0 0.0
lock-app BRD4161A (read only) 717400 717400 0 0.0
(read/write) 113244 113244 0 0.0
.bss 111532 111532 0 0.0
.data 1712 1712 0 0.0
.text 717392 717392 0 0.0
window-app BRD4161A (read only) 718304 718304 0 0.0
(read/write) 113572 113572 0 0.0
.bss 111852 111852 0 0.0
.data 1716 1716 0 0.0
.text 718296 718296 0 0.0
esp32 all-clusters-app c3devkit (read only) 876382 876382 0 0.0
(read/write) 1308944 1308944 0 0.0
.dram0.bss 59248 59248 0 0.0
.dram0.data 16448 16448 0 0.0
.flash.rodata 200016 200016 0 0.0
.flash.text 876382 876382 0 0.0
.iram0.text 57554 57554 0 0.0
m5stack (read only) 907747 907659 -88 -0.0
(read/write) 428724 428724 0 0.0
.dram0.bss 61744 61744 0 0.0
.dram0.data 32084 32084 0 0.0
.flash.rodata 208732 208732 0 0.0
.flash.text 907747 907659 -88 -0.0
.iram0.text 125115 125115 0 0.0
k32w lighting-app k32w061+se05x+release (read/write) 701656 701656 0 0.0
.bss 78688 78688 0 0.0
.data 1900 1900 0 0.0
.text 615268 615268 0 0.0
lock-app k32w061+debug (read/write) 593612 593612 0 0.0
.bss 69172 69172 0 0.0
.data 1864 1864 0 0.0
.text 516776 516776 0 0.0
shell k32w061+debug (read/write) 425252 425252 0 0.0
.bss 63256 63256 0 0.0
.data 672 672 0 0.0
.text 359620 359620 0 0.0
linux all-clusters-app debug (read only) 1655073 1655073 0 0.0
(read/write) 119104 119104 0 0.0
.bss 51376 51376 0 0.0
.data 978 978 0 0.0
.data.rel.ro 61504 61504 0 0.0
.dynamic 592 592 0 0.0
.got 4088 4088 0 0.0
.init 27 27 0 0.0
.init_array 520 520 0 0.0
.rodata 138069 138069 0 0.0
.text 1384738 1384738 0 0.0
bridge-app debug+rpc (read only) 1283341 1283341 0 0.0
(read/write) 85160 85160 0 0.0
.bss 51856 51856 0 0.0
.data 976 976 0 0.0
.data.rel.ro 27336 27336 0 0.0
.dynamic 592 592 0 0.0
.got 3952 3952 0 0.0
.init 27 27 0 0.0
.init_array 400 400 0 0.0
.rodata 111044 111044 0 0.0
.text 1076981 1076981 0 0.0
chip-tool debug (read only) 4266229 4266229 0 0.0
(read/write) 122176 122176 0 0.0
.bss 17680 17680 0 0.0
.data 1584 1584 0 0.0
.data.rel.ro 97504 97504 0 0.0
.dynamic 592 592 0 0.0
.got 4368 4368 0 0.0
.init 27 27 0 0.0
.init_array 424 424 0 0.0
.rodata 214704 214704 0 0.0
.text 3788725 3788725 0 0.0
lighting-app debug+rpc (read only) 1542281 1542281 0 0.0
(read/write) 102000 102000 0 0.0
.bss 41208 41208 0 0.0
.data 1106 1106 0 0.0
.data.rel.ro 54416 54416 0 0.0
.dynamic 608 608 0 0.0
.got 4112 4112 0 0.0
.init 27 27 0 0.0
.init_array 528 528 0 0.0
.rodata 129169 129169 0 0.0
.text 1280658 1280658 0 0.0
ota-provider-app debug (read only) 1239849 1239849 0 0.0
(read/write) 67872 67872 0 0.0
.bss 37440 37440 0 0.0
.data 752 752 0 0.0
.data.rel.ro 24584 24584 0 0.0
.dynamic 592 592 0 0.0
.got 4016 4016 0 0.0
.init 27 27 0 0.0
.init_array 440 440 0 0.0
.rodata 111208 111208 0 0.0
.text 1032466 1032466 0 0.0
ota-requestor-app debug (read only) 1301465 1301465 0 0.0
(read/write) 76616 76616 0 0.0
.bss 45216 45216 0 0.0
.data 816 816 0 0.0
.data.rel.ro 25464 25464 0 0.0
.dynamic 592 592 0 0.0
.got 3984 3984 0 0.0
.init 27 27 0 0.0
.init_array 512 512 0 0.0
.rodata 127424 127424 0 0.0
.text 1076226 1076226 0 0.0
shell debug (read only) 787153 787153 0 0.0
(read/write) 57760 57760 0 0.0
.bss 16168 16168 0 0.0
.data 242 242 0 0.0
.data.rel.ro 36848 36848 0 0.0
.dynamic 592 592 0 0.0
.got 3528 3528 0 0.0
.init 27 27 0 0.0
.init_array 336 336 0 0.0
.rodata 77519 77519 0 0.0
.text 608098 608098 0 0.0
tv-app debug (read only) 1774929 1774929 0 0.0
(read/write) 289624 289624 0 0.0
.bss 223280 223280 0 0.0
.data 2032 2032 0 0.0
.data.rel.ro 58672 58672 0 0.0
.dynamic 592 592 0 0.0
.got 4408 4408 0 0.0
.init 27 27 0 0.0
.init_array 608 608 0 0.0
.rodata 154488 154488 0 0.0
.text 1478178 1478178 0 0.0
mbed all-clusters-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2291400 2291400 0 0.0
.bss 180620 180620 0 0.0
.data 5192 5192 0 0.0
.heap 850632 850632 0 0.0
.text 1254000 1254000 0 0.0
lighting-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2275608 2275608 0 0.0
.bss 172820 172820 0 0.0
.data 5568 5568 0 0.0
.heap 858056 858056 0 0.0
.text 1238208 1238208 0 0.0
lock-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2253328 2253328 0 0.0
.bss 171724 171724 0 0.0
.data 5552 5552 0 0.0
.heap 859168 859168 0 0.0
.text 1215928 1215928 0 0.0
pigweed-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 1139744 1139744 0 0.0
.bss 11752 11752 0 0.0
.data 4368 4368 0 0.0
.heap 1020328 1020328 0 0.0
.text 103128 103128 0 0.0
shell CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2048976 2048976 0 0.0
.bss 156208 156208 0 0.0
.data 4968 4968 0 0.0
.heap 875272 875272 0 0.0
.text 1011576 1011576 0 0.0
nrfconnect lighting-app nrf52840dk_nrf52840 (read/write) 863535 863535 0 0.0
bss 112132 112132 0 0.0
rodata 97816 97816 0 0.0
text 577960 577960 0 0.0
nrf52840dk_nrf52840+rpc (read/write) 824363 824363 0 0.0
bss 108372 108372 0 0.0
rodata 88596 88596 0 0.0
text 551136 551136 0 0.0
nrf5340dk_nrf5340_cpuapp (read/write) 788526 788526 0 0.0
bss 113504 113504 0 0.0
rodata 93056 93056 0 0.0
text 507428 507428 0 0.0
lock-app nrf52840dk_nrf52840 (read/write) 840211 840211 0 0.0
bss 111168 111168 0 0.0
rodata 94172 94172 0 0.0
text 559444 559444 0 0.0
nrf5340dk_nrf5340_cpuapp (read/write) 765506 765506 0 0.0
bss 112576 112576 0 0.0
rodata 89476 89476 0 0.0
text 489004 489004 0 0.0
pigweed-app nrf52840dk_nrf52840 (read/write) 497323 497323 0 0.0
bss 51824 51824 0 0.0
rodata 45776 45776 0 0.0
text 339436 339436 0 0.0
pump-app nrf52840dk_nrf52840 (read/write) 844911 844911 0 0.0
bss 111304 111304 0 0.0
rodata 95416 95416 0 0.0
text 562656 562656 0 0.0
pump-controller-app nrf52840dk_nrf52840 (read/write) 840199 840199 0 0.0
bss 111200 111200 0 0.0
rodata 94192 94192 0 0.0
text 559288 559288 0 0.0
shell nrf52840dk_nrf52840 (read/write) 776435 776435 0 0.0
bss 109072 109072 0 0.0
rodata 72536 72536 0 0.0
text 520236 520236 0 0.0
nrf5340dk_nrf5340_cpuapp (read/write) 691490 691490 0 0.0
bss 110056 110056 0 0.0
rodata 67180 67180 0 0.0
text 440848 440848 0 0.0
p6 lock-app default (read/write) 2169744 2169744 0 0.0
.bss 67168 67168 0 0.0
.data 2416 2416 0 0.0
.heap 963760 963760 0 0.0
.text 1128008 1128008 0 0.0
qpg lighting-app qpg6100+debug (read only) 491224 491224 0 0.0
(read/write) 114144 114144 0 0.0
.bss 51288 51288 0 0.0
.data 1000 1000 0 0.0
.text 485904 485904 0 0.0
lock-app qpg6100+debug (read only) 467556 467556 0 0.0
(read/write) 114140 114140 0 0.0
.bss 50240 50240 0 0.0
.data 956 956 0 0.0
.text 462236 462236 0 0.0
persistent-storage-app qpg6100+debug (read only) 155236 155236 0 0.0
(read/write) 114140 114140 0 0.0
.bss 27752 27752 0 0.0
.data 372 372 0 0.0
.text 149916 149916 0 0.0
telink lighting-app tlsr9518adk80d (read/write) 665202 665202 0 0.0
bss 69944 69944 0 0.0
noinit 33216 33216 0 0.0
text 458454 458454 0 0.0

@andy31415 andy31415 merged commit 06f9a38 into project-chip:master Oct 29, 2021
@ATmobica ATmobica deleted the mbed-os-add-docs branch November 3, 2021 17:31
PSONALl pushed a commit to PSONALl/connectedhomeip that referenced this pull request Dec 3, 2021
@ATmobica
[Mbed] Mbed platform documentation (project-chip#11121)
b885522 
* Add Mbed OS guides
Add README file to lighting-app and lock-app

* Update the Mbed OS guides
Add mbed os guides images

* Update lock and lighting apps README files

* Add all-clusters-app and pigweed-app README files
Small fixes in lock and ligthing app docs

* Add Mbed Unit Tests README file
Docs files restyle

* Add shell example README file
Restyle docs

* Restyle shell doc

* Fix spelling

* Fix spelling
Include the missing words into the dictionary

* Fix wordlist
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@andy31415 andy31415 andy31415 approved these changes

@woody-apple woody-apple woody-apple approved these changes

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

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

@bzbarsky-apple bzbarsky-apple Awaiting requested review from bzbarsky-apple

@carol-apple carol-apple Awaiting requested review from carol-apple

@chrisdecenzo chrisdecenzo Awaiting requested review from chrisdecenzo

@chulspro chulspro Awaiting requested review from chulspro

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

@emargolis emargolis Awaiting requested review from emargolis

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

@harimau-qirex harimau-qirex Awaiting requested review from harimau-qirex

@hawk248 hawk248 Awaiting requested review from hawk248

@holbrookt holbrookt Awaiting requested review from holbrookt

@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

@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

@mspang mspang Awaiting requested review from mspang

@pan-apple pan-apple Awaiting requested review from pan-apple

@robszewczyk robszewczyk Awaiting requested review from robszewczyk

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

@saurabhst saurabhst Awaiting requested review from saurabhst

@selissia selissia Awaiting requested review from selissia

@tcarmelveilleux tcarmelveilleux Awaiting requested review from tcarmelveilleux

@tecimovic tecimovic Awaiting requested review from tecimovic

@turon turon Awaiting requested review from turon

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

@wbschiller wbschiller Awaiting requested review from wbschiller

@yunhanw-google yunhanw-google Awaiting requested review from yunhanw-google

@electrocucaracha electrocucaracha Awaiting requested review from electrocucaracha

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation examples fast track github review - pending
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@ATmobica @woody-apple @andy31415 @electrocucaracha