Home API Android 示例应用

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

前提条件

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

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

    下载 Android Studio

  • Android 调试程序 (adb)。

    安装 adb。

    您可以使用 SDK 管理器执行此操作。

如需测试 Home API，您需要：

  • 搭载 Android 10 或更高版本的 Android 设备，并已设置您打算用于开发的 Google 账号。确保已安装最新版本的 Android Studio，并使用此开发者账号登录。
  • Wi-Fi 网络。
  • 支持 Home API 的 Google 集线器。

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

    • 色温灯（开启和关闭、亮度）
    • 接触传感器（布尔值状态）
    • 可调光灯（开启和关闭、亮度）
    • 扩展色彩灯（开启和关闭、亮度）
    • 通用开关
    • 在家/外出传感器（在家/外出感知）
    • 开/关灯（开启和关闭、亮度）
    • 开/关灯开关
    • 开/关插入式装置（开启和关闭）
    • 开/关传感器

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

  3. 如果您尚未为此 Google Cloud 项目配置同意屏幕，系统会显示配置同意屏幕按钮。在这种情况下，请按照以下步骤配置同意屏幕。否则，请直接进入下一部分。

    1. 点击配置同意屏幕。系统会显示 OAuth 权限请求页面。
    2. 根据您的用例，选择内部或外部，然后点击创建。系统会显示 OAuth 权限请求页面窗格。
    3. 按照屏幕上的说明在“应用信息”页面上输入信息，然后点击保存并继续。系统随即会显示 Scopes 窗格。
    4. 您无需添加任何镜重，因此请点击保存并继续。系统会显示测试用户窗格。
    5. 如果您想添加用户来测试对应用的访问权限，请点击添加用户。系统随即会显示添加用户窗格。测试用户有权在您的应用中授予权限。
    6. 在空白字段中，添加一个或多个 Google 账号电子邮件地址，然后点击添加。
    7. 点击保存并继续。系统随即会显示摘要窗格。
    8. 查看您的 OAuth 同意屏幕信息，然后点击返回信息中心。

如需了解完整详情，请参阅 Google Cloud 控制台帮助网站上的设置 OAuth 权限请求页面。

下载源代码

示例应用的源代码可在 GitHub 上找到。

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

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

设置 SDK

此 Beta 版公开测试中的 Home API 尚未纳入 Google 提供的开发标准库。如需使用 Home API 开发应用，您需要在本地下载并托管库。

如需下载 Home API Android SDK，您必须先登录 Google Home 开发者。

立即登录！

构建并运行

  1. 打开 Android Studio，然后打开克隆到本地机器的 google-home-api-sample-app-android 项目文件夹。
  2. 在首次设置期间，Android Studio 最多可能需要 10 分钟才能下载所有项目依赖项并完成 Gradle build。
    • 如果您在此步骤中收到错误消息（例如 Gradle Sync Failed），请点击重试重新开始同步。
  3. 将示例应用的软件包名称更改为之前未注册的新名称，例如基于贵组织名称的名称：
    1. 打开项目。
    2. 展开来源层次结构。
    3. 选择要更改的软件包部分，也就是 com.example。
    4. 右键点击该软件包，然后依次选择 Refactor > Rename...
    5. 点击所有目录。
    6. 输入新名称，然后点击 Refactor（重构）。
    7. 修改 build.gradle.kts 文件，将 android namespace 和 applicationId 更改为新软件包名称。
    8. 修改 AndroidManifest.xml 文件，并将文件中出现的软件包名称更改为新软件包名称。

  4. 在 Android Studio 中运行应用以生成 OAuth 密钥。当您在 Android Studio 中运行或调试应用时，Android Studio 会自动生成用于开发和调试的 OAuth 密钥。如需完整了解，请参阅 Android Studio：为调试 build 签名。

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

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

    现在，停止运行的应用。

  5. 按照 Google Cloud 控制台帮助网站上设置 OAuth 2.0 / 原生应用 / Android 中详述的说明获取 OAuth 证书的 SHA-1 指纹。

  6. 按照设置 OAuth 2.0 中提供的说明，为 OAuth 2.0 注册示例应用并创建 OAuth 凭据。

    1. 指明应用类型，即原生/Android 应用。
    2. 按照 Google Cloud 控制台帮助网站上设置 OAuth 2.0 / 原生应用 / Android 中的说明，将 SHA-1 指纹添加到 OAuth 客户端。在整个开发过程中，您应从默认的 Android Studio 密钥生成 SHA-1 密钥。
    3. 添加测试用户。测试用户有权在示例应用中授予权限。

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

安装完成后，该应用会以 Home API 示例应用的形式显示在您的移动设备上。