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

tv-casting-app cancel connection upon CancelPasscode CDC message from TV #35331

Merged
merged 3 commits into from
Sep 5, 2024
Merged

tv-casting-app cancel connection upon CancelPasscode CDC message from TV #35331

merged 3 commits into from
Sep 5, 2024

Conversation

pgregorr-amazon
Copy link
Contributor

@pgregorr-amazon pgregorr-amazon commented Aug 30, 2024 •
edited
Loading

Updated the common tv-casting-app Linux implementation to cancel connection attempt upon receiving CancelPasscode CDC message from CastingPlayer/Commissioner TV. This change corresponds to the following examples/tv-app change by @lazarkov: #34507

Change summary

  1. Updated CastingPlayer.h/cpp and CommissionerDeclarationHandler.h/cpp.
  2. CommissionerDeclarationHandler.h/cpp OnCommissionerDeclarationMessage(), upon receiving a CommissionerDeclaration message with CancelPasscode ==true from the CastingPlayer/Commissioner TV, calls the internal StopConnecting() API to cancel the current connection attempt.
  3. Implemented an internal version of the StopConnecting() API which can only be called by CommissionerDeclarationHandler. The public version of StopConnecting() API is unchanged and calls the internal StopConnecting() with shouldSendIdentificationDeclarationMessage set to true.
  4. Updated /connectedhomeip/examples/tv-casting-app/darwin/MatterTvCastingBridge/MatterTvCastingBridge/MCEndpoint.mm clusterForType() function to check for a null cppCluster object returned from GetCluster(). This prevents the Swift object from getting initialized with a null cpp value. This was also the cause of an iOS app crash when trying to invoke a command or read attribute in the iOS sample app.

Testing

Verified and tested locally with the Linux, Android and iOS tv-casting-app example mobile apps, and the Linux tv-app (CastingPlayer). Able to build and commission with the example apps using both the commissionee and commissioner generated passcode flows. Cancelling the connection attempt on the TV-app using “controller ux cancel” sends a CommissionerDeclaration with CancelPasscode. The tv-casting-app reads the CommissionerDeclaration with CancelPasscode and cancels the ongoing connection without replying to the TV-app.

Linux Test steps:

  1. Start Linux TV App: ./out/tv-app/chip-tv-app
  2. Start TV Casting App: ./out/tv-casting-app/chip-tv-casting-app
  3. TV App uninstall endpoint 4: app uninstall 65521 32769
  4. TV Casting App: cast request 0 or cast request 0 commissioner-generated-passcode
  5. TV App: controller ux ok
  6. TV App, to send CommissionerDeclaration with CancelPasscode flag: controller ux cancel
  7. Observe TV Casting App logs. We reset the CastingPlayer state after receiving the CommissionerDeclaration with CancelPasscode set to true: "[1725057856.727] [3844:11750597] [SVR] CastingPlayer::StopConnecting() shouldSendIdentificationDeclarationMessage: false, User Directed Commissioning stopped by the CastingPlayer/Commissioner user."
  8. TV Casting App: cast request 0 commissioner-generated-passcode
  9. TV App: controller ux ok
  10. TV Casting App: cast setcommissionerpasscode 12345678
  11. Observe TV Casting App logs, we successfully connected and started demo interactions.

iOS Test steps:

  1. Start Linux TV App: ./out/tv-app/chip-tv-app
  2. Start iOS TV Casting App from Xcode:
  3. TV App uninstall endpoint 4: app uninstall 65521 32769
  4. iOS TV Casting App UX: short or long press on the CastingPlayer
  5. TV App: controller ux ok
  6. TV App, to send CommissionerDeclaration with CancelPasscode flag: controller ux cancel
  7. Observe iOS TV Casting App logs. We reset the CastingPlayer state after receiving the CommissionerDeclaration with CancelPasscode set to true:
    "
    [0;32m[1725386754.362] [66107:12625175] [SVR] CastingPlayer::StopConnecting() shouldSendIdentificationDeclarationMessage: 0, User Directed Commissioning aborted by the CastingPlayer/Commissioner user.�[0m
    CastingPlayer::resetState()
    "
  8. Observe iOS TV Casting App UX. Since the mCmmissionerDeclarationCallback_ was not set, the mOnCompleted callback was called with the CHIP_ERROR_CONNECTION_ABORTED error. Note, if you long pressed in Step 4, you will need to press "Cancel" in the passcode input dialog. The UX screen will show a "Incorrect state" error since the "Cancel" button calls MCCastingPlayer.stopConnecting() after it has already been called once before.
  9. iOS TV Casting App UX: press "Back".
  10. iOS TV Casting App UX: long press on the CastingPlayer
  11. TV App: controller ux ok
  12. iOS TV Casting App UX passcode input dialog press "Continue Connecting"
  13. Observe iOS TV Casting App UX, we successfully connected. Click "Next" and try the demo commands like Launch URL

Android Test steps:

  1. Start Linux TV App on Raspberry PI: ./out/tv-app/chip-tv-app
  2. Start Android TV Casting App on Android phone.
  3. TV App uninstall endpoint 4: app uninstall 65521 32769
  4. Android TV Casting App UX: short or long press on the CastingPlayer
  5. TV App: controller ux ok
  6. TV App, to send CommissionerDeclaration with CancelPasscode flag: controller ux cancel
  7. Observe Android TV Casting App logs. We reset the CastingPlayer state after receiving the CommissionerDeclaration with CancelPasscode set to true:
    "
    2024-09-04 12:05:30.573 28756-28788 SVR com.chip.casting I CastingPlayer::StopConnecting() shouldSendIdentificationDeclarationMessage: 0, User Directed Commissioning aborted by the CastingPlayer/Commissioner user.
    2024-09-04 12:05:30.573 28756-28788 SVR com.chip.casting E MatterCastingPlayer-JNI::verifyOrEstablishConnection() ConnectCallback() Connection error: examples/tv-casting-app/tv-casting-common/core/CastingPlayer.cpp:263: CHIP Error 0x00000002: Connection aborted
    "
  8. Observe Android TV Casting App UX. Since the mCmmissionerDeclarationCallback_ was not set, the mOnCompleted callback was called with the CHIP_ERROR_CONNECTION_ABORTED error. Note, if you long pressed in Step 4, you will need to press "Cancel" in the passcode input dialog. The UX screen will show a "errorCode=3" error since the "Cancel" button calls MCCastingPlayer.stopConnecting() after it has already been called once before.
  9. Android TV Casting App UX: press "Back".
  10. Android TV Casting App UX: long press on the CastingPlayer
  11. TV App: controller ux ok
  12. Android TV Casting App UX passcode input dialog press "Continue Connecting"
  13. Observe Android Casting App UX, we successfully connected. Click "Next" and try the demo commands like Launch URL

@semanticdiff-com SemanticDiff.com
Copy link

Review changes with SemanticDiff.

@github-actions GitHub Actions
Copy link

github-actions bot commented Aug 30, 2024 •
edited
Loading

PR #35331: Size comparison from 3d69583 to ecc5f9e

Full report (77 builds for bl602, bl702, bl702l, cyw30739, efr32, esp32, linux, nrfconnect, nxp, psoc6, qpg, stm32, telink, tizen)
platform target config section 3d69583 ecc5f9e change % change
bl602 lighting-app bl602 FLASH 1279092 1279092 0 0.0
RAM 95880 95880 0 0.0
bl602+mfd FLASH 1293202 1293202 0 0.0
RAM 96024 96024 0 0.0
bl602+rpc FLASH 1318056 1318056 0 0.0
RAM 104304 104304 0 0.0
bl702 lighting-app bl702 FLASH 944678 944678 0 0.0
RAM 15209 15209 0 0.0
bl702+mfd FLASH 947078 947078 0 0.0
RAM 15353 15353 0 0.0
bl702+rpc FLASH 1039734 1039734 0 0.0
RAM 24221 24221 0 0.0
bl706-eth FLASH 647494 647494 0 0.0
RAM 25305 25305 0 0.0
bl706-wifi FLASH 894908 894908 0 0.0
RAM 14525 14525 0 0.0
bl702l lighting-app bl702l FLASH 961082 961082 0 0.0
RAM 16868 16868 0 0.0
bl702l+mfd FLASH 963704 963704 0 0.0
RAM 17012 17012 0 0.0
cyw30739 light CYW30739B2-P5-EVK-01 unknown 2040 2040 0 0.0
FLASH 672761 672761 0 0.0
RAM 78300 78300 0 0.0
CYW30739B2-P5-EVK-02 unknown 2040 2040 0 0.0
FLASH 692621 692621 0 0.0
RAM 80932 80932 0 0.0
CYW30739B2-P5-EVK-03 unknown 2040 2040 0 0.0
FLASH 692621 692621 0 0.0
RAM 80932 80932 0 0.0
CYW930739M2EVB-02 unknown 2040 2040 0 0.0
FLASH 649549 649549 0 0.0
RAM 73368 73368 0 0.0
light-switch CYW30739B2-P5-EVK-01 unknown 2040 2040 0 0.0
FLASH 611193 611193 0 0.0
RAM 71292 71292 0 0.0
CYW30739B2-P5-EVK-02 unknown 2040 2040 0 0.0
FLASH 630821 630821 0 0.0
RAM 73844 73844 0 0.0
CYW30739B2-P5-EVK-03 unknown 2040 2040 0 0.0
FLASH 630821 630821 0 0.0
RAM 73844 73844 0 0.0
lock CYW30739B2-P5-EVK-01 unknown 2040 2040 0 0.0
FLASH 629233 629233 0 0.0
RAM 74308 74308 0 0.0
CYW30739B2-P5-EVK-02 unknown 2040 2040 0 0.0
FLASH 648941 648941 0 0.0
RAM 76860 76860 0 0.0
CYW30739B2-P5-EVK-03 unknown 2040 2040 0 0.0
FLASH 648941 648941 0 0.0
RAM 76860 76860 0 0.0
thermostat CYW30739B2-P5-EVK-01 unknown 2040 2040 0 0.0
FLASH 603501 603501 0 0.0
RAM 68348 68348 0 0.0
CYW30739B2-P5-EVK-02 unknown 2040 2040 0 0.0
FLASH 623361 623361 0 0.0
RAM 70980 70980 0 0.0
CYW30739B2-P5-EVK-03 unknown 2040 2040 0 0.0
FLASH 623361 623361 0 0.0
RAM 70980 70980 0 0.0
efr32 lighting-app BRD4187C FLASH 930852 930844 -8 -0.0
RAM 135096 135096 0 0.0
lock-app BRD4338a FLASH 740996 740988 -8 -0.0
RAM 209516 209516 0 0.0
window-app BRD4187C FLASH 1015936 1015928 -8 -0.0
RAM 127036 127036 0 0.0
esp32 all-clusters-app c3devkit DRAM 94200 94200 0 0.0
FLASH 1535006 1535006 0 0.0
IRAM 82538 82538 0 0.0
m5stack DRAM 115136 115136 0 0.0
FLASH 1544966 1544966 0 0.0
IRAM 117039 117039 0 0.0
linux air-purifier-app debug unknown 4624 4624 0 0.0
FLASH 2763653 2763653 0 0.0
RAM 128536 128536 0 0.0
all-clusters-app debug unknown 5408 5408 0 0.0
FLASH 6056390 6056390 0 0.0
RAM 510328 510328 0 0.0
all-clusters-minimal-app debug unknown 5304 5304 0 0.0
FLASH 5386658 5386658 0 0.0
RAM 240248 240248 0 0.0
bridge-app debug unknown 5288 5288 0 0.0
FLASH 4732238 4732238 0 0.0
RAM 217368 217368 0 0.0
chip-tool debug unknown 5832 5832 0 0.0
FLASH 12650904 12650904 0 0.0
RAM 558354 558354 0 0.0
chip-tool-ipv6only arm64 unknown 20352 20352 0 0.0
FLASH 11322780 11322780 0 0.0
RAM 608424 608424 0 0.0
fabric-admin debug unknown 5664 5664 0 0.0
FLASH 10932537 10932537 0 0.0
RAM 556762 556762 0 0.0
fabric-bridge-app debug unknown 4520 4520 0 0.0
FLASH 4555346 4555346 0 0.0
RAM 203984 203984 0 0.0
lighting-app debug+rpc+ui unknown 5936 5936 0 0.0
FLASH 5668017 5668017 0 0.0
RAM 228056 228056 0 0.0
lock-app debug unknown 5224 5224 0 0.0
FLASH 4787062 4787062 0 0.0
RAM 203768 203768 0 0.0
ota-provider-app debug unknown 4600 4600 0 0.0
FLASH 4426600 4426600 0 0.0
RAM 197752 197752 0 0.0
ota-requestor-app debug unknown 4536 4536 0 0.0
FLASH 4565186 4565186 0 0.0
RAM 202288 202288 0 0.0
shell debug unknown 4176 4176 0 0.0
FLASH 3088141 3088141 0 0.0
RAM 159040 159040 0 0.0
thermostat-no-ble arm64 unknown 9296 9296 0 0.0
FLASH 4325884 4325884 0 0.0
RAM 241896 241896 0 0.0
tv-app debug unknown 5504 5504 0 0.0
FLASH 6011589 6011589 0 0.0
RAM 583192 583192 0 0.0
tv-casting-app debug unknown 5168 5168 0 0.0
FLASH 10854941 10854941 0 0.0
RAM 645768 645768 0 0.0
nrfconnect all-clusters-app nrf52840dk_nrf52840 FLASH 911048 911048 0 0.0
RAM 142219 142219 0 0.0
nrf7002dk_nrf5340_cpuapp FLASH 882772 882772 0 0.0
RAM 140358 140358 0 0.0
all-clusters-minimal-app nrf52840dk_nrf52840 FLASH 842316 842316 0 0.0
RAM 141038 141038 0 0.0
nxp contact k32w0+release FLASH 577796 577796 0 0.0
RAM 70444 70444 0 0.0
k32w1+release FLASH 590416 590416 0 0.0
RAM 62488 62488 0 0.0
light k32w0+release FLASH 613224 613224 0 0.0
RAM 69916 69916 0 0.0
k32w1+release FLASH 675104 675104 0 0.0
RAM 71472 71472 0 0.0
psoc6 all-clusters cy8ckit_062s2_43012 FLASH 1642156 1642156 0 0.0
RAM 210920 210920 0 0.0
all-clusters-minimal cy8ckit_062s2_43012 FLASH 1545972 1545972 0 0.0
RAM 207632 207632 0 0.0
light cy8ckit_062s2_43012 FLASH 1464764 1464764 0 0.0
RAM 200728 200728 0 0.0
lock cy8ckit_062s2_43012 FLASH 1463652 1463652 0 0.0
RAM 225064 225064 0 0.0
qpg lighting-app qpg6105+debug FLASH 656348 656348 0 0.0
RAM 105128 105128 0 0.0
lock-app qpg6105+debug FLASH 614208 614208 0 0.0
RAM 99612 99612 0 0.0
stm32 light STM32WB5MM-DK FLASH 478696 478696 0 0.0
RAM 144716 144716 0 0.0
telink air-quality-sensor-app tlsr9528a_retention FLASH 620504 620504 0 0.0
RAM 50932 50932 0 0.0
all-clusters-app tlsr9118bdk40d FLASH 682896 682896 0 0.0
RAM 149552 149552 0 0.0
all-clusters-minimal-app tlsr9528a FLASH 775206 775206 0 0.0
RAM 110712 110712 0 0.0
bridge-app tlsr9258a FLASH 679234 679234 0 0.0
RAM 91588 91588 0 0.0
contact-sensor-app tlsr9528a_retention FLASH 622096 622096 0 0.0
RAM 50972 50972 0 0.0
light-switch-app-ota-shell-factory-data tlsr9528a FLASH 708106 708106 0 0.0
RAM 74312 74312 0 0.0
lighting-app-ota-factory-data tlsr9118bdk40d FLASH 621040 621040 0 0.0
RAM 145532 145532 0 0.0
lighting-app-ota-rpc-factory-data-4mb tlsr9518adk80d FLASH 807172 807172 0 0.0
RAM 99456 99456 0 0.0
lock-app-dfu tlsr9528a FLASH 655078 655078 0 0.0
RAM 67008 67008 0 0.0
ota-requestor-app tlsr9258a FLASH 697362 697362 0 0.0
RAM 91272 91272 0 0.0
pump-app-usb tlsr9518adk80d FLASH 631542 631542 0 0.0
RAM 55752 55752 0 0.0
pump-controller-app tlsr9518adk80d FLASH 609052 609052 0 0.0
RAM 52996 52996 0 0.0
shell tlsr9518adk80d FLASH 466890 466890 0 0.0
RAM 68660 68660 0 0.0
smoke_co_alarm-app tlsr9528a_retention FLASH 628882 628882 0 0.0
RAM 52692 52692 0 0.0
temperature-measurement-app-mars-ota tlsr9518adk80d FLASH 653034 653034 0 0.0
RAM 56632 56632 0 0.0
thermostat tlsr9518adk80d FLASH 635784 635784 0 0.0
RAM 53400 53400 0 0.0
window-covering tlsr9118bdk40d FLASH 523038 523038 0 0.0
RAM 98532 98532 0 0.0
tizen all-clusters-app arm unknown 4848 4848 0 0.0
FLASH 1712256 1712256 0 0.0
RAM 89380 89380 0 0.0
chip-tool-ubsan arm unknown 10272 10272 0 0.0
FLASH 17510942 17510942 0 0.0
RAM 7601220 7601220 0 0.0

sharadb-amazon
sharadb-amazon reviewed Aug 30, 2024
View reviewed changes
Copy link
Contributor

@sharadb-amazon sharadb-amazon left a comment

Choose a reason for hiding this comment

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

Once the connection attempt is canceled, are you able to navigate back to the discovery page and go through connection successfully, WITHOUT killing the Android and iOS mobile tv-casting-app? Can you add that details in the testing done section of the PR?

examples/tv-casting-app/tv-casting-common/core/CommissionerDeclarationHandler.cpp Outdated Show resolved Hide resolved
examples/tv-casting-app/tv-casting-common/core/CastingPlayer.cpp Outdated Show resolved Hide resolved
examples/tv-casting-app/tv-casting-common/core/CastingPlayer.cpp Outdated Show resolved Hide resolved
examples/tv-casting-app/tv-casting-common/core/CommissionerDeclarationHandler.cpp Outdated Show resolved Hide resolved
examples/tv-casting-app/tv-casting-common/core/CastingPlayer.cpp Outdated Show resolved Hide resolved
@sharadb-amazon sharadb-amazon enabled auto-merge (squash) September 5, 2024 16:39
@sharadb-amazon sharadb-amazon merged commit a073055 into project-chip:master Sep 5, 2024
67 checks passed
andy31415
andy31415 reviewed Sep 5, 2024
View reviewed changes
examples/tv-casting-app/tv-casting-common/support/EndpointListLoader.cpp
for (unsigned long i = 0; i < mNewEndpointsToLoad; i++)
{
EndpointAttributes endpointAttributes = mEndpointAttributesList[i];
std::shared_ptr<Endpoint> endpoint =
std::make_shared<Endpoint>(CastingPlayer::GetTargetCastingPlayer(), endpointAttributes);
ChipLogProgress(AppServer, "EndpointListLoader::Complete() mEndpointServerLists[i].size: %lu ",
Copy link
Contributor

Choose a reason for hiding this comment

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

format of size differs between 32-bit and 64-bit.

@pgregorr-amazon pgregorr-amazon mentioned this pull request Sep 5, 2024
Merged
@pgregorr-amazon pgregorr-amazon mentioned this pull request Sep 27, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sharadb-amazon sharadb-amazon sharadb-amazon approved these changes

@andyg-apple andyg-apple Awaiting requested review from andyg-apple

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

@arkq arkq Awaiting requested review from arkq

@axelnxp axelnxp Awaiting requested review from axelnxp

@andy31415 andy31415 Awaiting requested review from andy31415

@bauerschwan bauerschwan Awaiting requested review from bauerschwan

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

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

@cecille cecille Awaiting requested review from cecille

@chapongatien chapongatien Awaiting requested review from chapongatien

@chshu chshu Awaiting requested review from chshu

@chulspro chulspro Awaiting requested review from chulspro

@cliffamzn cliffamzn Awaiting requested review from cliffamzn

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

@dhrishi dhrishi Awaiting requested review from dhrishi

@doru91 doru91 Awaiting requested review from doru91

@chrisdecenzo chrisdecenzo Awaiting requested review from chrisdecenzo

@fessehaeve fessehaeve Awaiting requested review from fessehaeve

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

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

@hicklin hicklin Awaiting requested review from hicklin

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

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

@jmeg-sfy jmeg-sfy Awaiting requested review from jmeg-sfy

@joonhaengHeo joonhaengHeo Awaiting requested review from joonhaengHeo

@jtung-apple jtung-apple Awaiting requested review from jtung-apple

@hawk248 hawk248 Awaiting requested review from hawk248

@kiel-apple kiel-apple Awaiting requested review from kiel-apple

@kkasperczyk-no kkasperczyk-no Awaiting requested review from kkasperczyk-no

@kpschoedel kpschoedel Awaiting requested review from kpschoedel

@ksperling-apple ksperling-apple Awaiting requested review from ksperling-apple

@lazarkov lazarkov Awaiting requested review from lazarkov

@lpbeliveau-silabs lpbeliveau-silabs Awaiting requested review from lpbeliveau-silabs

@LuDuda LuDuda Awaiting requested review from LuDuda

@mhazley mhazley Awaiting requested review from mhazley

@mkardous-silabs mkardous-silabs Awaiting requested review from mkardous-silabs

@mspang mspang Awaiting requested review from mspang

@nivi-apple nivi-apple Awaiting requested review from nivi-apple

@p0fi p0fi Awaiting requested review from p0fi

@pidarped pidarped Awaiting requested review from pidarped

@plauric plauric Awaiting requested review from plauric

@rcasallas-silabs rcasallas-silabs Awaiting requested review from rcasallas-silabs

@ReneJosefsen ReneJosefsen Awaiting requested review from ReneJosefsen

@robszewczyk robszewczyk Awaiting requested review from robszewczyk

@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

@tima-q tima-q Awaiting requested review from tima-q

@tobiasgraf tobiasgraf Awaiting requested review from tobiasgraf

@turon turon Awaiting requested review from turon

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

@wiba-nordic wiba-nordic Awaiting requested review from wiba-nordic

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

@younghak-hwang younghak-hwang Awaiting requested review from younghak-hwang

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

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

Successfully merging this pull request may close these issues.
5 participants
@pgregorr-amazon @andy31415 @sharadb-amazon @hawk248 @chrisdecenzo