Home API Android 示例应用

示例应用展示了 Google Home API for Android 的基本功能。

前提条件

如需构建、安装和测试该应用，您需要满足以下几个前提条件：

  • Android Studio，版本 2024.2.1 ("Ladybug") 或更高版本。 请注意，低于此版本的版本可能无法与 Home API SDK 正常搭配使用。

    下载 Android Studio

  • Android 调试器 (adb)。

    安装 adb。

    您可以使用 SDK 管理器 完成此操作。

如需测试 Home API，您还需要：

  • 一部搭载 Android 10 或更高版本的 Android 设备，并使用您打算用于开发的 Google 账号进行设置。确保已安装最新版本的 Android Studio，并使用此 开发账号登录。
  • Wi-Fi 网络。
  • 如需访问和控制 Matter 设备，您还需要支持 Home API 的 Google hub。 如需了解详情，请参阅 Android 上的连接 。

  • 住宅中至少有一部受支持的设备。如果此设备（或您要测试的任何其他设备）使用 Thread，则 hub 还必须是 Thread 边界路由器。Android 示例应用支持以下设备类型和特征：

    • 色温灯（开/关、亮度）
    • 接触传感器（布尔值状态）
    • 可调光灯（开/关、亮度）
    • 扩展色灯（开/关、亮度）
    • 通用开关
    • Google 相机
    • 在家/外出传感器（在家/外出感知）
    • 开/关灯（开/关、亮度）
    • 开/关灯开关
    • 开/关插件单元（开/关）
    • 开/关传感器

下载源代码

GitHub 上提供了示例应用的 source code 源代码。

前往您要保存项目的位置，然后克隆该项目：

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

设置 SDK

此开放 Beta 版中的 Home API for Android 尚未纳入 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 可以连接到 Android 手机 通过 ADB。

  4. 将示例应用的软件包名称更改为之前未注册的新名称，例如基于您组织名称的名称：

    1. 打开项目。
    2. 展开源层次结构。
    3. 选择您要更改的软件包部分，即 com.example。
    4. 右键点击软件包，然后依次选择 Refactor > Rename... “重构”>“重命名”菜单
    5. 输入新名称，然后点击 Refactor 。
    6. 修改 build.gradle.kts 文件，将 android namespace 和 applicationId 更改为新的软件包名称。

  5. 下载所有必需的库并完成 Gradle 同步后，点击 Run （运行）按钮以构建并运行应用。当应用在手机上成功运行时，您会看到示例应用主页。

创建签名证书

当您在 Android Studio 中运行或调试应用时，系统会自动 生成一个用于开发和调试的调试证书。如需了解完整说明，请参阅 Android Studio：为调试 build 签名。

  1. 通过在 Android Studio中运行应用来生成调试应用签名证书。当您在 Android Studio 中运行或调试应用时，Android Studio 会自动 生成一个用于开发和调试的应用签名证书。 如需了解完整说明，请参阅 Android Studio：为调试 build 签名 。

    将移动设备连接到本地机器。 Android Studio 会按型号 列出已连接的设备。从列表中选择您的设备，然后点击 Run project （运行项目）。这会在您的移动设备上构建并安装示例应用。

    如需更详细的说明，请参阅 在硬件设备上运行应用 在 Android 开发者网站上。

    现在停止正在运行的应用。

  2. 按照 Google Cloud 控制台帮助网站上的 管理 OAuth 客户端 / 应用类型 / 原生应用 / Android 中详述的说明，获取调试证书的 SHA-1 指纹。

  1. 在 Google Cloud 控制台中，前往 项目选择器信息中心 ，然后选择您要用于创建 OAuth 凭据的项目。
  2. 前往 APIs and Services （API 和服务）页面，然后在导航菜单中点击 Credentials （凭据）。

  3. 如果您尚未为此 Google Cloud 项目配置权限请求页面，系统会显示 Configure consent screen （配置权限请求页面）按钮。在这种情况下，请使用以下过程配置权限请求页面。否则，请继续下一部分。

    1. 点击 Configure consent screen （配置权限请求页面）。系统会显示 OAuth consent screen （OAuth 权限请求页面）页面。
    2. 根据您的使用情形，选择 Internal（内部）或 External（外部），然后 点击 Create（创建）。系统会显示 OAuth consent screen （OAuth 权限请求页面）窗格。
    3. 按照屏幕上的说明在 App information page （应用信息页面）上输入信息，然后点击 Save and continue （保存并继续）。系统会显示 Scopes （范围）窗格。
    4. 您无需添加任何范围，因此请点击 Save and continue （保存并继续）。系统会显示 Test users （测试用户）窗格。
    5. 点击 Audience （受众群体），然后点击 + ADD USERS （添加用户）按钮。
    6. 输入您的测试用户电子邮件地址，然后点击 SAVE （保存）按钮。
    7. 点击 Save and continue （保存并继续）。系统会显示 Summary （摘要）窗格。
    8. 查看您的 OAuth 权限请求页面信息，然后点击 Back to dashboard （返回信息中心）。

如需了解完整详情，请参阅 Google Cloud 控制台帮助网站上的设置 OAuth 权限请求 页面 。请务必先添加至少一个测试用户，然后再继续。

设置 OAuth 凭据

  1. 按照 设置 OAuth 2.0中提供的说明，为 OAuth 2.0 注册示例应用并创建 OAuth 凭据。
    1. 指明应用类型，即 native/Android app （原生/Android 应用）。
    2. 按照 Google Cloud 控制台帮助网站上的 说明，将 SHA-1 指纹添加到 OAuth 客户端。 设置 OAuth 2.0 / 原生应用 / Android在整个开发过程中，您都应从默认 Android Studio 密钥生成 SHA-1 密钥。

运行应用

  1. 将移动设备连接到本地机器后，再次点击 Run project （运行项目），以在移动设备上运行示例应用。

安装后，该应用在您的移动设备上显示为 Home API Sample App 。