跳到主要内容
ESP RainMaker Classic 文档

基本配置

ESP RainMaker Home 是一款混合型应用，可连接至你在 AWS 账户中私有部署的 ESP RainMaker 云服务。开箱即用的应用需要进行配置，才能与私有部署的 ESP RainMaker 实例配合使用。

前提条件：你已克隆 ESP RainMaker Home 应用的开源 GitHub 仓库。请进入该仓库，前往根目录，编辑 rainmaker.config.ts 文件。

云端配置​

在下表的配置中修改 baseUrl 参数，使其指向云服务后端的服务地址。

键类型描述
baseUrl字符串与每个 API 端点相对应。获取端点请参考获取 RainMaker API URL。

第三方登录​

此外，还需要根据部署修改 authUrl、clientId 和 redirectUrl 等参数。

键类型描述
clientId字符串用于识别用户池中的应用。详细内容请参阅获取 Client ID 的步骤。
authUrl字符串用于第三方登录的 OAuth 认证 URL。详细内容请参阅获取认证 URL 的步骤。
redirectUri字符串第三方登录完成后，用于将用户重定向回应用的自定义 URI scheme。你还需要将该值复制到 rainmaker.config.ts 文件中，详见设置重定向 URI。

在根目录编辑 rainmaker.config.ts 文件：

export const SDKConfig = {
  baseUrl: "<private_rainmaker_deployment_endpoint>",
  version: "v1",
  authUrl: "https://3pauth.rainmaker.espressif.com",
  clientId: "1h7ujqjs8140n17v0ahb4n51m2",
  redirectUrl: "rainmaker://com.espressif.novahome/success",
  customStorageAdapter: asyncStorageAdapter,
  localDiscoveryAdapter: EspLocalDiscoveryAdapter,
  localControlAdapter: ESPLocalControlAdapter,
  provisionAdapter: provisionAdapter,
  notificationAdapter: ESPNotificationAdapter,
  oauthAdapter: espOauthAdapter,
  appUtilityAdapter: ESPAppUtilityAdapter,
};

export const CDFConfig = {
  autoSync: true, // 启用数据自动同步
};

外部链接​

这些是在应用内浏览器中打开与项目相关文档的链接。

键类型描述
WEBSITE_LINK字符串公司、产品或服务的网站链接。
PRIVACY_POLICY_LINK字符串隐私政策链接。
TERMS_OF_USE_LINK字符串使用条款链接。

请在 constants.ts 文件中为每种文档类型提供有效的 URL：

export const WEBSITE_LINK = "https://rainmaker.espressif.com";
export const TERMS_OF_USE_LINK =
  "https://rainmaker.espressif.com/docs/terms-of-use.html";
export const PRIVACY_POLICY_LINK =
  "https://rainmaker.espressif.com/docs/privacy-policy.html";

iOS 专属配置​

苹果开发者设置​

在苹果开发者控制台创建应用 ID​

  1. 打开苹果开发者网站。

  2. 点击左侧菜单中的 Identifiers，点击 + 图标，添加新的标识符。

    苹果标识符

  3. 从列表中选择 App IDs，然后点击 Continue。

    苹果登录界面

  4. 从类型中选择 App。

    应用类型

  5. 为你的应用添加 Bundle ID 和 Description 字段，请保证 Bundle ID 与你在 RainMaker iOS 应用中所使用的 ID 保持一致。

    注册应用 ID

  6. 向下滚动页面，选择 Push Notifications 和 Sign In with Apple 功能，并点击 Continue。

    注册应用 ID

  7. 检查更改并确认配置。

  8. 请记录下你的 Team ID（App ID Prefix 值）和 Bundle ID 值，然后点击 Register 保存更改。

    注册应用 ID

对于 iOS 应用，创建应用群组可以生成一个用于共享存储的容器。此步骤是使用通知服务所必需的。

应用群组​

应用群组支持同一开发团队下的多个应用使用共享容器 （存储空间）。此时，该容器由应用程序和扩展通知服务共享。共享容器用于存储节点的详细信息，这些信息用于通知服务中的自定义通知功能。更多信息请参阅什么是 iOS 的应用群组。

配置应用群组​

  1. 进入苹果开发者控制台，点击 identifiers：https://developer.apple.com/account/resources/identifiers/list。

  2. 点击 + 图标，添加新的标识符。

  3. 从列表中选择 App Groups 并点击 Continue。

    ios_config_app_group

  4. 为你的应用群组填写 Description 和 Identifier 字段，点击 Continue。

    ios_config_register_app_group

  5. 检查改动并点击 Register 保存更改。

    ios_config_register_app_group-1

在 Xcode 中配置应用群组​
  1. 打开 Xcode 项目，在你的主应用目标中，打开 Signing & Capabilities。
  2. 在 App Groups 中勾选你之前配置的应用群组。

ios_config_xcode_app_group

On this page