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 a guide on how to troubleshoot avahi #14926

Merged
merged 1 commit into from
Feb 9, 2022
Merged

Add a guide on how to troubleshoot avahi #14926

merged 1 commit into from
Feb 9, 2022

Conversation

cecille
Copy link
Contributor

@cecille cecille commented Feb 9, 2022

Problem

Avahi is finicky, but we don't have good documentation on how to tame it.

Change overview

Add troubleshooting doc for avahi.

Testing

Tested suggestions on company developer who was setting up avahi for the first time.

@cecille
Add a guide on how to troubleshoot avahi
340f8ee 
Covers some common errors when using platform mdns on linux.
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Feb 9, 2022
@kghost
Copy link
Contributor

kghost commented Feb 9, 2022

The document covers several typical errors, it definitely helps.

@woody-apple woody-apple merged commit 5ace0cd into project-chip:master Feb 9, 2022
@github-actions
Copy link

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

PR #14926: Size comparison from 3ef9ec3 to 340f8ee

Full report (43 builds for cyw30739, efr32, esp32, k32w, linux, mbed, nrfconnect, p6, qpg, telink)
platform target config section 3ef9ec3 340f8ee change % change
cyw30739 light cyw930739m2evb_01 (read/write) 595382 595382 0 0.0
.app_xip_area 500916 500916 0 0.0
.bss 77188 77188 0 0.0
.data 624 624 0 0.0
.rodata 0 0 0 0.0
.text 0 0 0 0.0
lock cyw930739m2evb_01 (read/write) 556334 556334 0 0.0
.app_xip_area 463404 463404 0 0.0
.bss 75684 75684 0 0.0
.data 588 588 0 0.0
.rodata 0 0 0 0.0
.text 0 0 0 0.0
ota-requestor cyw930739m2evb_01 (read/write) 577314 577314 0 0.0
.app_xip_area 475088 475088 0 0.0
.bss 84652 84652 0 0.0
.data 532 532 0 0.0
.rodata 0 0 0 0.0
.text 112 112 0 0.0
efr32 lighting-app BRD4161A (read only) 866340 866340 0 0.0
(read/write) 126684 126684 0 0.0
.bss 124760 124760 0 0.0
.data 1924 1924 0 0.0
.text 866332 866332 0 0.0
BRD4161A+rpc (read only) 853788 853788 0 0.0
(read/write) 143344 143344 0 0.0
.bss 141320 141320 0 0.0
.data 2024 2024 0 0.0
.text 853780 853780 0 0.0
window-app BRD4161A (read only) 838544 838544 0 0.0
(read/write) 125328 125328 0 0.0
.bss 123448 123448 0 0.0
.data 1880 1880 0 0.0
.text 838536 838536 0 0.0
esp32 all-clusters-app c3devkit (read only) 939198 939198 0 0.0
(read/write) 1401834 1401834 0 0.0
.dram0.bss 70024 70024 0 0.0
.dram0.data 14260 14260 0 0.0
.flash.rodata 198640 198640 0 0.0
.flash.text 939198 939198 0 0.0
.iram0.text 62056 62056 0 0.0
m5stack (read only) 987355 987355 0 0.0
(read/write) 466852 466852 0 0.0
.dram0.bss 75160 75160 0 0.0
.dram0.data 34024 34024 0 0.0
.flash.rodata 225540 225540 0 0.0
.flash.text 981971 981971 0 0.0
.iram0.text 123399 123399 0 0.0
k32w light k32w061+release (read/write) 679212 679212 0 0.0
.bss 76632 76632 0 0.0
.data 1884 1884 0 0.0
.text 594896 594896 0 0.0
lock k32w061+release (read/write) 684012 684012 0 0.0
.bss 76984 76984 0 0.0
.data 1928 1928 0 0.0
.text 599300 599300 0 0.0
linux all-clusters-app debug (read only) 2334969 2334969 0 0.0
(read/write) 140640 140640 0 0.0
.bss 55200 55200 0 0.0
.data 1168 1168 0 0.0
.data.rel.ro 78600 78600 0 0.0
.dynamic 592 592 0 0.0
.got 4136 4136 0 0.0
.init 27 27 0 0.0
.init_array 920 920 0 0.0
.rodata 205285 205285 0 0.0
.text 1967362 1967362 0 0.0
bridge-app debug+rpc (read only) 1705909 1705909 0 0.0
(read/write) 84328 84328 0 0.0
.bss 39088 39088 0 0.0
.data 1970 1970 0 0.0
.data.rel.ro 38120 38120 0 0.0
.dynamic 592 592 0 0.0
.got 3976 3976 0 0.0
.init 27 27 0 0.0
.init_array 560 560 0 0.0
.rodata 140332 140332 0 0.0
.text 1449029 1449029 0 0.0
chip-tool debug (read only) 7472205 7472205 0 0.0
(read/write) 197048 197048 0 0.0
.bss 32360 32360 0 0.0
.data 1152 1152 0 0.0
.data.rel.ro 157512 157512 0 0.0
.dynamic 608 608 0 0.0
.got 4784 4784 0 0.0
.init 27 27 0 0.0
.init_array 616 616 0 0.0
.rodata 414773 414773 0 0.0
.text 6657285 6657285 0 0.0
chip-tool-ipv6only arm64 (read only) 7394508 7394508 0 0.0
(read/write) 301233 301233 0 0.0
.bss 50641 50641 0 0.0
.data 1176 1176 0 0.0
.data.rel.ro 199216 199216 0 0.0
.dynamic 560 560 0 0.0
.got 46400 46400 0 0.0
.init 24 24 0 0.0
.init_array 192 192 0 0.0
.rodata 397316 397316 0 0.0
.text 6360180 6360180 0 0.0
door-lock-app debug (read only) 1910633 1910633 0 0.0
(read/write) 110680 110680 0 0.0
.bss 42160 42160 0 0.0
.data 946 946 0 0.0
.data.rel.ro 62160 62160 0 0.0
.dynamic 592 592 0 0.0
.got 4112 4112 0 0.0
.init 27 27 0 0.0
.init_array 672 672 0 0.0
.rodata 171858 171858 0 0.0
.text 1590258 1590258 0 0.0
lighting-app debug+rpc (read only) 2005193 2005193 0 0.0
(read/write) 115632 115632 0 0.0
.bss 43104 43104 0 0.0
.data 1368 1368 0 0.0
.data.rel.ro 65672 65672 0 0.0
.dynamic 608 608 0 0.0
.got 4144 4144 0 0.0
.init 27 27 0 0.0
.init_array 712 712 0 0.0
.rodata 163057 163057 0 0.0
.text 1687490 1687490 0 0.0
ota-provider-app debug (read only) 1714521 1714521 0 0.0
(read/write) 81368 81368 0 0.0
.bss 41120 41120 0 0.0
.data 1160 1160 0 0.0
.data.rel.ro 33560 33560 0 0.0
.dynamic 608 608 0 0.0
.got 4240 4240 0 0.0
.init 27 27 0 0.0
.init_array 624 624 0 0.0
.rodata 151910 151910 0 0.0
.text 1443906 1443906 0 0.0
ota-requestor-app debug (read only) 1703177 1703177 0 0.0
(read/write) 83320 83320 0 0.0
.bss 42272 42272 0 0.0
.data 1128 1128 0 0.0
.data.rel.ro 34616 34616 0 0.0
.dynamic 592 592 0 0.0
.got 4040 4040 0 0.0
.init 27 27 0 0.0
.init_array 624 624 0 0.0
.rodata 145047 145047 0 0.0
.text 1441234 1441234 0 0.0
shell debug (read only) 2308409 2308409 0 0.0
(read/write) 142224 142224 0 0.0
.bss 62592 62592 0 0.0
.data 768 768 0 0.0
.data.rel.ro 73168 73168 0 0.0
.dynamic 592 592 0 0.0
.got 4168 4168 0 0.0
.init 27 27 0 0.0
.init_array 904 904 0 0.0
.rodata 206002 206002 0 0.0
.text 1945890 1945890 0 0.0
thermostat-no-ble arm64 (read only) 2134876 2134876 0 0.0
(read/write) 141009 141009 0 0.0
.bss 57953 57953 0 0.0
.data 984 984 0 0.0
.data.rel.ro 74952 74952 0 0.0
.dynamic 560 560 0 0.0
.got 4152 4152 0 0.0
.init 24 24 0 0.0
.init_array 336 336 0 0.0
.rodata 132316 132316 0 0.0
.text 1784400 1784400 0 0.0
tv-app debug (read only) 2525753 2525753 0 0.0
(read/write) 140056 140056 0 0.0
.bss 57568 57568 0 0.0
.data 3168 3168 0 0.0
.data.rel.ro 73288 73288 0 0.0
.dynamic 592 592 0 0.0
.got 4528 4528 0 0.0
.init 27 27 0 0.0
.init_array 880 880 0 0.0
.rodata 197196 197196 0 0.0
.text 2155186 2155186 0 0.0
mbed all-clusters-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2390920 2390920 0 0.0
.bss 188932 188932 0 0.0
.data 5288 5288 0 0.0
.text 1353520 1353520 0 0.0
lighting-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2349448 2349448 0 0.0
.bss 181000 181000 0 0.0
.data 5600 5600 0 0.0
.text 1312048 1312048 0 0.0
lock-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2317408 2317408 0 0.0
.bss 180912 180912 0 0.0
.data 5584 5584 0 0.0
.text 1280008 1280008 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) 2303404 2303404 0 0.0
.bss 178164 178164 0 0.0
.data 5400 5400 0 0.0
.text 1265976 1265976 0 0.0
nrfconnect lighting-app nrf52840dk_nrf52840 (read/write) 1005707 1005707 0 0.0
bss 121352 121352 0 0.0
rodata 118312 118312 0 0.0
text 687048 687048 0 0.0
nrf52840dk_nrf52840+rpc (read/write) 974551 974551 0 0.0
bss 118540 118540 0 0.0
rodata 109700 109700 0 0.0
text 666664 666664 0 0.0
nrf52840dongle_nrf52840 (read/write) 1022399 1022399 0 0.0
bss 122716 122716 0 0.0
rodata 117200 117200 0 0.0
text 692620 692620 0 0.0
nrf5340dk_nrf5340_cpuapp (read/write) 912322 912322 0 0.0
bss 117912 117912 0 0.0
rodata 111572 111572 0 0.0
text 602076 602076 0 0.0
lock-app nrf52840dk_nrf52840 (read/write) 940775 940775 0 0.0
bss 119720 119720 0 0.0
rodata 107540 107540 0 0.0
text 634956 634956 0 0.0
nrf5340dk_nrf5340_cpuapp (read/write) 848250 848250 0 0.0
bss 116312 116312 0 0.0
rodata 100708 100708 0 0.0
text 550752 550752 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) 940211 940211 0 0.0
bss 119440 119440 0 0.0
rodata 106896 106896 0 0.0
text 635212 635212 0 0.0
pump-controller-app nrf52840dk_nrf52840 (read/write) 935535 935535 0 0.0
bss 119444 119444 0 0.0
rodata 106188 106188 0 0.0
text 631244 631244 0 0.0
shell nrf52840dk_nrf52840 (read/write) 803911 803911 0 0.0
bss 111304 111304 0 0.0
rodata 78716 78716 0 0.0
text 536272 536272 0 0.0
p6 all-clusters-app default (read/write) 2465432 2465432 0 0.0
.bss 118544 118544 0 0.0
.data 2568 2568 0 0.0
.text 1423696 1423696 0 0.0
light-app default (read/write) 2367776 2367776 0 0.0
.bss 107664 107664 0 0.0
.data 2432 2432 0 0.0
.text 1326040 1326040 0 0.0
lock-app default (read/write) 2336584 2336584 0 0.0
.bss 107400 107400 0 0.0
.data 2400 2400 0 0.0
.text 1294848 1294848 0 0.0
qpg lighting-app qpg6105+debug (read only) 586368 586368 0 0.0
(read/write) 146936 146936 0 0.0
.bss 88920 88920 0 0.0
.data 1084 1084 0 0.0
.text 581048 581048 0 0.0
lock-app qpg6105+debug (read only) 535332 535332 0 0.0
(read/write) 146936 146936 0 0.0
.bss 88392 88392 0 0.0
.data 1028 1028 0 0.0
.text 530012 530012 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) 870166 870166 0 0.0
bss 88680 88680 0 0.0
noinit 37160 37160 0 0.0
text 611502 611502 0 0.0

@cecille cecille deleted the avahi_documentation branch February 9, 2022 18:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kghost kghost kghost approved these changes

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

@andy31415 andy31415 Awaiting requested review from andy31415

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

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

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

@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

@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

@LuDuda LuDuda Awaiting requested review from LuDuda

@mrjerryjohns mrjerryjohns Awaiting requested review from mrjerryjohns

@msandstedt msandstedt Awaiting requested review from msandstedt

@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

@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

@xylophone21 xylophone21 Awaiting requested review from xylophone21

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

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation review - approved
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@cecille @kghost @woody-apple