05．BLEデバイスから値の変更の通知を受け取る処理を作る

BLEデバイスから値の変更の通知を受け取る処理を作成します。

解説

Bluetooth Low Energyには、キャラクタリスティックが書き換えられて，値が変更された時にその通知を受け取れる仕組みがあります。この仕組みをノーティファイ(Notify)と呼びます。ノーティファイを用いると値が自動更新されます。

BLEデバイスから、値の変更の通知を受け取るためにすべきことは、以下です。

1. BluetoothGattオブジェクトを用いて、サービスUUIDを指定してサービスオブジェクトを取得します。
   mBluetoothGatt.getService( uuid_service );
2. 取得したサービスオブジェクトを用いて、キャラクタリスティックUUIDを指定してキャラクタリスティックオブジェクトを取得します。
   blechar = mBluetoothGatt.getService( uuid_service ).getCharacteristic( uuid_characteristic );
3. BluetoothGattオブジェクトを用いて、取得したキャラクタリスティックオブジェクトを指定して、キャラクタリスティック通知関数を呼び出します。
   mBluetoothGatt.setCharacteristicNotification( blechar, enable );
4. 取得したキャラクタリスティックオブジェクトを用いて、デスクリプターを取得します。
   descriptor = blechar.getDescriptor( UUID_NOTIFY );
5. 取得したデスクリプターに、ノーティフィケーションを有効にする値をセットします。
   descriptor.setValue( BluetoothGattDescriptor.ENABLE_NOTIFICATION_VALUE );
6. BluetoothGattオブジェクトを用いて、デスクリプターを書き込みます。
   mBluetoothGatt.writeDescriptor( descriptor );
7. BluetoothGattコールバックオブジェクトの定義にて、キャラクタリスティック変更が通知されたときの処理であるonCharacteristicChanged関数を定義し、ソフトウェア固有の処理（値の表示等）を行います。

上記以外に、今回やっていることは、以下です。

• 「Chara1(Notify)」チェックボックスをチェックすると、キャラクタリスティック１の変更通知機能が有効になります。チェックを外すと、キャラクタリスティック１の変更通知機能が無効になります。
  （onClick関数において、「Char1(Notify)」チェックボックスの場合は、setCharacteristicNotification関数を呼び出します。）

実装

プロジェクトを開く

04．で作成したプロジェクトを開きます。

文字列リソースの追加

必要な文字列定義を追加します。

「Project」ペインの「app > res > values > strings.xml」を開きます。

「キャラクタリスティック１変更通知ON/OFF」チェックボックス用の文字列の定義を追加します。
<string name="chara1_notify">Chara1(Notify) : </string>

「strings.xml」全体としては、以下のようにします。
<resources> <string name="app_name">BLE Communicator</string> <!-- MainActivity トースト用 --> <string name="ble_is_not_supported">BLE is not supported</string> <string name="bluetooth_is_not_supported">Bluetooth is not supported.</string> <string name="bluetooth_is_not_working">Bluetooth is not working.</string> <!-- MainActivity メニュー用 --> <string name="search">Search</string> <!-- MainActivity ラベル用 --> <string name="device_name">Device Name : </string> <string name="device_address">Device Address : </string> <string name="connect">Connect</string> <string name="disconnect">Disconnect</string> <string name="chara1">Chara1 : </string> <string name="chara2">Chara2 : </string> <string name="chara1_notify">Chara1(Notify) : </string> <!-- DeviceListActivity トースト用 --> <string name="unknown_device">Unknown device</string> <!-- DeviceListActivity メニュー用 --> <string name="scan">Scan</string> <string name="stop">Stop</string> </resources>

ファイルを上書き保存します。

レイアウトの編集

メインアクティビティのレイアウトを編集します。

「Project」ペインの「app > res > layout > activity_main.xml」を開きます。

２つの「キャラクタリスティック読み込み」ボタンと値を表示するためのTextViewの下に、 「キャラクタリスティック１変更通知ON/OFF」チェックボックスと値を表示するためのTextViewを設置します。
<LinearLayout android:layout_width="match_parent" android:layout_height="wrap_content" android:layout_margin="10dp" android:orientation="horizontal"> <CheckBox android:id="@+id/checkbox_notifychara1" android:layout_width="wrap_content" android:layout_height="wrap_content" android:text="@string/chara1_notify" android:textSize="18sp"/> <Space android:layout_width="5dp" android:layout_height="wrap_content"/> <TextView android:id="@+id/textview_notifychara1" android:layout_width="match_parent" android:layout_height="wrap_content" android:textSize="18sp"/> </LinearLayout>

activity_main.xmlの内容を以下のようにします。
<?xml version="1.0" encoding="utf-8"?> <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android" android:layout_width="match_parent" android:layout_height="wrap_content" android:layout_margin="10dp" android:orientation="vertical"> <LinearLayout android:layout_width="match_parent" android:layout_height="wrap_content" android:layout_margin="10dp" android:orientation="horizontal"> <TextView android:layout_width="wrap_content" android:layout_height="wrap_content" android:text="@string/device_name" android:textSize="18sp"/> <Space android:layout_width="5dp" android:layout_height="wrap_content"/> <TextView android:id="@+id/textview_devicename" android:layout_width="match_parent" android:layout_height="wrap_content" android:textSize="18sp"/> </LinearLayout> <LinearLayout android:layout_width="match_parent" android:layout_height="wrap_content" android:layout_margin="10dp" android:orientation="horizontal"> <TextView android:layout_width="wrap_content" android:layout_height="wrap_content" android:text="@string/device_address" android:textSize="18sp"/> <Space android:layout_width="5dp" android:layout_height="wrap_content"/> <TextView android:id="@+id/textview_deviceaddress" android:layout_width="match_parent" android:layout_height="wrap_content" android:textSize="18sp"/> </LinearLayout> <Space android:layout_width="match_parent" android:layout_height="20dp"/> <LinearLayout android:layout_width="match_parent" android:layout_height="wrap_content" android:layout_margin="10dp" android:orientation="horizontal"> <Button android:id="@+id/button_connect" android:layout_width="wrap_content" android:layout_height="wrap_content" android:text="@string/connect" android:textSize="18sp"/> <Space android:layout_width="5dp" android:layout_height="wrap_content"/> <Button android:id="@+id/button_disconnect" android:layout_width="wrap_content" android:layout_height="wrap_content" android:text="@string/disconnect" android:textSize="18sp"/> </LinearLayout> <Space android:layout_width="match_parent" android:layout_height="20dp"/> <LinearLayout android:layout_width="match_parent" android:layout_height="wrap_content" android:layout_margin="10dp" android:orientation="horizontal"> <Button android:id="@+id/button_readchara1" android:layout_width="wrap_content" android:layout_height="wrap_content" android:text="@string/chara1" android:textSize="18sp"/> <Space android:layout_width="5dp" android:layout_height="wrap_content"/> <TextView android:id="@+id/textview_readchara1" android:layout_width="match_parent" android:layout_height="wrap_content" android:textSize="18sp"/> </LinearLayout> <LinearLayout android:layout_width="match_parent" android:layout_height="wrap_content" android:layout_margin="10dp" android:orientation="horizontal"> <Button android:id="@+id/button_readchara2" android:layout_width="wrap_content" android:layout_height="wrap_content" android:text="@string/chara2" android:textSize="18sp"/> <Space android:layout_width="5dp" android:layout_height="wrap_content"/> <TextView android:id="@+id/textview_readchara2" android:layout_width="match_parent" android:layout_height="wrap_content" android:textSize="18sp"/> </LinearLayout> <LinearLayout android:layout_width="match_parent" android:layout_height="wrap_content" android:layout_margin="10dp" android:orientation="horizontal"> <CheckBox android:id="@+id/checkbox_notifychara1" android:layout_width="wrap_content" android:layout_height="wrap_content" android:text="@string/chara1_notify" android:textSize="18sp"/> <Space android:layout_width="5dp" android:layout_height="wrap_content"/> <TextView android:id="@+id/textview_notifychara1" android:layout_width="match_parent" android:layout_height="wrap_content" android:textSize="18sp"/> </LinearLayout> </LinearLayout>

メインアクティビティクラスのメンバー変数の追加

メインアクティビティに、必要な定数宣言とメンバー変数宣言を追加します。

ノーティフィケーション用の「Bluetooth LE Gatt UUID」定数の宣言、「キャラクタリスティック１変更通知ON/OFF」チェックボックスオブジェクトの変数宣言を追加します。

「MainActivity」クラスの定数、変数の宣言を以下のようにします。
public class MainActivity extends AppCompatActivity implements View.OnClickListener { // 定数（Bluetooth LE Gatt UUID） // Private Service private static final UUID UUID_SERVICE_PRIVATE = UUID.fromString( "FF6B1160-8FE6-11E7-ABC4-CEC278B6B50A" ); private static final UUID UUID_CHARACTERISTIC_PRIVATE1 = UUID.fromString( "FF6B1426-8FE6-11E7-ABC4-CEC278B6B50A" ); private static final UUID UUID_CHARACTERISTIC_PRIVATE2 = UUID.fromString( "FF6B1548-8FE6-11E7-ABC4-CEC278B6B50A" ); // for Notification private static final UUID UUID_NOTIFY = UUID.fromString( "00002902-0000-1000-8000-00805f9b34fb" ); // 定数 private static final int REQUEST_ENABLEBLUETOOTH = 1; // Bluetooth機能の有効化要求時の識別コード private static final int REQUEST_CONNECTDEVICE = 2; // デバイス接続要求時の識別コード // メンバー変数 private BluetoothAdapter mBluetoothAdapter; // BluetoothAdapter : Bluetooth処理で必要 private String mDeviceAddress = ""; // デバイスアドレス private BluetoothGatt mBluetoothGatt = null; // Gattサービスの検索、キャラスタリスティックの読み書き // GUIアイテム private Button mButton_Connect; // 接続ボタン private Button mButton_Disconnect; // 切断ボタン private Button mButton_ReadChara1; // キャラクタリスティック１の読み込みボタン private Button mButton_ReadChara2; // キャラクタリスティック２の読み込みボタン private CheckBox mCheckBox_NotifyChara1; // キャラクタリスティック１の変更通知ON/OFFチェックボックス // BluetoothGattコールバックオブジェクト private final BluetoothGattCallback mGattcallback = new BluetoothGattCallback() （・・・省略・・・）

「Cannot resolve symbol」エラーは、「Alt + Enter」で、必要なクラスをimportします。
リビルドし、エラー、警告がないことを確認します。

メインアクティビティクラスのonCreate関数の編集

メインアクティビティのonCreate関数に、必要な処理を追加します。

「キャラクタリスティック１変更通知ON/OFF」チェックボックスの取得とクリックリスナーの設定の処理を追加します。

onCreate関数を、以下のようにします。
@Override protected void onCreate( Bundle savedInstanceState ) { super.onCreate( savedInstanceState ); setContentView( R.layout.activity_main ); // GUIアイテム mButton_Connect = (Button)findViewById( R.id.button_connect ); mButton_Connect.setOnClickListener( this ); mButton_Disconnect = (Button)findViewById( R.id.button_disconnect ); mButton_Disconnect.setOnClickListener( this ); mButton_ReadChara1 = (Button)findViewById( R.id.button_readchara1 ); mButton_ReadChara1.setOnClickListener( this ); mButton_ReadChara2 = (Button)findViewById( R.id.button_readchara2 ); mButton_ReadChara2.setOnClickListener( this ); mCheckBox_NotifyChara1 = (CheckBox)findViewById( R.id.checkbox_notifychara1 ); mCheckBox_NotifyChara1.setOnClickListener( this ); // Android端末がBLEをサポートしてるかの確認 （・・・省略・・・）

メインアクティビティクラスのクリックリスナーの編集

メインアクティビティのクリックリスナーに、必要な処理を追加します。

「キャラクタリスティック１変更通知ON/OFF」チェックボックスクリック時の処理を追加します。

onClick関数を、以下のようにします。
@Override public void onClick( View v ) { if( mButton_Connect.getId() == v.getId() ) { mButton_Connect.setEnabled( false ); // 接続ボタンの無効化（連打対策） connect(); // 接続 return; } if( mButton_Disconnect.getId() == v.getId() ) { mButton_Disconnect.setEnabled( false ); // 切断ボタンの無効化（連打対策） disconnect(); // 切断 return; } if( mButton_ReadChara1.getId() == v.getId() ) { readCharacteristic( UUID_SERVICE_PRIVATE, UUID_CHARACTERISTIC_PRIVATE1 ); return; } if( mButton_ReadChara2.getId() == v.getId() ) { readCharacteristic( UUID_SERVICE_PRIVATE, UUID_CHARACTERISTIC_PRIVATE2 ); return; } if( mCheckBox_NotifyChara1.getId() == v.getId() ) { setCharacteristicNotification( UUID_SERVICE_PRIVATE, UUID_CHARACTERISTIC_PRIVATE1, mCheckBox_NotifyChara1.isChecked() ); return; } }

キャラクタリスティック通知の設定の関数の追加

キャラクタリスティック通知の設定の関数を追加します。

「MainActivity」クラスの末尾に、以下を追加します。
// キャラクタリスティック通知の設定 private void setCharacteristicNotification( UUID uuid_service, UUID uuid_characteristic, boolean enable ) { if( null == mBluetoothGatt ) { return; } BluetoothGattCharacteristic blechar = mBluetoothGatt.getService( uuid_service ).getCharacteristic( uuid_characteristic ); mBluetoothGatt.setCharacteristicNotification( blechar, enable ); BluetoothGattDescriptor descriptor = blechar.getDescriptor( UUID_NOTIFY ); descriptor.setValue( BluetoothGattDescriptor.ENABLE_NOTIFICATION_VALUE ); mBluetoothGatt.writeDescriptor( descriptor ); }

BluetoothGattコールバッククラスのオブジェクトの定義の編集

BluetoothGattコールバッククラスのオブジェクトの定義を編集します。

接続可能範囲から外れて切断されたとき処理に、「キャラクタリスティック１変更通知ON/OFF」チェックボックスを無効にする処理を追加します。
サービス検索が完了したときの処理に、「キャラクタリスティック１変更通知ON/OFF」チェックボックスを有効にする処理を追加します。
キャラクタリスティック変更が通知されたときの処理を追加します。

BluetoothGattコールバッククラスのオブジェクトの定義を以下のようにします。
// BluetoothGattコールバックオブジェクト private final BluetoothGattCallback mGattcallback = new BluetoothGattCallback() { // 接続状態変更（connectGatt()の結果として呼ばれる。） @Override public void onConnectionStateChange( BluetoothGatt gatt, int status, int newState ) { if( BluetoothGatt.GATT_SUCCESS != status ) { return; } if( BluetoothProfile.STATE_CONNECTED == newState ) { // 接続完了 mBluetoothGatt.discoverServices(); // サービス検索 runOnUiThread( new Runnable() { public void run() { // GUIアイテムの有効無効の設定 // 切断ボタンを有効にする mButton_Disconnect.setEnabled( true ); } } ); return; } if( BluetoothProfile.STATE_DISCONNECTED == newState ) { // 切断完了（接続可能範囲から外れて切断された） // 接続可能範囲に入ったら自動接続するために、mBluetoothGatt.connect()を呼び出す。 mBluetoothGatt.connect(); runOnUiThread( new Runnable() { public void run() { // GUIアイテムの有効無効の設定 // 読み込みボタンを無効にする（通知チェックボックスはチェック状態を維持。通知ONで切断した場合、再接続時に通知は再開するので） mButton_ReadChara1.setEnabled( false ); mButton_ReadChara2.setEnabled( false ); mCheckBox_NotifyChara1.setEnabled( false ); } } ); return; } } // サービス検索が完了したときの処理（mBluetoothGatt.discoverServices()の結果として呼ばれる。） @Override public void onServicesDiscovered( BluetoothGatt gatt, int status ) { if( BluetoothGatt.GATT_SUCCESS != status ) { return; } // 発見されたサービスのループ for( BluetoothGattService service : gatt.getServices() ) { // サービスごとに個別の処理 if( ( null == service ) || ( null == service.getUuid() ) ) { continue; } if( UUID_SERVICE_PRIVATE.equals( service.getUuid() ) ) { // プライベートサービス runOnUiThread( new Runnable() { public void run() { // GUIアイテムの有効無効の設定 mButton_ReadChara1.setEnabled( true ); mButton_ReadChara2.setEnabled( true ); mCheckBox_NotifyChara1.setEnabled( true ); } } ); continue; } } } // キャラクタリスティックが読み込まれたときの処理 @Override public void onCharacteristicRead( BluetoothGatt gatt, BluetoothGattCharacteristic characteristic, int status ) { if( BluetoothGatt.GATT_SUCCESS != status ) { return; } // キャラクタリスティックごとに個別の処理 if( UUID_CHARACTERISTIC_PRIVATE1.equals( characteristic.getUuid() ) ) { // キャラクタリスティック１：データサイズは、2バイト（数値を想定。0～65,535） byte[] byteChara = characteristic.getValue(); ByteBuffer bb = ByteBuffer.wrap( byteChara ); final String strChara = String.valueOf( bb.getShort() ); runOnUiThread( new Runnable() { public void run() { // GUIアイテムへの反映 ( (TextView)findViewById( R.id.textview_readchara1 ) ).setText( strChara ); } } ); return; } if( UUID_CHARACTERISTIC_PRIVATE2.equals( characteristic.getUuid() ) ) { // キャラクタリスティック２：データサイズは、8バイト（文字列を想定。半角文字8文字） final String strChara = characteristic.getStringValue( 0 ); runOnUiThread( new Runnable() { public void run() { // GUIアイテムへの反映 ( (TextView)findViewById( R.id.textview_readchara2 ) ).setText( strChara ); } } ); return; } } // キャラクタリスティック変更が通知されたときの処理 @Override public void onCharacteristicChanged( BluetoothGatt gatt, BluetoothGattCharacteristic characteristic ) { // キャラクタリスティックごとに個別の処理 if( UUID_CHARACTERISTIC_PRIVATE1.equals( characteristic.getUuid() ) ) { // キャラクタリスティック１：データサイズは、2バイト（数値を想定。0～65,535） byte[] byteChara = characteristic.getValue(); ByteBuffer bb = ByteBuffer.wrap( byteChara ); final String strChara = String.valueOf( bb.getShort() ); runOnUiThread( new Runnable() { public void run() { // GUIアイテムへの反映 ( (TextView)findViewById( R.id.textview_notifychara1 ) ).setText( strChara ); } } ); return; } } };

「Cannot resolve symbol」エラーは、「Alt + Enter」で、必要なクラスをimportします。
リビルドし、エラー、警告がないことを確認します。

メインアクティビティクラスのonResume関数の編集

onResume関数を編集します。

初回表示時および復帰時には、「キャラクタリスティック１変更通知ON/OFF」チェックボックスのチェックを外し、無効となるように処理を追加します。
// 初回表示時、および、ポーズからの復帰時 @Override protected void onResume() { super.onResume(); // Android端末のBluetooth機能の有効化要求 requestBluetoothFeature(); // GUIアイテムの有効無効の設定 mButton_Connect.setEnabled( false ); mButton_Disconnect.setEnabled( false ); mButton_ReadChara1.setEnabled( false ); mButton_ReadChara2.setEnabled( false ); mCheckBox_NotifyChara1.setChecked( false ); mCheckBox_NotifyChara1.setEnabled( false ); // デバイスアドレスが空でなければ、接続ボタンを有効にする。 if( !mDeviceAddress.equals( "" ) ) { mButton_Connect.setEnabled( true ); } // 接続ボタンを押す mButton_Connect.callOnClick(); }

メインアクティビティクラスの、disconnect関数の編集

disconnect関数を編集します。

接続を切断したときには、「キャラクタリスティック１変更通知ON/OFF」チェックボックスのチェックを外し、無効となるように処理を追加します。
// 切断 private void disconnect() { if( null == mBluetoothGatt ) { return; } // 切断 // mBluetoothGatt.disconnect()ではなく、mBluetoothGatt.close()しオブジェクトを解放する。 // 理由：「ユーザーの意思による切断」と「接続範囲から外れた切断」を区別するため。 // ①「ユーザーの意思による切断」は、mBluetoothGattオブジェクトを解放する。再接続は、オブジェクト構築から。 // ②「接続可能範囲から外れた切断」は、内部処理でmBluetoothGatt.disconnect()処理が実施される。 // 切断時のコールバックでmBluetoothGatt.connect()を呼んでおくと、接続可能範囲に入ったら自動接続する。 mBluetoothGatt.close(); mBluetoothGatt = null; // GUIアイテムの有効無効の設定 // 接続ボタンのみ有効にする mButton_Connect.setEnabled( true ); mButton_Disconnect.setEnabled( false ); mButton_ReadChara1.setEnabled( false ); mButton_ReadChara2.setEnabled( false ); mCheckBox_NotifyChara1.setChecked( false ); mCheckBox_NotifyChara1.setEnabled( false ); }

メインアクティビティクラスのonActivityResult関数の編集

メインアクティビティクラスのonActivityResult関数を編集します。

デバイスリストアクティビティから復帰したときの処理に、TextViewの値を初期化する処理を追加します。

onActivityResult関数を、以下のようにします。
// 機能の有効化ダイアログの操作結果 @Override protected void onActivityResult( int requestCode, int resultCode, Intent data ) { switch( requestCode ) { case REQUEST_ENABLEBLUETOOTH: // Bluetooth有効化要求 if( Activity.RESULT_CANCELED == resultCode ) { // 有効にされなかった Toast.makeText( this, R.string.bluetooth_is_not_working, Toast.LENGTH_SHORT ).show(); finish(); // アプリ終了宣言 return; } break; case REQUEST_CONNECTDEVICE: // デバイス接続要求 String strDeviceName; if( Activity.RESULT_OK == resultCode ) { // デバイスリストアクティビティからの情報の取得 strDeviceName = data.getStringExtra( DeviceListActivity.EXTRAS_DEVICE_NAME ); mDeviceAddress = data.getStringExtra( DeviceListActivity.EXTRAS_DEVICE_ADDRESS ); } else { strDeviceName = ""; mDeviceAddress = ""; } ( (TextView)findViewById( R.id.textview_devicename ) ).setText( strDeviceName ); ( (TextView)findViewById( R.id.textview_deviceaddress ) ).setText( mDeviceAddress ); ( (TextView)findViewById( R.id.textview_readchara1 ) ).setText( "" ); ( (TextView)findViewById( R.id.textview_readchara2 ) ).setText( "" ); ( (TextView)findViewById( R.id.textview_notifychara1 ) ).setText( "" ); break; } super.onActivityResult( requestCode, resultCode, data ); }

「Cannot resolve symbol」エラーは、「Alt + Enter」で、必要なクラスをimportします。
リビルドし、エラー、警告がないことを確認します。

実行

BLEモジュールの準備。

「フィジカルコンピューティング > RN4020 > Arduinoからのキャラクタリスティックの値の書き込み」に従い、BLEモジュールを準備しておきます。

作成したプライベートサービスの仕様としては、以下です。

• キャラクタリスティックは２つ。
• １つ目のキャラクタリスティックは、
  - 読み出しができる。
  - ノーティファイが可能。
  - データサイズは、2バイト（数値を想定。0～65,535）。
• ２つ目のキャラクタリスティックは、
  - 書き込みと読み出しができる。
  - ノーティファイはなし。
  - データサイズは、8バイト（文字列を想定。半角文字8文字）

Arduinoからのキャラクタリスティックの値の書き込みのプログラムの内容としては、以下です。

• １秒ごとに、カウンターをカウントアップする。
• １秒ごとに、カウンターの値を、１つ目のキャラクタリスティックに書き込む。
• 60秒ごとに、(カウンターの値 / 60)から経過分数を算出し、文字列「(経過分数)[min]」を、２つ目のキャラクタリスティックにを書き込む。

Android端末にて、動作確認。

BLEデバイスと接続直後の画面。
「Chara1(Notify)」チェックボックスがあります。


「Chara1(Notify)」チェックボックスをチェックすると、キャラクタリスティック１の値が読み込まれ、表示されます。


ノーティファイ機能により、キャラクタリスティック１の値は自動更新されます

ダウンロード

サンプルプロジェクト
（github.com上のダウンロードページ）

関連ページ

前項目：04．BLEデバイスから値を読み込む処理を作る

次項目：06．BLEデバイスへの値を書き込む処理を作る