2015年11月4日水曜日

[第二回] 生活で使えるBLE~ペアリング編~


http://developer.android.com/intl/ja/about/versions/jelly-bean.html から引用

この記事は以下の記事の続きになります。
[第一回] 生活で使えるBLEデバイス

はじめに

前回の記事では、BluetoothとBLEおさらいをしました。
では今回はAndroid端末からのBLEデバイス検知とペアリングを行う方法を紹介します。

環境

今回はNexus 5から周辺のBLE端末(Nexus9)を検知して、接続を試みます。

  • Nexus 5(OS 6.0)
  • Nexus 9(OS 6.0)
Nexus 5(検知する側)
以下のサンプルアプリを元に、BLEデバイスの検知と接続方法を説明します。
BluetoothLeGatt

図1 BluetoothLeGatt

ただし、実装方法が一部古いままの為、以下の修正を加えています。(詳細は後述)
  1. RuntimePermission対応(「Bluetooth機能を利用する」の項目を参照)
  2. BLEスキャン時のAPIの修正(「BLEデバイスの検知」の項目を参照)
Nexus 9(BLE端末)
以下のサンプルアプリをインストールしておき、BLE端末としての役割をもたせています。
BluetoothAdvertisements


図2 BluetoothAdvertisements


では、実際にBLEデバイスの検知と接続を行う実装方法を紹介していきます。

BLEデバイスの検知と接続

Bluetooth機能を利用する
まずはじめに、Bluettoth機能を利用する宣言を行います。
AndroidManifest.xmlに宣言するパーミッションは以下の通りです。
<uses-permission android:name="android.permission.BLUETOOTH"></uses-permission>
<uses-permission android:name="android.permission.BLUETOOTH_ADMIN"></uses-permission>
また、BLEの機能を利用する場合は以下の宣言も必要です。
<uses-feature android:name="android.hardware.bluetooth_le" android:required="true"/>
※端末がBLEに対応しているかの確認
if (!getPackageManager().hasSystemFeature(PackageManager.FEATURE_BLUETOOTH_LE)) {
    Toast.makeText(this, "BLE未対応端末です", Toast.LENGTH_SHORT).show();
    finish();
}

さらに、Android 6.0からBLEの利用には位置情報の権限が必要になりました。

よって、マニフェストにも「ACCESS_COARSE_LOCATION」または「ACCESS_FINE_LOCATION」の宣言が必要になります。
 <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>
または
 <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"/>
しかし、それだけではBLE機能を使用することは出来ません。。

位置情報の権限はプロテクションレベルが「Dangerous」になるので、ユーザーが権限を許可しない限りBLEの機能は使用することが出来ません。
※RuntimePermissionの詳細はこちら

よって、BLE機能を利用する前には、位置情報の権限の利用が許可されているかの確認を行い、ユーザーが許可をしていなければ許可を行うように促します。

許可されているかのチェックと権限取得の要求
private boolean checkPermission() {
    if (checkSelfPermission(Manifest.permission.ACCESS_FINE_LOCATION) != PackageManager.PERMISSION_GRANTED) { requestPermissions(new String[]{Manifest.permission.ACCESS_FINE_LOCATION}, PERMISSIONS_REQUEST_LOCATION_STATE);
        return false;
    }
    return true;
}

許可/不許可の結果は onRequestPermissionsResult で判別出来ます。
@Override
public void onRequestPermissionsResult(int requestCode, String[] permissions, int[] grantResults) {
    if (PERMISSIONS_REQUEST_LOCATION_STATE == requestCode) {
        if (grantResults[0] == PackageManager.PERMISSION_GRANTED) {
            // 許可された場合
            Toast.makeText(this, "許可されました", Toast.LENGTH_SHORT).show();
        } else {
            // 不許可だった場合
            Toast.makeText(this, "権限を拒否されました", Toast.LENGTH_SHORT).show();
            finish();
        }
    }
}
事前準備としては以上です。
次はBluetooth関連クラスを使用していきます。

BluetoothAdapterの取得
まずはBluetoothAdapterを取得します。
(BluetoothAdapterは、すべてのBluetooth相互作用のためのエントリー・ポイントです。)
final BluetoothManager bluetoothManager = (BluetoothManager)getSystemService(Context.BLUETOOTH_SERVICE);
mBluetoothAdapter = bluetoothManager.getAdapter();
次に、端末のBluetoothが有効になっているかの確認を行います。
もし、Bluetoothが無効であればユーザーに有効にするように促します。
if (mBluetoothAdapter == null || !mBluetoothAdapter.isEnabled()) {
    Intent enableBtIntent = new Intent(BluetoothAdapter.ACTION_REQUEST_ENABLE);
    startActivityForResult(enableBtIntent, REQUEST_ENABLE_BT);
}

BLEデバイスの検知
次にBLEデバイスの検知方法を紹介します。
サンプルアプリでは、BLEを検知する為にBluetoothAdapter#startLeScanを使用していますが、APIレベル21から非推奨となり、現在はBluetoothLeScannerを利用するようになりました。
使用方法は以下の通りです。

先ほど取得したBluetoothAdapterからBluetoothLeScannerを取得します。
mBluetoothLeScanner = mBluetoothAdapter.getBluetoothLeScanner();
BluetoothLeScannerを取得したら、以下のAPIを利用してスキャンの開始/停止を制御します。
そして、BLE機器が検知された場合、ScanCallback#onScanResultが呼び出され、ScanResultからBluetoothDeviceが取得出来ます。

BLEデバイスのスキャン開始

BLEデバイスのスキャン停止
BLEスキャンのCallback
// Device scan callback.
private ScanCallback mScanCallback = new ScanCallback() {
    @Override
    public void onScanResult(int callbackType, final ScanResult result) {
        super.onScanResult(callbackType, result);
        if (result != null && result.getDevice() != null) {
            runOnUiThread(new Runnable() {
               @Override
               public void run() {
                   mLeDeviceListAdapter.addDevice(result.getDevice());
                   mLeDeviceListAdapter.notifyDataSetChanged();
               }
            });
        }
    }
};
これで周辺のBLE機器の検知がすることが出来ました。
では次に、検知したデバイスに接続を行います。

ペアリング(GATTサーバーに接続)方法
ペアリングと銘打ってますが、BLEデバイスと通信を行う際にはペアリングをする必要はありません。(対応していればペアリングを行うことも可能です)
BLEデバイスの情報を取得するには、GATTサーバーに接続を行うことで、BLEデバイスの情報を読みとることが可能です。

GATTサーバーに接続するには先ほど検知したBluetoothDeviceのBluetoothDevice#connectGattメソッドを使用します。
mBluetoothGatt = device.connectGatt(this, false, mGattCallback);
接続が確立されると、BluetoothGattCallback#onConnectionStateChangeが呼ばれます。
newState が BluetoothProfile.STATE_CONNECTEDであれば接続が完了している状態です。

接続が確認出来たら、BluetoothGatt#discoverServicesにより、Gattサーバーの情報を検索します。
結果は BluetoothGattCallback#onServicesDiscovered が呼び出されます。

@Override
public void onConnectionStateChange(BluetoothGatt gatt, int status, int newState) {
    String intentAction;
    if (newState == BluetoothProfile.STATE_CONNECTED) {
        mBluetoothGatt.discoverServices();
    }
}

@Override
public void onServicesDiscovered(BluetoothGatt gatt, int status) {
    super.onServicesDiscovered(gatt, status);
    serviceList = gatt.getServices();
    // サービスの内容を取得等処理を行う
    // 取得したサービスからBLEデバイスの情報を取得する
}
以上が、BLEデバイス検知から接続までの方法になります。

では最後に、BLEデバイスの情報を取りまとめるGATTについての説明をします。

Generic Attribute Profile (GATT)について
GATTとは、前回の記事で言うところのBluetooth 4.0で使用出来るプロファイルです。

GATTプロファイルは、"attribute"として知られる、BLE link上での短いデータの送受信の一般的な仕様で、現在のBLEアプリケーションプロファイルは、全て、GATTをベースにしています。

※Bluetooth SIGは、BLE端末のための多くのプロファイルを定義します。
※プロファイルは、特定のアプリケーションにおける端末の動作仕様です。
※端末は1つ以上のプロファイルを実装可能です。


図3 Generic Attribute Profile (GATT)について
https://developer.bluetooth.org/TechnologyOverview/Pages/GATT.aspx より引用

・Attribute Protocol (ATT)
GATTは、Attribute Protocol (ATT)の上位に組み込まれています。
GATT/ATTとしても参照されます。
ATTは、BLEデバイス上で動作するよう最適化されています(数バイト使用します)
各attributeは、Universally Unique Identifier (UUID)によりユニークに識別され、ユニークに情報を識別するために使われるstring IDのため標準化された128-bitフォーマットとなります。
ATTにより転送されたattributeは、characteristicおよびserviceとしてフォーマットされています。

・Characteristic
characteristicは1つの値と0-nのcharacteristicに言及するdescriptorを含みます。
characteristicはtypeとみなされ、classに似たものとなります。

・Descriptor
Descriptorは、characteristic値を記述する定義されたattributeです。
例えば, characteristicの値が許容可能な範囲を人間が読めるdescriptionとして定義されるものであったり, characteristicの値の単位を表すものであったりします。

・Service
serviceは、characteristicを集めたものです。
例えば, "Heart rate Monitor"と呼ばれるサービスには"heart rate measurement"という名のcharacteristicが含まれます。
既存のGATTベースのprofile/serviceリストをbluetooth.orgで入手可能です。

※これらのサービスやキャラクタリスティックは、Bluetooth SIG が標準として定義していますが、デバイス開発者が独自に定義することも可能です。

GATTプロファイルのサービスとその中にあるCharacteristicを読み取ることで、BLEデバイスの情報を読み出すことが出来ます。

また、GATT通信はサーバークライアントモデルであるため、基本的にはサーバーが機能や情報を保持し、クライアントがそれを利用することになります。

GATTクライアント
 データを利用する機器

GATTサーバー
 データを保持する機器

GATTクライアントとGATTサーバーは接続確立後、2つの端末がどのように通信し合うかのか決定します。
※今回であれば、Nexus 5(client、つまり端末)とNexus 9(server、つまりBLEデバイス)があると考えて下さい。

接続が確立すると、GATTメタデータの他への転送を開始します。
転送するデータの種類により、どちらかがサーバーとして動作します。

例えば、
BLEデバイスがセンサーデータを端末へレポートしたい場合、BLEデバイスがサーバーとして動作するのが理にかなっていると考えられます。
BLEデバイス端末からアップデートを受信したい場合は、端末がサーバーとして動作するのが理にかなっていると考えられます。

本記事で使用したアプリにおいては、Nexus 5はGATTクライアントとして動作しています。
Nexus 5側のアプリ(GATTクライアント)は、Nexus 9(GATTサーバー)からデータを読み取り、アプリ内で解釈することで連携を行っている。という構成になっています。

さいごに

今回はBLEデバイスの検知から接続までをまとめました。

サンプルアプリでBLEの検知と接続を試すことは出来ますが、非推奨になっている点とBLE機能を使用する為の権限が増えている点に御留意いただければと思います。

次回はBLEデバイスからの情報の読み書きを行い、実際にBLE端末とデータのやり取りをしてみたいと思います。
140 180 Android 6.0 , BLE , Marshmallow

記載されている会社名、および商品名等は、各社の商標または登録商標です。

2 コメント:

  1. 全く初心者のものですみません。私はセンサのデータをBLEを用いてスマホに送信、表示させたいと思っており、このページを参考にさせてもらっています。
    私自身ほぼ知識がなく、かなり初歩的な質問になるのですが、パーミッションをmanifest.xmlに追加するのはわかるのですが、それ以下のBluetoothAdaptorの取得以降のプログラムはMainActivity.javaに書けばいいということでしょうか?
    そのままコピーペーストしてもエラーが出、進まない状況です。
    かなり初歩的なことで申し訳ないですがご教授頂ければ幸いです。

    返信削除
    返信
    1. 中本様

      お世話になっております。ブリリアントサービスの角野です。
      返信が遅れてしまい大変申し訳ありませんでした。。。

      ブログの閲覧およびコメントありがとうございます!

      質問に関してですが、どのような箇所で、どのような内容のエラーが出ていますでしょうか。
      また、以下の情報を記載いただけるとこちらでも状況を把握しやすいです。
      ・エラーの内容
      ・使用している端末のOSバージョン(設定 > 端末情報 > Androidバージョン の項目に記載されています)

      例えばですが、許可されているかのチェックと権限取得の要求を行うメソッドである「checkSelfPermission」でエラーが発生している場合、以下のようなエラーが出ます。
      「Call requires API level 23 (current min is 21): android.content.ContextWrapper#checkSelfPermission」

      こちらは今回のブログでは、OSバージョンが6.0を対象に実装を行っている為、作成されたプロジェクトのminSdkVersionが22以下の場合にはエラーが発生してしまいます。
      その為、Android 6.0での開発が必要ないのであれば、該当するメソッドを削除していただくことで対応することが可能です。
      もしくは、Android 6.0による開発を行うのであれば、プロジェクトのターゲットSDKを23に変更していただけば問題ありません。

      例をあげさせていただきましたが、詳細を記載していただければこちらでも確認させていただこうと思います。

      【補足】
      今回のブログではGoogleから公開されているサンプルアプリをベースに説明を行っています。
      その為、ソースコードの一部のみを紹介している為、実装場所が把握しづらくなっております。

      こちらのサンプルアプリがベースになっていますので、こちらをご参考にしていただければ実装箇所はわかりやすいと思います。
      http://developer.android.com/intl/ja/samples/BluetoothLeGatt/index.html

      デバイスの検出部分は以下のURLに掲載されています。
      http://developer.android.com/intl/ja/samples/BluetoothLeGatt/src/com.example.android.bluetoothlegatt/DeviceScanActivity.html

      削除

Related Posts Plugin for WordPress, Blogger...