कंपैनियन डिवाइस को जोड़ना

Android 8.0 (एपीआई लेवल 26) और उसके बाद के वर्शन वाले डिवाइसों पर, साथ काम करने वाले डिवाइस को जोड़ने की सुविधा, आपके ऐप्लिकेशन की ओर से आस-पास मौजूद डिवाइसों का ब्लूटूथ या वाई-फ़ाई स्कैन करती है. इसके लिए, ACCESS_FINE_LOCATION की अनुमति की ज़रूरत नहीं होती. इससे उपयोगकर्ता की निजता सुरक्षा को ज़्यादा से ज़्यादा बढ़ाने में मदद मिलती है. इस तरीके का इस्तेमाल करके, साथी डिवाइस का शुरुआती कॉन्फ़िगरेशन करें. जैसे, बीएलई की सुविधा वाली स्मार्ट वॉच. साथ ही, साथी डिवाइस को जोड़ने के लिए, जगह की जानकारी की सेवा चालू होनी चाहिए.

साथ काम करने वाले डिवाइस को जोड़ने की सुविधा, अपने-आप कनेक्शन नहीं बनाती और न ही लगातार स्कैन करने की सुविधा चालू करती है. ऐप्लिकेशन, कनेक्शन बनाने के लिए ब्लूटूथ या वाई-फ़ाई कनेक्टिविटी एपीआई का इस्तेमाल कर सकते हैं.

डिवाइस को जोड़ने के बाद, उसे बैकग्राउंड से ऐप्लिकेशन चालू करने के लिए, REQUEST_COMPANION_RUN_IN_BACKGROUND और REQUEST_COMPANION_USE_DATA_IN_BACKGROUND की अनुमतियों का इस्तेमाल किया जा सकता है. ऐप्लिकेशन, बैकग्राउंड से फ़ोरग्राउंड सेवा शुरू करने के लिए, REQUEST_COMPANION_START_FOREGROUND_SERVICES_FROM_BACKGROUND अनुमति का भी इस्तेमाल कर सकते हैं.

उपयोगकर्ता, सूची में से कोई डिवाइस चुन सकता है और ऐप्लिकेशन को डिवाइस ऐक्सेस करने की अनुमतियां दे सकता है. ऐप्लिकेशन को अनइंस्टॉल करने या disassociate() को कॉल करने पर, ये अनुमतियां रद्द हो जाती हैं. अगर उपयोगकर्ता को अब इन असोसिएशन की ज़रूरत नहीं है, तो साथी ऐप्लिकेशन को खुद के असोसिएशन हटाने की ज़िम्मेदारी मिलती है. जैसे, जब वे लॉग आउट करते हैं या सीमित डिवाइसों को हटाते हैं.

साथ काम करने वाले डिवाइस को जोड़ने की सुविधा लागू करना

इस सेक्शन में, ब्लूटूथ, बीएलई, और वाई-फ़ाई की मदद से, ऐप्लिकेशन को साथी डिवाइसों से जोड़ने के लिए, CompanionDeviceManager का इस्तेमाल करने का तरीका बताया गया है.

साथी डिवाइसों की जानकारी देना

यहां दिए गए कोड सैंपल में, मेनिफ़ेस्ट फ़ाइल में <uses-feature> फ़्लैग जोड़ने का तरीका बताया गया है. इससे सिस्टम को पता चलता है कि आपका ऐप्लिकेशन, साथी डिवाइसों को सेट अप करना चाहता है.

<uses-feature android:name="android.software.companion_device_setup"/>

DeviceFilter के हिसाब से डिवाइसों की सूची बनाना

आपके पास, रेंज में मौजूद उन सभी कंपैनियन डिवाइसों को दिखाने का विकल्प है जो आपके दिए गए DeviceFilter से मिलते-जुलते हैं (पहली इमेज में दिखाया गया है). अगर आपको सिर्फ़ एक डिवाइस पर स्कैनिंग की सुविधा सीमित करनी है, तो setSingleDevice() को true पर सेट करें (जैसा कि दूसरे चित्र में दिखाया गया है).

साथी डिवाइस से जोड़ा जा रहा है
पहला डायग्राम. कंपैनियन डिवाइसों को जोड़ना
किसी एक डिवाइस से जोड़ना
दूसरी इमेज. एक डिवाइस से जोड़ना

DeviceFilter के ये सबक्लास, AssociationRequest में बताए जा सकते हैं:

तीनों सबक्लास में ऐसे बिल्डर होते हैं जो फ़िल्टर के कॉन्फ़िगरेशन को आसान बनाते हैं. नीचे दिए गए उदाहरण में, कोई डिवाइस BluetoothDeviceFilter के साथ ब्लूटूथ डिवाइस को स्कैन करता है.

Kotlin

val deviceFilter: BluetoothDeviceFilter = BluetoothDeviceFilter.Builder()
        // Match only Bluetooth devices whose name matches the pattern.
        .setNamePattern(Pattern.compile("My device"))
        // Match only Bluetooth devices whose service UUID matches this pattern.
        .addServiceUuid(ParcelUuid(UUID(0x123abcL, -1L)), null)
        .build()

Java

BluetoothDeviceFilter deviceFilter = new BluetoothDeviceFilter.Builder()
        // Match only Bluetooth devices whose name matches the pattern.
        .setNamePattern(Pattern.compile("My device"))
        // Match only Bluetooth devices whose service UUID matches this pattern.
        .addServiceUuid(new ParcelUuid(new UUID(0x123abcL, -1L)), null)
        .build();

DeviceFilter को AssociationRequest पर सेट करें, ताकि CompanionDeviceManager यह तय कर सके कि किस तरह के डिवाइसों को खोजना है.

Kotlin

val pairingRequest: AssociationRequest = AssociationRequest.Builder()
        // Find only devices that match this request filter.
        .addDeviceFilter(deviceFilter)
        // Stop scanning as soon as one device matching the filter is found.
        .setSingleDevice(true)
        .build()

Java

AssociationRequest pairingRequest = new AssociationRequest.Builder()
        // Find only devices that match this request filter.
        .addDeviceFilter(deviceFilter)
        // Stop scanning as soon as one device matching the filter is found.
        .setSingleDevice(true)
        .build();

जब आपका ऐप्लिकेशन AssociationRequest को शुरू कर देता है, तो CompanionDeviceManager पर associate() फ़ंक्शन चलाएं. associate() फ़ंक्शन, AssociationRequest और Callback को पैरामीटर के तौर पर लेता है.

जब CompanionDeviceManager किसी डिवाइस का पता लगाता है और वह उपयोगकर्ता की सहमति वाला डायलॉग बॉक्स लॉन्च करने के लिए तैयार होता है, तो Callback, onAssociationPending में IntentSender दिखाता है. उपयोगकर्ता के डिवाइस की पुष्टि करने के बाद, onAssociationCreated में डिवाइस का AssociationInfo रिटर्न किया जाता है. अगर आपके ऐप्लिकेशन को कोई डिवाइस नहीं मिलता है, तो कॉलबैक गड़बड़ी के मैसेज के साथ onFailure दिखाता है.

Android 13 (एपीआई लेवल 33) और उसके बाद के वर्शन वाले डिवाइसों पर:

Kotlin

val deviceManager =
  requireContext().getSystemService(Context.COMPANION_DEVICE_SERVICE)

val executor: Executor =  Executor { it.run() }

deviceManager.associate(pairingRequest,
    executor,
    object : CompanionDeviceManager.Callback() {
    // Called when a device is found. Launch the IntentSender so the user
    // can select the device they want to pair with.
    override fun onAssociationPending(intentSender: IntentSender) {
        intentSender?.let {
             startIntentSenderForResult(it, SELECT_DEVICE_REQUEST_CODE, null, 0, 0, 0)
        }
    }

    override fun onAssociationCreated(associationInfo: AssociationInfo) {
        // An association is created.
    }

    override fun onFailure(errorMessage: CharSequence?) {
        // To handle the failure.
     }
})

Java

CompanionDeviceManager deviceManager =
        (CompanionDeviceManager) getSystemService(Context.COMPANION_DEVICE_SERVICE);

Executor executor = new Executor() {
            @Override
            public void execute(Runnable runnable) {
                runnable.run();
            }
        };
deviceManager.associate(pairingRequest, new CompanionDeviceManager.Callback() {
    executor,
    // Called when a device is found. Launch the IntentSender so the user can
    // select the device they want to pair with.
    @Override
    public void onDeviceFound(IntentSender chooserLauncher) {
        try {
            startIntentSenderForResult(
                    chooserLauncher, SELECT_DEVICE_REQUEST_CODE, null, 0, 0, 0
            );
        } catch (IntentSender.SendIntentException e) {
            Log.e("MainActivity", "Failed to send intent");
        }
    }

    @Override
    public void onAssociationCreated(AssociationInfo associationInfo) {
        // An association is created.
    }

    @Override
    public void onFailure(CharSequence errorMessage) {
        // To handle the failure.
    });

Android 12L (एपीआई लेवल 32) या इससे पहले के वर्शन वाले डिवाइसों पर (अब सेवा में नहीं है):

Kotlin

val deviceManager =
      requireContext().getSystemService(Context.COMPANION_DEVICE_SERVICE)

deviceManager.associate(pairingRequest,
    object : CompanionDeviceManager.Callback() {
        // Called when a device is found. Launch the IntentSender so the user
        // can select the device they want to pair with.
        override fun onDeviceFound(chooserLauncher: IntentSender) {
            startIntentSenderForResult(chooserLauncher,
                SELECT_DEVICE_REQUEST_CODE, null, 0, 0, 0)
        }

        override fun onFailure(error: CharSequence?) {
            // To handle the failure.
        }
    }, null)

Java

CompanionDeviceManager deviceManager =
        (CompanionDeviceManager) getSystemService(Context.COMPANION_DEVICE_SERVICE);
deviceManager.associate(pairingRequest, new CompanionDeviceManager.Callback() {
    // Called when a device is found. Launch the IntentSender so the user can
    // select the device they want to pair with.
    @Override
    public void onDeviceFound(IntentSender chooserLauncher) {
        try {
            startIntentSenderForResult(
                    chooserLauncher, SELECT_DEVICE_REQUEST_CODE, null, 0, 0, 0
            );
        } catch (IntentSender.SendIntentException e) {
            Log.e("MainActivity", "Failed to send intent");
        }
    }

    @Override
    public void onFailure(CharSequence error) {
        // To handle the failure.
    }
}, null);

उपयोगकर्ता के चुने गए विकल्प का नतीजा, आपकी गतिविधि के onActivityResult() में मौजूद फ़्रैगमेंट में भेजा जाता है. इसके बाद, चुने गए डिवाइस को ऐक्सेस किया जा सकता है.

जब उपयोगकर्ता कोई ब्लूटूथ डिवाइस चुनता है, तो आपको BluetoothDevice दिखेगा. जब उपयोगकर्ता कोई ब्लूटूथ एलई डिवाइस चुनता है, तो आपको android.bluetooth.le.ScanResult दिखेगा. जब उपयोगकर्ता कोई वाई-फ़ाई डिवाइस चुनता है, तो आपको android.net.wifi.ScanResult दिखेगा.

Kotlin

override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
    when (requestCode) {
        SELECT_DEVICE_REQUEST_CODE -> when(resultCode) {
            Activity.RESULT_OK -> {
                // The user chose to pair the app with a Bluetooth device.
                val deviceToPair: BluetoothDevice? =
data?.getParcelableExtra(CompanionDeviceManager.EXTRA_DEVICE)
                deviceToPair?.let { device ->
                    device.createBond()
                    // Continue to interact with the paired device.
                }
            }
        }
        else -> super.onActivityResult(requestCode, resultCode, data)
    }
}

Java

@Override
protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data) {
    if (resultCode != Activity.RESULT_OK) {
        return;
    }
    if (requestCode == SELECT_DEVICE_REQUEST_CODE && data != null) {
        BluetoothDevice deviceToPair =
data.getParcelableExtra(CompanionDeviceManager.EXTRA_DEVICE);
        if (deviceToPair != null) {
            deviceToPair.createBond();
            // Continue to interact with the paired device.
        }
    } else {
        super.onActivityResult(requestCode, resultCode, data);
    }
}

पूरा उदाहरण देखें:

Android 13 (एपीआई लेवल 33) और उसके बाद के वर्शन वाले डिवाइसों पर:

Kotlin

private const val SELECT_DEVICE_REQUEST_CODE = 0

class MainActivity : AppCompatActivity() {

    private val deviceManager: CompanionDeviceManager by lazy {
        getSystemService(Context.COMPANION_DEVICE_SERVICE) as CompanionDeviceManager
    }
    val mBluetoothAdapter: BluetoothAdapter by lazy {
        val java = BluetoothManager::class.java
        getSystemService(java)!!.adapter }
    val executor: Executor =  Executor { it.run() }

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        // To skip filters based on names and supported feature flags (UUIDs),
        // omit calls to setNamePattern() and addServiceUuid()
        // respectively, as shown in the following  Bluetooth example.
        val deviceFilter: BluetoothDeviceFilter = BluetoothDeviceFilter.Builder()
            .setNamePattern(Pattern.compile("My device"))
            .addServiceUuid(ParcelUuid(UUID(0x123abcL, -1L)), null)
            .build()

        // The argument provided in setSingleDevice() determines whether a single
        // device name or a list of them appears.
        val pairingRequest: AssociationRequest = AssociationRequest.Builder()
            .addDeviceFilter(deviceFilter)
            .setSingleDevice(true)
            .build()

        // When the app tries to pair with a Bluetooth device, show the
        // corresponding dialog box to the user.
        deviceManager.associate(pairingRequest,
            executor,
            object : CompanionDeviceManager.Callback() {
                // Called when a device is found. Launch the IntentSender so the user
                // can select the device they want to pair with.
                override fun onAssociationPending(intentSender: IntentSender) {
                intentSender?.let {
                    startIntentSenderForResult(it, SELECT_DEVICE_REQUEST_CODE, null, 0, 0, 0)
              }
            }

             override fun onAssociationCreated(associationInfo: AssociationInfo) {
                 // AssociationInfo object is created and get association id and the
                 // macAddress.
                 var associationId: int = associationInfo.id
                 var macAddress: MacAddress = associationInfo.deviceMacAddress
             }
             override fun onFailure(errorMessage: CharSequence?) {
                // Handle the failure.
            }
    )

    override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
        when (requestCode) {
            SELECT_DEVICE_REQUEST_CODE -> when(resultCode) {
                Activity.RESULT_OK -> {
                    // The user chose to pair the app with a Bluetooth device.
                    val deviceToPair: BluetoothDevice? =
                        data?.getParcelableExtra(CompanionDeviceManager.EXTRA_DEVICE)
                    deviceToPair?.let { device ->
                        device.createBond()
                        // Maintain continuous interaction with a paired device.
                    }
                }
            }
            else -> super.onActivityResult(requestCode, resultCode, data)
        }
    }
}

Java

class MainActivityJava extends AppCompatActivity {

    private static final int SELECT_DEVICE_REQUEST_CODE = 0;
    Executor executor = new Executor() {
        @Override
        public void execute(Runnable runnable) {
            runnable.run();
        }
    };

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        CompanionDeviceManager deviceManager =
            (CompanionDeviceManager) getSystemService(
                Context.COMPANION_DEVICE_SERVICE
            );

        // To skip filtering based on name and supported feature flags,
        // do not include calls to setNamePattern() and addServiceUuid(),
        // respectively. This example uses Bluetooth.
        BluetoothDeviceFilter deviceFilter =
            new BluetoothDeviceFilter.Builder()
                .setNamePattern(Pattern.compile("My device"))
                .addServiceUuid(
                    new ParcelUuid(new UUID(0x123abcL, -1L)), null
                )
                .build();

        // The argument provided in setSingleDevice() determines whether a single
        // device name or a list of device names is presented to the user as
        // pairing options.
        AssociationRequest pairingRequest = new AssociationRequest.Builder()
            .addDeviceFilter(deviceFilter)
            .setSingleDevice(true)
            .build();

        // When the app tries to pair with the Bluetooth device, show the
        // appropriate pairing request dialog to the user.
        deviceManager.associate(pairingRequest, new CompanionDeviceManager.Callback() {
            executor,
           // Called when a device is found. Launch the IntentSender so the user can
           // select the device they want to pair with.
           @Override
           public void onDeviceFound(IntentSender chooserLauncher) {
               try {
                   startIntentSenderForResult(
                       chooserLauncher, SELECT_DEVICE_REQUEST_CODE, null, 0, 0, 0
                   );
               } catch (IntentSender.SendIntentException e) {
                   Log.e("MainActivity", "Failed to send intent");
               }
           }

          @Override
          public void onAssociationCreated(AssociationInfo associationInfo) {
                 // AssociationInfo object is created and get association id and the
                 // macAddress.
                 int associationId = associationInfo.getId();
                 MacAddress macAddress = associationInfo.getDeviceMacAddress();
          }

          @Override
          public void onFailure(CharSequence errorMessage) {
             // Handle the failure.
        });
    }

    @Override
    protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data) {
        if (resultCode != Activity.RESULT_OK) {
            return;
        }
        if (requestCode == SELECT_DEVICE_REQUEST_CODE) {
            if (resultCode == Activity.RESULT_OK && data != null) {
                BluetoothDevice deviceToPair = data.getParcelableExtra(
                    CompanionDeviceManager.EXTRA_DEVICE
                );

                if (deviceToPair != null) {
                    deviceToPair.createBond();
                    // ... Continue interacting with the paired device.
                }
            }
        } else {
            super.onActivityResult(requestCode, resultCode, data);
        }
    }
}

Android 12L (एपीआई लेवल 32) या इससे पहले के वर्शन वाले डिवाइसों पर (अब सेवा में नहीं है):

Kotlin

private const val SELECT_DEVICE_REQUEST_CODE = 0

class MainActivity : AppCompatActivity() {

    private val deviceManager: CompanionDeviceManager by lazy {
        getSystemService(Context.COMPANION_DEVICE_SERVICE) as CompanionDeviceManager
    }

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        // To skip filters based on names and supported feature flags (UUIDs),
        // omit calls to setNamePattern() and addServiceUuid()
        // respectively, as shown in the following  Bluetooth example.
        val deviceFilter: BluetoothDeviceFilter = BluetoothDeviceFilter.Builder()
            .setNamePattern(Pattern.compile("My device"))
            .addServiceUuid(ParcelUuid(UUID(0x123abcL, -1L)), null)
            .build()

        // The argument provided in setSingleDevice() determines whether a single
        // device name or a list of them appears.
        val pairingRequest: AssociationRequest = AssociationRequest.Builder()
            .addDeviceFilter(deviceFilter)
            .setSingleDevice(true)
            .build()

        // When the app tries to pair with a Bluetooth device, show the
        // corresponding dialog box to the user.
        deviceManager.associate(pairingRequest,
            object : CompanionDeviceManager.Callback() {

                override fun onDeviceFound(chooserLauncher: IntentSender) {
                    startIntentSenderForResult(chooserLauncher,
                        SELECT_DEVICE_REQUEST_CODE, null, 0, 0, 0)
                }

                override fun onFailure(error: CharSequence?) {
                    // Handle the failure.
                }
            }, null)
    }

    override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
        when (requestCode) {
            SELECT_DEVICE_REQUEST_CODE -> when(resultCode) {
                Activity.RESULT_OK -> {
                    // The user chose to pair the app with a Bluetooth device.
                    val deviceToPair: BluetoothDevice? =
                        data?.getParcelableExtra(CompanionDeviceManager.EXTRA_DEVICE)
                    deviceToPair?.let { device ->
                        device.createBond()
                        // Maintain continuous interaction with a paired device.
                    }
                }
            }
            else -> super.onActivityResult(requestCode, resultCode, data)
        }
    }
}

Java

class MainActivityJava extends AppCompatActivity {

    private static final int SELECT_DEVICE_REQUEST_CODE = 0;

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        CompanionDeviceManager deviceManager =
            (CompanionDeviceManager) getSystemService(
                Context.COMPANION_DEVICE_SERVICE
            );

        // To skip filtering based on name and supported feature flags,
        // don't include calls to setNamePattern() and addServiceUuid(),
        // respectively. This example uses Bluetooth.
        BluetoothDeviceFilter deviceFilter =
            new BluetoothDeviceFilter.Builder()
                .setNamePattern(Pattern.compile("My device"))
                .addServiceUuid(
                    new ParcelUuid(new UUID(0x123abcL, -1L)), null
                )
                .build();

        // The argument provided in setSingleDevice() determines whether a single
        // device name or a list of device names is presented to the user as
        // pairing options.
        AssociationRequest pairingRequest = new AssociationRequest.Builder()
            .addDeviceFilter(deviceFilter)
            .setSingleDevice(true)
            .build();

        // When the app tries to pair with the Bluetooth device, show the
        // appropriate pairing request dialog to the user.
        deviceManager.associate(pairingRequest,
            new CompanionDeviceManager.Callback() {
                @Override
                public void onDeviceFound(IntentSender chooserLauncher) {
                    try {
                        startIntentSenderForResult(chooserLauncher,
                            SELECT_DEVICE_REQUEST_CODE, null, 0, 0, 0);
                    } catch (IntentSender.SendIntentException e) {
                        // failed to send the intent
                    }
                }

                @Override
                public void onFailure(CharSequence error) {
                    // handle failure to find the companion device
                }
            }, null);
    }

    @Override
    protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data) {
        if (requestCode == SELECT_DEVICE_REQUEST_CODE) {
            if (resultCode == Activity.RESULT_OK && data != null) {
                BluetoothDevice deviceToPair = data.getParcelableExtra(
                    CompanionDeviceManager.EXTRA_DEVICE
                );

                if (deviceToPair != null) {
                    deviceToPair.createBond();
                    // ... Continue interacting with the paired device.
                }
            }
        } else {
            super.onActivityResult(requestCode, resultCode, data);
        }
    }
}

कंपैनियन डिवाइस की प्रोफ़ाइलें

Android 12 (एपीआई लेवल 31) और इसके बाद के वर्शन पर, स्मार्टवॉच जैसे डिवाइसों को मैनेज करने वाले साथी ऐप्लिकेशन, साथी डिवाइस की प्रोफ़ाइलों का इस्तेमाल कर सकते हैं. इससे, डिवाइसों को जोड़ते समय ज़रूरी अनुमतियां देकर, सेटअप की प्रोसेस को आसान बनाया जा सकता है. ज़्यादा जानकारी के लिए, साथ काम करने वाले डिवाइस की प्रोफ़ाइलें देखें.

साथी ऐप्लिकेशन चालू रखना

Android 12 (एपीआई लेवल 31) और उसके बाद के वर्शन पर, अतिरिक्त एपीआई का इस्तेमाल किया जा सकता है. इससे साथी डिवाइस के रेंज में होने पर भी आपका साथी ऐप्लिकेशन चलता रहेगा. इन एपीआई की मदद से ये काम किए जा सकते हैं:

  • जब साथी डिवाइस रेंज में हो, तब अपने ऐप्लिकेशन को चालू करें.

    ज़्यादा जानकारी के लिए, CompanionDeviceManager.startObservingDevicePresence() देखें.

  • यह गारंटी देना कि जब तक साथी डिवाइस रेंज में रहेगा, तब तक ऐप्लिकेशन की प्रोसेस चलती रहेगी.

    ज़्यादा जानकारी के लिए, CompanionDeviceService.onDeviceAppeared() देखें.