Home API Android 範例應用程式

範例應用程式會展示 Android 版 Google Home API 的基本功能。

必要條件

如要建構、安裝及測試應用程式，您必須符合下列幾項先決條件：

  • Android Studio，版本 2024.2.1 (「Ladybug」) 以上。請注意，舊版可能無法與 Home API SDK 正常運作。

    下載 Android Studio

  • Android 偵錯工具 (adb)。

    安裝 adb。

    您可以使用 SDK Manager 完成這項操作。

如要測試 Home API，您需要：

  • 搭載 Android 10 以上版本的 Android 裝置，並已設定要用於開發作業的 Google 帳戶。請確認已安裝最新版本的 Android Studio，並使用這個開發人員帳戶登入。
  • Wi-Fi 網路。
  • 如要存取及控制 Matter 裝置，你還需要支援 Google Home API 的 Google 中樞裝置。詳情請參閱「Android 上的連線功能 」。

  • 住家中至少有一台支援的裝置。如果這部裝置 (或任何你想測試的裝置) 使用 Thread，中樞也必須是 Thread 邊界路由器。Android 範例應用程式支援下列裝置類型和特徵：

    • 色溫燈光 (開啟、關閉、亮度)
    • 接觸感應器 (布林值狀態)
    • 可調光燈具 (開啟、關閉、亮度)
    • 延長色彩燈 (開啟和關閉、亮度)
    • 一般切換
    • 活動情形感應器 (活動情形偵測)
    • 開/關燈 (開啟和關閉、亮度)
    • 開/關燈開關
    • 開/關插入式裝置 (開啟和關閉)
    • 開關感應器

下載原始碼

您可以在 GitHub 上找到範例應用程式的原始碼。

前往要儲存專案的位置，然後複製專案：

git clone https://github.com/google-home/google-home-api-sample-app-android.git

設定 SDK

這個公開測試版中的 Android 版 Home API 尚未納入 Google 提供的標準程式庫。如要使用 Home API 開發 Android 應用程式，您必須在本機下載及代管程式庫。

如要下載 Home API Android SDK，您必須先登入 Google Home 開發人員。

立即登入！

建構應用程式

  1. 開啟 Android Studio，然後開啟已複製到本機的 google-home-api-sample-app-android 專案資料夾。

  2. 在首次設定期間，Android Studio 可能需要最多 10 分鐘的時間才能下載所有專案依附元件，並完成 Gradle 建構作業。

  3. 使用 USB 傳輸線將電腦連接至實體 Android 手機，然後在開發人員選項中啟用 ADB。確認 Android Studio 可透過 ADB 連線至 Android 手機。

  4. 將範例應用程式的套件名稱變更為先前未註冊過的新名稱，例如以貴機構名稱為名的名稱：

    1. 開啟專案。
    2. 展開來源階層。
    3. 選取要變更的套件部分，也就是 com.example。
    4. 在套件上按一下滑鼠右鍵，然後依序選取「Refactor」>「Rename...」 Refactor > Rename 選單
    5. 輸入新名稱，然後按一下「Refactor」。
    6. 編輯 build.gradle.kts 檔案，將 android namespace 和 applicationId 變更為新的套件名稱。

  5. 下載所有必要的程式庫並完成 Gradle 同步處理後，請按一下「Run」按鈕，建構並執行應用程式。當應用程式在手機上順利執行時，您會看到「Sample App」主頁面。

建立簽署憑證

在 Android Studio 中執行或偵錯應用程式時，系統會自動產生用於開發和偵錯的偵錯憑證。如需完整說明，請參閱「Android Studio：簽署偵錯版本」。

  1. 在 Android Studio 中執行應用程式，產生偵錯應用程式簽署憑證。當您在 Android Studio 中執行或偵錯應用程式時，Android Studio 會自動產生應用程式簽署憑證，用於開發和偵錯。如需完整說明，請參閱「Android Studio：簽署偵錯版本」。

    將行動裝置連接至本機。Android Studio 會依型號列出已連結的裝置。從清單中選取裝置，然後按一下「執行專案」。這會在行動裝置上建構及安裝範例應用程式。

    如需更詳細的操作說明，請參閱 Android 開發人員網站上的「在硬體裝置上執行應用程式」。

    接著停止執行中的應用程式。

  2. 請按照 Google Cloud 控制台說明網站的「管理 OAuth 用戶端 / 應用程式類型 / 原生應用程式 / Android」一節中詳述的操作說明，取得偵錯憑證的 SHA-1 指紋。

  1. 在 Google Cloud 控制台中前往專案選取器資訊主頁，然後選取要用來建立 OAuth 憑證的專案。
  2. 前往「API 和服務」頁面，然後點選導覽選單中的「憑證」。

  3. 如果您尚未為這個 Google Cloud 專案設定同意畫面，系統會顯示「Configure consent screen」按鈕。在這種情況下，請按照下列程序設定同意畫面。否則，請繼續閱讀下一個部分。

    1. 按一下「設定同意畫面」。系統會顯示 OAuth 同意畫面頁面。
    2. 視用途而定，選取「內部」或「外部」，然後按一下「建立」。畫面上會顯示 OAuth 同意畫面窗格。
    3. 按照畫面上的指示，在應用程式資訊頁面中輸入資訊，然後按一下「儲存並繼續」。系統會顯示「Scopes」窗格。
    4. 您不需要新增任何範圍，因此請按一下「儲存並繼續」。系統會顯示「Test users」窗格。
    5. 依序點選「目標對象」和「+ 新增使用者」按鈕。
    6. 輸入測試使用者的電子郵件地址，然後按一下「儲存」按鈕。
    7. 按一下「儲存並繼續」。系統會顯示「Summary」窗格。
    8. 查看 OAuth 同意畫面資訊，然後點選「返回資訊主頁」。

詳情請參閱 Google Cloud 控制台說明網站的「設定 OAuth 同意畫面」一文。請務必先新增至少一位測試使用者，再繼續操作。

設定 OAuth 憑證

  1. 按照「設定 OAuth 2.0」一文的操作說明，註冊 OAuth 2.0 範例應用程式並建立 OAuth 憑證。
    1. 指出應用程式類型，也就是「原生/Android 應用程式」。
    2. 請按照 Google Cloud 控制台說明網站上的「設定 OAuth 2.0 / 原生應用程式 / Android」一文中的指示，將 SHA-1 指紋新增至 OAuth 用戶端。在整個開發程序中，您應從預設的 Android Studio 金鑰產生 SHA-1 金鑰。

執行應用程式

  1. 行動裝置連線至本機電腦後，請再次按一下「Run project」，在行動裝置上執行範例應用程式。

安裝完成後，應用程式會以「Home API 範例應用程式」的形式顯示在行動裝置上。