ESP RainMaker Customer Docs

ESP RainMaker Customer Docs

  • 入门指南
  • 发布版本
  • 帮助

›集成

介绍

  • 介绍

RainMaker 云

  • RainMaker 云
  • 准备工作
  • 部署前配置
  • 部署
  • 后端
  • 节点注册模块
  • 前端部署
  • 部署后配置
  • 部署验证
  • 获取许可证
  • 附加服务
  • 推送通知
  • 部署升级
  • 配置
  • 卸载

手机应用

  • 安卓配置
  • iOS 配置
  • 通知 Payload

CLIs

  • CLI

固件

  • 固件

第三方登录

  • 谷歌登录
  • 苹果登录

集成

  • 语音助手集成
  • Alexa
  • 谷歌语音助手
  • 语音助手集成插件仓库
  • Alexa 账号关联
  • 发布 Alexa Skill
  • 发布谷歌语音助手 Action
  • 升级

功能

  • 功能

监测

  • 监测面板

参考

  • 参考

语音助手集成插件

[English Version]

完成 Alexa Skill 和 Google Actions 集成后,可以部署语音助手集成插件 (RainMaker-3P-Integrations-Addons)。

语音助手集成插件仓库为 Alexa Skill 和 Google Actions 与 RainMaker 的集成提供了额外的功能。 目前,该仓库提供的功能如下所示:

  1. Google Actions:语音助手集成插件仓库提供 Webhook 处理程序,该处理程序能主动将节点状态的变化报告至谷歌 Home Graph 数据库。了解更多信息,请参考 谷歌 Smart Home Actions 状态报告功能。如需认证 Google Actions,必须主动进行状态报告。

  2. Alexa Skill:语音助手集成插件仓库提供了设置 Alexa App to App 账号关联功能所需的 API 端点,该功能允许用户从自有应用程序关联 Alexa 账户。了解更多信息,请参考 Alexa App to App 账号关联。如需为产品获取 Works With Alexa (WWA) 认证,必须为 Alexa Skill 启用 App to App 账号关联功能。注意,WWA 认证与 Alexa Skill 认证和发布不同。

若要通过认证,需要部署语音助手集成插件仓库,因为该仓库中的上述功能是通过 Alexa 和 Google Actions 认证的必要条件。

部署 ESP_RainMaker-3P-Integrations-Addons SAR 仓库

  • 打开 AWS 控制台,搜索 "Serverless Application Repository" 或 "SAR"。请确保您所选的 AWS 区域与 RainMaker 的部署区域相同。

  • 打开 Private applications,勾选复选框 Show apps that create custom IAM roles or resource policies。

SAR Private Applications

  • 搜索并打开 ESP-RainMaker-3P-Integration-Addons 仓库。

  • 您将看到 ESP-RainMaker-3P-Integration-Addons 仓库部署面板,如下所示:

Skill Add ons Sar

  • 输入 AWSClientId 值。该值应当为您在其他小节中记下的 AlexaClientId 值。

  • 输入 AWSClientSecret 值。该值应当为您在其他小节中记下的 AlexaClientSecret 值。

如果您只需部署谷歌语音助手,可以为 AlexaClientId 和 AlexaClientSecret 添加占位符值,例如 "NA" 或 "To be decided"。此后,若您需要再集成 Alexa,可以对这些值进行修改。

  • 在 ESP-RainMaker-3P-Integrations 中输入 GVAClientID (client_id)、GVAClientEmail (client_email)、GVAPrivateKey (private_key)、GVAPrivateKeyID (private_key_id) 和 GVAProjectID (project_id) 字段的值。您可以在服务账号密钥文件中找到相应值(如括号中所示)。

如果您只需部署 Alexa,可以为 GVAClientEmail、GVAClientID、GVAPrivateKey、GVAPrivateKeyID 和 GVAProjectID 添加占位符值,例如 "NA" 或 "To be decided"。此后,若您需要再集成谷歌语音助手,可以对这些值进行修改。

  • 勾选复选框并点击 Deploy。

Deploy Button

  • 您可以在 CloudFormation 中查看部署状态。若如下图所示,则表示堆栈部署成功。

SAR Addons

插件组件堆栈部署完毕后,可以进行后续配置,如下文所示。

Alexa Skill 后续操作

Skill 认证与发布

Skill 认证与发布的具体步骤,可参考 Alexa Skill 官方文档 Skill 认证。 认证成功后,您的 Skill 将按照地区被列入 Skills Store。

App to App 账号关联功能(可选)

获取 Works With Alexa (WWA) 认证需要启用 App to App 账号关联功能。 具体步骤可参考 Alexa App to App 账号关联功能。

启用 RainMaker 事件通知(可选)

如需对产品进行 WWA 认证,需要确保当添加/删除设备、设备状态改变、设备连接成功/断开时向 Alexa 发送通知。 Skills lambda 程序将处理这些 RainMaker 事件并将改动通知到 Alexa,因此您需要启用以下事件:

  • 添加用户节点
  • 删除用户节点
  • 节点断开连接
  • 节点已连接
  • 节点参数变更
  • 节点共享给用户

启用 RainMaker Webhook 事件的具体步骤,请参考 启用通知推送。

Works with Alexa 认证(可选)

如果您想在产品包装和智能家居商店上展示 Works with Alexa (WWA) 徽章,需确保您的 Skill 已通过 WWA 认证。更多细节,请查看 WWA 文档。 在发布 Alexa Skill 并启用 App to App 账号关联功能和 RainMaker 事件通知功能后,您可以为该 Skill 申请 WWA 认证。

Google Actions 后续操作

启用 RainMaker 事件通知

要发布 Google Actions,需要确保将事件报告给 Google Home Graph。 Google Actions lambda 程序将处理这些 RainMaker 事件并将改动通知到 Google Home Graph,因此您需要启用以下事件:

  • 添加用户节点
  • 删除用户节点
  • 节点断开连接
  • 节点已连接
  • 节点参数变更
  • 节点共享给用户

启用 RainMaker Webhook 事件的具体步骤,请参考 启用通知推送。

Action 认证与发布

  • 确认您的 Action 与固件兼容后,您可以对其进行 认证。

  • 认证成功后,您的 Skill 将按照地区被列入 Skills Store。

← 谷歌语音助手Alexa 账号关联 →
  • Alexa Skill 后续操作
    • Skill 认证与发布
    • App to App 账号关联功能(可选)
    • 启用 RainMaker 事件通知(可选)
    • Works with Alexa 认证(可选)
  • Google Actions 后续操作
    • 启用 RainMaker 事件通知
    • Action 认证与发布
Copyright © 2024 Espressif Systems