diff --git a/examples/tv-casting-app/android/App/app/src/main/java/com/chip/casting/app/MainActivity.java b/examples/tv-casting-app/android/App/app/src/main/java/com/chip/casting/app/MainActivity.java index cb04518f5c6259..685dbf2fb6426e 100644 --- a/examples/tv-casting-app/android/App/app/src/main/java/com/chip/casting/app/MainActivity.java +++ b/examples/tv-casting-app/android/App/app/src/main/java/com/chip/casting/app/MainActivity.java @@ -66,9 +66,11 @@ public void handleCommissioningButtonClicked(DiscoveredNodeData commissioner) { } @Override - public void handleConnectionButtonClicked(CastingPlayer castingPlayer) { - Log.i(TAG, "MainActivity.handleConnectionButtonClicked() called"); - showFragment(ConnectionExampleFragment.newInstance(castingPlayer)); + public void handleConnectionButtonClicked( + CastingPlayer castingPlayer, boolean useCommissionerGeneratedPasscode) { + Log.i(TAG, "MainActivity.handleConnectionButtonClicked()"); + showFragment( + ConnectionExampleFragment.newInstance(castingPlayer, useCommissionerGeneratedPasscode)); } @Override @@ -77,26 +79,35 @@ public void handleCommissioningComplete() { } @Override - public void handleConnectionComplete(CastingPlayer castingPlayer) { - Log.i(TAG, "MainActivity.handleConnectionComplete() called "); - showFragment(ActionSelectorFragment.newInstance(castingPlayer)); + public void handleConnectionComplete( + CastingPlayer castingPlayer, boolean useCommissionerGeneratedPasscode) { + Log.i(TAG, "MainActivity.handleConnectionComplete()"); + showFragment( + ActionSelectorFragment.newInstance(castingPlayer, useCommissionerGeneratedPasscode)); } @Override - public void handleContentLauncherLaunchURLSelected(CastingPlayer selectedCastingPlayer) { - showFragment(ContentLauncherLaunchURLExampleFragment.newInstance(selectedCastingPlayer)); + public void handleContentLauncherLaunchURLSelected( + CastingPlayer selectedCastingPlayer, boolean useCommissionerGeneratedPasscode) { + showFragment( + ContentLauncherLaunchURLExampleFragment.newInstance( + selectedCastingPlayer, useCommissionerGeneratedPasscode)); } @Override - public void handleApplicationBasicReadVendorIDSelected(CastingPlayer selectedCastingPlayer) { - showFragment(ApplicationBasicReadVendorIDExampleFragment.newInstance(selectedCastingPlayer)); + public void handleApplicationBasicReadVendorIDSelected( + CastingPlayer selectedCastingPlayer, boolean useCommissionerGeneratedPasscode) { + showFragment( + ApplicationBasicReadVendorIDExampleFragment.newInstance( + selectedCastingPlayer, useCommissionerGeneratedPasscode)); } @Override public void handleMediaPlaybackSubscribeToCurrentStateSelected( - CastingPlayer selectedCastingPlayer) { + CastingPlayer selectedCastingPlayer, boolean useCommissionerGeneratedPasscode) { showFragment( - MediaPlaybackSubscribeToCurrentStateExampleFragment.newInstance(selectedCastingPlayer)); + MediaPlaybackSubscribeToCurrentStateExampleFragment.newInstance( + selectedCastingPlayer, useCommissionerGeneratedPasscode)); } @Override @@ -148,7 +159,10 @@ private boolean initJni() { private void showFragment(Fragment fragment, boolean showOnBack) { Log.d( TAG, - "showFragment() called with " + fragment.getClass().getSimpleName() + " and " + showOnBack); + "showFragment() called with: " + + fragment.getClass().getSimpleName() + + ", and showOnBack: " + + showOnBack); FragmentTransaction fragmentTransaction = getSupportFragmentManager() .beginTransaction() diff --git a/examples/tv-casting-app/android/App/app/src/main/java/com/matter/casting/ActionSelectorFragment.java b/examples/tv-casting-app/android/App/app/src/main/java/com/matter/casting/ActionSelectorFragment.java index cb5d2170e96d6d..a931d1ff3baf44 100644 --- a/examples/tv-casting-app/android/App/app/src/main/java/com/matter/casting/ActionSelectorFragment.java +++ b/examples/tv-casting-app/android/App/app/src/main/java/com/matter/casting/ActionSelectorFragment.java @@ -31,14 +31,17 @@ public class ActionSelectorFragment extends Fragment { private static final String TAG = ActionSelectorFragment.class.getSimpleName(); private final CastingPlayer selectedCastingPlayer; + private final boolean useCommissionerGeneratedPasscode; private View.OnClickListener selectContentLauncherButtonClickListener; private View.OnClickListener selectApplicationBasicButtonClickListener; private View.OnClickListener selectMediaPlaybackButtonClickListener; private View.OnClickListener disconnectButtonClickListener; - public ActionSelectorFragment(CastingPlayer selectedCastingPlayer) { + public ActionSelectorFragment( + CastingPlayer selectedCastingPlayer, boolean useCommissionerGeneratedPasscode) { this.selectedCastingPlayer = selectedCastingPlayer; + this.useCommissionerGeneratedPasscode = useCommissionerGeneratedPasscode; } /** @@ -46,10 +49,13 @@ public ActionSelectorFragment(CastingPlayer selectedCastingPlayer) { * parameters. * * @param selectedCastingPlayer CastingPlayer that the casting app connected to + * @param useCommissionerGeneratedPasscode Boolean indicating whether this CastingPlayer was + * commissioned using the Commissioner-Generated passcode commissioning flow. * @return A new instance of fragment SelectActionFragment. */ - public static ActionSelectorFragment newInstance(CastingPlayer selectedCastingPlayer) { - return new ActionSelectorFragment(selectedCastingPlayer); + public static ActionSelectorFragment newInstance( + CastingPlayer selectedCastingPlayer, boolean useCommissionerGeneratedPasscode) { + return new ActionSelectorFragment(selectedCastingPlayer, useCommissionerGeneratedPasscode); } @Override @@ -64,17 +70,20 @@ public View onCreateView( this.selectContentLauncherButtonClickListener = v -> { Log.d(TAG, "handle() called on selectContentLauncherButtonClickListener"); - callback.handleContentLauncherLaunchURLSelected(selectedCastingPlayer); + callback.handleContentLauncherLaunchURLSelected( + selectedCastingPlayer, useCommissionerGeneratedPasscode); }; this.selectApplicationBasicButtonClickListener = v -> { Log.d(TAG, "handle() called on selectApplicationBasicButtonClickListener"); - callback.handleApplicationBasicReadVendorIDSelected(selectedCastingPlayer); + callback.handleApplicationBasicReadVendorIDSelected( + selectedCastingPlayer, useCommissionerGeneratedPasscode); }; this.selectMediaPlaybackButtonClickListener = v -> { Log.d(TAG, "handle() called on selectMediaPlaybackButtonClickListener"); - callback.handleMediaPlaybackSubscribeToCurrentStateSelected(selectedCastingPlayer); + callback.handleMediaPlaybackSubscribeToCurrentStateSelected( + selectedCastingPlayer, useCommissionerGeneratedPasscode); }; this.disconnectButtonClickListener = @@ -107,13 +116,16 @@ public void onViewCreated(View view, @Nullable Bundle savedInstanceState) { /** Interface for notifying the host. */ public interface Callback { /** Notifies listener to trigger transition on selection of Content Launcher cluster */ - void handleContentLauncherLaunchURLSelected(CastingPlayer selectedCastingPlayer); + void handleContentLauncherLaunchURLSelected( + CastingPlayer selectedCastingPlayer, boolean useCommissionerGeneratedPasscode); /** Notifies listener to trigger transition on selection of Application Basic cluster */ - void handleApplicationBasicReadVendorIDSelected(CastingPlayer selectedCastingPlayer); + void handleApplicationBasicReadVendorIDSelected( + CastingPlayer selectedCastingPlayer, boolean useCommissionerGeneratedPasscode); /** Notifies listener to trigger transition on selection of Media PLayback cluster */ - void handleMediaPlaybackSubscribeToCurrentStateSelected(CastingPlayer selectedCastingPlayer); + void handleMediaPlaybackSubscribeToCurrentStateSelected( + CastingPlayer selectedCastingPlayer, boolean useCommissionerGeneratedPasscode); /** Notifies listener to trigger transition on click of the Disconnect button */ void handleDisconnect(); diff --git a/examples/tv-casting-app/android/App/app/src/main/java/com/matter/casting/ApplicationBasicReadVendorIDExampleFragment.java b/examples/tv-casting-app/android/App/app/src/main/java/com/matter/casting/ApplicationBasicReadVendorIDExampleFragment.java index 878c18019f4d09..b64d10ce811332 100644 --- a/examples/tv-casting-app/android/App/app/src/main/java/com/matter/casting/ApplicationBasicReadVendorIDExampleFragment.java +++ b/examples/tv-casting-app/android/App/app/src/main/java/com/matter/casting/ApplicationBasicReadVendorIDExampleFragment.java @@ -37,25 +37,32 @@ public class ApplicationBasicReadVendorIDExampleFragment extends Fragment { private static final String TAG = ApplicationBasicReadVendorIDExampleFragment.class.getSimpleName(); + private static final int DEFAULT_ENDPOINT_ID_FOR_CGP_FLOW = 1; private final CastingPlayer selectedCastingPlayer; + private final boolean useCommissionerGeneratedPasscode; private View.OnClickListener readButtonClickListener; - public ApplicationBasicReadVendorIDExampleFragment(CastingPlayer selectedCastingPlayer) { + public ApplicationBasicReadVendorIDExampleFragment( + CastingPlayer selectedCastingPlayer, boolean useCommissionerGeneratedPasscode) { this.selectedCastingPlayer = selectedCastingPlayer; + this.useCommissionerGeneratedPasscode = useCommissionerGeneratedPasscode; } /** * Use this factory method to create a new instance of this fragment using the provided * parameters. * - * @param selectedCastingPlayer CastingPlayer that the casting app connected to + * @param selectedCastingPlayer CastingPlayer that the casting app connected to. + * @param useCommissionerGeneratedPasscode Boolean indicating whether this CastingPlayer was + * commissioned using the Commissioner-Generated Passcode (CGP) commissioning flow. * @return A new instance of fragment ApplicationBasicReadVendorIDExampleFragment. */ public static ApplicationBasicReadVendorIDExampleFragment newInstance( - CastingPlayer selectedCastingPlayer) { - return new ApplicationBasicReadVendorIDExampleFragment(selectedCastingPlayer); + CastingPlayer selectedCastingPlayer, boolean useCommissionerGeneratedPasscode) { + return new ApplicationBasicReadVendorIDExampleFragment( + selectedCastingPlayer, useCommissionerGeneratedPasscode); } @Override @@ -68,8 +75,14 @@ public View onCreateView( LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) { this.readButtonClickListener = v -> { - Endpoint endpoint = - EndpointSelectorExample.selectFirstEndpointByVID(selectedCastingPlayer); + Endpoint endpoint; + if (useCommissionerGeneratedPasscode) { + endpoint = + EndpointSelectorExample.selectEndpointById( + selectedCastingPlayer, DEFAULT_ENDPOINT_ID_FOR_CGP_FLOW); + } else { + endpoint = EndpointSelectorExample.selectFirstEndpointByVID(selectedCastingPlayer); + } if (endpoint == null) { Log.e(TAG, "No Endpoint with sample vendorID found on CastingPlayer"); return; diff --git a/examples/tv-casting-app/android/App/app/src/main/java/com/matter/casting/ConnectionExampleFragment.java b/examples/tv-casting-app/android/App/app/src/main/java/com/matter/casting/ConnectionExampleFragment.java index 690a9b02e840bc..1bf95ef4a2d7eb 100644 --- a/examples/tv-casting-app/android/App/app/src/main/java/com/matter/casting/ConnectionExampleFragment.java +++ b/examples/tv-casting-app/android/App/app/src/main/java/com/matter/casting/ConnectionExampleFragment.java @@ -16,20 +16,27 @@ */ package com.matter.casting; +import android.app.AlertDialog; +import android.content.Context; +import android.content.DialogInterface; import android.os.Bundle; import android.util.Log; import android.view.LayoutInflater; import android.view.View; import android.view.ViewGroup; import android.widget.Button; +import android.widget.EditText; import android.widget.TextView; import androidx.annotation.Nullable; import androidx.fragment.app.Fragment; import com.R; import com.matter.casting.core.CastingPlayer; -import com.matter.casting.support.EndpointFilter; +import com.matter.casting.support.CommissionerDeclaration; +import com.matter.casting.support.ConnectionCallbacks; +import com.matter.casting.support.IdentificationDeclarationOptions; import com.matter.casting.support.MatterCallback; import com.matter.casting.support.MatterError; +import com.matter.casting.support.TargetAppInfo; import java.util.concurrent.Executors; /** A {@link Fragment} to Verify or establish a connection with a selected Casting Player. */ @@ -37,18 +44,28 @@ public class ConnectionExampleFragment extends Fragment { private static final String TAG = ConnectionExampleFragment.class.getSimpleName(); // Time (in sec) to keep the commissioning window open, if commissioning is required. // Must be >= 3 minutes. - private static final long MIN_CONNECTION_TIMEOUT_SEC = 3 * 60; - private static final Integer DESIRED_ENDPOINT_VENDOR_ID = 65521; + private static final short MIN_CONNECTION_TIMEOUT_SEC = 3 * 60; + private static final Integer DESIRED_TARGET_APP_VENDOR_ID = 65521; + // Use this Target Content Application Vendor ID, configured on the tv-app, to demonstrate the + // CastingPlayer/Commissioner-Generated passcode commissioning flow. + private static final Integer DESIRED_TARGET_APP_VENDOR_ID_FOR_CGP_FLOW = 1111; + private static final long DEFAULT_COMMISSIONER_GENERATED_PASSCODE = 12345678; + private static final int DEFAULT_DISCRIMINATOR_FOR_CGP_FLOW = 0; private final CastingPlayer targetCastingPlayer; + private final boolean useCommissionerGeneratedPasscode; private TextView connectionFragmentStatusTextView; private Button connectionFragmentNextButton; - public ConnectionExampleFragment(CastingPlayer targetCastingPlayer) { + public ConnectionExampleFragment( + CastingPlayer targetCastingPlayer, boolean useCommissionerGeneratedPasscode) { Log.i( TAG, - "ConnectionExampleFragment() called with target CastingPlayer ID: " - + targetCastingPlayer.getDeviceId()); + "ConnectionExampleFragment() Target CastingPlayer ID: " + + targetCastingPlayer.getDeviceId() + + ", useCommissionerGeneratedPasscode: " + + useCommissionerGeneratedPasscode); this.targetCastingPlayer = targetCastingPlayer; + this.useCommissionerGeneratedPasscode = useCommissionerGeneratedPasscode; } /** @@ -57,21 +74,22 @@ public ConnectionExampleFragment(CastingPlayer targetCastingPlayer) { * * @return A new instance of fragment ConnectionExampleFragment. */ - public static ConnectionExampleFragment newInstance(CastingPlayer castingPlayer) { - Log.i(TAG, "newInstance() called"); - return new ConnectionExampleFragment(castingPlayer); + public static ConnectionExampleFragment newInstance( + CastingPlayer castingPlayer, Boolean useCommissionerGeneratedPasscode) { + Log.i(TAG, "newInstance()"); + return new ConnectionExampleFragment(castingPlayer, useCommissionerGeneratedPasscode); } @Override public void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); - Log.i(TAG, "onCreate() called"); + Log.i(TAG, "onCreate()"); } @Override public View onCreateView( LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) { - Log.i(TAG, "onCreateView() called"); + Log.i(TAG, "onCreateView()"); // Inflate the layout for this fragment return inflater.inflate(R.layout.fragment_matter_connection_example, container, false); } @@ -79,23 +97,30 @@ public View onCreateView( @Override public void onViewCreated(View view, @Nullable Bundle savedInstanceState) { super.onViewCreated(view, savedInstanceState); - Log.i(TAG, "onViewCreated() called"); + Log.i(TAG, "onViewCreated()"); connectionFragmentStatusTextView = getView().findViewById(R.id.connectionFragmentStatusText); - connectionFragmentStatusTextView.setText( - "Verifying or establishing connection with Casting Player with device name: " - + targetCastingPlayer.getDeviceName() - + "\nSetup Passcode: " - + InitializationExample.commissionableDataProvider.get().getSetupPasscode() - + "\nDiscriminator: " - + InitializationExample.commissionableDataProvider.get().getDiscriminator()); + if (useCommissionerGeneratedPasscode) { + connectionFragmentStatusTextView.setText( + "Verifying or establishing connection with Casting Player with device name: " + + targetCastingPlayer.getDeviceName() + + "\n\nAttempting CastingPlayer/Commissioner-Generated passcode commissioning."); + } else { + connectionFragmentStatusTextView.setText( + "Verifying or establishing connection with Casting Player with device name: " + + targetCastingPlayer.getDeviceName() + + "\nClient/Commissionee-Generated Setup Passcode: " + + InitializationExample.commissionableDataProvider.get().getSetupPasscode() + + "\nDiscriminator: " + + InitializationExample.commissionableDataProvider.get().getDiscriminator()); + } connectionFragmentNextButton = getView().findViewById(R.id.connectionFragmentNextButton); Callback callback = (ConnectionExampleFragment.Callback) this.getActivity(); connectionFragmentNextButton.setOnClickListener( v -> { Log.i(TAG, "onViewCreated() NEXT clicked. Calling handleConnectionComplete()"); - callback.handleConnectionComplete(targetCastingPlayer); + callback.handleConnectionComplete(targetCastingPlayer, useCommissionerGeneratedPasscode); }); Executors.newSingleThreadExecutor() @@ -103,25 +128,42 @@ public void onViewCreated(View view, @Nullable Bundle savedInstanceState) { () -> { Log.d(TAG, "onViewCreated() calling CastingPlayer.verifyOrEstablishConnection()"); - EndpointFilter desiredEndpointFilter = new EndpointFilter(); - desiredEndpointFilter.vendorId = DESIRED_ENDPOINT_VENDOR_ID; + IdentificationDeclarationOptions idOptions = new IdentificationDeclarationOptions(); + TargetAppInfo targetAppInfo = new TargetAppInfo(); + targetAppInfo.vendorId = DESIRED_TARGET_APP_VENDOR_ID; - MatterError err = - targetCastingPlayer.verifyOrEstablishConnection( - MIN_CONNECTION_TIMEOUT_SEC, - desiredEndpointFilter, + if (useCommissionerGeneratedPasscode) { + idOptions.commissionerPasscode = true; + targetAppInfo.vendorId = DESIRED_TARGET_APP_VENDOR_ID_FOR_CGP_FLOW; + Log.d( + TAG, + "onViewCreated() calling CastingPlayer.verifyOrEstablishConnection() Target Content Application Vendor ID: " + + targetAppInfo.vendorId + + ", useCommissionerGeneratedPasscode: " + + useCommissionerGeneratedPasscode); + } else { + Log.d( + TAG, + "onViewCreated() calling CastingPlayer.verifyOrEstablishConnection() Target Content Application Vendor ID: " + + targetAppInfo.vendorId); + } + + idOptions.addTargetAppInfo(targetAppInfo); + + ConnectionCallbacks connectionCallbacks = + new ConnectionCallbacks( new MatterCallback() { @Override public void handle(Void v) { Log.i( TAG, - "Connected to CastingPlayer with deviceId: " + "Successfully connected to CastingPlayer with deviceId: " + targetCastingPlayer.getDeviceId()); getActivity() .runOnUiThread( () -> { connectionFragmentStatusTextView.setText( - "Connected to Casting Player with device name: " + "Successfully connected to Casting Player with device name: " + targetCastingPlayer.getDeviceName() + "\n\n"); connectionFragmentNextButton.setEnabled(true); @@ -139,7 +181,39 @@ public void handle(MatterError err) { "Casting Player connection failed due to: " + err + "\n\n"); }); } - }); + }, + null); + + // CommissionerDeclaration is only needed for the CastingPlayer/Commissioner-Generated + // passcode commissioning flow. + if (useCommissionerGeneratedPasscode) { + connectionCallbacks.onCommissionerDeclaration = + new MatterCallback() { + @Override + public void handle(CommissionerDeclaration cd) { + Log.i(TAG, "CastingPlayer CommissionerDeclaration message received: "); + cd.logDetail(); + + getActivity() + .runOnUiThread( + () -> { + connectionFragmentStatusTextView.setText( + "CommissionerDeclaration message received from Casting Player: \n\n"); + if (cd.getCommissionerPasscode()) { + + displayPasscodeInputDialog(getActivity()); + + connectionFragmentStatusTextView.setText( + "CommissionerDeclaration message received from Casting Player: A passcode is now displayed for the user by the Casting Player. \n\n"); + } + }); + } + }; + } + + MatterError err = + targetCastingPlayer.verifyOrEstablishConnection( + connectionCallbacks, MIN_CONNECTION_TIMEOUT_SEC, idOptions); if (err.hasError()) { getActivity() @@ -152,9 +226,133 @@ public void handle(MatterError err) { }); } + private void displayPasscodeInputDialog(Context context) { + AlertDialog.Builder builder = new AlertDialog.Builder(context); + + LayoutInflater inflater = LayoutInflater.from(context); + View dialogView = inflater.inflate(R.layout.custom_passcode_dialog, null); + + // Set up the input dialog with the default passcode + final EditText input = dialogView.findViewById(R.id.passcode_input); + input.setText("" + DEFAULT_COMMISSIONER_GENERATED_PASSCODE); + + // Set up the buttons + builder.setPositiveButton( + "Continue Connecting", + new DialogInterface.OnClickListener() { + @Override + public void onClick(DialogInterface dialog, int which) { + String passcode = input.getText().toString(); + Log.i( + TAG, + "displayPasscodeInputDialog() User entered CastingPlayer/Commissioner-Generated passcode: " + + passcode); + + // Display the user entered passcode on the screen + connectionFragmentStatusTextView.setText( + "Continue Connecting with user entered CastingPlayer/Commissioner-Generated passcode: " + + passcode + + "\n\n"); + + long passcodeLongValue = DEFAULT_COMMISSIONER_GENERATED_PASSCODE; + try { + passcodeLongValue = Long.parseLong(passcode); + Log.i( + TAG, + "displayPasscodeInputDialog() User entered CastingPlayer/Commissioner-Generated passcode: " + + passcodeLongValue); + } catch (NumberFormatException nfe) { + Log.e( + TAG, + "displayPasscodeInputDialog()User entered CastingPlayer/Commissioner-Generated passcode is not a valid integer. NumberFormatException: " + + nfe); + connectionFragmentStatusTextView.setText( + "User entered CastingPlayer/Commissioner-Generated passcode is not a valid integer: " + + passcode + + "\n\n"); + } + + // Update the CommissionableData DataProvider with the user entered + // CastingPlayer/Commissioner-Generated setup passcode. This is mandatory for + // Commissioner-Generated passcode commissioning since the commissioning session's PAKE + // verifier needs to be updated with the entered passcode. + InitializationExample.commissionableDataProvider.updateCommissionableDataSetupPasscode( + passcodeLongValue, DEFAULT_DISCRIMINATOR_FOR_CGP_FLOW); + + Log.i(TAG, "displayPasscodeInputDialog() calling continueConnecting()"); + connectionFragmentStatusTextView = + getView().findViewById(R.id.connectionFragmentStatusText); + connectionFragmentStatusTextView.setText( + "Continuing to connect with Casting Player with device name: " + + targetCastingPlayer.getDeviceName() + + "\nCastingPlayer/Commissioner-Generated Setup Passcode: " + + InitializationExample.commissionableDataProvider.get().getSetupPasscode() + + "\nDiscriminator: " + + InitializationExample.commissionableDataProvider.get().getDiscriminator()); + + MatterError err = targetCastingPlayer.continueConnecting(); + + if (err.hasError()) { + MatterError finalErr = err; + getActivity() + .runOnUiThread( + () -> { + connectionFragmentStatusTextView.setText( + "Casting Player CONTINUE CONNECTING failed due to: " + + finalErr + + "\n\n"); + }); + Log.e( + TAG, + "displayPasscodeInputDialog() continueConnecting() failed, calling stopConnecting() due to: " + + err); + // Since continueConnecting() failed, Attempt to cancel the connection attempt with + // the CastingPlayer/Commissioner. + err = targetCastingPlayer.stopConnecting(); + if (err.hasError()) { + Log.e(TAG, "displayPasscodeInputDialog() stopConnecting() failed due to: " + err); + } + } + } + }); + + builder.setNegativeButton( + "Cancel", + new DialogInterface.OnClickListener() { + @Override + public void onClick(DialogInterface dialog, int which) { + Log.i( + TAG, + "displayPasscodeInputDialog() user cancelled the CastingPlayer/Commissioner-Generated Passcode input dialog. Calling stopConnecting()"); + connectionFragmentStatusTextView.setText( + "Connection attempt with Casting Player cancelled by the user, route back to exit. \n\n"); + MatterError err = targetCastingPlayer.stopConnecting(); + if (err.hasError()) { + MatterError finalErr = err; + getActivity() + .runOnUiThread( + () -> { + connectionFragmentStatusTextView.setText( + "Casting Player CANCEL failed due to: " + finalErr + "\n\n"); + }); + Log.e(TAG, "displayPasscodeInputDialog() stopConnecting() failed due to: " + err); + } + dialog.cancel(); + } + }); + + builder.setView(dialogView); + AlertDialog alertDialog = builder.create(); + alertDialog.show(); + alertDialog + .getWindow() + .setLayout(ViewGroup.LayoutParams.MATCH_PARENT, ViewGroup.LayoutParams.WRAP_CONTENT); + } + /** Interface for notifying the host. */ public interface Callback { /** Notifies listener to trigger transition on completion of connection */ - void handleConnectionComplete(CastingPlayer castingPlayer); + void handleConnectionComplete( + CastingPlayer castingPlayer, boolean useCommissionerGeneratedPasscode); } } diff --git a/examples/tv-casting-app/android/App/app/src/main/java/com/matter/casting/ContentLauncherLaunchURLExampleFragment.java b/examples/tv-casting-app/android/App/app/src/main/java/com/matter/casting/ContentLauncherLaunchURLExampleFragment.java index ddf41b349d6890..e1cfc4a456112b 100644 --- a/examples/tv-casting-app/android/App/app/src/main/java/com/matter/casting/ContentLauncherLaunchURLExampleFragment.java +++ b/examples/tv-casting-app/android/App/app/src/main/java/com/matter/casting/ContentLauncherLaunchURLExampleFragment.java @@ -37,25 +37,32 @@ public class ContentLauncherLaunchURLExampleFragment extends Fragment { private static final String TAG = ContentLauncherLaunchURLExampleFragment.class.getSimpleName(); private static final Integer SAMPLE_ENDPOINT_VID = 65521; + private static final int DEFAULT_ENDPOINT_ID_FOR_CGP_FLOW = 1; private final CastingPlayer selectedCastingPlayer; + private final boolean useCommissionerGeneratedPasscode; private View.OnClickListener launchUrlButtonClickListener; - public ContentLauncherLaunchURLExampleFragment(CastingPlayer selectedCastingPlayer) { + public ContentLauncherLaunchURLExampleFragment( + CastingPlayer selectedCastingPlayer, boolean useCommissionerGeneratedPasscode) { this.selectedCastingPlayer = selectedCastingPlayer; + this.useCommissionerGeneratedPasscode = useCommissionerGeneratedPasscode; } /** * Use this factory method to create a new instance of this fragment using the provided * parameters. * - * @param selectedCastingPlayer CastingPlayer that the casting app connected to + * @param selectedCastingPlayer CastingPlayer that the casting app connected to. + * @param useCommissionerGeneratedPasscode Boolean indicating whether this CastingPlayer was + * commissioned using the Commissioner-Generated Passcode (CGP) commissioning flow. * @return A new instance of fragment ContentLauncherLaunchURLExampleFragment. */ public static ContentLauncherLaunchURLExampleFragment newInstance( - CastingPlayer selectedCastingPlayer) { - return new ContentLauncherLaunchURLExampleFragment(selectedCastingPlayer); + CastingPlayer selectedCastingPlayer, Boolean useCommissionerGeneratedPasscode) { + return new ContentLauncherLaunchURLExampleFragment( + selectedCastingPlayer, useCommissionerGeneratedPasscode); } @Override @@ -68,8 +75,14 @@ public View onCreateView( LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) { this.launchUrlButtonClickListener = v -> { - Endpoint endpoint = - EndpointSelectorExample.selectFirstEndpointByVID(selectedCastingPlayer); + Endpoint endpoint; + if (useCommissionerGeneratedPasscode) { + endpoint = + EndpointSelectorExample.selectEndpointById( + selectedCastingPlayer, DEFAULT_ENDPOINT_ID_FOR_CGP_FLOW); + } else { + endpoint = EndpointSelectorExample.selectFirstEndpointByVID(selectedCastingPlayer); + } if (endpoint == null) { Log.e(TAG, "No Endpoint with sample vendorID found on CastingPlayer"); return; diff --git a/examples/tv-casting-app/android/App/app/src/main/java/com/matter/casting/DiscoveryExampleFragment.java b/examples/tv-casting-app/android/App/app/src/main/java/com/matter/casting/DiscoveryExampleFragment.java index 65d670584971aa..3dca2320b8924c 100644 --- a/examples/tv-casting-app/android/App/app/src/main/java/com/matter/casting/DiscoveryExampleFragment.java +++ b/examples/tv-casting-app/android/App/app/src/main/java/com/matter/casting/DiscoveryExampleFragment.java @@ -45,7 +45,7 @@ public class DiscoveryExampleFragment extends Fragment { private static final Long DISCOVERY_TARGET_DEVICE_TYPE = 35L; private static final int DISCOVERY_RUNTIME_SEC = 15; private TextView matterDiscoveryMessageTextView; - private TextView matterDiscoveryErrorMessageTextView; + public static TextView matterDiscoveryErrorMessageTextView; private static final List castingPlayerList = new ArrayList<>(); private static ArrayAdapter arrayAdapter; @@ -221,8 +221,8 @@ public void onPause() { /** Interface for notifying the host. */ public interface Callback { /** Notifies listener of Connection Button click. */ - // TODO: In following PRs. Implement CastingPlayer connection - void handleConnectionButtonClicked(CastingPlayer castingPlayer); + void handleConnectionButtonClicked( + CastingPlayer castingPlayer, boolean useCommissionerGeneratedPasscode); } private boolean startDiscovery() { @@ -320,6 +320,8 @@ public View getView(int i, View view, ViewGroup viewGroup) { Button playerDescription = view.findViewById(R.id.commissionable_player_description); playerDescription.setText(buttonText); + // OnClickListener for the CastingPLayer button, to be used for the Commissionee-Generated + // passcode commissioning flow. View.OnClickListener clickListener = v -> { CastingPlayer castingPlayer = playerList.get(i); @@ -329,9 +331,37 @@ public View getView(int i, View view, ViewGroup viewGroup) { + castingPlayer.getDeviceId()); DiscoveryExampleFragment.Callback onClickCallback = (DiscoveryExampleFragment.Callback) context; - onClickCallback.handleConnectionButtonClicked(castingPlayer); + onClickCallback.handleConnectionButtonClicked(castingPlayer, false); }; playerDescription.setOnClickListener(clickListener); + + // OnLongClickListener for the CastingPLayer button, to be used for the Commissioner-Generated + // passcode commissioning flow. + View.OnLongClickListener longClickListener = + v -> { + CastingPlayer castingPlayer = playerList.get(i); + if (!castingPlayer.getSupportsCommissionerGeneratedPasscode()) { + Log.e( + TAG, + "OnLongClickListener.onLongClick() called for CastingPlayer with deviceId " + + castingPlayer.getDeviceId() + + ". This CastingPlayer does not support Commissioner-Generated passcode commissioning."); + + DiscoveryExampleFragment.matterDiscoveryErrorMessageTextView.setText( + "The selected Casting Player does not support Commissioner-Generated passcode commissioning"); + return true; + } + Log.d( + TAG, + "OnLongClickListener.onLongClick() called for CastingPlayer with deviceId " + + castingPlayer.getDeviceId() + + ", attempting the Commissioner-Generated passcode commissioning flow."); + DiscoveryExampleFragment.Callback onClickCallback = + (DiscoveryExampleFragment.Callback) context; + onClickCallback.handleConnectionButtonClicked(castingPlayer, true); + return true; + }; + playerDescription.setOnLongClickListener(longClickListener); return view; } @@ -353,7 +383,7 @@ private String getCastingPlayerButtonText(CastingPlayer player) { aux += (aux.isEmpty() ? "" : ", ") + "Resolved IP?: " + (player.getIpAddresses().size() > 0); aux += (aux.isEmpty() ? "" : ", ") - + "Supports Commissioner Generated Passcode: " + + "Supports Commissioner-Generated Passcode: " + (player.getSupportsCommissionerGeneratedPasscode()); aux = aux.isEmpty() ? aux : "\n" + aux; diff --git a/examples/tv-casting-app/android/App/app/src/main/java/com/matter/casting/EndpointSelectorExample.java b/examples/tv-casting-app/android/App/app/src/main/java/com/matter/casting/EndpointSelectorExample.java index c2932c59117c64..5a906d7007d8b5 100644 --- a/examples/tv-casting-app/android/App/app/src/main/java/com/matter/casting/EndpointSelectorExample.java +++ b/examples/tv-casting-app/android/App/app/src/main/java/com/matter/casting/EndpointSelectorExample.java @@ -19,14 +19,33 @@ public static Endpoint selectFirstEndpointByVID(CastingPlayer selectedCastingPla if (selectedCastingPlayer != null) { List endpoints = selectedCastingPlayer.getEndpoints(); if (endpoints == null) { - Log.e(TAG, "No Endpoints found on CastingPlayer"); + Log.e(TAG, "selectFirstEndpointByVID() No Endpoints found on CastingPlayer"); } else { endpoint = endpoints .stream() .filter(e -> SAMPLE_ENDPOINT_VID.equals(e.getVendorId())) .findFirst() - .get(); + .orElse(null); + } + } + return endpoint; + } + + /** + * Returns the Endpoint with the desired endpoint Id in the list of Endpoints associated with the + * selectedCastingPlayer. + */ + public static Endpoint selectEndpointById( + CastingPlayer selectedCastingPlayer, int desiredEndpointId) { + Endpoint endpoint = null; + if (selectedCastingPlayer != null) { + List endpoints = selectedCastingPlayer.getEndpoints(); + if (endpoints == null) { + Log.e(TAG, "selectEndpointById() No Endpoints found on CastingPlayer"); + } else { + endpoint = + endpoints.stream().filter(e -> desiredEndpointId == e.getId()).findFirst().orElse(null); } } return endpoint; diff --git a/examples/tv-casting-app/android/App/app/src/main/java/com/matter/casting/InitializationExample.java b/examples/tv-casting-app/android/App/app/src/main/java/com/matter/casting/InitializationExample.java index aa602c79a66a94..6cae9ab8326474 100644 --- a/examples/tv-casting-app/android/App/app/src/main/java/com/matter/casting/InitializationExample.java +++ b/examples/tv-casting-app/android/App/app/src/main/java/com/matter/casting/InitializationExample.java @@ -28,6 +28,10 @@ public class InitializationExample { private static final String TAG = InitializationExample.class.getSimpleName(); + // Dummy values for commissioning demonstration only. These are hard coded in the example tv-app: + // connectedhomeip/examples/tv-app/tv-common/src/AppTv.cpp + private static final long DUMMY_SETUP_PASSCODE = 20202021; + private static final int DUMMY_DISCRIMINATOR = 3874; /** * DataProvider implementation for the Unique ID that is used by the SDK to generate the Rotating @@ -48,14 +52,32 @@ public byte[] get() { * DataProvider implementation for the Commissioning Data used by the SDK when the CastingApp goes * through commissioning */ - static final DataProvider commissionableDataProvider = - new DataProvider() { - @Override - public CommissionableData get() { - // dummy values for demonstration only - return new CommissionableData(20202021, 3874); - } - }; + public static class CommissionableDataProvider implements DataProvider { + CommissionableData commissionableData = + new CommissionableData(DUMMY_SETUP_PASSCODE, DUMMY_DISCRIMINATOR); + + @Override + public CommissionableData get() { + return commissionableData; + } + + /** + * Must be implemented in the CommissionableData DataProvider if the + * CastingPlayer/Commissioner-Generated passcode commissioning flow is going to be used. In this + * flow, the setup passcode is generated by the Commissioner and entered by the user in the + * tv-casting-app CX. Once it is obtained, this function should be called with the + * Commissioner-Generated passcode to update the CommissionableData DataProvider in + * AppParameters. + */ + public void updateCommissionableDataSetupPasscode(long setupPasscode, int discriminator) { + Log.i(TAG, "DataProvider::updateCommissionableDataSetupPasscode()"); + commissionableData.setSetupPasscode(setupPasscode); + commissionableData.setDiscriminator(discriminator); + } + }; + + public static CommissionableDataProvider commissionableDataProvider = + new CommissionableDataProvider(); /** * DACProvider implementation for the Device Attestation Credentials required at the time of @@ -70,7 +92,7 @@ public CommissionableData get() { */ public static MatterError initAndStart(Context applicationContext) { // Create an AppParameters object to pass in global casting parameters to the SDK - final AppParameters appParameters = + AppParameters appParameters = new AppParameters( applicationContext, new DataProvider() { diff --git a/examples/tv-casting-app/android/App/app/src/main/java/com/matter/casting/MediaPlaybackSubscribeToCurrentStateExampleFragment.java b/examples/tv-casting-app/android/App/app/src/main/java/com/matter/casting/MediaPlaybackSubscribeToCurrentStateExampleFragment.java index 77f5129b6b9e4d..cd5bbba14af2ed 100644 --- a/examples/tv-casting-app/android/App/app/src/main/java/com/matter/casting/MediaPlaybackSubscribeToCurrentStateExampleFragment.java +++ b/examples/tv-casting-app/android/App/app/src/main/java/com/matter/casting/MediaPlaybackSubscribeToCurrentStateExampleFragment.java @@ -40,26 +40,33 @@ public class MediaPlaybackSubscribeToCurrentStateExampleFragment extends Fragment { private static final String TAG = MediaPlaybackSubscribeToCurrentStateExampleFragment.class.getSimpleName(); + private static final int DEFAULT_ENDPOINT_ID_FOR_CGP_FLOW = 1; private final CastingPlayer selectedCastingPlayer; + private final boolean useCommissionerGeneratedPasscode; private View.OnClickListener subscribeButtonClickListener; private View.OnClickListener shutdownSubscriptionsButtonClickListener; - public MediaPlaybackSubscribeToCurrentStateExampleFragment(CastingPlayer selectedCastingPlayer) { + public MediaPlaybackSubscribeToCurrentStateExampleFragment( + CastingPlayer selectedCastingPlayer, boolean useCommissionerGeneratedPasscode) { this.selectedCastingPlayer = selectedCastingPlayer; + this.useCommissionerGeneratedPasscode = useCommissionerGeneratedPasscode; } /** * Use this factory method to create a new instance of this fragment using the provided * parameters. * - * @param selectedCastingPlayer CastingPlayer that the casting app connected to + * @param selectedCastingPlayer CastingPlayer that the casting app connected to. + * @param useCommissionerGeneratedPasscode Boolean indicating whether this CastingPlayer was + * commissioned using the Commissioner-Generated Passcode (CGP) commissioning flow. * @return A new instance of fragment MediaPlaybackSubscribeToCurrentStateExampleFragment. */ public static MediaPlaybackSubscribeToCurrentStateExampleFragment newInstance( - CastingPlayer selectedCastingPlayer) { - return new MediaPlaybackSubscribeToCurrentStateExampleFragment(selectedCastingPlayer); + CastingPlayer selectedCastingPlayer, boolean useCommissionerGeneratedPasscode) { + return new MediaPlaybackSubscribeToCurrentStateExampleFragment( + selectedCastingPlayer, useCommissionerGeneratedPasscode); } @Override @@ -70,7 +77,14 @@ public void onCreate(Bundle savedInstanceState) { @Override public View onCreateView( LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) { - Endpoint endpoint = EndpointSelectorExample.selectFirstEndpointByVID(selectedCastingPlayer); + Endpoint endpoint; + if (useCommissionerGeneratedPasscode) { + endpoint = + EndpointSelectorExample.selectEndpointById( + selectedCastingPlayer, DEFAULT_ENDPOINT_ID_FOR_CGP_FLOW); + } else { + endpoint = EndpointSelectorExample.selectFirstEndpointByVID(selectedCastingPlayer); + } if (endpoint == null) { Log.e(TAG, "No Endpoint with sample vendorID found on CastingPlayer"); return inflater.inflate( diff --git a/examples/tv-casting-app/android/App/app/src/main/jni/com/matter/casting/core/CastingApp.java b/examples/tv-casting-app/android/App/app/src/main/jni/com/matter/casting/core/CastingApp.java index f79eab859a8ce3..8b99fefcfa50f8 100644 --- a/examples/tv-casting-app/android/App/app/src/main/jni/com/matter/casting/core/CastingApp.java +++ b/examples/tv-casting-app/android/App/app/src/main/jni/com/matter/casting/core/CastingApp.java @@ -46,6 +46,7 @@ public final class CastingApp { private AppParameters appParameters; private NsdManagerServiceResolver.NsdManagerResolverAvailState nsdManagerResolverAvailState; private ChipAppServer chipAppServer; + private AndroidChipPlatform chipPlatform; private CastingApp() {} @@ -62,7 +63,7 @@ public static CastingApp getInstance() { * @param appParameters */ public MatterError initialize(AppParameters appParameters) { - Log.i(TAG, "CastingApp.initialize called"); + Log.i(TAG, "CastingApp.initialize() called"); if (mState != CastingAppState.UNINITIALIZED) { return MatterError.CHIP_ERROR_INCORRECT_STATE; } @@ -72,7 +73,7 @@ public MatterError initialize(AppParameters appParameters) { new NsdManagerServiceResolver.NsdManagerResolverAvailState(); Context applicationContext = appParameters.getApplicationContext(); - AndroidChipPlatform chipPlatform = + chipPlatform = new AndroidChipPlatform( new AndroidBleManager(), new PreferencesKeyValueStoreManager(appParameters.getApplicationContext()), @@ -83,6 +84,34 @@ public MatterError initialize(AppParameters appParameters) { new ChipMdnsCallbackImpl(), new DiagnosticDataProviderImpl(applicationContext)); + MatterError err = updateAndroidChipPlatformWithCommissionableData(); + if (err.hasError()) { + Log.e( + TAG, + "CastingApp.initialize() failed to updateCommissionableDataProviderData() on AndroidChipPlatform"); + return err; + } + + err = finishInitialization(appParameters); + + if (err.hasNoError()) { + chipAppServer = new ChipAppServer(); // get a reference to the Matter server now + mState = CastingAppState.NOT_RUNNING; // initialization done, set state to NOT_RUNNING + } + return err; + } + + /** + * Updates the Android CHIP platform with the CommissionableData. This function retrieves + * commissionable data from the AppParameters and updates the Android CHIP platform using this + * data. The commissionable data includes information such as the SPAKE2+ verifier, salt, + * iteration count, setup passcode, and discriminator. + * + * @return MatterError.NO_ERROR if the update was successful, + * MatterError.CHIP_ERROR_INVALID_ARGUMENT otherwise. + */ + MatterError updateAndroidChipPlatformWithCommissionableData() { + Log.i(TAG, "CastingApp.updateAndroidChipPlatformWithCommissionableData()"); CommissionableData commissionableData = appParameters.getCommissionableDataProvider().get(); boolean updated = chipPlatform.updateCommissionableDataProviderData( @@ -93,17 +122,11 @@ public MatterError initialize(AppParameters appParameters) { commissionableData.getDiscriminator()); if (!updated) { Log.e( - TAG, "CastingApp.initApp failed to updateCommissionableDataProviderData on chipPlatform"); + TAG, + "CastingApp.updateAndroidChipPlatformWithCommissionableData() failed to updateCommissionableDataProviderData() on AndroidChipPlatform"); return MatterError.CHIP_ERROR_INVALID_ARGUMENT; } - - MatterError err = finishInitialization(appParameters); - - if (err.hasNoError()) { - chipAppServer = new ChipAppServer(); // get a reference to the Matter server now - mState = CastingAppState.NOT_RUNNING; // initialization done, set state to NOT_RUNNING - } - return err; + return MatterError.NO_ERROR; } /** diff --git a/examples/tv-casting-app/android/App/app/src/main/jni/com/matter/casting/core/CastingPlayer.java b/examples/tv-casting-app/android/App/app/src/main/jni/com/matter/casting/core/CastingPlayer.java index 3c3a74032bd313..d7ba6f00f9888f 100644 --- a/examples/tv-casting-app/android/App/app/src/main/jni/com/matter/casting/core/CastingPlayer.java +++ b/examples/tv-casting-app/android/App/app/src/main/jni/com/matter/casting/core/CastingPlayer.java @@ -16,14 +16,14 @@ */ package com.matter.casting.core; -import com.matter.casting.support.EndpointFilter; -import com.matter.casting.support.MatterCallback; +import com.matter.casting.support.ConnectionCallbacks; +import com.matter.casting.support.IdentificationDeclarationOptions; import com.matter.casting.support.MatterError; import java.net.InetAddress; import java.util.List; /** - * The CastingPlayer interface defines a Matter commissioner that is able to play media to a + * The CastingPlayer interface defines a Matter Commissioner that is able to play media to a * physical output or to a display screen which is part of the device (e.g. TV). It is discovered on * the local network using Matter Commissioner discovery over DNS. It contains all the information * about the service discovered/resolved. @@ -63,39 +63,92 @@ public interface CastingPlayer { int hashCode(); /** - * Verifies that a connection exists with this CastingPlayer, or triggers a new session request. - * If the CastingApp does not have the nodeId and fabricIndex of this CastingPlayer cached on - * disk, this will execute the user directed commissioning process. - * + * @brief Verifies that a connection exists with this CastingPlayer, or triggers a new + * commissioning session request. If the CastingApp does not have the nodeId and fabricIndex + * of this CastingPlayer cached on disk, this will execute the User Directed Commissioning + * (UDC) process by sending an IdentificationDeclaration message to the Commissioner. For + * certain UDC features, where a Commissioner reply is expected, this API needs to be followed + * up with the continueConnecting() API defiend below. See the Matter UDC specification or + * parameter class definitions for details on features not included in the description below. + * @param connectionCallbacks contains the onSuccess (Required), onFailure (Required) and + * onCommissionerDeclaration (Optional) callbacks defiend in ConnectCallbacks.java. + *

For example: During CastingPlayer/Commissioner-Generated passcode commissioning, the + * Commissioner replies with a CommissionerDeclaration message with PasscodeDialogDisplayed + * and CommissionerPasscode set to true. Given these Commissioner state details, the client is + * expected to perform some actions, detailed in the continueConnecting() API below, and then + * call the continueConnecting() API to complete the process. * @param commissioningWindowTimeoutSec (Optional) time (in sec) to keep the commissioning window - * open, if commissioning is required. Needs to be >= MIN_CONNECTION_TIMEOUT_SEC. - * @param desiredEndpointFilter (Optional) Attributes (such as VendorId) describing an Endpoint - * that the client wants to interact with after commissioning. If this value is passed in, the - * VerifyOrEstablishConnection will force User Directed Commissioning, in case the desired - * Endpoint is not found in the on device CastingStore. - * @param successCallback called when the connection is established successfully - * @param failureCallback called with MatterError when the connection is fails to establish - * @return MatterError - Matter.NO_ERROR if request submitted successfully, otherwise a - * MatterError object corresponding to the error + * open, if commissioning is required. Needs to be >= kCommissioningWindowTimeoutSec. + * @param idOptions (Optional) Parameters in the IdentificationDeclaration message sent by the + * Commissionee to the Commissioner. These parameters specify the information relating to the + * requested commissioning session. + *

For example: To invoke the CastingPlayer/Commissioner-Generated passcode commissioning + * flow, the client would call this API with IdentificationDeclarationOptions containing + * CommissionerPasscode set to true. See IdentificationDeclarationOptions.java for a complete + * list of optional parameters. + *

Furthermore, attributes (such as VendorId) describe the TargetApp that the client wants + * to interact with after commissioning. If this value is passed in, + * verifyOrEstablishConnection() will force UDC, in case the desired TargetApp is not found in + * the on-device CastingStore. + * @return MatterError - MatterError.NO_ERROR if request submitted successfully, otherwise a + * MatterError object corresponding to the error. */ MatterError verifyOrEstablishConnection( - long commissioningWindowTimeoutSec, - EndpointFilter desiredEndpointFilter, - MatterCallback successCallback, - MatterCallback failureCallback); + ConnectionCallbacks connectionCallbacks, + short commissioningWindowTimeoutSec, + IdentificationDeclarationOptions idOptions); /** - * Verifies that a connection exists with this CastingPlayer, or triggers a new session request. - * If the CastingApp does not have the nodeId and fabricIndex of this CastingPlayer cached on - * disk, this will execute the user directed commissioning process. + * The simplified version of the verifyOrEstablishConnection() API above. * - * @param successCallback called when the connection is established successfully - * @param failureCallback called with MatterError when the connection is fails to establish - * @return MatterError - Matter.NO_ERROR if request submitted successfully, otherwise a - * MatterError object corresponding to the error + * @param connectionCallbacks contains the onSuccess (Required), onFailure (Required) and + * onCommissionerDeclaration (Optional) callbacks defiend in ConnectCallbacks.java. + * @return MatterError - MatterError.NO_ERROR if request submitted successfully, otherwise a + * MatterError object corresponding to the error. */ - MatterError verifyOrEstablishConnection( - MatterCallback successCallback, MatterCallback failureCallback); + MatterError verifyOrEstablishConnection(ConnectionCallbacks connectionCallbacks); + + /** + * @brief This is a continuation of the CastingPlayer/Commissioner-Generated passcode + * commissioning flow started via the verifyOrEstablishConnection() API above. It continues + * the UDC process by sending a second IdentificationDeclaration message to Commissioner + * containing CommissionerPasscode and CommissionerPasscodeReady set to true. At this point it + * is assumed that the following have occurred: + *

1. Client (Commissionee) has sent the first IdentificationDeclaration message, via + * verifyOrEstablishConnection(), to the Commissioner containing CommissionerPasscode set to + * true. + *

2. Commissioner generated and displayed a passcode. + *

3. The Commissioner replied with a CommissionerDecelration message with + * PasscodeDialogDisplayed and CommissionerPasscode set to true. + *

4. Client has handled the Commissioner's CommissionerDecelration message. + *

5. Client prompted user to input Passcode from Commissioner. + *

6. Client has updated the CastingApp's AppParameters DataProvider + * via the following function call: DataProvider.updateCommissionableDataSetupPasscode(long + * setupPasscode, int discriminator). This allows continueConnecting() to update the + * commissioning session's PAKE verifier with the user entered passcode. + *

Note: The same connectionCallbacks and commissioningWindowTimeoutSec parameters passed + * into verifyOrEstablishConnection() will be used. + * @return MatterError - MatterError.NO_ERROR if request submitted successfully, otherwise a + * MatterError object corresponding to the error. + */ + MatterError continueConnecting(); + + MatterError continueConnectingNative(); + + /** + * @brief This cancels the CastingPlayer/Commissioner-Generated passcode commissioning flow + * started via the VerifyOrEstablishConnection() API above. It constructs and sends an + * IdentificationDeclaration message to the CastingPlayer/Commissioner containing + * CancelPasscode set to true. It is used to indicate that the user, and thus the + * Client/Commissionee, have cancelled the commissioning process. This indicates that the + * CastingPlayer/Commissioner can dismiss any dialogs corresponding to commissioning, such as + * a Passcode input dialog or a Passcode display dialog. + *

Note: stopConnecting() does not call the onSuccess() callback passed to the + * VerifyOrEstablishConnection() API above since no connection is established. + * @return MatterError - MatterError.NO_ERROR if request submitted successfully, otherwise a + * MatterError object corresponding to the error. + */ + MatterError stopConnecting(); /** @brief Sets the internal connection state of this CastingPlayer to "disconnected" */ void disconnect(); diff --git a/examples/tv-casting-app/android/App/app/src/main/jni/com/matter/casting/core/Endpoint.java b/examples/tv-casting-app/android/App/app/src/main/jni/com/matter/casting/core/Endpoint.java index f906b80235700c..d98ee77d5d3806 100644 --- a/examples/tv-casting-app/android/App/app/src/main/jni/com/matter/casting/core/Endpoint.java +++ b/examples/tv-casting-app/android/App/app/src/main/jni/com/matter/casting/core/Endpoint.java @@ -1,20 +1,16 @@ -/* - * Copyright (c) 2024 Project CHIP Authors - * All rights reserved. +/** + * Copyright (c) 2024 Project CHIP Authors All rights reserved. * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at + *

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + *

http://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + *

Unless required by applicable law or agreed to in writing, software distributed under the + * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either + * express or implied. See the License for the specific language governing permissions and + * limitations under the License. */ - package com.matter.casting.core; import chip.devicecontroller.ChipClusters; diff --git a/examples/tv-casting-app/android/App/app/src/main/jni/com/matter/casting/core/MatterCastingPlayer.java b/examples/tv-casting-app/android/App/app/src/main/jni/com/matter/casting/core/MatterCastingPlayer.java index a4f03a00e4f5a2..29ee17e26db8be 100644 --- a/examples/tv-casting-app/android/App/app/src/main/jni/com/matter/casting/core/MatterCastingPlayer.java +++ b/examples/tv-casting-app/android/App/app/src/main/jni/com/matter/casting/core/MatterCastingPlayer.java @@ -16,15 +16,16 @@ */ package com.matter.casting.core; -import com.matter.casting.support.EndpointFilter; -import com.matter.casting.support.MatterCallback; +import android.util.Log; +import com.matter.casting.support.ConnectionCallbacks; +import com.matter.casting.support.IdentificationDeclarationOptions; import com.matter.casting.support.MatterError; import java.net.InetAddress; import java.util.List; import java.util.Objects; /** - * A Matter Casting Player represents a Matter commissioner that is able to play media to a physical + * A Matter Casting Player represents a Matter Commissioner that is able to play media to a physical * output or to a display screen which is part of the device (e.g. TV). It is discovered on the * local network using Matter Commissioner discovery over DNS. It contains all the information about * the service discovered/resolved. @@ -35,7 +36,7 @@ public class MatterCastingPlayer implements CastingPlayer { * Time (in sec) to keep the commissioning window open, if commissioning is required. Must be >= 3 * minutes. */ - public static final long MIN_CONNECTION_TIMEOUT_SEC = 3 * 60; + public static final short MIN_CONNECTION_TIMEOUT_SEC = 3 * 60; private boolean connected; private String deviceId; @@ -162,49 +163,108 @@ public boolean equals(Object o) { } /** - * Verifies that a connection exists with this CastingPlayer, or triggers a new session request. - * If the CastingApp does not have the nodeId and fabricIndex of this CastingPlayer cached on - * disk, this will execute the user directed commissioning process. - * + * @brief Verifies that a connection exists with this CastingPlayer, or triggers a new + * commissioning session request. If the CastingApp does not have the nodeId and fabricIndex + * of this CastingPlayer cached on disk, this will execute the User Directed Commissioning + * (UDC) process by sending an IdentificationDeclaration message to the Commissioner. For + * certain UDC features, where a Commissioner reply is expected, this API needs to be followed + * up with the continueConnecting() API defiend below. See the Matter UDC specification or + * parameter class definitions for details on features not included in the description below. + * @param connectionCallbacks contains the onSuccess (Required), onFailure (Required) and + * onCommissionerDeclaration (Optional) callbacks defiend in ConnectCallbacks.java. + *

For example: During CastingPlayer/Commissioner-Generated passcode commissioning, the + * Commissioner replies with a CommissionerDeclaration message with PasscodeDialogDisplayed + * and CommissionerPasscode set to true. Given these Commissioner state details, the client is + * expected to perform some actions, detailed in the continueConnecting() API below, and then + * call the continueConnecting() API to complete the process. * @param commissioningWindowTimeoutSec (Optional) time (in sec) to keep the commissioning window - * open, if commissioning is required. Needs to be >= MIN_CONNECTION_TIMEOUT_SEC. - * @param desiredEndpointFilter (Optional) Attributes (such as VendorId) describing an Endpoint - * that the client wants to interact with after commissioning. If this value is passed in, the - * VerifyOrEstablishConnection will force User Directed Commissioning, in case the desired - * Endpoint is not found in the on device CastingStore. - * @return A CompletableFuture that completes when the VerifyOrEstablishConnection is completed. - * The CompletableFuture will be completed with a Void value if the - * VerifyOrEstablishConnection is successful. Otherwise, the CompletableFuture will be - * completed with an Exception. The Exception will be of type - * com.matter.casting.core.CastingException. If the VerifyOrEstablishConnection fails, the - * CastingException will contain the error code and message from the CastingApp. + * open, if commissioning is required. Needs to be >= kCommissioningWindowTimeoutSec. + * @param idOptions (Optional) Parameters in the IdentificationDeclaration message sent by the + * Commissionee to the Commissioner. These parameters specify the information relating to the + * requested commissioning session. + *

For example: To invoke the CastingPlayer/Commissioner-Generated passcode commissioning + * flow, the client would call this API with IdentificationDeclarationOptions containing + * CommissionerPasscode set to true. See IdentificationDeclarationOptions.java for a complete + * list of optional parameters. + *

Furthermore, attributes (such as VendorId) describe the TargetApp that the client wants + * to interact with after commissioning. If this value is passed in, + * verifyOrEstablishConnection() will force UDC, in case the desired TargetApp is not found in + * the on-device CastingStore. + * @return MatterError - MatterError.NO_ERROR if request submitted successfully, otherwise a + * MatterError object corresponding to the error. */ @Override public native MatterError verifyOrEstablishConnection( - long commissioningWindowTimeoutSec, - EndpointFilter desiredEndpointFilter, - MatterCallback successCallback, - MatterCallback failureCallback); + ConnectionCallbacks connectionCallbacks, + short commissioningWindowTimeoutSec, + IdentificationDeclarationOptions idOptions); /** - * Verifies that a connection exists with this CastingPlayer, or triggers a new session request. - * If the CastingApp does not have the nodeId and fabricIndex of this CastingPlayer cached on - * disk, this will execute the user directed commissioning process. + * The simplified version of the verifyOrEstablishConnection() API above. * - * @return A CompletableFuture that completes when the VerifyOrEstablishConnection is completed. - * The CompletableFuture will be completed with a Void value if the - * VerifyOrEstablishConnection is successful. Otherwise, the CompletableFuture will be - * completed with an Exception. The Exception will be of type - * com.matter.casting.core.CastingException. If the VerifyOrEstablishConnection fails, the - * CastingException will contain the error code and message from the CastingApp. + * @param connectionCallbacks contains the onSuccess (Required), onFailure (Required) and + * onCommissionerDeclaration (Optional) callbacks defiend in ConnectCallbacks.java. + * @return MatterError - MatterError.NO_ERROR if request submitted successfully, otherwise a + * MatterError object corresponding to the error. */ @Override - public MatterError verifyOrEstablishConnection( - MatterCallback successCallback, MatterCallback failureCallback) { - return verifyOrEstablishConnection( - MIN_CONNECTION_TIMEOUT_SEC, null, successCallback, failureCallback); + public MatterError verifyOrEstablishConnection(ConnectionCallbacks connectionCallbacks) { + Log.d(TAG, "verifyOrEstablishConnection() (ConnectionCallbacks)"); + return verifyOrEstablishConnection(connectionCallbacks, MIN_CONNECTION_TIMEOUT_SEC, null); + } + + /** + * @brief This is a continuation of the CastingPlayer/Commissioner-Generated passcode + * commissioning flow started via the verifyOrEstablishConnection() API above. It continues + * the UDC process by sending a second IdentificationDeclaration message to Commissioner + * containing CommissionerPasscode and CommissionerPasscodeReady set to true. At this point it + * is assumed that the following have occurred: + *

1. Client (Commissionee) has sent the first IdentificationDeclaration message, via + * verifyOrEstablishConnection(), to the Commissioner containing CommissionerPasscode set to + * true. + *

2. Commissioner generated and displayed a passcode. + *

3. The Commissioner replied with a CommissionerDecelration message with + * PasscodeDialogDisplayed and CommissionerPasscode set to true. + *

4. Client has handled the Commissioner's CommissionerDecelration message. + *

5. Client prompted user to input Passcode from Commissioner. + *

6. Client has updated the CastingApp's AppParameters DataProvider + * via the following function call: DataProvider.updateCommissionableDataSetupPasscode(long + * setupPasscode, int discriminator). This allows continueConnecting() to update the + * commissioning session's PAKE verifier with the user entered passcode. + *

Note: The same connectionCallbacks and commissioningWindowTimeoutSec parameters passed + * into verifyOrEstablishConnection() will be used. + * @return MatterError - MatterError.NO_ERROR if request submitted successfully, otherwise a + * MatterError object corresponding to the error. + */ + public MatterError continueConnecting() { + Log.d(TAG, "continueConnecting()"); + // Update AndroidChipPlatform's CommissionableData with the user entered passcode. + MatterError err = CastingApp.getInstance().updateAndroidChipPlatformWithCommissionableData(); + if (err != MatterError.NO_ERROR) { + Log.e(TAG, "continueConnecting() Error updating AndroidChipPlatform with CommissionableData"); + return err; + } + Log.d(TAG, "continueConnecting() calling continueConnectingNative()"); + return continueConnectingNative(); } + public native MatterError continueConnectingNative(); + + /** + * @brief This cancels the CastingPlayer/Commissioner-Generated passcode commissioning flow + * started via the VerifyOrEstablishConnection() API above. It constructs and sends an + * IdentificationDeclaration message to the CastingPlayer/Commissioner containing + * CancelPasscode set to true. It is used to indicate that the user, and thus the + * Client/Commissionee, have cancelled the commissioning process. This indicates that the + * CastingPlayer/Commissioner can dismiss any dialogs corresponding to commissioning, such as + * a Passcode input dialog or a Passcode display dialog. + *

Note: stopConnecting() does not call the onSuccess() callback passed to the + * VerifyOrEstablishConnection() API above since no connection is established. + * @return MatterError - MatterError.NO_ERROR if request submitted successfully, otherwise a + * MatterError object corresponding to the error. + */ + public native MatterError stopConnecting(); + @Override public native void disconnect(); } diff --git a/examples/tv-casting-app/android/App/app/src/main/jni/com/matter/casting/support/CommissionableData.java b/examples/tv-casting-app/android/App/app/src/main/jni/com/matter/casting/support/CommissionableData.java index b436c98c533786..cafa42919a121f 100644 --- a/examples/tv-casting-app/android/App/app/src/main/jni/com/matter/casting/support/CommissionableData.java +++ b/examples/tv-casting-app/android/App/app/src/main/jni/com/matter/casting/support/CommissionableData.java @@ -39,10 +39,18 @@ public long getSetupPasscode() { return setupPasscode; } + public void setSetupPasscode(long setupPasscode) { + this.setupPasscode = setupPasscode; + } + public int getDiscriminator() { return discriminator; } + public void setDiscriminator(int discriminator) { + this.discriminator = discriminator; + } + @Nullable public String getSpake2pVerifierBase64() { return spake2pVerifierBase64; diff --git a/examples/tv-casting-app/android/App/app/src/main/jni/com/matter/casting/support/CommissionerDeclaration.java b/examples/tv-casting-app/android/App/app/src/main/jni/com/matter/casting/support/CommissionerDeclaration.java new file mode 100644 index 00000000000000..82213a3a69517d --- /dev/null +++ b/examples/tv-casting-app/android/App/app/src/main/jni/com/matter/casting/support/CommissionerDeclaration.java @@ -0,0 +1,172 @@ +/** + * Copyright (c) 2024 Project CHIP Authors All rights reserved. + * + *

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of the License at + * + *

http://www.apache.org/licenses/LICENSE-2.0 + * + *

Unless required by applicable law or agreed to in writing, software distributed under the + * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either + * express or implied. See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.matter.casting.support; + +import android.util.Log; + +/** + * Represents the Commissioner Declaration message sent by a User Directed Commissioning server + * (CastingPlayer/Commissioner) to a UDC client (Casting Client/Commissionee). + */ +public class CommissionerDeclaration { + static final String TAG = CommissionerDeclaration.class.getSimpleName(); + + /** The allowed values for the ErrorCode field are the following */ + public enum CdError { + kNoError(0), + kCommissionableDiscoveryFailed(1), + kPaseConnectionFailed(2), + kPaseAuthFailed(3), + kDacValidationFailed(4), + kAlreadyOnFabric(5), + kOperationalDiscoveryFailed(6), + kCaseConnectionFailed(7), + kCaseAuthFailed(8), + kConfigurationFailed(9), + kBindingConfigurationFailed(10), + kCommissionerPasscodeNotSupported(11), + kInvalidIdentificationDeclarationParams(12), + kAppInstallConsentPending(13), + kAppInstalling(14), + kAppInstallFailed(15), + kAppInstalledRetryNeeded(16), + kCommissionerPasscodeDisabled(17), + kUnexpectedCommissionerPasscodeReady(18); + private final int value; + + CdError(int value) { + this.value = value; + } + + public int getValue() { + return value; + } + } + /** Feature: All - Indicates errors incurred during commissioning. */ + private CdError errorCode = CdError.kNoError; + /** + * Feature: Coordinate PIN Dialogs - When NoPasscode field set to true, and the Commissioner + * determines that a Passcode code will be needed for commissioning. + */ + private boolean needsPasscode = false; + /** + * Feature: Target Content Application - No apps with AccountLogin cluster implementation were + * found for the last IdentificationDeclaration request. Only apps which provide access to the + * vendor id of the Commissionee will be considered. + */ + private boolean noAppsFound = false; + /** + * Feature: Coordinate PIN Dialogs - A Passcode input dialog is now displayed for the user on the + * Commissioner. + */ + private boolean passcodeDialogDisplayed = false; + /** + * Feature: Commissioner-Generated Passcode - A Passcode is now displayed for the user by the + * CastingPlayer/Commissioner. + */ + private boolean commissionerPasscode = false; + /** + * Feature: Commissioner-Generated Passcode - The user experience conveying a Passcode to the user + * also displays a QR code. + */ + private boolean qRCodeDisplayed = false; + + public CommissionerDeclaration( + int errorCode, + boolean needsPasscode, + boolean noAppsFound, + boolean passcodeDialogDisplayed, + boolean commissionerPasscode, + boolean qRCodeDisplayed) { + this.errorCode = CdError.values()[errorCode]; + this.needsPasscode = needsPasscode; + this.noAppsFound = noAppsFound; + this.passcodeDialogDisplayed = passcodeDialogDisplayed; + this.commissionerPasscode = commissionerPasscode; + this.qRCodeDisplayed = qRCodeDisplayed; + } + + public void setErrorCode(CdError errorCode) { + this.errorCode = errorCode; + } + + public CdError getErrorCode() { + return this.errorCode; + } + + public void setNeedsPasscode(boolean needsPasscode) { + this.needsPasscode = needsPasscode; + } + + public boolean getNeedsPasscode() { + return this.needsPasscode; + } + + public void setNoAppsFound(boolean noAppsFound) { + this.noAppsFound = noAppsFound; + } + + public boolean getNoAppsFound() { + return this.noAppsFound; + } + + public void setPasscodeDialogDisplayed(boolean passcodeDialogDisplayed) { + this.passcodeDialogDisplayed = passcodeDialogDisplayed; + } + + public boolean getPasscodeDialogDisplayed() { + return this.passcodeDialogDisplayed; + } + + public void setCommissionerPasscode(boolean commissionerPasscode) { + this.commissionerPasscode = commissionerPasscode; + } + + public boolean getCommissionerPasscode() { + return this.commissionerPasscode; + } + + public void setQRCodeDisplayed(boolean qRCodeDisplayed) { + this.qRCodeDisplayed = qRCodeDisplayed; + } + + public boolean getQRCodeDisplayed() { + return this.qRCodeDisplayed; + } + + @Override + public String toString() { + return "CommissionerDeclaration::errorCode: " + + errorCode.name() + + "\n" + + "CommissionerDeclaration::needsPasscode: " + + needsPasscode + + "\n" + + "CommissionerDeclaration::noAppsFound: " + + noAppsFound + + "\n" + + "CommissionerDeclaration::passcodeDialogDisplayed: " + + passcodeDialogDisplayed + + "\n" + + "CommissionerDeclaration:commissionerPasscode: " + + commissionerPasscode + + "\n" + + "CommissionerDeclaration::qRCodeDisplayed: " + + qRCodeDisplayed; + } + + public void logDetail() { + Log.d(TAG, "CommissionerDeclaration::logDetail()\n" + this.toString()); + } +} diff --git a/examples/tv-casting-app/android/App/app/src/main/jni/com/matter/casting/support/ConnectionCallbacks.java b/examples/tv-casting-app/android/App/app/src/main/jni/com/matter/casting/support/ConnectionCallbacks.java new file mode 100644 index 00000000000000..3d4152bf106cce --- /dev/null +++ b/examples/tv-casting-app/android/App/app/src/main/jni/com/matter/casting/support/ConnectionCallbacks.java @@ -0,0 +1,53 @@ +/** + * Copyright (c) 2024 Project CHIP Authors All rights reserved. + * + *

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of the License at + * + *

http://www.apache.org/licenses/LICENSE-2.0 + * + *

Unless required by applicable law or agreed to in writing, software distributed under the + * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either + * express or implied. See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.matter.casting.support; + +/** @brief A container struct for User Directed Commissioning (UDC) callbacks. */ +public class ConnectionCallbacks { + + /** (Required) The callback called when the connection is established successfully. */ + public final MatterCallback onSuccess; + + /** (Required) The callback called with MatterError when the connection is fails to establish. */ + public final MatterCallback onFailure; + + /** + * (Optional) The callback called when the Client/Commissionee receives a CommissionerDeclaration + * message from the CastingPlayer/Commissioner. This callback is needed to support UDC features + * where a reply from the Commissioner is expected. It provides information indicating the + * Commissioner’s pre-commissioning state. + */ + public MatterCallback onCommissionerDeclaration; + + public ConnectionCallbacks( + MatterCallback onSuccess, + MatterCallback onFailure, + MatterCallback onCommissionerDeclaration) { + this.onSuccess = onSuccess; + this.onFailure = onFailure; + this.onCommissionerDeclaration = onCommissionerDeclaration; + } + + public MatterCallback getOnSuccess() { + return onSuccess; + } + + public MatterCallback getOnFailure() { + return onFailure; + } + + public MatterCallback getOnCommissionerDeclaration() { + return onCommissionerDeclaration; + } +} diff --git a/examples/tv-casting-app/android/App/app/src/main/jni/com/matter/casting/support/DataProvider.java b/examples/tv-casting-app/android/App/app/src/main/jni/com/matter/casting/support/DataProvider.java index eb701413bcd477..854cf76ce8aca8 100644 --- a/examples/tv-casting-app/android/App/app/src/main/jni/com/matter/casting/support/DataProvider.java +++ b/examples/tv-casting-app/android/App/app/src/main/jni/com/matter/casting/support/DataProvider.java @@ -19,15 +19,15 @@ import android.util.Log; -public abstract class DataProvider { - private static final String TAG = DataProvider.class.getSimpleName(); +public interface DataProvider { + public static final String TAG = DataProvider.class.getSimpleName(); - protected T _get() { + default T _get() { T val = null; try { val = get(); } catch (Throwable t) { - Log.e(TAG, "DataProvider::Caught an unhandled Throwable from the client: " + t); + Log.e(TAG, "DataProvider::_get() Caught an unhandled Throwable from the client: " + t); } return val; } diff --git a/examples/tv-casting-app/android/App/app/src/main/jni/com/matter/casting/support/IdentificationDeclarationOptions.java b/examples/tv-casting-app/android/App/app/src/main/jni/com/matter/casting/support/IdentificationDeclarationOptions.java new file mode 100644 index 00000000000000..18567374c66a17 --- /dev/null +++ b/examples/tv-casting-app/android/App/app/src/main/jni/com/matter/casting/support/IdentificationDeclarationOptions.java @@ -0,0 +1,145 @@ +/** + * Copyright (c) 2024 Project CHIP Authors All rights reserved. + * + *

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of the License at + * + *

http://www.apache.org/licenses/LICENSE-2.0 + * + *

Unless required by applicable law or agreed to in writing, software distributed under the + * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either + * express or implied. See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.matter.casting.support; + +import android.util.Log; +import java.util.ArrayList; +import java.util.List; + +/** + * This class contains the optional parameters used in the IdentificationDeclaration Message, sent + * by the Commissionee to the Commissioner. The options specify information relating to the + * requested UDC commissioning session. + */ +public class IdentificationDeclarationOptions { + private final String TAG = IdentificationDeclarationOptions.class.getSimpleName(); + private final short CHIP_DEVICE_CONFIG_UDC_MAX_TARGET_APPS = + getChipDeviceConfigUdcMaxTargetApps(); + + public IdentificationDeclarationOptions() {} + + public IdentificationDeclarationOptions( + boolean noPasscode, + boolean cdUponPasscodeDialog, + boolean commissionerPasscode, + boolean commissionerPasscodeReady, + boolean cancelPasscode, + List targetAppInfos) { + this.noPasscode = noPasscode; + this.cdUponPasscodeDialog = cdUponPasscodeDialog; + this.commissionerPasscode = commissionerPasscode; + this.commissionerPasscodeReady = commissionerPasscodeReady; + this.cancelPasscode = cancelPasscode; + this.targetAppInfos = targetAppInfos != null ? targetAppInfos : new ArrayList<>(); + } + + /** + * @brief Gets the maximum number of Target Content Apps that can be added to the + * IdentificationDeclarationOptions.java TargetAppInfo list from + * connectedhomeip/examples/tv-casting-app/tv-casting-common/include/CHIPProjectAppConfig.h. + * See this file for details. + */ + private native short getChipDeviceConfigUdcMaxTargetApps(); + + /** + * Feature: Target Content Application - Flag to instruct the Commissioner not to display a + * Passcode input dialog, and instead send a CommissionerDeclaration message if a commissioning + * Passcode is needed. + */ + public boolean noPasscode = false; + /** + * Feature: Coordinate Passcode Dialogs - Flag to instruct the Commissioner to send a + * CommissionerDeclaration message when the Passcode input dialog on the Commissioner has been + * shown to the user. + */ + public boolean cdUponPasscodeDialog = false; + /** + * Feature: Commissioner-Generated Passcode - Flag to instruct the Commissioner to use the + * Commissioner-generated Passcode for commissioning. + */ + public boolean commissionerPasscode = false; + /** + * Feature: Commissioner-Generated Passcode - Flag to indicate whether or not the Commissionee has + * obtained the Commissioner Passcode from the user and is therefore ready for commissioning. + */ + public boolean commissionerPasscodeReady = false; + /** + * Feature: Coordinate Passcode Dialogs Flag - to indicate when the Commissionee user has decided + * to exit the commissioning process. + */ + public boolean cancelPasscode = false; + /** + * Feature: Target Content Application - The set of content app Vendor IDs (and optionally, + * Product IDs) that can be used for authentication. Also, if TargetAppInfo is passed in, + * VerifyOrEstablishConnection() will force User Directed Commissioning, in case the desired + * TargetApp is not found in the on-device CastingStore. + */ + private List targetAppInfos = new ArrayList<>(); + + /** + * @brief Adds a TargetAppInfo to the IdentificationDeclarationOptions.java TargetAppInfos list, + * up to a maximum of CHIP_DEVICE_CONFIG_UDC_MAX_TARGET_APPS. + */ + public boolean addTargetAppInfo(TargetAppInfo targetAppInfo) { + Log.d(TAG, "addTargetAppInfo()"); + if (targetAppInfos.size() >= CHIP_DEVICE_CONFIG_UDC_MAX_TARGET_APPS) { + Log.e( + TAG, + "addTargetAppInfo() failed to add TargetAppInfo, max list size is: " + + CHIP_DEVICE_CONFIG_UDC_MAX_TARGET_APPS); + return false; + } + targetAppInfos.add(targetAppInfo); + return true; + } + + public List getTargetAppInfoList() { + return targetAppInfos; + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("IdentificationDeclarationOptions::noPasscode: ") + .append(noPasscode) + .append("\n"); + sb.append("IdentificationDeclarationOptions::cdUponPasscodeDialog: ") + .append(cdUponPasscodeDialog) + .append("\n"); + sb.append("IdentificationDeclarationOptions::commissionerPasscode: ") + .append(commissionerPasscode) + .append("\n"); + sb.append("IdentificationDeclarationOptions::commissionerPasscodeReady: ") + .append(commissionerPasscodeReady) + .append("\n"); + sb.append("IdentificationDeclarationOptions::cancelPasscode: ") + .append(cancelPasscode) + .append("\n"); + sb.append("IdentificationDeclarationOptions::targetAppInfos list: \n"); + + for (TargetAppInfo targetAppInfo : targetAppInfos) { + sb.append("\t\tTargetAppInfo - Vendor ID: ") + .append(targetAppInfo.vendorId) + .append(", Product ID: ") + .append(targetAppInfo.productId) + .append("\n"); + } + + return sb.toString(); + } + + public void logDetail() { + Log.d(TAG, "IdentificationDeclarationOptions::logDetail()\n" + this.toString()); + } +} diff --git a/examples/tv-casting-app/android/App/app/src/main/jni/com/matter/casting/support/TargetAppInfo.java b/examples/tv-casting-app/android/App/app/src/main/jni/com/matter/casting/support/TargetAppInfo.java new file mode 100644 index 00000000000000..1f605a89833bb1 --- /dev/null +++ b/examples/tv-casting-app/android/App/app/src/main/jni/com/matter/casting/support/TargetAppInfo.java @@ -0,0 +1,25 @@ +/** + * Copyright (c) 2024 Project CHIP Authors All rights reserved. + * + *

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of the License at + * + *

http://www.apache.org/licenses/LICENSE-2.0 + * + *

Unless required by applicable law or agreed to in writing, software distributed under the + * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either + * express or implied. See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.matter.casting.support; + +/** + * Feature: Target Content Application - The set of content app Vendor IDs (and optionally, Product + * IDs) that can be used for authentication. + */ +public class TargetAppInfo { + /** Target Target Content Application Vendor ID, null means unspecified */ + public Integer vendorId; + /** Target Target Content Application Product ID, null means unspecified */ + public Integer productId; +} diff --git a/examples/tv-casting-app/android/App/app/src/main/jni/cpp/core/CastingApp-JNI.cpp b/examples/tv-casting-app/android/App/app/src/main/jni/cpp/core/CastingApp-JNI.cpp index 81a42115070da7..ce8e8c0e1b77a6 100644 --- a/examples/tv-casting-app/android/App/app/src/main/jni/cpp/core/CastingApp-JNI.cpp +++ b/examples/tv-casting-app/android/App/app/src/main/jni/cpp/core/CastingApp-JNI.cpp @@ -24,6 +24,7 @@ // from tv-casting-common #include "core/CastingApp.h" +#include "core/CommissionerDeclarationHandler.h" #include "support/ChipDeviceEventHandler.h" #include @@ -47,7 +48,7 @@ jobject extractJAppParameter(jobject jAppParameters, const char * methodName, co JNI_METHOD(jobject, finishInitialization)(JNIEnv *, jobject, jobject jAppParameters) { chip::DeviceLayer::StackLock lock; - ChipLogProgress(AppServer, "JNI_METHOD CastingApp-JNI::finishInitialization() called"); + ChipLogProgress(AppServer, "CastingApp-JNI::finishInitialization() called"); VerifyOrReturnValue(jAppParameters != nullptr, support::convertMatterErrorFromCppToJava(CHIP_ERROR_INVALID_ARGUMENT)); CHIP_ERROR err = CHIP_NO_ERROR; @@ -81,7 +82,7 @@ JNI_METHOD(jobject, finishInitialization)(JNIEnv *, jobject, jobject jAppParamet JNI_METHOD(jobject, finishStartup)(JNIEnv *, jobject) { chip::DeviceLayer::StackLock lock; - ChipLogProgress(AppServer, "JNI_METHOD CastingAppJNI::finishStartup() called"); + ChipLogProgress(AppServer, "CastingApp-JNI::finishStartup() called"); CHIP_ERROR err = CHIP_NO_ERROR; auto & server = chip::Server::GetInstance(); @@ -102,13 +103,28 @@ JNI_METHOD(jobject, finishStartup)(JNIEnv *, jobject) VerifyOrReturnValue(err == CHIP_NO_ERROR, support::convertMatterErrorFromCppToJava(err), ChipLogError(AppServer, "Failed to register ChipDeviceEventHandler %" CHIP_ERROR_FORMAT, err.Format())); + ChipLogProgress(AppServer, + "CastingApp-JNI::finishStartup() calling " + "GetUserDirectedCommissioningClient()->SetCommissionerDeclarationHandler()"); +#if CHIP_DEVICE_CONFIG_ENABLE_COMMISSIONER_DISCOVERY_CLIENT + // Set a handler for Commissioner's CommissionerDeclaration messages. This is set in + // connectedhomeip/src/protocols/user_directed_commissioning/UserDirectedCommissioning.h + chip::Server::GetInstance().GetUserDirectedCommissioningClient()->SetCommissionerDeclarationHandler( + CommissionerDeclarationHandler::GetInstance()); +#endif // CHIP_DEVICE_CONFIG_ENABLE_COMMISSIONER_DISCOVERY_CLIENT + return support::convertMatterErrorFromCppToJava(CHIP_NO_ERROR); } JNI_METHOD(jobject, shutdownAllSubscriptions)(JNIEnv * env, jobject) { chip::DeviceLayer::StackLock lock; - ChipLogProgress(AppServer, "JNI_METHOD CastingApp-JNI::shutdownAllSubscriptions called"); + ChipLogProgress(AppServer, "CastingApp-JNI::shutdownAllSubscriptions() called"); + +#if CHIP_DEVICE_CONFIG_ENABLE_COMMISSIONER_DISCOVERY_CLIENT + // Remove the handler previously set for Commissioner's CommissionerDeclaration messages. + chip::Server::GetInstance().GetUserDirectedCommissioningClient()->SetCommissionerDeclarationHandler(nullptr); +#endif // CHIP_DEVICE_CONFIG_ENABLE_COMMISSIONER_DISCOVERY_CLIENT CHIP_ERROR err = matter::casting::core::CastingApp::GetInstance()->ShutdownAllSubscriptions(); return support::convertMatterErrorFromCppToJava(err); @@ -117,7 +133,7 @@ JNI_METHOD(jobject, shutdownAllSubscriptions)(JNIEnv * env, jobject) JNI_METHOD(jobject, clearCache)(JNIEnv * env, jobject) { chip::DeviceLayer::StackLock lock; - ChipLogProgress(AppServer, "JNI_METHOD CastingApp-JNI::clearCache called"); + ChipLogProgress(AppServer, "CastingApp-JNI::clearCache called"); CHIP_ERROR err = matter::casting::core::CastingApp::GetInstance()->ClearCache(); return support::convertMatterErrorFromCppToJava(err); @@ -125,7 +141,7 @@ JNI_METHOD(jobject, clearCache)(JNIEnv * env, jobject) jobject extractJAppParameter(jobject jAppParameters, const char * methodName, const char * methodSig) { - ChipLogProgress(AppServer, "JNI_METHOD CastingApp-JNI::extractJAppParameter() called"); + ChipLogProgress(AppServer, "CastingApp-JNI::extractJAppParameter() called"); JNIEnv * env = chip::JniReferences::GetInstance().GetEnvForCurrentThread(); jclass jAppParametersClass; diff --git a/examples/tv-casting-app/android/App/app/src/main/jni/cpp/core/MatterCastingPlayer-JNI.cpp b/examples/tv-casting-app/android/App/app/src/main/jni/cpp/core/MatterCastingPlayer-JNI.cpp index b2597c883406d8..b718682a17124b 100644 --- a/examples/tv-casting-app/android/App/app/src/main/jni/cpp/core/MatterCastingPlayer-JNI.cpp +++ b/examples/tv-casting-app/android/App/app/src/main/jni/cpp/core/MatterCastingPlayer-JNI.cpp @@ -21,10 +21,12 @@ #include "../JNIDACProvider.h" #include "../support/Converters-JNI.h" #include "../support/RotatingDeviceIdUniqueIdProvider-JNI.h" -#include "core/CastingApp.h" // from tv-casting-common -#include "core/CastingPlayer.h" // from tv-casting-common -#include "core/CastingPlayerDiscovery.h" // from tv-casting-common -#include "core/ConnectionCallbacks.h" // from tv-casting-common +#include "core/CastingApp.h" // from tv-casting-common +#include "core/CastingPlayer.h" // from tv-casting-common +#include "core/CastingPlayerDiscovery.h" // from tv-casting-common +#include "core/CommissionerDeclarationHandler.h" // from tv-casting-common +#include "core/ConnectionCallbacks.h" // from tv-casting-common +#include "core/IdentificationDeclarationOptions.h" // from tv-casting-common #include #include @@ -44,87 +46,113 @@ namespace core { MatterCastingPlayerJNI MatterCastingPlayerJNI::sInstance; JNI_METHOD(jobject, verifyOrEstablishConnection) -(JNIEnv * env, jobject thiz, jlong commissioningWindowTimeoutSec, jobject desiredEndpointFilterJavaObject, jobject jSuccessCallback, - jobject jFailureCallback) +(JNIEnv * env, jobject thiz, jobject jconnectionCallbacks, jlong commissioningWindowTimeoutSec, + jobject jIdentificationDeclarationOptions) { chip::DeviceLayer::StackLock lock; - ChipLogProgress(AppServer, "MatterCastingPlayer-JNI::verifyOrEstablishConnection() called with a timeout of: %ld seconds", - static_cast(commissioningWindowTimeoutSec)); + ChipLogProgress(AppServer, "MatterCastingPlayer-JNI::verifyOrEstablishConnection() called with a timeout of: %d seconds", + static_cast(commissioningWindowTimeoutSec)); CastingPlayer * castingPlayer = support::convertCastingPlayerFromJavaToCpp(thiz); VerifyOrReturnValue(castingPlayer != nullptr, support::convertMatterErrorFromCppToJava(CHIP_ERROR_INVALID_ARGUMENT)); - matter::casting::core::IdentificationDeclarationOptions idOptions; - - // TODO: In the following PRs. Replace EndpointFilter Java class with IdentificationDeclarationOptions Java class. - matter::casting::core::EndpointFilter desiredEndpointFilter; - if (desiredEndpointFilterJavaObject != nullptr) + // Find the ConnectionCallbacks class, get the field IDs of the connection callbacks and extract the callback objects. + jclass connectionCallbacksClass = env->GetObjectClass(jconnectionCallbacks); + VerifyOrReturnValue( + connectionCallbacksClass != nullptr, support::convertMatterErrorFromCppToJava(CHIP_ERROR_INVALID_ARGUMENT), + ChipLogError(AppServer, "MatterCastingPlayer-JNI::verifyOrEstablishConnection() connectionCallbacksClass == nullptr ")); + + jfieldID successCallbackFieldID = + env->GetFieldID(connectionCallbacksClass, "onSuccess", "Lcom/matter/casting/support/MatterCallback;"); + jfieldID failureCallbackFieldID = + env->GetFieldID(connectionCallbacksClass, "onFailure", "Lcom/matter/casting/support/MatterCallback;"); + jfieldID commissionerDeclarationCallbackFieldID = + env->GetFieldID(connectionCallbacksClass, "onCommissionerDeclaration", "Lcom/matter/casting/support/MatterCallback;"); + + jobject jSuccessCallback = env->GetObjectField(jconnectionCallbacks, successCallbackFieldID); + jobject jFailureCallback = env->GetObjectField(jconnectionCallbacks, failureCallbackFieldID); + jobject jCommissionerDeclarationCallback = env->GetObjectField(jconnectionCallbacks, commissionerDeclarationCallbackFieldID); + + VerifyOrReturnValue( + jSuccessCallback != nullptr, support::convertMatterErrorFromCppToJava(CHIP_ERROR_INVALID_ARGUMENT), + ChipLogError(AppServer, + "MatterCastingPlayer-JNI::verifyOrEstablishConnection() jSuccessCallback == nullptr but is mandatory ")); + VerifyOrReturnValue( + jFailureCallback != nullptr, support::convertMatterErrorFromCppToJava(CHIP_ERROR_INVALID_ARGUMENT), + ChipLogError(AppServer, + "MatterCastingPlayer-JNI::verifyOrEstablishConnection() jFailureCallback == nullptr but is mandatory ")); + + // jIdentificationDeclarationOptions is optional + matter::casting::core::IdentificationDeclarationOptions * idOptions = nullptr; + if (jIdentificationDeclarationOptions == nullptr) + { + ChipLogProgress(AppServer, + "MatterCastingPlayer-JNI::verifyOrEstablishConnection() Optional jIdentificationDeclarationOptions not " + "provided by the client"); + } + else { - chip::Protocols::UserDirectedCommissioning::TargetAppInfo targetAppInfo; - - // Convert the EndpointFilter Java class to a C++ EndpointFilter - jclass endpointFilterJavaClass = env->GetObjectClass(desiredEndpointFilterJavaObject); - jfieldID vendorIdFieldId = env->GetFieldID(endpointFilterJavaClass, "vendorId", "Ljava/lang/Integer;"); - jfieldID productIdFieldId = env->GetFieldID(endpointFilterJavaClass, "productId", "Ljava/lang/Integer;"); - jobject vendorIdIntegerObject = env->GetObjectField(desiredEndpointFilterJavaObject, vendorIdFieldId); - jobject productIdIntegerObject = env->GetObjectField(desiredEndpointFilterJavaObject, productIdFieldId); - // jfieldID requiredDeviceTypesFieldId = env->GetFieldID(endpointFilterJavaClass, "requiredDeviceTypes", - // "Ljava/util/List;"); - - // Value of 0 means unspecified - targetAppInfo.vendorId = vendorIdIntegerObject != nullptr - ? static_cast(env->CallIntMethod( - vendorIdIntegerObject, env->GetMethodID(env->GetObjectClass(vendorIdIntegerObject), "intValue", "()I"))) - : 0; - targetAppInfo.productId = productIdIntegerObject != nullptr - ? static_cast(env->CallIntMethod( - productIdIntegerObject, env->GetMethodID(env->GetObjectClass(productIdIntegerObject), "intValue", "()I"))) - : 0; - - CHIP_ERROR result = idOptions.addTargetAppInfo(targetAppInfo); - if (result != CHIP_NO_ERROR) - { - ChipLogError(AppServer, - "MatterCastingPlayer-JNI::verifyOrEstablishConnection() failed to add targetAppInfo: %" CHIP_ERROR_FORMAT, - result.Format()); - } + ChipLogProgress( + AppServer, + "MatterCastingPlayer-JNI::verifyOrEstablishConnection() jIdentificationDeclarationOptions was provided by client"); + idOptions = support::convertIdentificationDeclarationOptionsFromJavaToCpp(jIdentificationDeclarationOptions); + VerifyOrReturnValue(idOptions != nullptr, support::convertMatterErrorFromCppToJava(CHIP_ERROR_INVALID_ARGUMENT), + ChipLogError(AppServer, + "MatterCastingPlayer-JNI::verifyOrEstablishConnection() " + "convertIdentificationDeclarationOptionsFromJavaToCpp() error")); + idOptions->LogDetail(); } MatterCastingPlayerJNIMgr().mConnectionSuccessHandler.SetUp(env, jSuccessCallback); MatterCastingPlayerJNIMgr().mConnectionFailureHandler.SetUp(env, jFailureCallback); - auto connectCallback = [](CHIP_ERROR err, CastingPlayer * playerPtr) { - ChipLogProgress(AppServer, "MatterCastingPlayer-JNI::verifyOrEstablishConnection() ConnectCallback()"); - if (err == CHIP_NO_ERROR) - { - ChipLogProgress(AppServer, - "MatterCastingPlayer-JNI::verifyOrEstablishConnection() ConnectCallback() Connected to Casting Player " - "with device ID: %s", - playerPtr->GetId()); - // The Java jSuccessCallback is expecting a Void v callback parameter which translates to a nullptr. When calling the - // Java method from C++ via JNI, passing nullptr is equivalent to passing a Void object in Java. - MatterCastingPlayerJNIMgr().mConnectionSuccessHandler.Handle(nullptr); - } - else - { - ChipLogError( - AppServer, - "MatterCastingPlayer-JNI::verifyOrEstablishConnection() ConnectCallback() Connection error: %" CHIP_ERROR_FORMAT, - err.Format()); - MatterCastingPlayerJNIMgr().mConnectionFailureHandler.Handle(err); - } - }; - - // TODO: In the following PRs. Add optional CommissionerDeclarationHandler callback parameter for the Commissioner-Generated - // passcode commissioning flow. + // jCommissionerDeclarationCallback is optional + if (jCommissionerDeclarationCallback == nullptr) + { + ChipLogProgress(AppServer, + "MatterCastingPlayer-JNI::verifyOrEstablishConnection() optional jCommissionerDeclarationCallback was not " + "provided by the client"); + } + else + { + MatterCastingPlayerJNIMgr().mCommissionerDeclarationHandler.SetUp(env, jCommissionerDeclarationCallback); + } + matter::casting::core::ConnectionCallbacks connectionCallbacks; - connectionCallbacks.mOnConnectionComplete = connectCallback; + connectionCallbacks.mOnConnectionComplete = MatterCastingPlayerJNI::getInstance().getConnectCallback(); + connectionCallbacks.mCommissionerDeclarationCallback = + MatterCastingPlayerJNI::getInstance().getCommissionerDeclarationCallback(); castingPlayer->VerifyOrEstablishConnection(connectionCallbacks, static_cast(commissioningWindowTimeoutSec), - idOptions); + *idOptions); + return support::convertMatterErrorFromCppToJava(CHIP_NO_ERROR); } +JNI_METHOD(jobject, continueConnectingNative) +(JNIEnv * env, jobject thiz) +{ + chip::DeviceLayer::StackLock lock; + ChipLogProgress(AppServer, "MatterCastingPlayer-JNI::continueConnecting()"); + + CastingPlayer * castingPlayer = support::convertCastingPlayerFromJavaToCpp(thiz); + VerifyOrReturnValue(castingPlayer != nullptr, support::convertMatterErrorFromCppToJava(CHIP_ERROR_INVALID_ARGUMENT)); + + return support::convertMatterErrorFromCppToJava(castingPlayer->ContinueConnecting()); +} + +JNI_METHOD(jobject, stopConnecting) +(JNIEnv * env, jobject thiz) +{ + chip::DeviceLayer::StackLock lock; + ChipLogProgress(AppServer, "MatterCastingPlayer-JNI::stopConnecting()"); + + CastingPlayer * castingPlayer = support::convertCastingPlayerFromJavaToCpp(thiz); + VerifyOrReturnValue(castingPlayer != nullptr, support::convertMatterErrorFromCppToJava(CHIP_ERROR_INVALID_ARGUMENT)); + + return support::convertMatterErrorFromCppToJava(castingPlayer->StopConnecting()); +} + JNI_METHOD(void, disconnect) (JNIEnv * env, jobject thiz) { @@ -161,6 +189,54 @@ JNI_METHOD(jobject, getEndpoints) return jEndpointList; } +void MatterCastingPlayerJNI::ConnectCallback(CHIP_ERROR err, CastingPlayer * playerPtr) +{ + ChipLogProgress(AppServer, "MatterCastingPlayer-JNI::verifyOrEstablishConnection() ConnectCallback()"); + if (err == CHIP_NO_ERROR) + { + ChipLogProgress(AppServer, + "MatterCastingPlayer-JNI::verifyOrEstablishConnection() ConnectCallback() Connected to Casting Player " + "with device ID: %s", + playerPtr->GetId()); + // The Java jSuccessCallback is expecting a Void v callback parameter which translates to a nullptr. When calling the + // Java method from C++ via JNI, passing nullptr is equivalent to passing a Void object in Java. + MatterCastingPlayerJNIMgr().mConnectionSuccessHandler.Handle(nullptr); + } + else + { + ChipLogError( + AppServer, + "MatterCastingPlayer-JNI::verifyOrEstablishConnection() ConnectCallback() Connection error: %" CHIP_ERROR_FORMAT, + err.Format()); + MatterCastingPlayerJNIMgr().mConnectionFailureHandler.Handle(err); + } +} + +void MatterCastingPlayerJNI::CommissionerDeclarationCallback(const chip::Transport::PeerAddress & source, + chip::Protocols::UserDirectedCommissioning::CommissionerDeclaration cd) +{ + ChipLogProgress(AppServer, "MatterCastingPlayer-JNI::verifyOrEstablishConnection() CommissionerDeclarationCallback()"); + cd.DebugLog(); + + char addressStr[chip::Transport::PeerAddress::kMaxToStringSize]; + source.ToString(addressStr, sizeof(addressStr)); + ChipLogProgress(AppServer, + "MatterCastingPlayer-JNI::verifyOrEstablishConnection() CommissionerDeclarationCallback() source: %s", + addressStr); + + // Call the Java CommissionerDeclarationCallback if it was provided by the client. + if (!MatterCastingPlayerJNIMgr().mCommissionerDeclarationHandler.IsSetUp()) + { + ChipLogError(AppServer, + "MatterCastingPlayer-JNI::verifyOrEstablishConnection() CommissionerDeclarationCallback() received from " + "but Java callback is not set"); + } + else + { + MatterCastingPlayerJNIMgr().mCommissionerDeclarationHandler.Handle(cd); + } +} + }; // namespace core }; // namespace casting }; // namespace matter diff --git a/examples/tv-casting-app/android/App/app/src/main/jni/cpp/core/MatterCastingPlayer-JNI.h b/examples/tv-casting-app/android/App/app/src/main/jni/cpp/core/MatterCastingPlayer-JNI.h index 7f58162fff52b3..286d380cf7d942 100644 --- a/examples/tv-casting-app/android/App/app/src/main/jni/cpp/core/MatterCastingPlayer-JNI.h +++ b/examples/tv-casting-app/android/App/app/src/main/jni/cpp/core/MatterCastingPlayer-JNI.h @@ -27,16 +27,32 @@ namespace matter { namespace casting { namespace core { +/** + * This class is used to manage the JNI callbacks and C++ to Java conversions for the CastingPlayer. + */ class MatterCastingPlayerJNI { public: - MatterCastingPlayerJNI() : mConnectionSuccessHandler([](void *) { return nullptr; }) {} + // Member initializer list + MatterCastingPlayerJNI() : + mConnectionSuccessHandler([](void *) { return nullptr; }), + mConnectionFailureHandler(matter::casting::support::convertMatterErrorFromCppToJava), + mCommissionerDeclarationHandler(matter::casting::support::convertCommissionerDeclarationFromCppToJava) + {} support::MatterCallbackJNI mConnectionSuccessHandler; - support::MatterFailureCallbackJNI mConnectionFailureHandler; + support::MatterCallbackJNI mConnectionFailureHandler; + support::MatterCallbackJNI mCommissionerDeclarationHandler; + + static MatterCastingPlayerJNI & getInstance() { return sInstance; } + auto getConnectCallback() const { return ConnectCallback; } + auto getCommissionerDeclarationCallback() const { return CommissionerDeclarationCallback; } private: friend MatterCastingPlayerJNI & MatterCastingPlayerJNIMgr(); static MatterCastingPlayerJNI sInstance; + static void ConnectCallback(CHIP_ERROR err, CastingPlayer * playerPtr); + static void CommissionerDeclarationCallback(const chip::Transport::PeerAddress & source, + chip::Protocols::UserDirectedCommissioning::CommissionerDeclaration cd); }; inline class MatterCastingPlayerJNI & MatterCastingPlayerJNIMgr() diff --git a/examples/tv-casting-app/android/App/app/src/main/jni/cpp/support/Converters-JNI.cpp b/examples/tv-casting-app/android/App/app/src/main/jni/cpp/support/Converters-JNI.cpp index 00ca47216ae804..69f70c47d1762e 100644 --- a/examples/tv-casting-app/android/App/app/src/main/jni/cpp/support/Converters-JNI.cpp +++ b/examples/tv-casting-app/android/App/app/src/main/jni/cpp/support/Converters-JNI.cpp @@ -25,6 +25,17 @@ namespace support { using namespace chip; +extern "C" { + +JNIEXPORT jshort JNICALL +Java_com_matter_casting_support_IdentificationDeclarationOptions_getChipDeviceConfigUdcMaxTargetApps(JNIEnv *, jclass clazz) +{ + ChipLogProgress(AppServer, "Converters-JNI::getChipDeviceConfigUdcMaxTargetApps(), CHIP_DEVICE_CONFIG_UDC_MAX_TARGET_APPS: %d", + CHIP_DEVICE_CONFIG_UDC_MAX_TARGET_APPS); + return CHIP_DEVICE_CONFIG_UDC_MAX_TARGET_APPS; +} +} + jobject convertLongFromCppToJava(jlong value) { ChipLogProgress(AppServer, "convertLongFromCppToJava called"); @@ -366,6 +377,171 @@ jobject convertLongFromCppToJava(uint64_t responseData) return env->NewObject(responseTypeClass, constructor, responseData); } +chip::Protocols::UserDirectedCommissioning::TargetAppInfo * convertTargetAppInfoFromJavaToCpp(jobject jTargetAppInfo) +{ + ChipLogProgress(AppServer, "convertTargetAppInfoFromJavaToCpp() called"); + + JNIEnv * env = chip::JniReferences::GetInstance().GetEnvForCurrentThread(); + VerifyOrReturnValue(env != nullptr, nullptr, + ChipLogError(AppServer, "convertTargetAppInfoFromJavaToCpp() Could not get JNIEnv for current thread")); + jclass targetAppInfoClass = env->GetObjectClass(jTargetAppInfo); + VerifyOrReturnValue(targetAppInfoClass != nullptr, nullptr, + ChipLogError(AppServer, "convertTargetAppInfoFromJavaToCpp() TargetAppInfo class not found!")); + + jfieldID vendorIdField = env->GetFieldID(targetAppInfoClass, "vendorId", "Ljava/lang/Integer;"); + jfieldID productIdField = env->GetFieldID(targetAppInfoClass, "productId", "Ljava/lang/Integer;"); + VerifyOrReturnValue(vendorIdField != nullptr, nullptr, + ChipLogError(AppServer, "convertTargetAppInfoFromJavaToCpp() vendorIdField not found!")); + VerifyOrReturnValue(productIdField != nullptr, nullptr, + ChipLogError(AppServer, "convertTargetAppInfoFromJavaToCpp() productIdField not found!")); + + jobject jVendorIdObject = env->GetObjectField(jTargetAppInfo, vendorIdField); + jobject jProductIdObject = env->GetObjectField(jTargetAppInfo, productIdField); + + jclass integerClass = env->FindClass("java/lang/Integer"); + jmethodID intValueMethod = env->GetMethodID(integerClass, "intValue", "()I"); + + jint vendorId = 0; + jint productId = 0; + if (jVendorIdObject != nullptr) + { + vendorId = env->CallIntMethod(jVendorIdObject, intValueMethod); + } + if (jProductIdObject != nullptr) + { + productId = env->CallIntMethod(jProductIdObject, intValueMethod); + } + + chip::Protocols::UserDirectedCommissioning::TargetAppInfo * cppTargetAppInfo = + new chip::Protocols::UserDirectedCommissioning::TargetAppInfo(); + + cppTargetAppInfo->vendorId = static_cast(vendorId); + cppTargetAppInfo->productId = static_cast(productId); + + env->DeleteLocalRef(targetAppInfoClass); + env->DeleteLocalRef(jVendorIdObject); + env->DeleteLocalRef(jProductIdObject); + env->DeleteLocalRef(integerClass); + + return reinterpret_cast(cppTargetAppInfo); +} + +matter::casting::core::IdentificationDeclarationOptions * convertIdentificationDeclarationOptionsFromJavaToCpp(jobject jIdOptions) +{ + ChipLogProgress(AppServer, "convertIdentificationDeclarationOptionsFromJavaToCpp() called"); + + JNIEnv * env = chip::JniReferences::GetInstance().GetEnvForCurrentThread(); + VerifyOrReturnValue( + env != nullptr, nullptr, + ChipLogError(AppServer, "convertIdentificationDeclarationOptionsFromJavaToCpp() Could not get JNIEnv for current thread")); + + jclass idOptionsClass = env->GetObjectClass(jIdOptions); + VerifyOrReturnValue( + idOptionsClass != nullptr, nullptr, + ChipLogError(AppServer, + "convertIdentificationDeclarationOptionsFromJavaToCpp() IdentificationDeclarationOptions class not found!")); + + jfieldID noPasscodeField = env->GetFieldID(idOptionsClass, "noPasscode", "Z"); + jfieldID cdUponPasscodeDialogField = env->GetFieldID(idOptionsClass, "cdUponPasscodeDialog", "Z"); + jfieldID commissionerPasscodeField = env->GetFieldID(idOptionsClass, "commissionerPasscode", "Z"); + jfieldID commissionerPasscodeReadyField = env->GetFieldID(idOptionsClass, "commissionerPasscodeReady", "Z"); + jfieldID cancelPasscodeField = env->GetFieldID(idOptionsClass, "cancelPasscode", "Z"); + jfieldID targetAppInfosField = env->GetFieldID(idOptionsClass, "targetAppInfos", "Ljava/util/List;"); + VerifyOrReturnValue( + noPasscodeField != nullptr, nullptr, + ChipLogError(AppServer, "convertIdentificationDeclarationOptionsFromJavaToCpp() noPasscodeField not found!")); + VerifyOrReturnValue( + cdUponPasscodeDialogField != nullptr, nullptr, + ChipLogError(AppServer, "convertIdentificationDeclarationOptionsFromJavaToCpp() cdUponPasscodeDialogField not found!")); + VerifyOrReturnValue( + commissionerPasscodeField != nullptr, nullptr, + ChipLogError(AppServer, "convertIdentificationDeclarationOptionsFromJavaToCpp() commissionerPasscodeField not found!")); + VerifyOrReturnValue( + commissionerPasscodeReadyField != nullptr, nullptr, + ChipLogError(AppServer, + "convertIdentificationDeclarationOptionsFromJavaToCpp() commissionerPasscodeReadyField not found!")); + VerifyOrReturnValue( + cancelPasscodeField != nullptr, nullptr, + ChipLogError(AppServer, "convertIdentificationDeclarationOptionsFromJavaToCpp() cancelPasscodeField not found!")); + VerifyOrReturnValue( + targetAppInfosField != nullptr, nullptr, + ChipLogError(AppServer, "convertIdentificationDeclarationOptionsFromJavaToCpp() targetAppInfosField not found!")); + + matter::casting::core::IdentificationDeclarationOptions * cppIdOptions = + new matter::casting::core::IdentificationDeclarationOptions(); + + cppIdOptions->mNoPasscode = env->GetBooleanField(jIdOptions, noPasscodeField); + cppIdOptions->mCdUponPasscodeDialog = env->GetBooleanField(jIdOptions, cdUponPasscodeDialogField); + cppIdOptions->mCommissionerPasscode = env->GetBooleanField(jIdOptions, commissionerPasscodeField); + cppIdOptions->mCommissionerPasscodeReady = env->GetBooleanField(jIdOptions, commissionerPasscodeReadyField); + cppIdOptions->mCancelPasscode = env->GetBooleanField(jIdOptions, cancelPasscodeField); + + jobject targetAppInfosList = env->GetObjectField(jIdOptions, targetAppInfosField); + VerifyOrReturnValue( + targetAppInfosList != nullptr, nullptr, + ChipLogError(AppServer, "convertIdentificationDeclarationOptionsFromJavaToCpp() targetAppInfosList not found!")); + jclass listClass = env->FindClass("java/util/List"); + jmethodID sizeMethod = env->GetMethodID(listClass, "size", "()I"); + jmethodID getMethod = env->GetMethodID(listClass, "get", "(I)Ljava/lang/Object;"); + + jint size = env->CallIntMethod(targetAppInfosList, sizeMethod); + + for (jint i = 0; i < size; i++) + { + jobject jTargetAppInfo = env->CallObjectMethod(targetAppInfosList, getMethod, i); + + chip::Protocols::UserDirectedCommissioning::TargetAppInfo * cppTargetAppInfo = + convertTargetAppInfoFromJavaToCpp(jTargetAppInfo); + VerifyOrReturnValue( + cppTargetAppInfo != nullptr, nullptr, + ChipLogError(AppServer, "convertIdentificationDeclarationOptionsFromJavaToCpp() Could not convert jTargetAppInfo")); + + CHIP_ERROR err = cppIdOptions->addTargetAppInfo(*cppTargetAppInfo); + + env->DeleteLocalRef(jTargetAppInfo); + VerifyOrReturnValue(err == CHIP_NO_ERROR, nullptr, + ChipLogError(AppServer, + "convertIdentificationDeclarationOptionsFromJavaToCpp() failed to addTargetAppInfo, due " + "to err: %" CHIP_ERROR_FORMAT, + err.Format())); + } + + env->DeleteLocalRef(targetAppInfosList); + env->DeleteLocalRef(listClass); + env->DeleteLocalRef(idOptionsClass); + + return reinterpret_cast(cppIdOptions); +} + +jobject +convertCommissionerDeclarationFromCppToJava(const chip::Protocols::UserDirectedCommissioning::CommissionerDeclaration & cppCd) +{ + ChipLogProgress(AppServer, "convertCommissionerDeclarationFromCppToJava() called"); + + JNIEnv * env = chip::JniReferences::GetInstance().GetEnvForCurrentThread(); + VerifyOrReturnValue( + env != nullptr, nullptr, + ChipLogError(AppServer, "convertCommissionerDeclarationFromCppToJava() Could not get JNIEnv for current thread")); + + jclass jCommissionerDeclarationClass; + CHIP_ERROR err = chip::JniReferences::GetInstance().GetLocalClassRef(env, "com/matter/casting/support/CommissionerDeclaration", + jCommissionerDeclarationClass); + VerifyOrReturnValue(err == CHIP_NO_ERROR, nullptr); + + jmethodID jCommissionerDeclarationConstructor = env->GetMethodID(jCommissionerDeclarationClass, "", "(IZZZZZ)V"); + if (jCommissionerDeclarationConstructor == nullptr) + { + ChipLogError(AppServer, + "convertCommissionerDeclarationFromCppToJava() Failed to access Java CommissionerDeclaration constructor"); + env->ExceptionClear(); + return nullptr; + } + + return env->NewObject(jCommissionerDeclarationClass, jCommissionerDeclarationConstructor, + static_cast(cppCd.GetErrorCode()), cppCd.GetNeedsPasscode(), cppCd.GetNoAppsFound(), + cppCd.GetPasscodeDialogDisplayed(), cppCd.GetCommissionerPasscode(), cppCd.GetQRCodeDisplayed()); +} + }; // namespace support }; // namespace casting }; // namespace matter diff --git a/examples/tv-casting-app/android/App/app/src/main/jni/cpp/support/Converters-JNI.h b/examples/tv-casting-app/android/App/app/src/main/jni/cpp/support/Converters-JNI.h index aa96af0668f5d4..d5ef62e349ae61 100644 --- a/examples/tv-casting-app/android/App/app/src/main/jni/cpp/support/Converters-JNI.h +++ b/examples/tv-casting-app/android/App/app/src/main/jni/cpp/support/Converters-JNI.h @@ -19,7 +19,10 @@ #include "core/BaseCluster.h" #include "core/CastingPlayer.h" #include "core/Command.h" +#include "core/CommissionerDeclarationHandler.h" +#include "core/ConnectionCallbacks.h" #include "core/Endpoint.h" +#include "core/IdentificationDeclarationOptions.h" #include @@ -74,6 +77,28 @@ void * convertCommandFromJavaToCpp(jobject jCommandObject); jobject convertLongFromCppToJava(uint64_t responseData); +/** + * @brief Converts a Java TargetAppInfo into a native MatterTargetAppInfo. + * + * @return pointer to the TargetAppInfo jobject if created successfully, nullptr otherwise. + */ +chip::Protocols::UserDirectedCommissioning::TargetAppInfo * convertTargetAppInfoFromJavaToCpp(jobject jTargetAppInfo); + +/** + * @brief Converts a Java IdentificationDeclarationOptions into a native IdentificationDeclarationOptions + * + * @return pointer to the IdentificationDeclarationOptions if created successfully, nullptr otherwise. + */ +matter::casting::core::IdentificationDeclarationOptions * convertIdentificationDeclarationOptionsFromJavaToCpp(jobject jIdOptions); + +/** + * @brief Converts a native CommissioningDeclaration into a MatterCommissioningDeclaration jobject + * + * @return pointer to the CommissioningDeclaration jobject if created successfully, nullptr otherwise. + */ +jobject +convertCommissionerDeclarationFromCppToJava(const chip::Protocols::UserDirectedCommissioning::CommissionerDeclaration & cppCd); + }; // namespace support }; // namespace casting }; // namespace matter diff --git a/examples/tv-casting-app/android/App/app/src/main/jni/cpp/support/MatterCallback-JNI.h b/examples/tv-casting-app/android/App/app/src/main/jni/cpp/support/MatterCallback-JNI.h index 82894e075ea912..6bd185952535e7 100644 --- a/examples/tv-casting-app/android/App/app/src/main/jni/cpp/support/MatterCallback-JNI.h +++ b/examples/tv-casting-app/android/App/app/src/main/jni/cpp/support/MatterCallback-JNI.h @@ -62,6 +62,8 @@ class MatterCallbackJNI return CHIP_NO_ERROR; } + bool IsSetUp() const { return mCallbackObject.HasValidObjectRef() && mMethod != nullptr; } + void Handle(T responseData) { ChipLogProgress(AppServer, "MatterCallbackJNI::Handle called"); diff --git a/examples/tv-casting-app/android/App/app/src/main/res/layout/custom_passcode_dialog.xml b/examples/tv-casting-app/android/App/app/src/main/res/layout/custom_passcode_dialog.xml new file mode 100644 index 00000000000000..1b868e06b71f29 --- /dev/null +++ b/examples/tv-casting-app/android/App/app/src/main/res/layout/custom_passcode_dialog.xml @@ -0,0 +1,39 @@ + + + + + + + + + + \ No newline at end of file diff --git a/examples/tv-casting-app/android/App/app/src/main/res/values/strings.xml b/examples/tv-casting-app/android/App/app/src/main/res/values/strings.xml index 4485b6a31ab788..21b7841a656796 100644 --- a/examples/tv-casting-app/android/App/app/src/main/res/values/strings.xml +++ b/examples/tv-casting-app/android/App/app/src/main/res/values/strings.xml @@ -33,11 +33,13 @@ Initializing Discovering Casting Players on-network: Discovery Stopped - No errors to report + Long click on a Casting Player to connect using CastingPlayer/Commissioner-Generated passcode commissioning flow (if supported). Start discovery error. - Start discovery error. Discovery ongoing, stop before starting. - Stop discovery error. - Next + Enter the Commissioner-Generated Passcode + Input the Commissioner-Generated passcode displayed on the CastingPlayer UX, or use the default provided (12345678). Select an action Content Launcher Launch URL Disconnect from Casting Player diff --git a/examples/tv-casting-app/android/BUILD.gn b/examples/tv-casting-app/android/BUILD.gn index 416570417b0794..48d68100930a91 100644 --- a/examples/tv-casting-app/android/BUILD.gn +++ b/examples/tv-casting-app/android/BUILD.gn @@ -114,12 +114,16 @@ android_library("java") { "App/app/src/main/jni/com/matter/casting/core/MatterCastingPlayerDiscovery.java", "App/app/src/main/jni/com/matter/casting/support/AppParameters.java", "App/app/src/main/jni/com/matter/casting/support/CommissionableData.java", + "App/app/src/main/jni/com/matter/casting/support/CommissionerDeclaration.java", + "App/app/src/main/jni/com/matter/casting/support/ConnectionCallbacks.java", "App/app/src/main/jni/com/matter/casting/support/DACProvider.java", "App/app/src/main/jni/com/matter/casting/support/DataProvider.java", "App/app/src/main/jni/com/matter/casting/support/DeviceTypeStruct.java", "App/app/src/main/jni/com/matter/casting/support/EndpointFilter.java", + "App/app/src/main/jni/com/matter/casting/support/IdentificationDeclarationOptions.java", "App/app/src/main/jni/com/matter/casting/support/MatterCallback.java", "App/app/src/main/jni/com/matter/casting/support/MatterError.java", + "App/app/src/main/jni/com/matter/casting/support/TargetAppInfo.java", ] javac_flags = [ "-Xlint:deprecation" ] diff --git a/examples/tv-casting-app/linux/simple-app-helper.cpp b/examples/tv-casting-app/linux/simple-app-helper.cpp index beef624eea5ff8..c961bd5adaaacb 100644 --- a/examples/tv-casting-app/linux/simple-app-helper.cpp +++ b/examples/tv-casting-app/linux/simple-app-helper.cpp @@ -344,7 +344,7 @@ void CommissionerDeclarationCallback(const chip::Transport::PeerAddress & source { ChipLogProgress(AppServer, "---- Awaiting user input ----"); ChipLogProgress(AppServer, "Input the Commissioner-Generated passcode displayed on the CastingPlayer UX."); - ChipLogProgress(AppServer, "Input 1245678 to use the default passcode."); + ChipLogProgress(AppServer, "Input 12345678 to use the default passcode."); ChipLogProgress(AppServer, "Example: cast setcommissionerpasscode 12345678"); ChipLogProgress(AppServer, "---- Awaiting user input ----"); gAwaitingCommissionerPasscodeInput = true; @@ -458,7 +458,7 @@ CHIP_ERROR CommandHandler(int argc, char ** argv) uint32_t passcode = (uint32_t) strtol(argv[1], &eptr, 10); if (gAwaitingCommissionerPasscodeInput) { - ChipLogProgress(AppServer, "CommandHandler() setcommissionerpasscode user enterd passcode: %d", passcode); + ChipLogProgress(AppServer, "CommandHandler() setcommissionerpasscode user entered passcode: %d", passcode); gAwaitingCommissionerPasscodeInput = false; // Per connectedhomeip/examples/platform/linux/LinuxCommissionableDataProvider.h: We don't support overriding the @@ -486,7 +486,12 @@ CHIP_ERROR CommandHandler(int argc, char ** argv) } // Continue Connecting to the target CastingPlayer with the user entered Commissioner-generated Passcode. - targetCastingPlayer->ContinueConnecting(); + err = targetCastingPlayer->ContinueConnecting(); + if (err != CHIP_NO_ERROR) + { + ChipLogError(AppServer, "CommandHandler() setcommissionerpasscode ContinueConnecting() err %" CHIP_ERROR_FORMAT, + err.Format()); + } } else { @@ -495,6 +500,15 @@ CHIP_ERROR CommandHandler(int argc, char ** argv) "CommandHandler() setcommissionerpasscode, no Commissioner-Generated passcode input expected at this time."); } } + if (strcmp(argv[0], "stop-connecting") == 0) + { + ChipLogProgress(AppServer, "CommandHandler() stop-connecting"); + CHIP_ERROR err = targetCastingPlayer->StopConnecting(); + if (err != CHIP_NO_ERROR) + { + ChipLogError(AppServer, "CommandHandler() stop-connecting, err %" CHIP_ERROR_FORMAT, err.Format()); + } + } if (strcmp(argv[0], "print-bindings") == 0) { PrintBindings(); @@ -536,6 +550,9 @@ CHIP_ERROR PrintAllCommands() " setcommissionerpasscode Set the commissioning session's passcode to the " "Commissioner-Generated passcode. Used for the the Commissioner-Generated passcode commissioning flow. Usage: " "cast setcommissionerpasscode 12345678\r\n"); + streamer_printf(sout, + " stop-connecting Stop connecting to Casting Player upon " + "Commissioner-Generated passcode commissioning flow passcode input request. Usage: cast stop-connecting\r\n"); streamer_printf(sout, "\r\n"); return CHIP_NO_ERROR; diff --git a/examples/tv-casting-app/tv-casting-common/core/CastingPlayer.cpp b/examples/tv-casting-app/tv-casting-common/core/CastingPlayer.cpp index ff204923da5d40..cff903a1a1316b 100644 --- a/examples/tv-casting-app/tv-casting-common/core/CastingPlayer.cpp +++ b/examples/tv-casting-app/tv-casting-common/core/CastingPlayer.cpp @@ -60,6 +60,10 @@ void CastingPlayer::VerifyOrEstablishConnection(ConnectionCallbacks connectionCa // information indicating the Commissioner's pre-commissioning state. if (connectionCallbacks.mCommissionerDeclarationCallback != nullptr) { + ChipLogProgress(AppServer, + "CastingPlayer::VerifyOrEstablishConnection() Setting CommissionerDeclarationCallback in " + "CommissionerDeclarationHandler"); + // Set the callback for handling CommissionerDeclaration messages. matter::casting::core::CommissionerDeclarationHandler::GetInstance()->SetCommissionerDeclarationCallback( connectionCallbacks.mCommissionerDeclarationCallback); } @@ -155,9 +159,9 @@ void CastingPlayer::VerifyOrEstablishConnection(ConnectionCallbacks connectionCa } else { - // We need to call OpenBasicCommissioningWindow() for both Commissionee-Generated passcode commissioning flow and - // Commissioner-Generated passcode commissioning flow. Per the Matter spec (UserDirectedCommissioning), even if the - // Commissionee sends an IdentificationDeclaration with CommissionerPasscode set to true, the Commissioner will first + // We need to call OpenBasicCommissioningWindow() for both the Client/Commissionee-Generated passcode commissioning flow and + // Casting Player/Commissioner-Generated passcode commissioning flow. Per the Matter spec (UserDirectedCommissioning), even + // if the Commissionee sends an IdentificationDeclaration with CommissionerPasscode set to true, the Commissioner will first // attempt to use AccountLogin in order to obtain Passcode using rotatingID. If no Passcode is obtained, Commissioner // displays a Passcode. ChipLogProgress(AppServer, "CastingPlayer::VerifyOrEstablishConnection() calling OpenBasicCommissioningWindow()"); @@ -178,18 +182,20 @@ void CastingPlayer::VerifyOrEstablishConnection(ConnectionCallbacks connectionCa } } -void CastingPlayer::ContinueConnecting() +CHIP_ERROR CastingPlayer::ContinueConnecting() { ChipLogProgress(AppServer, "CastingPlayer::ContinueConnecting()"); - CHIP_ERROR err = CHIP_NO_ERROR; - // Verify that mOnCompleted is not nullptr. - VerifyOrExit(mOnCompleted != nullptr, ChipLogError(AppServer, "CastingPlayer::ContinueConnecting() mOnCompleted == nullptr")); - if (!matter::casting::core::CommissionerDeclarationHandler::GetInstance()->HasCommissionerDeclarationCallback()) - { - ChipLogProgress(AppServer, - "CastingPlayer::ContinueConnecting() CommissionerDeclaration message callback has not been set."); - } - mConnectionState = CASTING_PLAYER_CONNECTING; + VerifyOrReturnValue(mOnCompleted != nullptr, CHIP_ERROR_INVALID_ARGUMENT, + ChipLogError(AppServer, "CastingPlayer::ContinueConnecting() mOnCompleted == nullptr");); + VerifyOrReturnValue(mConnectionState == CASTING_PLAYER_CONNECTING, CHIP_ERROR_INCORRECT_STATE, + ChipLogError(AppServer, "CastingPlayer::ContinueConnecting() called while not in connecting state");); + VerifyOrReturnValue( + mIdOptions.mCommissionerPasscode, CHIP_ERROR_INCORRECT_STATE, + ChipLogError(AppServer, + "CastingPlayer::ContinueConnecting() mIdOptions.mCommissionerPasscode == false, ContinueConnecting() should " + "only be called when the CastingPlayer/Commissioner-Generated passcode commissioning flow is in progress.");); + + CHIP_ERROR err = CHIP_NO_ERROR; mTargetCastingPlayer = this; ChipLogProgress(AppServer, "CastingPlayer::ContinueConnecting() calling OpenBasicCommissioningWindow()"); @@ -208,6 +214,57 @@ void CastingPlayer::ContinueConnecting() ChipLogError(AppServer, "CastingPlayer::ContinueConnecting() failed with %" CHIP_ERROR_FORMAT, err.Format()); resetState(err); } + + return err; +} + +CHIP_ERROR CastingPlayer::StopConnecting() +{ + ChipLogProgress(AppServer, "CastingPlayer::StopConnecting() called, while ChipDeviceEventHandler.sUdcInProgress: %s", + support::ChipDeviceEventHandler::isUdcInProgress() ? "true" : "false"); + VerifyOrReturnValue(mConnectionState == CASTING_PLAYER_CONNECTING, CHIP_ERROR_INCORRECT_STATE, + ChipLogError(AppServer, "CastingPlayer::StopConnecting() called while not in connecting state");); + VerifyOrReturnValue( + mIdOptions.mCommissionerPasscode, CHIP_ERROR_INCORRECT_STATE, + ChipLogError(AppServer, + "CastingPlayer::StopConnecting() mIdOptions.mCommissionerPasscode == false, ContinueConnecting() should only " + "be called when the CastingPlayer/Commissioner-Generated passcode commissioning flow is in progress.");); + + CHIP_ERROR err = CHIP_NO_ERROR; + mIdOptions.resetState(); + mIdOptions.mCancelPasscode = true; + mConnectionState = CASTING_PLAYER_NOT_CONNECTED; + mCommissioningWindowTimeoutSec = kCommissioningWindowTimeoutSec; + mTargetCastingPlayer = nullptr; + + // If a CastingPlayer::ContinueConnecting() error occurs, StopConnecting() can be called while sUdcInProgress == true. + // sUdcInProgress should be set to false before sending the CancelPasscode IdentificationDeclaration message to the + // CastingPlayer/Commissioner. + if (support::ChipDeviceEventHandler::isUdcInProgress()) + { + support::ChipDeviceEventHandler::SetUdcStatus(false); + } + + ChipLogProgress( + AppServer, + "CastingPlayer::StopConnecting() calling SendUserDirectedCommissioningRequest() to indicate user canceled passcode entry"); +#if CHIP_DEVICE_CONFIG_ENABLE_COMMISSIONER_DISCOVERY_CLIENT + err = SendUserDirectedCommissioningRequest(); + if (err != CHIP_NO_ERROR) + { + ChipLogError(AppServer, "CastingPlayer::StopConnecting() failed with %" CHIP_ERROR_FORMAT, err.Format()); + resetState(err); + return err; + } +#endif // CHIP_DEVICE_CONFIG_ENABLE_COMMISSIONER_DISCOVERY_CLIENT + + // CastingPlayer::SendUserDirectedCommissioningRequest() calls SetUdcStatus(true) before sending the UDC + // IdentificationDeclaration message. Since StopConnecting() is attempting to cancel the commissioning process, we need to set + // the UDC status to false after sending the message. + support::ChipDeviceEventHandler::SetUdcStatus(false); + + ChipLogProgress(AppServer, "CastingPlayer::StopConnecting() User Directed Commissioning stopped"); + return err; } void CastingPlayer::resetState(CHIP_ERROR err) diff --git a/examples/tv-casting-app/tv-casting-common/core/CastingPlayer.h b/examples/tv-casting-app/tv-casting-common/core/CastingPlayer.h index d5bbcd46006920..0802765bf37dd7 100644 --- a/examples/tv-casting-app/tv-casting-common/core/CastingPlayer.h +++ b/examples/tv-casting-app/tv-casting-common/core/CastingPlayer.h @@ -89,7 +89,7 @@ class ConnectionContext; class CastingPlayer; /** - * @brief CastingPlayer represents a Matter commissioner that is able to play media to a physical + * @brief CastingPlayer represents a Matter Commissioner that is able to play media to a physical * output or to a display screen which is part of the device. */ class CastingPlayer : public std::enable_shared_from_this @@ -129,23 +129,18 @@ class CastingPlayer : public std::enable_shared_from_this /** * @brief Verifies that a connection exists with this CastingPlayer, or triggers a new commissioning session request. If the * CastingApp does not have the nodeId and fabricIndex of this CastingPlayer cached on disk, this will execute the User Directed - * Commissioning (UDC) process by sending an IdentificationDeclaration message to the Commissioner. For certain UDC features, - * where a Commissioner reply is expected, this API needs to be followed up with the ContinueConnecting() API defiend below. See - * the Matter UDC specification or parameter class definitions for details on features not included in the description below. + * Commissioning (UDC) process by sending an IdentificationDeclaration message to the CastingPlayer/Commissioner. For certain + * UDC features, where a Commissioner reply is expected, this API needs to be followed up with the ContinueConnecting() API + * defiend below. See the Matter UDC specification or parameter class definitions for details on features not included in the + * description below. * * @param connectionCallbacks contains the ConnectCallback (Required) and CommissionerDeclarationCallback (Optional) defiend in * ConnectCallbacks.h. * - * ConnectCallback: The callback called when the connection process has ended, regardless of whether it was successful or not. - * - * CommissionerDeclarationCallback: The callback called when the Commissionee receives a CommissionerDeclaration message from - * the Commissioner. This callback is needed to support UDC features where a reply from the Commissioner is expected. It - * provides information indicating the Commissioner’s pre-commissioning state. - * - * For example: During Commissioner-Generated passcode commissioning, the Commissioner replies with a CommissionerDeclaration - * message with PasscodeDialogDisplayed and CommissionerPasscode set to true. Given these Commissioner state details, the client - * is expected to perform some actions, detailed in the ContinueConnecting() API below, and then call the ContinueConnecting() - * API to complete the process. + * For example: During CastingPlayer/Commissioner-Generated passcode commissioning, the Commissioner replies with a + * CommissionerDeclaration message with PasscodeDialogDisplayed and CommissionerPasscode set to true. Given these Commissioner + * state details, the client is expected to perform some actions, detailed in the ContinueConnecting() API below, and then call + * the ContinueConnecting() API to complete the process. * * @param commissioningWindowTimeoutSec (Optional) time (in sec) to keep the commissioning window open, if commissioning is * required. Needs to be >= kCommissioningWindowTimeoutSec. @@ -153,9 +148,9 @@ class CastingPlayer : public std::enable_shared_from_this * @param idOptions (Optional) Parameters in the IdentificationDeclaration message sent by the Commissionee to the Commissioner. * These parameters specify the information relating to the requested commissioning session. * - * For example: To invoke the Commissioner-Generated passcode commissioning flow, the client would call this API with - * IdentificationDeclarationOptions containing CommissionerPasscode set to true. See IdentificationDeclarationOptions.h for a - * complete list of optional parameters. + * For example: To invoke the CastingPlayer/Commissioner-Generated passcode commissioning flow, the client would call this API + * with IdentificationDeclarationOptions containing CommissionerPasscode set to true. See IdentificationDeclarationOptions.h for + * a complete list of optional parameters. * * Furthermore, attributes (such as VendorId) describe the TargetApp that the client wants to interact with after commissioning. * If this value is passed in, VerifyOrEstablishConnection() will force UDC, in case the desired @@ -166,7 +161,7 @@ class CastingPlayer : public std::enable_shared_from_this IdentificationDeclarationOptions idOptions = IdentificationDeclarationOptions()); /** - * @brief This is a continuation of the Commissioner-Generated passcode commissioning flow started via the + * @brief This is a continuation of the CastingPlayer/Commissioner-Generated passcode commissioning flow started via the * VerifyOrEstablishConnection() API above. It continues the UDC process by sending a second IdentificationDeclaration message * to Commissioner containing CommissionerPasscode and CommissionerPasscodeReady set to true. At this point it is assumed that * the following have occurred: @@ -176,16 +171,29 @@ class CastingPlayer : public std::enable_shared_from_this * 2. Commissioner generated and displayed a passcode. * 3. The Commissioner replied with a CommissionerDecelration message with PasscodeDialogDisplayed and CommissionerPasscode set * to true. - * 3. Client has handled the Commissioner's CommissionerDecelration message. - * 4. Client prompted user to input Passcode from Commissioner. - * 5. Client has updated the commissioning session's PAKE verifier using the user input Passcode by updating the CastingApps + * 4. Client has handled the Commissioner's CommissionerDecelration message. + * 5. Client prompted user to input Passcode from Commissioner. + * 6. Client has updated the commissioning session's PAKE verifier using the user input Passcode by updating the CastingApp's * CommissionableDataProvider * (matter::casting::core::CastingApp::GetInstance()->UpdateCommissionableDataProvider(CommissionableDataProvider)). * * The same connectionCallbacks and commissioningWindowTimeoutSec parameters passed into VerifyOrEstablishConnection() will be * used. + * @return CHIP_NO_ERROR if this function was called with the CastingPlayer in the correct state and an error otherwise. + */ + CHIP_ERROR ContinueConnecting(); + + /** + * @brief This cancels the CastingPlayer/Commissioner-Generated passcode commissioning flow started via the + * VerifyOrEstablishConnection() API above. It constructs and sends an IdentificationDeclaration message to the + * CastingPlayer/Commissioner containing CancelPasscode set to true. It is used to indicate that the user, and thus the + * Client/Commissionee, have cancelled the commissioning process. This indicates that the CastingPlayer/Commissioner can dismiss + * any dialogs corresponding to commissioning, such as a Passcode input dialog or a Passcode display dialog. + * Note: stopConnecting() does not call the ConnectCallback() callback passed to the VerifyOrEstablishConnection() API above + * since no connection is established. + * @return CHIP_NO_ERROR if this function was called with the CastingPlayer in the correct state and an error otherwise. */ - void ContinueConnecting(); + CHIP_ERROR StopConnecting(); /** * @brief Sets the internal connection state of this CastingPlayer to "disconnected" diff --git a/examples/tv-casting-app/tv-casting-common/core/ConnectionCallbacks.h b/examples/tv-casting-app/tv-casting-common/core/ConnectionCallbacks.h index 01badaaf059dad..bc03df3afee421 100644 --- a/examples/tv-casting-app/tv-casting-common/core/ConnectionCallbacks.h +++ b/examples/tv-casting-app/tv-casting-common/core/ConnectionCallbacks.h @@ -47,11 +47,13 @@ using CommissionerDeclarationCallback = std::function getTargetAppInfoList() const { return mTargetAppInfos; } + void resetState() + { + mNoPasscode = false; + mCdUponPasscodeDialog = false; + mCommissionerPasscode = false; + mCommissionerPasscodeReady = false; + mCancelPasscode = false; + mTargetAppInfos.clear(); + } + /** * @brief Builds an IdentificationDeclaration message to be sent to a CastingPlayer, given the options state specified in this * object. @@ -107,7 +117,6 @@ class IdentificationDeclarationOptions { id.SetCommissionerPasscodeReady(true); id.SetInstanceName(mCommissioneeInstanceName); - mCommissionerPasscodeReady = false; } else { @@ -136,7 +145,7 @@ class IdentificationDeclarationOptions void LogDetail() { - ChipLogDetail(AppServer, "IdentificationDeclarationOptions::LogDetail()"); + ChipLogDetail(AppServer, "IdentificationDeclarationOptions::LogDetail() - cpp"); ChipLogDetail(AppServer, "IdentificationDeclarationOptions::mNoPasscode: %s", mNoPasscode ? "true" : "false"); ChipLogDetail(AppServer, "IdentificationDeclarationOptions::mCdUponPasscodeDialog: %s", @@ -148,6 +157,14 @@ class IdentificationDeclarationOptions ChipLogDetail(AppServer, "IdentificationDeclarationOptions::mCancelPasscode: %s", mCancelPasscode ? "true" : "false"); ChipLogDetail(AppServer, "IdentificationDeclarationOptions::mCommissioneeInstanceName: %s", mCommissioneeInstanceName); + + ChipLogDetail(AppServer, "IdentificationDeclarationOptions::TargetAppInfos list:"); + for (size_t i = 0; i < mTargetAppInfos.size(); i++) + { + const chip::Protocols::UserDirectedCommissioning::TargetAppInfo & info = mTargetAppInfos[i]; + ChipLogDetail(AppServer, "\t\tTargetAppInfo %d, Vendor ID: %u, Product ID: %u", int(i + 1), info.vendorId, + info.productId); + } } private: diff --git a/examples/tv-casting-app/tv-casting-common/support/ChipDeviceEventHandler.cpp b/examples/tv-casting-app/tv-casting-common/support/ChipDeviceEventHandler.cpp index fd6039d5256031..bb226a15298229 100644 --- a/examples/tv-casting-app/tv-casting-common/support/ChipDeviceEventHandler.cpp +++ b/examples/tv-casting-app/tv-casting-common/support/ChipDeviceEventHandler.cpp @@ -222,6 +222,11 @@ CHIP_ERROR ChipDeviceEventHandler::SetUdcStatus(bool udcInProgress) return CHIP_NO_ERROR; } +bool ChipDeviceEventHandler::isUdcInProgress() +{ + return sUdcInProgress; +} + }; // namespace support }; // namespace casting }; // namespace matter diff --git a/examples/tv-casting-app/tv-casting-common/support/ChipDeviceEventHandler.h b/examples/tv-casting-app/tv-casting-common/support/ChipDeviceEventHandler.h index d8660a007cc585..cdebdf698b927c 100644 --- a/examples/tv-casting-app/tv-casting-common/support/ChipDeviceEventHandler.h +++ b/examples/tv-casting-app/tv-casting-common/support/ChipDeviceEventHandler.h @@ -45,6 +45,11 @@ class ChipDeviceEventHandler */ static CHIP_ERROR SetUdcStatus(bool udcInProgress); + /** + * @brief Returns true if User Directed Commissioning (UDC) is in progress, false otherwise. + */ + static bool isUdcInProgress(); + private: /** * @brief if kFailSafeTimerExpired is received and a request to connect to a CastingPlayer is pending, open a basic diff --git a/src/protocols/user_directed_commissioning/UserDirectedCommissioning.h b/src/protocols/user_directed_commissioning/UserDirectedCommissioning.h index 7a496e5a2f0a33..cf9a55365b9191 100644 --- a/src/protocols/user_directed_commissioning/UserDirectedCommissioning.h +++ b/src/protocols/user_directed_commissioning/UserDirectedCommissioning.h @@ -535,6 +535,7 @@ class DLL_EXPORT UserDirectedCommissioningClient : public TransportMgrDelegate */ void SetCommissionerDeclarationHandler(CommissionerDeclarationHandler * commissionerDeclarationHandler) { + ChipLogProgress(AppServer, "UserDirectedCommissioningClient::SetCommissionerDeclarationHandler()"); mCommissionerDeclarationHandler = commissionerDeclarationHandler; } diff --git a/src/protocols/user_directed_commissioning/UserDirectedCommissioningClient.cpp b/src/protocols/user_directed_commissioning/UserDirectedCommissioningClient.cpp index 6d7c315ffb5308..aeb5691be2554c 100644 --- a/src/protocols/user_directed_commissioning/UserDirectedCommissioningClient.cpp +++ b/src/protocols/user_directed_commissioning/UserDirectedCommissioningClient.cpp @@ -242,7 +242,7 @@ void UserDirectedCommissioningClient::OnMessageReceived(const Transport::PeerAdd char addrBuffer[chip::Transport::PeerAddress::kMaxToStringSize]; source.ToString(addrBuffer); - ChipLogProgress(AppServer, "UserDirectedCommissioningClient::OnMessageReceived from %s", addrBuffer); + ChipLogProgress(AppServer, "UserDirectedCommissioningClient::OnMessageReceived() from %s", addrBuffer); PacketHeader packetHeader; @@ -250,14 +250,16 @@ void UserDirectedCommissioningClient::OnMessageReceived(const Transport::PeerAdd if (packetHeader.IsEncrypted()) { - ChipLogError(AppServer, "UDC encryption flag set - ignoring"); + ChipLogError(AppServer, "UserDirectedCommissioningClient::OnMessageReceived() UDC encryption flag set - ignoring"); return; } PayloadHeader payloadHeader; ReturnOnFailure(payloadHeader.DecodeAndConsume(msg)); - ChipLogProgress(AppServer, "CommissionerDeclaration DataLength()=%" PRIu32, static_cast(msg->DataLength())); + ChipLogProgress(AppServer, + "UserDirectedCommissioningClient::OnMessageReceived() CommissionerDeclaration DataLength() = %" PRIu32, + static_cast(msg->DataLength())); uint8_t udcPayload[IdentificationDeclaration::kUdcTLVDataMaxBytes]; size_t udcPayloadLength = std::min(msg->DataLength(), sizeof(udcPayload)); @@ -272,6 +274,10 @@ void UserDirectedCommissioningClient::OnMessageReceived(const Transport::PeerAdd { mCommissionerDeclarationHandler->OnCommissionerDeclarationMessage(source, cd); } + else + { + ChipLogProgress(AppServer, "UserDirectedCommissioningClient::OnMessageReceived() No registered handler for UDC messages"); + } } } // namespace UserDirectedCommissioning