跳到主要内容
ESP RainMaker Classic 文档

入门指南

示例应用代码是开源的，可以在许可条款范围内进行克隆、修改和使用。

下载源代码​

示例应用的源代码可在 GitHub 上获取。

在系统中进入要保存项目的位置，然后进行克隆：

git clone https://github.com/espressif/esp-rainmaker-home.git

构建和运行​

这是一个用于管理 ESP RainMaker 物联网生态系统的 React Native 应用，提供了设备配网、管理和控制的无缝工具，支持 BLE、SoftAP 和 Matter 配网。

前提条件：

  • Node.js 22+
  • Android Studio（用于安卓开发）
  • Xcode（用于 macOS 上的 iOS 开发）

快速入门：

cd esp-rainmaker-home
nvm use 22
npm install

# Android
npm run android

# iOS（仅限 macOS）
npm run ios -- --device

配置更改​

移动应用会连接到 ESP RainMaker 云，该云可能私有部署在你自己的 AWS 账户中。需要更新移动应用的配置，使其指向私有部署的端点。

更新配置​

应用使用中央数据框架 (CDF)，该框架在应用启动时使用 rainmaker.config.ts 中的配置进行初始化（参考 context/CDF.tsx 第 60 行）。

为云实例配置应用：

  1. 打开项目根目录中的 rainmaker.config.ts 文件
  2. 将 baseUrl 参数更改为指向你的云后端端点
  3. 如有需要，更新其他端点 URL（authUrl 等）
export const SDKConfig = {
  baseUrl: "https://api.rainmaker.espressif.com",  // Change this to your 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 };

注意：这些配置会在 context/CDF.tsx 中被导入并用于 CDF 初始化：

const store = await initCDF(SDKConfig, CDFConfig);

完成以上步骤后，应用即可开箱即用，并与你的私有部署 ESP RainMaker 云实例正常配合。

如需高级自定义，例如支持新设备类型和控制界面，请参阅 components/、config/ 和 app/ 目录中的项目文档和源代码结构。

⚠️ 重要声明：本文档中提供的公共部署详情和配置仅用于开发和教育目的，不应用于商业用途。

On this page