このページは Cloud Translation API によって翻訳されました。

外部デバイスを操作する

Android 11 以降では、クイックアクセスデバイスコントロール機能により、ユーザーはデフォルトのランチャーから 3 回の操作で、ユーザーアフォーダンスから照明、サーモスタット、カメラなどの外部デバイスをすばやく表示して操作できます。デバイスの OEM は、使用するランチャーを選択します。デバイスアグリゲータ（Google Home など）とサードパーティベンダーのアプリは、このスペースに表示するデバイスを提供します。このページでは、このスペースにデバイスコントロールを表示し、コントロールアプリにリンクする方法について説明します。

図 1. Android UI のデバイスコントロールスペース。

このサポートを追加するには、ControlsProviderService を作成して宣言します。事前定義されたコントロールタイプに基づいてアプリがサポートするコントロールを作成し、さらにそれらのコントロール用にパブリッシャーを作成します。

ユーザーインターフェース

デバイスは、[デバイスコントロール] の下にテンプレート化されたウィジェットとして表示されます。5 本さまざまなデバイスコントロールウィジェットを利用できます。

切り替え	スライダーで切り替え	<ph type="x-smartling-placeholder"> </ph> <ph type="x-smartling-placeholder"> </ph> 範囲（オンとオフの切り替えは不可）
ステートレス切り替え	温度パネル（閉じた状態）

図 2. テンプレート化されたウィジェットのコレクションです。

接触とウィジェットを長押しするとアプリに移動し、より細かい操作が可能です。Google Chat では各ウィジェットでアイコンや色をカスタマイズできますがデフォルトセットがデバイスと一致する場合は、デフォルトのアイコンと色を使用します。

温度パネルのウィジェットを示す画像（開いている） — **図 3.** 温度パネルウィジェットを開きます。

サービスを作成する

このセクションでは、Terraform を使用して ControlsProviderService。このサービスは、アプリにデバイスコントロールが含まれていることを Android システム UI に通知します。 Android UI の [デバイスコントロール] 領域に表示する必要があります。

ControlsProviderService API は、リアクティブストリームに精通していることを前提としています。 Reactive Streams GitHub で定義されるプロジェクト Java 9 Flow に実装されていますインターフェースをご覧ください。 API は次のコンセプトに基づいています。

パブリッシャー: アプリケーションがパブリッシャーです。
サブスクライバー: システム UI はサブスクライバーであり、番号をリクエストできます。さまざまな設定を行えます
サブスクリプション: パブリッシャーがシステム UI にアップデートを送信できる期間。パブリッシャーまたはサブスクライバーは、このクリックします。

サービスを宣言する

アプリでは、マニフェストでサービスを宣言する必要があります（MyCustomControlService など）。

サービスには ControlsProviderService のインテントフィルタが含まれている必要があります。このフィルタにより、アプリはシステム UI にコントロールを提供できます。

また、システム UI のコントロールに表示される label も必要です。

次の例は、サービスを宣言する方法を示しています。

<service
    android:name="MyCustomControlService"
    android:label="My Custom Controls"
    android:permission="android.permission.BIND_CONTROLS"
    android:exported="true"
    >
    <intent-filter>
      <action android:name="android.service.controls.ControlsProviderService" />
    </intent-filter>
</service>

次に、MyCustomControlService.kt という名前の新しい Kotlin ファイルを作成し、ControlsProviderService() を拡張します。

Kotlin

    class MyCustomControlService : ControlsProviderService() {
        ...
    }

Java

    public class MyCustomJavaControlService extends ControlsProviderService {
        ...
    }

正しいコントロールタイプを選択する

API には、コントロールを作成するためのビルダーメソッドが用意されています。ビルダーにデータを入力するには、制御するデバイスと、ユーザーがデバイスを操作する方法を決定します。次の手順を行います。

コントロールが表すデバイスのタイプを選択します。「 DeviceTypes クラスはサポートされているすべてのデバイスの列挙。種類は、変数の種類と UI でデバイスのアイコンと色を変更できます。
ユーザー向けの名前、デバイスの位置情報（キッチンなど）、コントロールに関連付けられているその他の UI テキスト要素を決定します。
ユーザーインタラクションをサポートする最適なテンプレートを選択します。コントロールには、アプリケーションから ControlTemplate が割り当てられます。このテンプレートは、コントロールの状態を利用可能な入力方法、つまり入力ソースが ControlAction。次の表は、利用可能なテンプレートの一部と、そのテンプレートでサポートされるアクションを示しています。

テンプレート	アクション	説明
`ControlTemplate.getNoTemplateObject()`	`None`	アプリケーションはこれを使用してコントロールに関する情報を伝えることができますが、ユーザーはコントロールを操作できません。
`ToggleTemplate`	`BooleanAction`	有効状態と無効状態を切り替えられるコントロールを表します。`BooleanAction` オブジェクトには、変更されるフィールドが含まれています。ユーザーがコントロールをタップしたときに、リクエストされた新しい状態を表すようにします。
`RangeTemplate`	`FloatAction`	指定された最小値、最大値、ステップ値を示すスライダーウィジェットを表します。ユーザーがスライダーを操作すると、値が更新された新しい `FloatAction` オブジェクトをアプリに返します。
`ToggleRangeTemplate`	`BooleanAction, FloatAction`	このテンプレートは `ToggleTemplate` と `RangeTemplate` を組み合わせたものです。タッチイベントやスライダー、調光可能な照明の制御などができます
`TemperatureControlTemplate`	`ModeAction, BooleanAction, FloatAction`	このテンプレートでは、前述のアクションをカプセル化するだけでなく、ユーザーがモード（暖房、冷房、暖房/冷房、エコ、またはオフ）を設定しました。
`StatelessTemplate`	`CommandAction`	リモートの IR テレビのように、タップ機能があるが状態を判定できないコントロールを示すために使用されます。このテンプレートを使用して、コントロールと状態の変化を集約したルーティンやマクロを定義できます。

この情報を使用して、コントロールを作成できます。

コントロールの状態が不明な場合は Control.StatelessBuilder ビルダークラスを使用します。
コントロールの状態がわかっている場合は Control.StatefulBuilder ビルダークラスを使用します。

たとえば、スマート電球とサーモスタットを操作するには、次のように追加します定数を MyCustomControlService に追加します。

Kotlin

    private const val LIGHT_ID = 1234
    private const val LIGHT_TITLE = "My fancy light"
    private const val LIGHT_TYPE = DeviceTypes.TYPE_LIGHT
    private const val THERMOSTAT_ID = 5678
    private const val THERMOSTAT_TITLE = "My fancy thermostat"
    private const val THERMOSTAT_TYPE = DeviceTypes.TYPE_THERMOSTAT
 
    class MyCustomControlService : ControlsProviderService() {
      ...
    }

Java

    public class MyCustomJavaControlService extends ControlsProviderService {
 
    private final int LIGHT_ID = 1337;
    private final String LIGHT_TITLE = "My fancy light";
    private final int LIGHT_TYPE = DeviceTypes.TYPE_LIGHT;
    private final int THERMOSTAT_ID = 1338;
    private final String THERMOSTAT_TITLE = "My fancy thermostat";
    private final int THERMOSTAT_TYPE = DeviceTypes.TYPE_THERMOSTAT;
 
    ...
    }

コントロール用のパブリッシャーを作成する

コントロールを作成したら、次はパブリッシャーが必要です。パブリッシャーは、システム UI にコントロールの存在を通知します。ControlsProviderService クラスには、アプリケーションコードでオーバーライドする必要がある 2 つのパブリッシャーメソッドがあります。

createPublisherForAllAvailable(): 環境変数を作成します。 Publisher をご覧ください。Control.StatelessBuilder() を使用するこのパブリッシャーの Control オブジェクトを作成します。
createPublisherFor(): 文字列識別子によって識別される特定のコントロールのリストについて、Publisher を作成します。Control.StatefulBuilder の用途これらの Control オブジェクトを作成します。これは、パブリッシャーが状態をオブジェクトに割り当てる必要があるためです。できます。

パブリッシャーを作成する

アプリがコントロールを最初にシステム UI に公開する時点では、アプリは各コントロールの状態を認識しません。デバイスプロバイダのネットワークでのホップ数が多い場合には、状態の取得に時間がかかることがあります。createPublisherForAllAvailable() メソッドを使用して、使用可能なコントロールをシステムにアドバタイズします。各コントロールの状態が不明であるため、このメソッドでは Control.StatelessBuilder ビルダークラスが使用されます。

Android UI にコントロールが表示されると、ユーザーはコントロールをお気に入りに追加できます。

Kotlin コルーチンを使用して ControlsProviderService を作成するには、新しい build.gradle に追加します。

Groovy

dependencies {
    implementation "org.jetbrains.kotlinx:kotlinx-coroutines-jdk9:1.6.4"
}

Kotlin

dependencies {
    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-jdk9:1.6.4")
}

Gradle ファイルを同期したら、Service に次のスニペットを追加して createPublisherForAllAvailable() を実装します。

Kotlin

    class MyCustomControlService : ControlsProviderService() {
 
      override fun createPublisherForAllAvailable(): Flow.Publisher =
          flowPublish {
              send(createStatelessControl(LIGHT_ID, LIGHT_TITLE, LIGHT_TYPE))
              send(createStatelessControl(THERMOSTAT_ID, THERMOSTAT_TITLE, THERMOSTAT_TYPE))
          }
 
      private fun createStatelessControl(id: Int, title: String, type: Int): Control {
          val intent = Intent(this, MainActivity::class.java)
              .putExtra(EXTRA_MESSAGE, title)
              .addFlags(Intent.FLAG_ACTIVITY_NEW_TASK)
          val action = PendingIntent.getActivity(
              this,
              id,
              intent,
              PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_IMMUTABLE
          )
 
          return Control.StatelessBuilder(id.toString(), action)
              .setTitle(title)
              .setDeviceType(type)
              .build()
      }
 
          override fun createPublisherFor(controlIds: List): Flow.Publisher {
           TODO()
        }
 
        override fun performControlAction(
            controlId: String,
            action: ControlAction,
            consumer: Consumer
        ) {
            TODO()
        }
    }

Java

    public class MyCustomJavaControlService extends ControlsProviderService {
 
        private final int LIGHT_ID = 1337;
        private final String LIGHT_TITLE = "My fancy light";
        private final int LIGHT_TYPE = DeviceTypes.TYPE_LIGHT;
        private final int THERMOSTAT_ID = 1338;
        private final String THERMOSTAT_TITLE = "My fancy thermostat";
        private final int THERMOSTAT_TYPE = DeviceTypes.TYPE_THERMOSTAT;
 
        private boolean toggleState = false;
        private float rangeState = 18f;
        private final Map<String, ReplayProcessor> controlFlows = new HashMap<>();
 
        @NonNull
        @Override
        public Flow.Publisher createPublisherForAllAvailable() {
            List controls = new ArrayList<>();
            controls.add(createStatelessControl(LIGHT_ID, LIGHT_TITLE, LIGHT_TYPE));
            controls.add(createStatelessControl(THERMOSTAT_ID, THERMOSTAT_TITLE, THERMOSTAT_TYPE));
            return FlowAdapters.toFlowPublisher(Flowable.fromIterable(controls));
        }
 
        @NonNull
        @Override
        public Flow.Publisher createPublisherFor(@NonNull List controlIds) {
            ReplayProcessor updatePublisher = ReplayProcessor.create();
 
            controlIds.forEach(control -> {
                controlFlows.put(control, updatePublisher);
                updatePublisher.onNext(createLight());
                updatePublisher.onNext(createThermostat());
            });
 
            return FlowAdapters.toFlowPublisher(updatePublisher);
        }
    }

システムメニューを下にスワイプして、[デバイスコントロール] ボタン（図 4:

デバイスのコントロールのシステム UI を示す画像 — **図 4.** システムメニューのデバイスコントロール。

[デバイスコントロール] をタップすると、2 つ目の画面に移動し、説明します。アプリを選択すると、前のスニペットによって新しいコントロールを表示するカスタムシステムメニューが表示されます（図 5 を参照）。

照明とサーモスタットのコントロールを含むシステムメニューを示す画像 — **図 5.** 追加する照明とサーモスタットの操作。

次に、createPublisherFor() メソッドを実装して、 Service:

Kotlin

    private val job = SupervisorJob()
    private val scope = CoroutineScope(Dispatchers.IO + job)
    private val controlFlows = mutableMapOf<String, MutableSharedFlow>()
 
    private var toggleState = false
    private var rangeState = 18f
 
    override fun createPublisherFor(controlIds: List): Flow.Publisher {
        val flow = MutableSharedFlow(replay = 2, extraBufferCapacity = 2)
 
        controlIds.forEach { controlFlows[it] = flow }
 
        scope.launch {
            delay(1000) // Retrieving the toggle state.
            flow.tryEmit(createLight())
 
            delay(1000) // Retrieving the range state.
            flow.tryEmit(createThermostat())
 
        }
        return flow.asPublisher()
    }
 
    private fun createLight() = createStatefulControl(
        LIGHT_ID,
        LIGHT_TITLE,
        LIGHT_TYPE,
        toggleState,
        ToggleTemplate(
            LIGHT_ID.toString(),
            ControlButton(
                toggleState,
                toggleState.toString().uppercase(Locale.getDefault())
            )
        )
    )
 
    private fun createThermostat() = createStatefulControl(
        THERMOSTAT_ID,
        THERMOSTAT_TITLE,
        THERMOSTAT_TYPE,
        rangeState,
        RangeTemplate(
            THERMOSTAT_ID.toString(),
            15f,
            25f,
            rangeState,
            0.1f,
            "%1.1f"
        )
    )
 
    private fun  createStatefulControl(id: Int, title: String, type: Int, state: T, template: ControlTemplate): Control {
        val intent = Intent(this, MainActivity::class.java)
            .putExtra(EXTRA_MESSAGE, "$title $state")
            .addFlags(Intent.FLAG_ACTIVITY_NEW_TASK)
        val action = PendingIntent.getActivity(
            this,
            id,
            intent,
            PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_IMMUTABLE
        )
 
        return Control.StatefulBuilder(id.toString(), action)
            .setTitle(title)
            .setDeviceType(type)
            .setStatus(Control.STATUS_OK)
            .setControlTemplate(template)
            .build()
    }
 
    override fun onDestroy() {
        super.onDestroy()
        job.cancel()
    }

Java

    @NonNull
    @Override
    public Flow.Publisher createPublisherFor(@NonNull List controlIds) {
        ReplayProcessor updatePublisher = ReplayProcessor.create();
 
        controlIds.forEach(control -> {
            controlFlows.put(control, updatePublisher);
            updatePublisher.onNext(createLight());
            updatePublisher.onNext(createThermostat());
        });
 
        return FlowAdapters.toFlowPublisher(updatePublisher);
    }
 
    private Control createStatelessControl(int id, String title, int type) {
        Intent intent = new Intent(this, MainActivity.class)
                .putExtra(EXTRA_MESSAGE, title)
                .addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
        PendingIntent action = PendingIntent.getActivity(
                this,
                id,
                intent,
                PendingIntent.FLAG_UPDATE_CURRENT | PendingIntent.FLAG_IMMUTABLE
        );
 
        return new Control.StatelessBuilder(id + "", action)
                .setTitle(title)
                .setDeviceType(type)
                .build();
    }
 
    private Control createLight() {
        return createStatefulControl(
                LIGHT_ID,
                LIGHT_TITLE,
                LIGHT_TYPE,
                toggleState,
                new ToggleTemplate(
                        LIGHT_ID + "",
                        new ControlButton(
                                toggleState,
                                String.valueOf(toggleState).toUpperCase(Locale.getDefault())
                        )
                )
        );
    }
 
    private Control createThermostat() {
        return createStatefulControl(
                THERMOSTAT_ID,
                THERMOSTAT_TITLE,
                THERMOSTAT_TYPE,
                rangeState,
                new RangeTemplate(
                        THERMOSTAT_ID + "",
                        15f,
                        25f,
                        rangeState,
                        0.1f,
                        "%1.1f"
                )
        );
    }
 
    private  Control createStatefulControl(int id, String title, int type, T state, ControlTemplate template) {
        Intent intent = new Intent(this, MainActivity.class)
                .putExtra(EXTRA_MESSAGE, "$title $state")
                .addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
        PendingIntent action = PendingIntent.getActivity(
                this,
                id,
                intent,
                PendingIntent.FLAG_UPDATE_CURRENT | PendingIntent.FLAG_IMMUTABLE
        );
 
        return new Control.StatefulBuilder(id + "", action)
                .setTitle(title)
                .setDeviceType(type)
                .setStatus(Control.STATUS_OK)
                .setControlTemplate(template)
                .build();
    }

この例では、createPublisherFor() メソッドに架空のアプリがやるべきことの実装方法。つまり、デバイスと通信し、そのステータスを取得してシステムに出力できます。

createPublisherFor() メソッドは、Kotlin のコルーチンとフローを使用して、次の方法で必要な Reactive Streams API を満たします。

Flow を作成します。
1 秒間待ちます。
スマートライトの状態を作成して出力します。
さらに 1 秒待ちます。
サーモスタットの状態を作成して出力します。

アクションを処理する

performControlAction() メソッドは、ユーザーがあります。送信される ControlAction のタイプによってアクションが決まります。指定されたコントロールに対して適切なアクションを実行し、状態を更新するデバイスの Android UI で表示できます。

この例を完了するには、次のコードを Service に追加します。

Kotlin

    override fun performControlAction(
        controlId: String,
        action: ControlAction,
        consumer: Consumer
    ) {
        controlFlows[controlId]?.let { flow ->
            when (controlId) {
                LIGHT_ID.toString() -> {
                    consumer.accept(ControlAction.RESPONSE_OK)
                    if (action is BooleanAction) toggleState = action.newState
                    flow.tryEmit(createLight())
                }
                THERMOSTAT_ID.toString() -> {
                    consumer.accept(ControlAction.RESPONSE_OK)
                    if (action is FloatAction) rangeState = action.newValue
                    flow.tryEmit(createThermostat())
                }
                else -> consumer.accept(ControlAction.RESPONSE_FAIL)
            }
        } ?: consumer.accept(ControlAction.RESPONSE_FAIL)
    }

Java

    @Override
    public void performControlAction(@NonNull String controlId, @NonNull ControlAction action, @NonNull Consumer consumer) {
        ReplayProcessor processor = controlFlows.get(controlId);
        if (processor == null) return;
 
        if (controlId.equals(LIGHT_ID + "")) {
            consumer.accept(ControlAction.RESPONSE_OK);
            if (action instanceof BooleanAction) toggleState = ((BooleanAction) action).getNewState();
            processor.onNext(createLight());
        }
        if (controlId.equals(THERMOSTAT_ID + "")) {
            consumer.accept(ControlAction.RESPONSE_OK);
            if (action instanceof FloatAction) rangeState = ((FloatAction) action).getNewValue()
            processor.onNext(createThermostat());
        }
    }

アプリを起動して [デバイスの操作] メニューにアクセスし、照明とサーモスタットの操作を確認します。

照明とサーモスタットのコントロールを示す画像 — **図 6.** 照明とサーモスタットの操作。

外部デバイスを操作する

ユーザー インターフェース

サービスを作成する

サービスを宣言する

Kotlin

Java

正しいコントロール タイプを選択する

Kotlin

Java

コントロール用のパブリッシャーを作成する

パブリッシャーを作成する

Groovy

Kotlin

Kotlin

Java

Kotlin

Java

アクションを処理する

Kotlin

Java

ユーザーインターフェース

正しいコントロールタイプを選択する