やりたいこと
Android で充電ケーブルを挿したときと、抜いた時のイベントを拾う方法を勉強したので、手順をまとめておきます。環境
Windows 10
Android Studio : 4.0
テスト環境
Nexus S API 22(emulator) : Android5.1
Pixel 3 API 26(emulator) : Android8.0
参考にしたサイト
[(1)ブロードキャストレシーバーについて]
https://developer.android.com/guide/components/broadcasts
[(2)電源管理について]
https://developer.android.com/training/monitoring-device-state/battery-monitoring?hl=ja
ざっくりと
ざっくり説明すると以下の手順となります。(1)manifestにひろいたいイベントと関数をかく。(android7まで用)
(2)イベントを拾う用のクラスを作成する。そのクラスはBroadcastReceiverを継承させる。
(3)イベントを拾う用のクラスをnewして、レシーバーとして登録する。
Android7までなら(1)と(2)だけでイベントを拾うことができます。 アプリがいなくてもイベントが拾えます。
Android8以降は(1)と(2)だけではイベントを拾えなくなってるので、(3)の手順が必要になります。 しかもAndroid8以降はアプリが起きていないと拾えなくなってます。 この辺のことは参考にしたサイト(1)に詳しく記載されております。
以降は手順を細かく記載します。
Step1.Manifestの登録
AndroidManifest.xmlに下記の6行を追加します。「PowerConnectionReceiver」はイベントをキャッチするクラスの名前です。<action android:name="android.intent.action.ACTION_POWER_CONNECTED"/> <action android:name="android.intent.action.ACTION_POWER_DISCONNECTED"/>
任意の名前でOKです。
「ACTION_POWER_CONNECTED」は接続したときのイベントを拾うときのIntent、
「ACTION_POWER_DISCONNECTED」は抜いた時のイベントを拾うときのIntentとなります。
manifest全体ではこうなります。
<action android:name="android.intent.action.MAIN" /> <category android:name="android.intent.category.LAUNCHER" /> <action android:name="android.intent.action.ACTION_POWER_CONNECTED"/> <action android:name="android.intent.action.ACTION_POWER_DISCONNECTED"/>
Step2.イベントをキャッチするクラスを追加
2-1.下図のようにクラスを追加します。クラス名はStep1で定義したものと同じ名前としてください。
2-2.BroadcastReceiverを継承します。
import android.content.BroadcastReceiver;
public class PowerConnectionReceiver extends BroadcastReceiver {
}
2-3.onReceiveメソッドを追加します。
import android.content.BroadcastReceiver;
import android.content.Context;
import android.content.Intent;
public class PowerConnectionReceiver extends BroadcastReceiver {
public void onReceive(Context context, Intent intent) {
}
}
2-4.イベントを拾ったときに文字列を画面に表示するようにしておきました。
import android.content.BroadcastReceiver;
import android.content.Context;
import android.content.Intent;
import android.widget.Toast;
public class PowerConnectionReceiver extends BroadcastReceiver {
public void onReceive(Context context, Intent intent) {
if (intent.getAction() == Intent.ACTION_POWER_CONNECTED) {
Toast.makeText(context, "ケーブルを接続した", Toast.LENGTH_LONG ).show();
}
else if (intent.getAction() == Intent.ACTION_POWER_DISCONNECTED) {
Toast.makeText(context, "ケーブルを抜いた", Toast.LENGTH_LONG ).show();
}
}
}
Android 7以前が対象の場合は、Step1, Step2までで完了となります。Android5.1で動作することが確認できました。さらにAndroid 7以前の場合はアプリが起動中でなくても、このイベントが発生するとアプリが起動します。
Step3.レシーバーを明示的に登録する
Android8以降はStep1のmanifestの方法でイベントがひろえなくなってます。そこで、明示的にPowerConnectionReceiverをnewしてレシーバーとして登録しておきます。
以下のようなコードとなります。
BroadcastReceiver br = new PowerConnectionReceiver();
IntentFilter filter = new IntentFilter(Intent.ACTION_POWER_CONNECTED);
filter.addAction(Intent.ACTION_POWER_DISCONNECTED);
this.registerReceiver(br, filter);
これをMainActivityのonCreateメソッドに追加しました。
public class MainActivity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
Toolbar toolbar = findViewById(R.id.toolbar);
setSupportActionBar(toolbar);
FloatingActionButton fab = findViewById(R.id.fab);
fab.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View view) {
Snackbar.make(view, "Replace with your own action", Snackbar.LENGTH_LONG)
.setAction("Action", null).show();
}
});
// ここから追加
BroadcastReceiver br = new PowerConnectionReceiver();
IntentFilter filter = new IntentFilter(Intent.ACTION_POWER_CONNECTED);
filter.addAction(Intent.ACTION_POWER_DISCONNECTED);
this.registerReceiver(br, filter);
}
※Googleのサイトの用語でいうと「コンテキスト登録されたレシーバー」というものになります。Step4.テスト
emulatorで電源挿抜のテストをします。emulatorの右の操作パネルの一番したのボタンをクリックします。
「Extended controls」ダイアログが表示されるので、Batteryを選択し、Charger connectionを操作します。
ここを操作すると電源ケーブルの挿抜の操作が仮想的にできます。
emulatorの下側に文字列が表示されたら成功です。
Android8でも確認。できました。
