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

Add documentation for commissioning parameters. #16262

Merged
merged 4 commits into from
Mar 18, 2022
Merged

Add documentation for commissioning parameters. #16262

merged 4 commits into from
Mar 18, 2022

Conversation

cecille
Copy link
Contributor

@cecille cecille commented Mar 16, 2022

Problem

There are a lot of commissioning parameters and not a log of documentation. This addresses both how the AutoCommissioner uses the parameters and when an externally provided CommissioningDelegate would provide them.

Change overview

add documentation

Testing

Comments only

msandstedt
msandstedt approved these changes Mar 16, 2022
View reviewed changes
Copy link
Contributor

@msandstedt msandstedt left a comment

Choose a reason for hiding this comment

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

Minor comments inline. But for the most part, the content seems accurate and I'm sure will be useful.

@github-actions
Copy link

github-actions bot commented Mar 16, 2022 •
edited
Loading

PR #16262: Size comparison from 046100b to e089e2c

Full report (18 builds for cyw30739, efr32, esp32, k32w, linux, mbed, nrfconnect, p6, telink)
platform target config section 046100b e089e2c change % change
cyw30739 light cyw930739m2evb_01 (read/write) 602866 602866 0 0.0
.app_xip_area 509948 509948 0 0.0
.bss 75672 75672 0 0.0
.data 596 596 0 0.0
.rodata 0 0 0 0.0
.text 0 0 0 0.0
lock cyw930739m2evb_01 (read/write) 560654 560654 0 0.0
.app_xip_area 469264 469264 0 0.0
.bss 74176 74176 0 0.0
.data 560 560 0 0.0
.rodata 0 0 0 0.0
.text 0 0 0 0.0
ota-requestor-no-progress-logging cyw930739m2evb_01 (read/write) 570530 570530 0 0.0
.app_xip_area 469492 469492 0 0.0
.bss 83480 83480 0 0.0
.data 520 520 0 0.0
.rodata 0 0 0 0.0
.text 112 112 0 0.0
efr32 lighting-app BRD4161A (read only) 920068 920068 0 0.0
(read/write) 128768 128768 0 0.0
.bss 126760 126760 0 0.0
.data 2008 2008 0 0.0
.text 920060 920060 0 0.0
BRD4161A+rpc (read only) 948872 948872 0 0.0
(read/write) 144728 144728 0 0.0
.bss 142536 142536 0 0.0
.data 2188 2188 0 0.0
.text 948864 948864 0 0.0
window-app BRD4161A (read only) 850816 850816 0 0.0
(read/write) 126728 126728 0 0.0
.bss 124864 124864 0 0.0
.data 1864 1864 0 0.0
.text 850808 850808 0 0.0
esp32 all-clusters-app c3devkit (read only) 961626 961626 0 0.0
(read/write) 1395066 1395066 0 0.0
.dram0.bss 64064 64064 0 0.0
.dram0.data 14188 14188 0 0.0
.flash.rodata 197904 197904 0 0.0
.flash.text 961626 961626 0 0.0
.iram0.text 62016 62016 0 0.0
m5stack (read only) 1017135 1017135 0 0.0
(read/write) 462284 462284 0 0.0
.dram0.bss 69592 69592 0 0.0
.dram0.data 34016 34016 0 0.0
.flash.rodata 226840 226840 0 0.0
.flash.text 1011751 1011751 0 0.0
.iram0.text 123107 123107 0 0.0
k32w light k32w061+release (read/write) 699568 699568 0 0.0
.bss 77640 77640 0 0.0
.data 1888 1888 0 0.0
.text 614240 614240 0 0.0
lock k32w061+release (read/write) 699872 699872 0 0.0
.bss 77632 77632 0 0.0
.data 1908 1908 0 0.0
.text 614532 614532 0 0.0
linux chip-tool-ipv6only arm64 (read only) 9753668 9753668 0 0.0
(read/write) 475441 475441 0 0.0
.bss 44017 44017 0 0.0
.data 1128 1128 0 0.0
.data.rel.ro 371232 371232 0 0.0
.dynamic 560 560 0 0.0
.got 55264 55264 0 0.0
.init 24 24 0 0.0
.init_array 192 192 0 0.0
.rodata 492348 492348 0 0.0
.text 8211444 8211444 0 0.0
thermostat-no-ble arm64 (read only) 2207772 2207772 0 0.0
(read/write) 149409 149409 0 0.0
.bss 65681 65681 0 0.0
.data 1024 1024 0 0.0
.data.rel.ro 75368 75368 0 0.0
.dynamic 560 560 0 0.0
.got 4352 4352 0 0.0
.init 24 24 0 0.0
.init_array 360 360 0 0.0
.rodata 136908 136908 0 0.0
.text 1851552 1851552 0 0.0
mbed lock-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2352908 2352908 0 0.0
.bss 186660 186660 0 0.0
.data 5752 5752 0 0.0
.text 1315508 1315508 0 0.0
nrfconnect all-clusters-app nrf52840dk_nrf52840 (read/write) 1154267 1154267 0 0.0
bss 146740 146740 0 0.0
rodata 145356 145356 0 0.0
text 787028 787028 0 0.0
p6 all-clusters-app default (read/write) 2492256 2492256 0 0.0
.bss 120088 120088 0 0.0
.data 2632 2632 0 0.0
.text 1450520 1450520 0 0.0
light-app default (read/write) 2396104 2396104 0 0.0
.bss 113552 113552 0 0.0
.data 2488 2488 0 0.0
.text 1354368 1354368 0 0.0
lock-app default (read/write) 2359648 2359648 0 0.0
.bss 113296 113296 0 0.0
.data 2448 2448 0 0.0
.text 1317912 1317912 0 0.0
telink lighting-app tlsr9518adk80d (read/write) 894098 894098 0 0.0
bss 87448 87448 0 0.0
noinit 37160 37160 0 0.0
text 632098 632098 0 0.0

@restyled-io restyled-io bot mentioned this pull request Mar 16, 2022
Closed
@github-actions
Copy link

github-actions bot commented Mar 16, 2022 •
edited
Loading

PR #16262: Size comparison from 046100b to 7938453

Increases above 0.2%:

platform target config section 046100b 7938453 change % change
linux thermostat-no-ble arm64 (read only) 2207772 2219932 12160 0.6
(read/write) 149409 149809 400 0.3
.data.rel.ro 75368 75696 328 0.4
.rodata 136908 137660 752 0.5
.text 1851552 1862304 10752 0.6
Increases (18 builds for cyw30739, efr32, esp32, k32w, linux, mbed, nrfconnect, p6, telink)
platform target config section 046100b 7938453 change % change
cyw30739 light cyw930739m2evb_01 (read/write) 602866 603354 488 0.1
.app_xip_area 509948 510436 488 0.1
lock cyw930739m2evb_01 (read/write) 560654 561142 488 0.1
.app_xip_area 469264 469752 488 0.1
ota-requestor-no-progress-logging cyw930739m2evb_01 (read/write) 570530 571018 488 0.1
.app_xip_area 469492 469980 488 0.1
efr32 lighting-app BRD4161A (read only) 920068 920996 928 0.1
.text 920060 920988 928 0.1
BRD4161A+rpc (read only) 948872 949800 928 0.1
.text 948864 949792 928 0.1
window-app BRD4161A (read only) 850816 851760 944 0.1
.text 850808 851752 944 0.1
esp32 all-clusters-app c3devkit (read only) 961626 961808 182 0.0
(read/write) 1395066 1395154 88 0.0
.flash.rodata 197904 197992 88 0.0
.flash.text 961626 961808 182 0.0
m5stack (read only) 1017135 1017283 148 0.0
(read/write) 462284 462380 96 0.0
.flash.rodata 226840 226936 96 0.0
.flash.text 1011751 1011899 148 0.0
k32w light k32w061+release (read/write) 699568 700040 472 0.1
.bss 77640 77648 8 0.0
.text 614240 614704 464 0.1
lock k32w061+release (read/write) 699872 700336 464 0.1
.bss 77632 77640 8 0.0
.text 614532 614988 456 0.1
linux chip-tool-ipv6only arm64 (read only) 9753668 9754132 464 0.0
(read/write) 475441 475473 32 0.0
.bss 44017 44033 16 0.0
.data.rel.ro 371232 371256 24 0.0
.text 8211444 8211892 448 0.0
thermostat-no-ble arm64 (read only) 2207772 2219932 12160 0.6
(read/write) 149409 149809 400 0.3
.bss 65681 65745 64 0.1
.data.rel.ro 75368 75696 328 0.4
.rodata 136908 137660 752 0.5
.text 1851552 1862304 10752 0.6
mbed lock-app CY8CPROTO_062_4343W+release (read/write) 2352908 2353124 216 0.0
.text 1315508 1315724 216 0.0
nrfconnect all-clusters-app nrf52840dk_nrf52840 (read/write) 1154267 1154739 472 0.0
rodata 145356 145444 88 0.1
text 787028 787408 380 0.0
p6 all-clusters-app default (read/write) 2492256 2492904 648 0.0
.text 1450520 1451168 648 0.0
light-app default (read/write) 2396104 2396744 640 0.0
.text 1354368 1355008 640 0.0
lock-app default (read/write) 2359648 2360296 648 0.0
.text 1317912 1318560 648 0.0
telink lighting-app tlsr9518adk80d (read/write) 894098 894654 556 0.1
text 632098 632562 464 0.1
Full report (18 builds for cyw30739, efr32, esp32, k32w, linux, mbed, nrfconnect, p6, telink)
platform target config section 046100b 7938453 change % change
cyw30739 light cyw930739m2evb_01 (read/write) 602866 603354 488 0.1
.app_xip_area 509948 510436 488 0.1
.bss 75672 75672 0 0.0
.data 596 596 0 0.0
.rodata 0 0 0 0.0
.text 0 0 0 0.0
lock cyw930739m2evb_01 (read/write) 560654 561142 488 0.1
.app_xip_area 469264 469752 488 0.1
.bss 74176 74176 0 0.0
.data 560 560 0 0.0
.rodata 0 0 0 0.0
.text 0 0 0 0.0
ota-requestor-no-progress-logging cyw930739m2evb_01 (read/write) 570530 571018 488 0.1
.app_xip_area 469492 469980 488 0.1
.bss 83480 83480 0 0.0
.data 520 520 0 0.0
.rodata 0 0 0 0.0
.text 112 112 0 0.0
efr32 lighting-app BRD4161A (read only) 920068 920996 928 0.1
(read/write) 128768 128768 0 0.0
.bss 126760 126760 0 0.0
.data 2008 2008 0 0.0
.text 920060 920988 928 0.1
BRD4161A+rpc (read only) 948872 949800 928 0.1
(read/write) 144728 144728 0 0.0
.bss 142536 142536 0 0.0
.data 2188 2188 0 0.0
.text 948864 949792 928 0.1
window-app BRD4161A (read only) 850816 851760 944 0.1
(read/write) 126728 126728 0 0.0
.bss 124864 124864 0 0.0
.data 1864 1864 0 0.0
.text 850808 851752 944 0.1
esp32 all-clusters-app c3devkit (read only) 961626 961808 182 0.0
(read/write) 1395066 1395154 88 0.0
.dram0.bss 64064 64064 0 0.0
.dram0.data 14188 14188 0 0.0
.flash.rodata 197904 197992 88 0.0
.flash.text 961626 961808 182 0.0
.iram0.text 62016 62016 0 0.0
m5stack (read only) 1017135 1017283 148 0.0
(read/write) 462284 462380 96 0.0
.dram0.bss 69592 69592 0 0.0
.dram0.data 34016 34016 0 0.0
.flash.rodata 226840 226936 96 0.0
.flash.text 1011751 1011899 148 0.0
.iram0.text 123107 123107 0 0.0
k32w light k32w061+release (read/write) 699568 700040 472 0.1
.bss 77640 77648 8 0.0
.data 1888 1888 0 0.0
.text 614240 614704 464 0.1
lock k32w061+release (read/write) 699872 700336 464 0.1
.bss 77632 77640 8 0.0
.data 1908 1908 0 0.0
.text 614532 614988 456 0.1
linux chip-tool-ipv6only arm64 (read only) 9753668 9754132 464 0.0
(read/write) 475441 475473 32 0.0
.bss 44017 44033 16 0.0
.data 1128 1128 0 0.0
.data.rel.ro 371232 371256 24 0.0
.dynamic 560 560 0 0.0
.got 55264 55264 0 0.0
.init 24 24 0 0.0
.init_array 192 192 0 0.0
.rodata 492348 492348 0 0.0
.text 8211444 8211892 448 0.0
thermostat-no-ble arm64 (read only) 2207772 2219932 12160 0.6
(read/write) 149409 149809 400 0.3
.bss 65681 65745 64 0.1
.data 1024 1024 0 0.0
.data.rel.ro 75368 75696 328 0.4
.dynamic 560 560 0 0.0
.got 4352 4352 0 0.0
.init 24 24 0 0.0
.init_array 360 360 0 0.0
.rodata 136908 137660 752 0.5
.text 1851552 1862304 10752 0.6
mbed lock-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2352908 2353124 216 0.0
.bss 186660 186660 0 0.0
.data 5752 5752 0 0.0
.text 1315508 1315724 216 0.0
nrfconnect all-clusters-app nrf52840dk_nrf52840 (read/write) 1154267 1154739 472 0.0
bss 146740 146740 0 0.0
rodata 145356 145444 88 0.1
text 787028 787408 380 0.0
p6 all-clusters-app default (read/write) 2492256 2492904 648 0.0
.bss 120088 120088 0 0.0
.data 2632 2632 0 0.0
.text 1450520 1451168 648 0.0
light-app default (read/write) 2396104 2396744 640 0.0
.bss 113552 113552 0 0.0
.data 2488 2488 0 0.0
.text 1354368 1355008 640 0.0
lock-app default (read/write) 2359648 2360296 648 0.0
.bss 113296 113296 0 0.0
.data 2448 2448 0 0.0
.text 1317912 1318560 648 0.0
telink lighting-app tlsr9518adk80d (read/write) 894098 894654 556 0.1
bss 87448 87448 0 0.0
noinit 37160 37160 0 0.0
text 632098 632562 464 0.1

@cecille cecille merged commit 2a692ef into project-chip:master Mar 18, 2022
@cecille cecille deleted the document_commissioning_parameters branch March 18, 2022 20:16
@cecille cecille mentioned this pull request Mar 29, 2022
Closed
andrei-menzopol pushed a commit to andrei-menzopol/connectedhomeip that referenced this pull request Apr 14, 2022
@cecille @msandstedt
@restyled-commits @andrei-menzopol
Add documentation for commissioning parameters. (project-chip#16262)
336d033 
* Add documentation for commissioning parameters.

* Update src/controller/CommissioningDelegate.h

Co-authored-by: Michael Sandstedt <[email protected]>

* Update src/controller/CommissioningDelegate.h

Co-authored-by: Michael Sandstedt <[email protected]>

* Restyled by clang-format

Co-authored-by: Michael Sandstedt <[email protected]>
Co-authored-by: Restyled.io <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

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

@msandstedt msandstedt msandstedt approved these changes

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

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

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

@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

@erjiaqing erjiaqing Awaiting requested review from erjiaqing

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

@gjc13 gjc13 Awaiting requested review from gjc13

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

@hawk248 hawk248 Awaiting requested review from hawk248

@holbrookt holbrookt Awaiting requested review from holbrookt

@harsha-rajendran harsha-rajendran Awaiting requested review from harsha-rajendran

@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

@kpschoedel kpschoedel Awaiting requested review from kpschoedel

@lazarkov lazarkov Awaiting requested review from lazarkov

@LuDuda LuDuda Awaiting requested review from LuDuda

@lzgrablic02 lzgrablic02 Awaiting requested review from lzgrablic02

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

@mrjerryjohns mrjerryjohns Awaiting requested review from mrjerryjohns

@mspang mspang Awaiting requested review from mspang

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

@saurabhst saurabhst Awaiting requested review from saurabhst

@selissia selissia Awaiting requested review from selissia

@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
controller review - approved
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@cecille @msandstedt @bzbarsky-apple @restyled-commits