Android 向けの Google Home API は、デベロッパーがユーザーの家のエンティティの状態を操作できるようにする統合 API サーフェスを提供します。これらのエンティティは、ユーザーの構造と部屋に関連付けられたデバイスとデバイス以外の情報を記述できます。
Home API は、ユーザーが操作できる次のエンティティを定義します。
- ストラクチャは、部屋とデバイスを含む家を表します。
- 部屋はストラクチャの一部であり、デバイスが含まれています。
- デバイスは、属性を含むトレイトを実装し、タイプに準拠し、イベントを発行し、コマンドに応答します。
- 自動化は構造の一部であり、家のメタデータとデバイスを使用して家のタスクを自動化します。
図 1 は、このアーキテクチャを示しています。
Home API のデバイスタイプは、スマートホームのオープン スタンダードである Matter に対応しているか、Google Home エコシステムの Cloud-to-cloud デバイスである可能性があります。一部のデバイスタイプでは、両方の機能が組み込まれている場合があります。詳しくは、Android でサポートされているデバイスの種類をご覧ください。
Matter では、デバイスの機能はクラスタごとにグループ化され、Home API では Matter 標準トレイトとして表されます。Home API は、現在の Matter 仕様で定義されている標準の Matter クラスタをサポートしています。
Google Home エコシステムでは、デバイスの機能はスマートホーム トレイトごとにグループ化され、Home API では Google スマートホーム トレイトとして表されます。Home API は、Cloud-to-cloud プログラムで定義されているスマートホーム トレイトのセットをサポートしています。
メーカー固有のクラスタやプラットフォーム トレイトなどの他のトレイトも利用できます。詳しくは、Android のデータモデルをご覧ください。
言語
Android 向けの Home API は Kotlin で記述されており、Flow を使用して状態とサブスクリプションを管理する Kotlin 固有のインターフェースを提供します。これにより、標準のサブスクリプション API よりも多くのメリットが得られます。
コルーチン、フロー、Jetpack Compose に関する Kotlin のドキュメントをまだお読みでない場合は、一読することをおすすめします。
- Kotlin で Android アプリを開発する
- Kotlin for Androids について学ぶ
- Android での Kotlin コルーチンをご覧ください。次の Codelab が役立つかもしれません。
- Android での Kotlin Flow、特に StateFlow。
- 状態と Jetpack Compose（特に
collectAsStateWithLifecycle()関数）。この関数は、その状態を表示する UI が実際にフォアグラウンドにあるかどうかに基づいて、フローの登録と登録解除を自動的に管理します。 - Automation API を使用する場合は、Kotlin のタイプセーフ ビルダーを読むと、Automation DSL の仕組みを理解するのに役立ちます。
エンティティ ID
Home API の各エンティティには、そのプライマリ識別子を表す ID があります。この ID は、エンティティの存続期間中は変更されない一意の安定した識別子です。この ID を使用して、オブジェクトをキャッシュに保存したり、エンティティのメタデータが変更された場合に等価性を確認したりできます。
ID を持つエンティティについては、HasId インターフェースをご覧ください。
用語マッピング
Home API のエンティティは、次のように Matter と Cloud-to-cloud のコンセプトにマッピングされます。
| Google Home の API | Matter | Cloud-to-cloud |
|---|---|---|
| トレイト | クラスタ | トレイト |
| 属性 | 属性 | 属性、状態 |
| コマンド | コマンド | コマンド |
| イベント | イベント | フォローアップの回答、通知 |