2023/11/30

【Kotlin/Android Studio】Bluetoothのスキャン方法！startScanの使い方

この記事からわかること

Android Studio/KotlinでBluetooth接続アプリの実装方法
startScanメソッドの使い方
スキャンにフィルタリングや設定をする方法

index

[open]

Bluetoothのスキャン方法
スキャンのフィルタリング方法
スキャン設定を指定する
RSSIを取得する

＼アプリをリリースしました／

友達や家族の誕生日をメモ！通知も届く-みんなの誕生日-

posted withアプリーチ

環境

Android Studio：Koala
Kotlin：1.9.0

公式リファレンス：BluetoothLeScanner

Bluetoothのスキャン方法

KotlinでBluetooth機能の実装の流れのペリフェラルのスキャンを実装するためにはbluetoothLeScannerクラスのstartScanメソッドを実行します。bluetoothLeScannerクラスを取得するためにはBluetoothAdapterクラスが必要になります。

MainActivity.kt
private val bluetoothAdapter: BluetoothAdapter? by lazy(LazyThreadSafetyMode.NONE) {
    val bluetoothManager = getSystemService(Context.BLUETOOTH_SERVICE) as BluetoothManager
    bluetoothManager.adapter
}

startScanメソッドの引数にはスキャンの結果後に処理を行うためのコールバックをScanCallback型で定義する必要があります。

MainActivity.kt
bluetoothLeScanner = bluetoothAdapter?.bluetoothLeScanner
scanCallback = leScanCallback()
// スキャンの開始
bluetoothLeScanner?.startScan(scanCallback)

ScanCallback内でonScanResultメソッドの中でスキャンしたペリフェラル情報を取得することが可能です。

private fun leScanCallback(): ScanCallback? {
    return object: ScanCallback() {
        override fun onScanResult(
            callbackType: Int,
            result: ScanResult,
        ) {
            super.onScanResult(callbackType, result)

            if (result != null && result.device != null && result.device.name?.toString() == "対象Peripheral名") {
                // 所望のペリフェラルが見つかった。
                // スキャンの停止
                bluetoothLeScanner?.stopScan(scanCallback)
            }
            return
        }
    }
}

スキャンのフィルタリング方法

startScanメソッドは引数にScanFilter型のリストを渡すことでデバイス名やサービスUUIDでスキャンを絞り込むことができます。setDeviceNameメソッドに絞り込みたいデバイス名をsetServiceUuidメソッドにはParcelUuid型でUUIDを渡します。

var serviceUuid = UUID.fromString("00000000-1111-1111-1111-111111111111")

var scanNameFilter: ScanFilter = ScanFilter.Builder()
    .setDeviceName("デバイス名")
    .build()

var scanUuidFilter: ScanFilter = ScanFilter.Builder()
    .setServiceUuid(ParcelUuid(serviceUuid))
    .build()

var scanFilters = ArrayList<ScanFilter>()
scanFilters.add(scanNameFilter)
scanFilters.add(scanUuidFilter)

bluetoothLeScanner?.startScan(scanFilters, scanCallback)

スキャン設定を指定する

startScanメソッドの引数にScanSettings型の値を渡すことでスキャン時の設定を指定することができます。例えばSCAN_MODE_BALANCEDを指定することで検出効率とエネルギー消費の適度なバランスを維持したスキャンにすることが可能です。

var scanSettings: ScanSettings = ScanSettings.Builder()
    .setScanMode(ScanSettings.SCAN_MODE_BALANCED)
    .build()

bluetoothLeScanner?.startScan(scanFilters, scanSettings, scanCallback)

他の設定は公式リファレンスを参考にしてください。

公式リファレンス：ScanSettings

RSSIを取得する

「RSSI(Received Signal Strength Indicator)」とは無線通信信号の強度を示す数値のことです。要は接続対象の機器との距離(一概には言えないが)を識別するために活用できたりします。

Androidではスキャン結果を保持するScanResult#rssiから対象機器のRSSI値を取得することが可能です。

private fun leScanCallback(): ScanCallback? {
    return object: ScanCallback() {
        override fun onScanResult(
            callbackType: Int,
            result: ScanResult,
        ) {
            super.onScanResult(callbackType, result)

            // 対象機器のRSSI値
            result.rssi 
        }
    }
}