跳到主要内容

后端发布版本

关于本文

本文列出了所有 RainMaker 后端发布版本。如需获取支持，请联系 esp-rainmaker-support@espressif.com。

2025 年后端发布版本​

3.3.0 (17-Jun-2025)​

If you are upgrading from any version older than 3.0.0, please note that there would be a downtime during the upgrade

Refer RainMaker version 3.0.0 release notes for downtime considerations.

For SAR deployment method, Please upgrade the Node Registration module to v25 after upgrading the backend.

Please upgrade the RainMaker Dashboard to 2.4.0 after upgrading the backend.

  • New Features:

    • Message Customisation: Added support for dynamic placement of the verification code in SMS templates. The {#var#} placeholder in templates for Signup, Forgot Password, and Delete Account flows is now replaced with the actual verification code, allowing more flexible message formatting. Refer Swagger

  • Bug Fixes:

    • OTA: Admins and End Users were not able to download securely signed OTA images.
    • Third-party identity providers (Google/GitHub/SignInWithApple) were not getting configured.
    • Node Tags attached by End users were not retrieved when Admins fetched the nodes list.
    • OAuth Only RainMaker: End users were able to call admin and superadmin APIs.
    • Automation Triggers: Server error was returned when invalid coordinates were provided in case of DayLight/Weather Automations. Now, a client error is returned instead.

  • Other changes:

    • OTA: The OTA image URL was valid only for 15 mins, now it is valid for a day.
    • User Node Mapping: When a node is added to a group via user-node mapping API, transferring the group will result in transferring the node too and the original user will lose access completely. Refer Swagger
    • Node Registration: Add Validation for Node IDs & Certificate Common Name and delete node if Node registration fails.
    • Identity Provider: Added support for deleting identity providers. Refer Swagger.
    • Simple TimeSeries: data_type query param has been changed to type to make it consistent with the regular time series APIs. data_type will be supported for backward compatibility, but should be considered deprecated. Refer Swagger.
    • Added support to change RainMaker's resource Lambda's log retention period. It is 7 days by default for most Lambdas and 'Never expire' for some. Refer Swagger. For cost savings, you may set it to a lower period, but for Production, we recommend keeping it at least 7 days.
    • Automation Triggers: Added pagination support when fetching automation triggers by Node ID. Refer Swagger

3.2.1 (2025.5.20)​

如果当前版本低于 3.0.0，则升级期间会停机

请参阅 RainMaker 3.0.0 版本发布说明，了解停机相关注意事项。

升级后端之后，请将节点注册模块升级到 v24。

升级后端之后，请将 RainMaker 管理面板升级到 2.3.2 版本。

  • 修复以下漏洞

    • 用户-节点映射：节点端恢复出厂设置未将设备从用户账户中解绑。
    • 推送通知：
      • 当节点共享请求被接受或拒绝时，没有发送通知。
      • 通知收到时有 5 到 6 秒的延迟。

  • 其他更新

    • 推送通知：如果事件数据被禁用，iOS 推送通知中已添加对可变内容的支持。
    • 用户-节点映射：如果节点已绑定到当前用户，从节点发起的重置请求将不会重置用户绑定。

3.2.0 (2025.4.23)​

如果当前版本低于 3.0.0，则升级期间会停机

请参阅 RainMaker 3.0.0 版本发布说明，了解停机相关注意事项。

升级后端之后，请将节点注册模块升级到 v24。

升级后端之后，请将 RainMaker 管理面板升级到 2.3.2 版本。

  • 新增以下功能

    • 持续 OTA：即使所有现有节点已完成 OTA（无论是报告成功还是被拒绝），OTA 任务仍可保持激活状态。详见 Swagger 文档。

  • 修复以下漏洞

    • 节点注册：未校验 node_id 和节点证书中 CN 字段的匹配。当节点证书 CSV 文件中的 node_id 与证书不一致时，可能导致异常行为。
    • API 访问日志：查询时设定的时间窗口未被正确应用，返回了额外的数据记录。详见 Swagger 文档。
    • 用户-节点映射：如果节点已链接到同一用户并属于同一分组，则在节点映射过程中添加到分组会失败。详见 Swagger 文档。
    • OTA：取消的任务状态未被处理。
    • Node HTTP API：当提供 CA 链时，仅注册了根 CA，导致 RainMaker + Matter 节点尝试通过 HTTP 连接时失败。仅影响 这些 API。
    • MQTT 访问日志：存储的 /params/local 和 /params/local/init 主题名错误。
    • 语音助手：添加节点时，语音助手集成未收到任何通知。
    • 节点自动化：对于字符串参数，“不等于”条件无法正常工作。详见 Swagger 文档。
    • 推送通知：RainMaker 升级后消息模板丢失。
    • OTA 镜像：如果 OTA 镜像关联了其他文件（如安全签名镜像和 bootloader），原始镜像可能被替换。详见 Swagger 文档。
    • 通过 RainMaker 升级或 API 更新发送者邮箱时，该值会被重置为默认发送者邮箱。
    • 命令响应：用户无法覆盖已有命令。详见 Swagger 文档。
    • OTA：当 OTA 镜像是安全签名镜像时，file_md5 校验值未通过 /otaurl 主题发送给节点。
    • OAuth-only RainMaker：在新部署和现有部署中，超级管理员登录失败。

  • 其他更新

    • 管理员 API：为避免当数据量较大时管理员 API 超时或失败，已省略 total 字段。以下是相关管理员 API 列表：
      • /admin/otaimage
      • /admin/otajob
      • /admin/event_filter
      • /admin/secure_sign/signed_images
      • /admin/secure_sign/signing_keys
      • /admin/webhook_integration
      • /admin/rainmaker_license
      • /admin/otajob/status
      • /admin/user
      • /admin/user2
      • /admin/nodes/cmd
      • /admin/node_group
      • /admin/file
      • /admin/role
      • /admin/policy
      • /admin/key

3.1.2 (2025.4.14)​

如果当前版本低于 3.0.0，则升级期间会停机

请参阅 RainMaker 3.0.0 版本发布说明，了解停机相关注意事项。

升级后端之后，请将节点注册模块升级到 v24。

  • 修复以下漏洞：升级到 3.1.0 版本期间以及完成升级后，第三方登录 (Google/GitHub/SignInWithApple) 和语音助手集成功能无法正常工作。

3.1.0 (2025.4.3)​

如果当前版本低于 3.0.0，则升级期间会停机

请参阅 RainMaker 3.0.0 版本发布说明，了解停机相关注意事项。

升级后端之后，请将节点注册模块升级到 v24。

  • 新增了以下功能

    • 通知推送：iOS 推送通知默认包含 "sound" 字段，因此所有 iOS 通知不会静默推送。详见 RainMaker 推送通知 Payload。
    • 管理员用户管理：管理员可以检索所有 RainMaker 用户。详见 Swagger API。
    • 管理员文件上传：在创建上传请求时可以指定可选功能校验和 (Checksum)，后端将校验上传文件的完整性。详见 Swagger API。
    • 管理员消息模板：管理员可以配置多种语言的邀请/欢迎/删除邮件和短信模板。详见 Swagger API。
    • OAuth-only RainMaker：现支持用户密码授权类型 (Resource Owner Password Credentials, ROPC)，可跳过浏览器重定向，提升登录体验。详见 Swagger API。
    • 许可证详情：Get License API 已修改，将返回更多有关最新许可证的详细信息。详见 Swagger API。
    • 支持删除简单时序 (Simple Time Series) 数据。

  • 修复以下漏洞

    • RainMaker 版本升级后，Cognito 设置会被重置，修复后将自动备份与恢复 Cognito 设置。
    • 云到云认证：创建用户的 API 存在延迟问题。
    • 命令响应：命令响应历史未按时间排序。详见 Swagger API。
    • 自动化触发器：使用 AND 运算符的自动化触发器在一个条件新满足、另一个条件已满足时无法执行。
    • API 透传服务：Get Configurations API 错误允许管理员访问，现已修复为仅超级管理员可访问。
    • 设备分组：重复的组 ID 会导致共享时服务器错误。
    • OAuth-only RainMaker：
      • 单个用户的多个会话共用刷新令牌。
      • 基于前缀的用户筛选功能失效。
      • 升级后 OAuth 登录不可用。
      • 重新登录后未更新提供商的刷新令牌，导致登录失败。

  • 已知问题：第三方登录 (Google/GitHub/SignInWithApple)、Alexa 和 GVA 登录不可用，请升级到新版本。

3.1.0-alpha.3 (2025.3.22)​

如果当前版本低于 3.0.0，则升级期间会停机

请参阅 RainMaker 3.0.0 版本发布说明，了解停机相关注意事项。

升级后端之后，请将节点注册模块升级到 v24。

升级前的重要提醒

RainMaker 升级后，部分 Cognito 设置会被重置为默认值。请务必在升级前备份 Cognito 设置。具体步骤参见备份 Cognito 设置。

升级后的重要提醒
  1. 请将默认邮件发送方设置为 AWS SES，而非 Cognito。详见操作指南。
  2. 请将 Cognito-assisted verification and confirmation 属性设置为 Send SMS message if phone number is available, otherwise send email message。详见操作指南。

  • 新增了以下功能

    • OTA 串行化：同一网络内的 Thread 节点进行 OTA 升级时，采用串行方式以避免带宽限制导致的失败。详情请联系 RainMaker 支持团队 (esp-rainmaker-support@espressif.com)。
    • 支持自定义节点警报的移动端通知推送模板。详见 Swagger API。

  • 修复以下漏洞：当节点已有高优先级任务时，较低优先级 OTA 任务被强制推送而导致 OTA 状态出现错误。

3.0.0 (2025.3.4)​

停机提醒

由于部分优化，本次升级将伴随停机（仅影响 Core 和 Base 堆栈），建议在低峰期进行升级。停机影响包括：

  • 设备将与云端断开连接约 3～4 小时，具体时间取决于注册节点数量。升级完成后设备将自动重连。
  • 手机应用端的节点操作在停机期间不可用，其他 API 可能间歇性失败。
  • 停机仅影响 ESP-Rainmaker-Base 和 ESP-Rainmaker-Core 堆栈升级。

如果已绑定自定义 AWS-IoT 策略，则其功能不受影响。

若有疑问，请联系你的客户经理或乐鑫支持团队 (esp-rainmaker-support@espressif.com)。

备注

升级到 3.0.0 版本后，请参照下列 升级后的重要提醒 中的步骤 3 进行验证。

如果升级失败，请回滚到旧版 IoT 策略，避免长时间停机。

升级后端之后，请将节点注册模块升级到 v24。

升级前的重要提醒

如果需要通知终端用户有关停机的信息，请参考通知步骤。
如果启用了设备防护，设备在停机期间会不断尝试重连，导致接收到大量的违规警报邮件。若想确认是否启用了设备防护，且想要修改规则避免发生上述情况，可以参考此文档。

升级前的重要提醒

RainMaker 升级后，部分 Cognito 设置会被重置为默认值。请务必在升级前备份 Cognito 设置。具体步骤参见备份 Cognito 设置。

升级后的重要提醒

  1. 请将默认邮件发送方设置为 AWS SES，而非 Cognito。详见操作指南。

  2. 请将 Cognito-assisted verification and confirmation 属性设置为 Send SMS message if phone number is available, otherwise send email message。详见操作指南。

  3. 确认升级完成且系统无停机。

  • 优化了以下内容

    • 成本优化：节点配置和参数更新优化后，DynamoDB 成本约降低 40%。

  • 新增了以下功能

    • OTA：通过 /otaurl 路径下发到设备节点的 JSON 数据中包含新的 file_md5 键，表示 OTA 镜像的 MD5 校验值。
注意事项

为优化成本与性能，即将发布的版本将进行以下变更：

  1. 所有分页管理 API 响应将不再返回 total 字段。如有自定义管理面板依赖此字段，请联系客户经理或乐鑫支持团队 (esp-rainmaker-support@espressif.com)。
  2. 节点数量汇总（活跃、非活跃、未激活）将通过邮件发送给超级管理员。

2.8.1（2025.1.31）​

升级后端之后，请将节点注册模块升级到 v12。

升级前的重要提示

RainMaker 升级后，部分 Cognito 设置会被重置为默认值。请务必在升级前备份 Cognito 设置。具体步骤参见备份 Cognito 设置。

升级后的重要提示
  1. 请将默认邮件发送方设置为 AWS SES，而非 Cognito。详见操作指南。
  2. 请将 Cognito-assisted verification and confirmation 属性设置为 Send SMS message if phone number is available, otherwise send email message。详见操作指南。

  • 新增了以下功能

    • OTA：固件镜像文件不再局限于 .bin 文件。现在可以使用 "raw" 作为镜像类型上传任意类型的文件，并用于 OTA 任务。请参考 OTA Image API 上传任意类型文件。

  • 修复以下漏洞

    • OTA 任务：已修复将新节点加入关联至 OTA 任务的动态分组中时，OTA 任务计数未更新的问题。同时也解决了由于计数错误导致部分节点未能成功 OTA 的问题。
    • OAuth-only RainMaker：Add Identity Provider API 出现错误的问题已修复。

为优化成本与性能，即将发布的版本将进行以下变更：

  • 所有分页管理 API 响应将不再返回 total 字段。
  • 节点数量汇总（活跃、非活跃、未激活）将通过邮件发送给超级管理员。

2.8.0（2025.1.3）​

升级后端之后，请将节点注册模块升级到 v12。

升级前的重要提醒

RainMaker 升级后，部分 Cognito 设置会被重置为默认值。请务必在升级前备份 Cognito 设置。具体步骤参见备份 Cognito 设置。

升级后的重要提醒
  1. 请将默认邮件发送方设置为 AWS SES，而非 Cognito。详见操作指南。
  2. 请将 Cognito-assisted verification and confirmation 属性设置为 Send SMS message if phone number is available, otherwise send email message。详见操作指南。

  • 新增了以下功能

  • 修复以下漏洞

    • OTA 任务：显式添加超过 100 个节点时，创建 OTA 任务 API 会返回服务器错误，现已改为返回验证错误。详见 OTA Create API。
    • 第三方登录：升级后，第三方登录偶发失败。
    • 节点分组：共享分组中的节点后续重新分配给其他用户时，通过获取节点分组 API 查询到的节点数量不正确。
    • 管理端 CLI 工具：设备证书注册时添加的通用/每节点标签，在进行用户节点关联时会被清除。现可使用 2.7.1 版本引入的 --update 选项重新附加标签。
    • OAuth-only RainMaker：
      • oidc_url 和 oidc_issuer 字段之前被混用，现已统一将请求和响应中的 oidc_url 重命名为 oidc_issuer，避免产生混淆。详见 Identity Provider API。
      • 之前允许创建无效名称的身份提供商，现已增加校验并将返回验证错误。详见 Identity Provider API。

  • 其他更新

    • 节点注册：现确保同一时间只能进行单个节点注册任务，其他任务将排队等待。
    • OAuth-only RainMaker：Cognito 身份池会自动进行备份和恢复。

  • 已知的问题

    • 某些场景中，OTA 任务统计数量可能并不准确，导致部分节点未能成功 OTA。

为优化成本与性能，即将发布的版本将进行以下变更：

  • 所有分页管理 API 响应将不再返回 total 字段。
  • 节点数量汇总（活跃、非活跃、未激活）将通过邮件发送给超级管理员。

2024 年后端发布版本​

2.7.1（2024.12.6）​

升级后端之后，请将节点注册模块升级到 v22。

升级前的重要提醒

RainMaker 升级后，部分 Cognito 设置会被重置为默认值。请务必在升级前备份 Cognito 设置。具体步骤参见备份 Cognito 设置。

升级后的重要提醒
  1. 请将默认邮件发送方设置为 AWS SES，而非 Cognito。详见操作指南。
  2. 请将 Cognito-assisted verification and confirmation 属性设置为 Send SMS message if phone number is available, otherwise send email message。详见操作指南。

  • 新增了以下功能

    • 节点注册：

      • 新增了更新已注册节点信息的选项。新增 --update_nodes 参数，可用于更新后端已注册节点的类型、型号、子类型及标签。
      • 新增了重新注册节点的选项。新增的 --force 参数用于在节点证书发生变化等情况下，强制重新注册已注册的节点。同时也可以更新节点的信息，例如类型、型号、子类型和标签。

      要使用这些新参数，请拉取最新的 RainMaker Admin CLI 代码。

    • 管理员用户管理：管理员可以自定义分配标签验证邮件的内容。详情请参考 Admin User Management API 和 Message Template API。

    • 用户管理：用户在注册后可自行添加标签。详情请参考 User Management API。

  • 修复以下漏洞

    • OTA：即便所有节点已完成 OTA，OTA 任务状态仍显示为“活跃”。
    • 管理员用户管理：用户详情中的自定义数据返回为文本格式，而非原有格式。详情请参考 Admin User Management API。
    • 节点分组：如果某个 Matter fabric 中包含含有 Matter 节点的子分组，共享该 fabric 会失败。
    • 标签管理：在节点注册过程中添加动态标签时，系统还额外添加了一个带有 "@" 前缀的标签字段。

  • 已知问题

    • OTA 任务节点数量统计：如果 OTA 任务是基于包含查询筛选条件的节点分组创建的，则节点总数统计可能不正确。
    • 节点标签与用户映射：当用户将节点映射到其账户时，在节点注册阶段添加的标签会被移除。
    • OAuth-only RainMaker 升级问题：升级会导致身份池重置，进而使所有登录功能失效。

2.7.0 (2024.11.26)​

请在升级后端服务之后，将节点注册模块升级到 v21。

升级前的重要提醒

在升级 RainMaker 后，一些 Cognito 设置可能会被重置为默认值。请务必在升级之前备份 Cognito 设置。备份步骤请参考备份 Cognito 设置。

升级后的重要提醒
  1. 请将默认的邮件发送服务从 Cognito 切换为 AWS SES。操作步骤请参考 FAQ。
  2. 请将 Cognito-assisted verification and confirmation 属性设置为 Send SMS message if phone number is available, otherwise send email message（如果可用，则发送 SMS 短信，否则发送电子邮件）。操作步骤请参考 FAQ。
  • 新增以下功能
    • 用户公共资料：新增了用户公共资料 (User Public Profile) 的概念。由于资料是公开的，其他经过认证的用户可以访问该资料。详情请参考 User Public Profile API。
    • 用户账号：用户在账号被删除时会收到邮件通知。管理员可以配置 DELETE_USER_CONFIRM_MESSAGE 消息模板，用于发送该邮件。详情请参考 Message Template API。
    • 用户文件管理：用户可以上传、获取和管理自定义文件。详情请参考 File Upload API。
    • 管理员用户：
      • 查询某个标签下的用户时，管理员可以通过新增的查询参数 node_counts，获取每个用户映射的节点数量。详情请参考 Tags Service API。
      • 管理员可以基于邮箱前缀（不区分大小写）来筛选用户。详情请参考 Admin User Management API。
    • OTA 任务：用户现在可以拉取用于用户审批任务的固件二进制文件。详情请参考 OTA Service API 和 User OTA API。
    • 用户-节点映射：简化了基于挑战-响应的用户-节点映射流程。详情请参考 User-Node Association Mapping Initiate API 和 User-Node Association Mapping Verify API。
    • OTA 镜像：通过 API 支持上传最大 200 MB 的固件二进制文件，详情请参考 OTA Image API。管理面板功能将会很快上线。
    • MQTT 直连支持：新增节点与手机应用之间的直接 MQTT 连接支持。如需了解更多信息，请联系 ESP RainMaker 支持团队，邮箱地址为 esp-rainmaker-support@espressif.com。
  • 修复以下漏洞
    • 自动化触发器：通过共享获得节点主访问权限 (Primary Access) 的用户，之前无法更新或删除自动化触发器，现已修复。详情请参考 Automation Trigger and Actions API。
    • 用户管理：用户注销时，刷新令牌 (refresh token) 未能正确吊销的问题已修复。现在可通过注销 API 传入刷新令牌进行吊销。详情请参考 User Management API。
    • 设备防护：当设备恢复到正常消息速率后，超级管理员用户仍收到错误邮件通知的问题已修复。
    • OTA 更新：针对超过 100 个节点的节点组发布 OTA 时，之前只有 100 个节点收到 OTA 的问题已修复。
    • 节点组：获取节点详情时，即便节点已连接，返回的连接状态仍为 false 的问题已修复。
    • OTA 包上传：之前如果上传的文件不是 zip 格式，上传会直接失败。现在会返回验证错误提示。
    • 时间序列：当节点重新映射到新用户后，新用户仍可访问前一用户的时间序列数据的问题已修复。
    • 标签管理：查询指定标签名的可能取值时，如果标签名不存在，之前会返回服务器错误 (5xx)，现已修正为返回空响应。详情请参考 Tags Service API。
    • Cloudwatch 用户：无法创建可用于排查 Cloudwatch 日志的 IAM 用户。详情请参考 Cloudwatch Log IAM User API。
    • 管理员用户：当超级管理员降级为管理员时，内部用户的 管理员标志未能正确更新，现已修复。详情请参考 Admin User Management API](https://swaggerapis.rainmaker.espressif.com/?urls.primaryName=RainMaker%20Superadmin%20APIs#/Admin%20User%20Management/createUserWithPrivileges2)。
备注

为降低成本与优化性能，在即将发布版本中将弃用：

  • 所有分页管理 API 的总数字段将被删除。
  • 节点计数摘要（活跃、非活跃和未激活）将通过邮件发送给超级管理员。详见 Swagger 文档。

2.6.0 (2024.10.18)​

请在升级后端服务之后，将节点注册模块升级到 v20。

升级前的重要提醒

在升级 RainMaker 后，一些 Cognito 设置可能会被重置为默认值。请务必在升级之前备份 Cognito 设置。备份步骤请参考备份 Cognito 设置。

升级后的重要提醒
  1. 请将默认的邮件发送服务从 Cognito 切换为 AWS SES。操作步骤请参考 FAQ。
  2. 请将 Cognito-assisted verification and confirmation 属性设置为 Send SMS message if phone number is available, otherwise send email message（如果可用，则发送 SMS 短信，否则发送电子邮件）。操作步骤请参考 FAQ。
  • 新增以下功能
    • 管理员访问权限：管理员现在可以访问用户的自定义数据、节点映射时间戳，并可以获取关联到不同资源类型的标签名称及其对应的取值。详情请参考 Admin Custom Data API、Admin Nodes API 和 Tags API。
    • 标签功能：
      • 管理员可以获取指定资源类型下的所有标签名称列表，以及指定标签名称对应的所有可能取值。详情请参考 Tags API。
      • 支持多语言。
      • 支持在通过标签查询用户时，一并获取用户的自定义数据。详情请参考 Tags API。
    • OTA 镜像：现在支持多语言的镜像名称。详情请参考 OTA Image API。
    • 文件完整性校验：
      • OTA 镜像上传与文件上传 API：在创建上传请求时，可以选择性地指定校验和 (Checksum)。后台将计算上传文件的校验和并与输入值进行比对，以验证文件完整性。详情请参考 OTA Image API 和 File Upload API。
    • 时间序列：
    • 管理员节点信息：在返回的节点数据中新增了激活时间、最后状态更新时间、最后配置更新时间以及最后活跃时间字段（分别为Activation、LastStatusUpdate、LastConfigUpdate 和 LastActivity）。详情请参考 Admin Nodes API。
    • 命令响应：即使目标节点离线，API 也会返回成功。系统框架将在节点重新上线后将命令下发。详情请参考 Command Response API。
    • 部署详情邮件和部署设置 API 将包含超级管理员用户名和管理面板 URL。详情请参考 Deployment Details API。
    • 发布消息：功能扩展，可以通过推送通知向所有终端用户发送消息，而无需逐个指定邮箱地址。详情请参考 Publish Message API。
    • RainMaker 已在中国区域上线，如需了解更多信息，请联系 ESP RainMaker 支持团队，邮箱地址为 esp-rainmaker-support@espressif.com。功能开放情况请参考相应文档。
    • 云对云认证已正式发布：支持将自有云端系统安全连接至 RainMaker 进行用户管理。如需了解更多，请联系 ESP RainMaker 支持团队，邮箱地址为 esp-rainmaker-support@espressif.com。
  • 修复以下漏洞
    • 设备组：动态组下允许创建子组的问题已修复。
    • 设备防护：删除 Device Defender 堆栈时，部分 AWS 资源未被正确删除的问题已修复。
    • OTA 任务：允许创建重名任务的问题已修复。
    • 用户-节点映射：API 响应中的描述文本错误问题已修复。
    • MQTT 统计：当 API 参数中同时传递 node_id 和 topic_name 时，返回的计数值不正确的问题已修复。详情请参考 MQTT Statistics API。
    • 用户节点组：在更新节点组属性时，custom_data 无法同步更新的问题已修复。
    • 时间序列：如果某一条记录中的任一测量值无效，所有记录都会被丢弃的问题已修复。
    • 节点组：更新节点组时，无论是单个属性还是多个属性，返回格式现已统一。
    • 标签：
      • 通过标签搜索节点时，未返回节点连接状态的问题已修复。
      • 次级用户可以修改节点标签、元数据等信息的问题已修复。
  • 其他更新
    • 文件上传：file_name 最大长度限制为 100 个字符。
    • 节点组：如果为同一用户和同一节点组创建了重复的分享请求，旧的请求将被自动丢弃，避免重复。
备注

为降低成本与优化性能，在即将发布版本中将弃用：

  • 所有分页管理 API 的总数字段将被删除。
  • 节点计数摘要（活跃、非活跃和未激活）将通过邮件发送给超级管理员。详见 Swagger 文档。

2.5.1 (2024.9.10)​

请在升级后端服务之后，将节点注册模块升级到 v19。

  • 修复以下漏洞：使用 TRAI 注册的发送者 ID 向印度手机号码发送短信失败的问题已修复。
升级前的重要提醒

在升级 RainMaker 后，一些 Cognito 设置可能会被重置为默认值。请务必在升级之前备份 Cognito 设置。备份步骤请参考备份 Cognito 设置。

升级后的重要提醒
  1. 请将默认的邮件发送服务从 Cognito 切换为 AWS SES。操作步骤请参考 FAQ。
  2. 请将 Cognito-assisted verification and confirmation 属性设置为 Send SMS message if phone number is available, otherwise send email message（如果可用，则发送 SMS 短信，否则发送电子邮件）。操作步骤请参考 FAQ。
备注

为降低成本与优化性能，在即将发布版本中将弃用：

  • 所有分页管理 API 的总数字段将被删除。
  • 节点计数摘要（活跃、非活跃和未激活）将通过邮件发送给超级管理员。详见 Swagger 文档。

2.5.0 (2024.8.21)​

请在升级后端服务之后，将节点注册模块升级到 v19。

  • 新增以下功能

    • 设备组支持更多特殊字符：现在设备组中除了 #$\\|外，其他特殊字符均被支持。
    • API 透传服务：现在可以使用 API 透传服务通过 POST 请求将数据发送到外部服务。详情请参考 Passthrough API。
    • 现已支持使用在印度电信管理局 (TRAI) 注册的发送者 ID，通过本地路由向印度手机号码发送短信。相关配置可通过Deployment Setting API 进行设置。
    • 为管理员提供节点读取访问权限：支持通过 Deployment Setting API 配置，以授予管理员读取节点数据的权限。此数据可以通过 Get Admin User Nodes API 的节点详情标志获取。
    • 管理员节点数据访问：具有节点数据访问权限的管理员现在可以获取时间序列数据。详见 Get Admin Nodes Time Series Data API。
    • 支持设备将文件上传到云端。详情请参考 Command Response Communication API。

  • 修复以下漏洞

    • 自动化：相同条件可能会多次触发自动化。例如，如果天气 = Thunderstorm 已经匹配并触发了自动化，则在下次定期检查时，如果天气依然是 Thunderstorm，自动化将再次触发。现在它只会触发一次，只有在天气变为其他值后，再次变回 Thunderstorm 时才会触发。如果希望恢复早期的重新触发行为，可以传递 "retrigger":true。详情请参考 Automation Trigger and Actions API。
    • 公有 RainMaker 上的洞察包上传功能已修复。
    • 相同名称的组无法在不同的父级下创建。
    • 通过标签服务返回的用户列表中仅包含 user_id，而未包含 user_id 和 user_name。

  • 其他更新

    • 对设备发送的消息处理进行了并行优化。
    • 管理员可以使用 user_name 查询参数来查询自定义用户数据，而不需要单独使用 user_email 和 user_phone_number 查询参数。user_email 和 user_phone_number 将在后续版本中废弃。详情请参考 Custom Superadmin Data API。
    • 管理员用户信息：管理员现在可以通过 user_id 获取用户详情，之前仅支持使用 user_name 作为查询参数。详情请参考 Admin User Management API。

  • 已知问题

    • OTA：状态统计有时会出现负值。

2.4.0 (2024.7.1)​

请在升级后端服务之后，将节点注册模块升级到 v18。

  • 新增以下功能
    • 支持用户通过 Put API 将节点的读取权限授予管理员。管理员可以通过节点详情标志在 Get Admin User Nodes API 中获取这些数据。
    • 支持管理员通过 Get Admin User Nodes API 获取与节点关联的终端用户。
    • 时间序列：
      • 节点上报累计值的情况下，所有聚合数据查询支持差分查询。负值时可选择是否重置。详见 Swagger 文档。
      • 节点可以通过发送 'ow':true 覆盖已有数据。
    • 超级管理员可以为用户添加标签。详见 Swagger 文档。
    • 所有待处理命令可以通过新的命令响应请求被覆盖。
    • 在 Cognito Backup API 中新增了 Cognito 应用客户端备份时间戳。
  • 修复以下漏洞
    • 数字字符串键未能正确添加到 JSON 中，影响到节点参数、各种自定义数据和元数据。
    • 群组共享推送通知事件数据中出现重复的群组信息。
    • 状态和摘要 API 中 OTA 任务 "进行中" 状态的节点数量始终显示为 0。
    • Get OTA Status API 返回了重复的节点。
    • 通过 Publish Message API 发送的推送通知在用户登出并重新登录后可能失败。
    • 管理员无法访问 Get Admin User Nodes API。
  • 其他更新
    • 当用户没有关联节点时，错误消息内容有所调整。详见 Swagger 文档。
    • 允许在节点组名称中使用单引号。详见 Swagger 文档。
    • AWS 架构优化：
      • 所有 DynamoDB 表启用时间点恢复。
      • SQS 消息启用静态加密。
  • Matter 相关更新
  • 已知问题

2.3.0 (2024.5.30)​

请在升级后端服务之后，将节点注册模块升级到 v18。

  • 新增以下功能
    • API 透传服务为用户提供了一种通过 RainMaker 与外部 API 无缝交互的方式，同时支持管理和存储调用外部 API 所需的配置信息。详见 Swagger 文档。
    • 支持在用户注册时添加用户标签，并可通过 Get User API 返回。管理员可以通过 Get Tags API 基于标签筛选用户。
    • 支持在用户节点关联时，将节点直接添加到分组中。
    • 在 Get User Groups API node details 中新增了配置、参数、节点信息和标签。对于以主页/分组视图为主界面的应用，这个 API 可以取代 GET /user/nodes，避免拉取不相关的节点数据。
    • 支持通过 User API 和 Admin API 获取命令响应的历史日志。需通过 Deployment Settings API 启用该功能。
    • 支持在节点分组创建或更新时添加带 JSON 规则的自定义数据。
    • 在 Get User Nodes API 中返回用户节点关联的时间戳。
  • 修复以下漏洞
    • 创建 OTA 作业时，如果节点或分组列表中包含重复节点，OTA 节点数量统计不正确的问题已修复。
    • 当节点/分组共享的待处理请求数量超过 10 个时，获取群组共享请求 API 报服务器错误的问题已修复。详见 Swagger 文档。
  • 其他更新
    • 允许在 OTA 固件镜像名称中使用多个连字符。
    • OTA 优化：优化 OTA 节点状态流转及作业完成标记流程。
    • 删除用户验证邮件默认改为纯文本格式，而不是使用 RainMaker 品牌模板。建议通过 Message Template API 自定义邮件格式，类似注册邮件的风格。
    • 允许节点的主要用户和次要用户离开节点分组。主用户也可以移除其他用户共享的分组。详见 Swagger 文档。
    • 通过 User API 和 Admin API 可根据 command_id 查询命令响应请求。
    • 文件上传的元数据支持为字符串或 JSON 格式。详见 Swagger 文档。
    • OAuth：支持 Cognito OAuth 用户修改密码。
  • Matter 相关更新
    • Matter 控制器：允许将任意 RainMaker 节点转换为 RainMaker + Matter 节点。适用于 Matter 控制器设备本身不是 Matter 设备，但仍需分配 Matter NodeId 的场景。详见 Swagger 文档。
    • 在 Get User Groups API 中支持单独拉取 Matter NodeIds，无需获取完整节点详情，适用于内存受限的客户端如 Matter 控制器。
  • 已知问题
    • 创建 Matter Fabric 时添加自定义数据的功能暂不可用。可以在创建后通过 Put Group API 补充添加。
    • 第三方登录时遇到 Attribute mapping 错误，可参阅文档解决。
备注

从 2024 年 6 月 1 日起，Google 计划移除通过旧版 FCM API 发送移动推送通知的能力。为了避免影响你的 Android 应用，我们建议你在 2024 年 6 月 1 日之前完成现有平台应用的迁移。请按照以下步骤更新推送通知密钥：迁移到 HTTP v1 API 的步骤。

备注

在升级之前，如果你的当前版本是 [2.0.2, 2.1.0, 2.1.2] 中的任意一个，请务必执行以下操作：

  1. 前往 AWS CloudWatch，检查是否存在名为 /aws/lambda/esp-GetUserPoolDetails 的日志组。
  2. 如果不存在，请参考创建日志组的方法手动创建。
  3. 如果漏掉此步骤，ESP-RainMaker-Core 栈升级时可能会因为 Log group not found（找不到日志组）而失败。遇到这种情况可执行步骤 2 进行补救。

2.2.0 (2024.5.16)​

请在升级后端服务之后，将节点注册模块升级到 v18。

  • 新增以下功能
    • 为了支持安装人员（及其他类似）场景，允许主要用户执行以下操作：
      • 将节点/组转让给其他用户，而不仅仅是共享。转让后，原用户将完全失去访问权限。
      • 在将节点/组共享给其他用户后，将自己的角色更改为次要用户。此后，原用户将只拥有有限访问权限。详见 Swagger 文档。
    • OAuth-only 部署（测试版）：一种基于标准 OAuth 2.0 协议的替代性、成本更低的身份管理方案。目前仅支持通过社交身份提供商进行用户注册。如需了解更多信息，请联系 ESP RainMaker 支持团队，邮箱地址为 esp-rainmaker-support@espressif.com。详见 Swagger 文档。
  • 修复以下漏洞
    • 当已注册节点数量超过 50 万，节点注册失败的问题已修复。
    • 对于非强制推送的 OTA 作业，节点 OTA 启动状态的 “Additional Info” 为空的问题已修复。
备注

在升级之前，如果你的当前版本是 [2.0.2, 2.1.0, 2.1.2] 中的任意一个，请务必执行以下操作：

  1. 前往 AWS CloudWatch，检查是否存在名为 /aws/lambda/esp-GetUserPoolDetails 的日志组。
  2. 如果不存在，请参考创建日志组的方法手动创建。
  3. 如果漏掉此步骤，ESP-RainMaker-Core 栈升级时可能会因为 Log group not found（找不到日志组）而失败。遇到这种情况可执行步骤2进行补救。

2.1.2 (2024.4.30)​

请在升级后端服务之后，将节点注册模块升级到 v17。

  • 修复以下漏洞：在 Extend Session API 调用中，如果提供了无效的 user_name，不再抛出错误。此修复解决了第三方用户在 Android 应用中被登出的情况。详见 Swagger 文档。该 API 本身并不需要 user_name 参数。此次改动仅用于保持向后兼容性。
  • 其他变更：天气自动化触发器现在支持多个天气事件。但同一触发器中只允许一个天气条件类型事件。详见 Swagger 文档。
  • 已知问题：从此版本升级时，可能偶发出现 Log group not found 错误。手动创建所需的日志组可以解决该问题。

2.1.0 (2024.4.22)​

请在升级后端服务之后，将节点注册模块升级到 v17。

  • 新增以下功能
    • 基于挑战-响应的身份验证：作为用户与节点关联的一种替代方式，取代基于密钥的身份验证。详见 Swagger 文档。
    • 安全签名的 OTA发：此功能允许管理员将安全签名的 OTA 镜像推送到节点。详见 Swagger 文档。要使用此功能，需要兼容的固件。如需了解更多信息，请联系 ESP RainMaker 支持团队，邮箱地址为 esp-rainmaker-support@espressif.com。
  • 修复以下漏洞
    • 创建管理员用户时出现间歇性错误。
    • 当参数名称或值包含 "-" 字符时，简单时间序列数据会出现问题。
  • 其他变更
    • 天气自动化触发器的推送通知。详见 Swagger 文档。
    • 由主要用户添加的新用户现在可以访问完整的简单时间序列数据，不受节点共享时间影响。
    • 小幅性能和成本优化。
  • 已知问题
    • 每当满足指定的事件条件时，自动化操作都会被触发，无论节点当前的状态如何。尤其是在天气自动化中，定期获取天气状态时，可能会导致重复触发。
    • 即使系统内部并没有实际使用用户名字段，只要用户名不是有效的邮箱地址或电话号码，调用 Extend session API 时就会报错。此问题会导致第三方用户在安卓手机应用中被注销。
    • 从此版本升级时，可能偶发出现 Log group not found 错误。手动创建所需的日志组可以解决该问题。
备注

为降低成本与优化性能，在即将发布版本中将弃用：

  • 所有分页管理 API 的总数字段将被删除。
  • 节点计数摘要（活跃、非活跃和未激活）将通过邮件发送给超级管理员。详见 Swagger 文档。

2.0.2 (2024.2.28)​

请在升级后端服务之后，将节点注册模块升级到 v17。

  • 修复以下漏洞
    • 间歇性出现在新部署项目中无法创建超级管理员的问题。
    • 进行明确查询时，节点无法获取待处理的命令请求（在命令-响应工作流中）。
    • 子节点组删除后留下悬空指针，导致无法查询其父节点组。
    • Upload Files API 中的 CORS 问题。
  • 其他变更
    • 支持在创建 OTA 任务时自定义描述，对于用户批准的 OTA 工作流程，终端用户也可查看对应的自定义描述，这有助于公开固件发布信息。（详见 Swagger 文档）。
    • 更新了基于多种天气条件的自动化触发器，详见 Swagger 文档。
    • 支持在标签中使用特殊字符（详见 Swagger 文档）。如需使用，请首先拉取最新的 RainMaker Admin CLI。
    • 对统计数据进行定期调节，以提高数据准确性。
  • Matter 相关更新：
    • 修复了用户在拥有 Matter 节点时，删除该用户会失败的问题。
    • 仅针对 Matter 的部署：如果未在请求头中自定义用户 ID，则使用授权请求头 (Authorization header)。修复了管理面板的访问问题。
  • 已知问题：升级此版本时可能会出现 Log group not found（找不到日志组）的错误，可通过手动创建日志组解决此问题。
备注

为降低成本与优化性能，在即将发布版本中将弃用：

  • 所有分页管理 API 的总数字段将被删除。
  • 节点计数摘要（活跃、非活跃和未激活）将通过电子邮件发送给超级管理员（详见 Swagger 文档）。

2.0.1 (2024.1.6)​

请在升级后端服务之后，将节点注册模块升级到 v16。

  • 新增以下功能
    • 简单时间序列数据（详见 Swagger 文档）：使用 AWS DynamoDB 而非 AWS Timestream。
      • 在原始值数量足够且不需要计算最小值、最大值、平均值等数值的情况下，有助于降低成本。
      • 需要在固件中启用相关支持。
    • 支持将 clear_sky 作为一种天气条件，用于设置基于天气条件的自动化触发器（详见 Swagger 文档）。
  • 修复以下漏洞
    • 分页响应中重复添加自动化触发器。
    • 由于删除过程是异步的，导致删除节点组后立即查询给出不正确的响应。
    • 创建基于天气的自动化触发器后，第一天的日光自动触发失效。
  • 其他更新
    • 设备组名称和自动化触发器名称的最小长度更新为一个字符。
    • 优化天气和日光自动触发处理程序。
  • Matter 相关更新：支持多个 Matter 控制器（详见 Swagger 文档）。

2023 年后端发布版本​

2.0.0 (2023.12.6)​

请在升级后端服务之后，将节点注册模块升级到 v16。

  • 新增以下功能
    • 自动化触发器新增对日光触发的支持，包括日出和日落（详见 Swagger 文档）。
    • 改进 RainMaker 许可证文件格式。此更新向后兼容，不强制更新许可证文件，但仍然推荐你联系 ESP RainMaker 支持团队 (esp-rainmaker-support@espressif.com) 获取新的许可证。
  • 修复以下漏洞：节点数计算错误导致无法正确完成 OTA 任务。
  • 其他更新
    • 支持存档已完成的 OTA 任务（详见 Swagger 文档）。
    • 支持使用其他语言设置节点组名称、描述和自动化名称（设备和场景名称已支持使用其他语言）。
    • 在苹果推送通知服务证书过期的电子邮件中新增更多信息。
    • 支持按照节点 ID 和节点状态获取命令-响应列表（详见 Swagger 文档）。
    • 在通知违反 API 速率限制的电子邮件中包含被阻止的用户 IP（需按照这些步骤 升级到最新版本）。
    • al2 lambda 运行时 升级至最新版本以提高性能和安全性。
  • Matter 相关更新：

1.2.1 (2023.11.7)​

请在升级后端服务之后，将节点注册模块升级到 v14。

  • 修复以下漏洞
    • 缺失某些 IoT streams 的权限，导致在创建 OTA 任务时出错。
    • 某些 AWS 账户部署 ESP-RainMaker-Base SAR 出错。
    • 非关联用户可访问节点的天气自动化触发器。

1.2.0 (2023.10.4)​

请在升级后端服务之后，将节点注册模块升级到 v14。

  • 新增以下功能
  • 已知问题：在某些部署中，OTA 任务可能会创建失败，出现 500 - Internal server error 错误。

1.1.31 (2023.9.14)​

请在升级后端服务之后，将节点注册模块升级到 v14。

  • 新增以下功能：自定义用户上下文：特权用户可以代表其他用户执行用户操作，该功能可用于 Matter 部署，需启用相关 API。
  • 次要问题修复及改进。
  • 其他更新：命令-响应框架支持 Base64 数据（详见 Swagger 文档）。

1.1.30 (2023.8.17)​

请在升级后端服务之后，将节点注册模块升级到 v14。

  • 新增以下功能
    • 支持对管理员组、OTA 固件镜像和任务进行标记（详见 Swagger 文档）。
    • 提供新 HTTP 网关以降低成本 (BETA)（注意，需迁移到新用户池以使用新网关，详细迁移步骤请参阅用户池迁移指南）。
  • 修复以下漏洞
    • 修复了删除共享组时未向共享用户发送群组移除通知的问题。
    • 修复了更改密码时未撤销其他用户池令牌的问题。
    • 修复了在节点注册时未添加节点到父节点组的问题。
    • 在 Change Password API 请求正文中删除了多余的访问令牌。
  • 其他更新
    • 在 Get Node API和获取节点组 API 中添加了主要用户和次要用户的信息。
    • 在 Get requests API 中新增了共享组名。
    • 在命令-响应框架中对 Command ID 1（设置节点参数）设置特殊处理程序（详见 Swagger 文档）。需要在固件中提供相应支持。
    • 通过 RainMaker Admin CLI 进行节点注册时，若无父节点组，则创建父节点组。
    • 支持次要用户更新节点级别的事件过滤器（详见 Swagger 文档）。

1.1.28 和 1.1.29 (2023.6.28)​

请在升级后端服务之后，将节点注册模块升级到 v13。

  • 新增以下功能
    • 通过 RainMaker Admin CLI 注册节点时，支持为每批节点和每个节点添加节点标签。
    • 在统计信息页面，支持基于 type 或 model 对在线和离线节点进行统计（详见 Swagger 文档）。
    • 支持统计活跃、非活跃和未激活节点数量（详见 Swagger 文档）。
    • 支持转让超级管理员权限（详见 Swagger 文档）。
  • 修复以下漏洞
    • 修复了删除管理员组时节点也会从其他组中移除的问题。
    • 修复了优先级较低的任务无法被用户批准的问题。
    • 修复了 OTA 状态中时间戳显示不正确的问题。
    • 修复了添加节点标签时自动删除空格的问题。
    • 为 RainMaker 管理员 CLI 增加额外验证。
  • 其他更新
    • 标记 ESP RainMaker 创建的所有 AWS 资源。
    • 在 Activate or Deactivate Nodes API 中支持同时对多个节点进行操作 。
    • 为删除用户的短信通知和忘记密码的电子邮件通知新增自定义模板（详见 Swagger 文档）。
    • 次要用户可管理自动化触发器（详见 Swagger 文档）和事件过滤器（详见 Swagger 文档）。
    • 禁止删除超级管理员用户。
    • 禁止升级 ESP-RainMaker-Base-API。
    • 支持获取给定标签的所有值（详见 Swagger 文档）。
    • RBAC：在 API 中返回用户名。
备注
重要

RainMaker 版本 1.1.27 已支持切换到新用户池，新用户池具有更多功能。旧用户池不久后会被弃用，建议用户迁移到新用户池，详细步骤请参考用户池迁移指南。如需任何帮助，请联系 RainMaker 支持团队 (esp-rainmaker-support@espressif.com)。

1.1.27 (2023.4.18)​

请在升级后端服务之后，将节点注册模块升级到 v12。

  • 新增以下功能
  • 修复以下漏洞
    • 修复了使用标签搜索时，获取的管理员节点 total 和 next_id 参数不正确的问题。
    • 修复了动态组中节点总数错误的问题。
    • 修复了禁用推送通知时仍会发送通知的问题。
  • 其他更新
    • 新增用户批准 OTA 任务的推送通知。
    • 为 RBAC 角色添加角色级别，其中 0 级别的用户享有最高权限。用户只能为其他用户附加更高级别的角色。通过此 API 可启用这一行为。
    • 条款和政策文件支持 HTML 格式。
    • 为设备组添加了 group_metadata 参数（详见 Swagger 文档）。
备注

重要：

  1. ESP RainMaker 已切换至新的用户池，与原先的用户池相比，新用户池具有更多功能。旧用户池不久后会被弃用，建议迁移至新用户池。请参考用户池迁移指南 中的详细步骤。如需帮助，请联系 RainMaker 支持团队 (esp-rainmaker-support@espressif.com)。

  2. RainMaker Admin CLI：进行相关更新以延长设备证书的有效期。请在更新 CLI 后注册新节点证书。

1.1.26 (2023.1.16)​

请在升级后端服务之后，将节点注册模块升级到 v11。

  • 新增以下功能
    • 设置 OTA 优先级以方便管理（详见 Swagger 文档）。
    • 新增超时参数，可将 OTA 任务设置为过期（详见 Swagger 文档）。
  • 修复以下漏洞
    • 删除重复的动态组。
    • 修复了节点未被添加到相关动态组的问题。
    • 修复了删除主要用户时共享组无效的问题。
    • 修复了节点处于离线状态时，用户批准的 OTA 任务会丢失的问题。
    • 支持验证自定义推送通知消息中占位符的数量（详见 Swagger 文档）。
  • 其他更新
    • 支持内容为空的动态组。
    • 改善了节点到云端的通信延迟。
    • 支持在节点组名称中包含空格。
    • 优化了 OTA 状态的更新流程。
    • 在时间序列数据查询中支持对 sum 进行汇总（详见 Swagger 文档）。
    • 允许设置自定义推送通知信息不添加占位符（详见 Swagger 文档）。

2022 年后端发布版本​

1.1.25 (2022.11.29)​

请在升级后端服务之后，将节点注册模块升级到 v11。

  • 修复以下漏洞：修复了由于 payload 中没有发送 event_data 而导致推送通知格式错误的问题。

1.1.24 (2022.11.7)​

请在升级后端服务之后，将节点注册模块升级到 v11。

  • 新增以下功能
    • 支持基于 MQTT 的 OTA，以避免使用多个 TLS 连接，优化了 RAM 使用。
    • 支持对节点的 type 和 model 进行统计。
    • 为超级管理员用户提供用于获取当前可用配额的 API。
    • 支持使用 node/+/alert 发送节点警报。
    • 创建 OTA 任务时，支持备用的 OTA 固件镜像 URL。
  • 修复以下漏洞
    • 支持在任何事件数据状态下自定义消息内容。
    • 修复了信息模板更新后，发起删除账户的请求时无法正常发送验证码的问题。
    • 修复了在 Get Admin Nodes API 中已提供标签参数时，节点类型被忽略的问题。
    • 提供 raw_aggregate 时忽略 aggregation_interval 参数（详见 Swagger 文档）。请参照这些步骤升级到最新版本。
  • 其他更新
    • 移除了附加 SAR 中的一些非必要参数。
    • 在 Publish Message API 中支持消息类型 (message type) 和附加信息 (additional information) 字段。
    • 为所有支持的事件主题配置了共同的消息标题（详见 Swagger 文档）。
    • 为 ESP API 限流服务和 ESP Device Defender 违规邮件设置了格式。请参照 ESP API Rate Limiter 和 ESP Device Defender 中的步骤升级到最新版本。
重大更新：
  • 已移除对 DigiCert S3 服务器证书的 OTA 支持，OTA 服务对于这样的支持案例 会失效。
  • 已支持对动态节点组进行自动重新分组，手动重新分组的功能在此 API 中将被移除。

1.1.23 (2022.10.3)​

请在升级后端服务之后，将节点注册模块升级到 v11。

  • 修复以下漏洞
    • 修复了节点移除通知被重复触发两次的问题。
    • 修复了分页参数给定时，Get API 中缺失自动化触发器的问题（详见 Swagger 文档）。
    • 修复了在短期内连续收到节点 OTA 状态事件时，事件顺序被调换的问题。
    • 修复了在最新 OTA 任务被报告为成功或被拒后，节点依旧能获取到旧 OTA 任务的问题。
    • 修复了 RainMaker 非空 S3 存储桶的清空问题。
  • 其他更新：将所有 S3 对象更新为私有。

1.1.22 (2022.8.23)​

请在升级后端服务之后，将节点注册模块升级到 v11。

  • 新增以下功能
    • 支持在统计服务中捕获 MQTT 消息合计。如需升级或部署附加服务，请参考这些步骤（详见 Swagger 文档）。
    • 在节点注册中支持上传预配置模块 csv 文件，请参考 RainMaker Admin CLI。
  • 修复以下漏洞：修复了已注册节点的问题，无论用户有无节点，均计入统计服务。
  • 其他更新
    • 命令/响应功能支持处理大于 255 字节的数据。
    • 移除对所有 RainMaker S3 存储桶的公开访问。
    • 在 RainMaker 部署中新增对电子邮件 ID 的验证功能。

1.1.21 (2022.7.26)​

请在升级后端服务之后，将节点注册模块升级到 v10。

  • 新增以下功能
    • 支持将节点上的标签生成列表（详见 Swagger 文档）。
    • 支持在 Stats 服务中捕获 API 计数指标。如需部署附加服务，请参考这些步骤（详见 Swagger 文档）。
  • 修复以下漏洞
    • 修复了在有大量节点时删除管理员节点组会超时的问题。
    • 在获取管理节点的 API 中删除了配额 (quota) 字段并添加了对状态参数的验证。
    • 在修改密码的 API 中修复了首尾空格的问题。
    • 修复了获取管理员节点 API 的分页和响应问题。
  • 其他更新
    • 支持在标签中添加同时包含字母和数字的字符串。

1.1.20 (2022.7.5)​

请在升级后端服务之后，将节点注册模块升级到 v10。

  • 修复以下漏洞
    • 对推送消息的正文和标题部分增加了最大字符限制。
    • 在创建节点组的 API 中增加了对组名的验证功能。
    • 为 WebHooks 配置增加了对请求 payload 的验证功能。
    • 修复了通用自定义数据 API 中的一个问题。
    • 修复了获取 OTA 镜像 API 中与总数计算相关的问题。
    • 修正了管理员用户获取 API 中与响应 payload 相关的问题。
    • 修复了 RainMaker 部署中与 CloudWatch 日志组相关的问题。

1.1.19 (2022.6.22)​

请在升级后端服务之后，将节点注册模块升级到 v10。

  • 新增以下功能
    • 增加了对苹果推送通知证书过期的检测功能。
    • 增加 PUT 方法 API，用于配置推送通知（详见 Swagger 文档）。
  • 修复以下漏洞
    • 增加了对节点标签参数的验证功能。
    • 修复了删除用户时对事件映射的移除功能。
  • 其他更新
    • 优化了系统级 WebHook 过滤器。
    • 时间序列服务中支持过期数据。
    • 支持查看相关节点标签（详见 Swagger 文档）。

1.1.18 (2022.6.9)​

请在升级后端服务之后，将节点注册模块升级到 v10。

  • 新增以下功能：支持自定义电子邮件模板（详见 Swagger 文档）。
  • 修复以下漏洞
    • 修复了与命令响应功能相关的问题。
    • 修复了与每周时区汇总相关的问题。
    • 修复了与更新和删除节点标签相关的问题。
  • 其他更新
    • 更新了获取自动化触发器 API，允许查看共享节点。
    • 将用于各类情况（如用户注册、找回密码等）的验证码设置为相同长度。
    • 对删除用户操作中无效的尝试进行次数限制。

1.1.17 (2022.5.24)​

请在升级后端服务之后，将节点注册模块升级到 v10。

  • 新增以下功能
  • 修复以下漏洞
    • 修复了 RainMaker 升级中与 CloudWatch 日志相关的问题。
    • 修复了时间序列数据服务中与数据提取相关的问题（请按照以下步骤 升级到最新版本）。
  • 其他更新
    • 优化了 WebHook 过滤器以降低成本。
    • 支持创建多个谷歌和苹果推送通知平台。
    • 优化了基于角色的访问控制，支持多个管理员用户访问节点。
    • 优化了生成 OTA 镜像 URL 的方法，以支持 DigiCert 和 Amazon CA。
RainMaker OTA 服务器的验证问题

这个问题具体指什么？​

此前，AWS 将其默认 TLS 证书从 DigiCert 迁移到 Amazon Trust Services。原 RainMaker 固件使用 Digicert 证书进行 OTA 服务器验证，迁移后此证书失效，导致 RainMaker OTA 无法验证。

如何确认我是否受到影响？​

ESP RainMaker 证书已于 2022 年 2 月 1 日在此提交中更新。如果你的项目基于此提交或之后版本，且你使用的是默认证书（如下所示），那么你不会受到影响。

esp_rmaker_ota_config_t ota_config = {
.server_cert = ESP_RMAKER_OTA_DEFAULT_SERVER_CERT,
};

如果使用旧的证书，你在进行 OTA 时会遇到以下错误：

E (57062) esp-tls-mbedtls: mbedtls_ssl_handshake returned -0x2700
I (57062) esp-tls-mbedtls: Failed to verify peer certificate!
I (57062) esp-tls-mbedtls: verification info: ! The certificate is not correctly signed by the trusted CA

出现该错误后，你必须向 AWS 提出请求，暂时更改你的服务器证书，以同时支持 Digicert 和 Amazon Trust Services 的证书。具体步骤参见下文。注意，以下操作涉及改变 OTA 的 URL 生成逻辑，因此仅适用于 RainMaker 后端 1.1.17 及之后的版本。

向 AWS 提交请求​

按照这些步骤创建一个支持案例，并为案例添加以下描述：

We have deployed the RainMaker IoT Platform in our AWS account. RainMaker uses S3 buckets to store the Firmware images required for the Over the Air Upgrades (OTA). We are aware that AWS had started migrating the S3 server certificates from Digicert to Amazon Trust Services and we have added the new certificate in our SDK. However, there already are devices in the field that had only the old certificate. If they try to do an OTA upgrade, it fails because of server validation failure. So can you enable the DigiCert certificate for the below S3 bucket - esp-rainmaker-ota-<AWS_Account_Number>.s3.us-east-1.amazonaws.com?（我们已经在 AWS 账户中部署了 RainMaker IoT 平台。RainMaker 使用 S3 存储桶来存储空中升级 (OTA) 所需的固件镜像。我们知悉 AWS 已经开始将 S3 服务器证书从 Digicert 迁移到 Amazon Trust Services，因此我们已在 SDK 中添加新证书。然而，已有一些设备目前仅使用旧的证书，如果对这些设备进行 OTA，会遇到服务器验证失败的问题。因此，能否请你为此 S3 存储桶——esp-rainmaker-ota-<AWS_Account_Number>.s3.us-east-1.amazonaws.com 启用 DigiCert 证书?）

如何确保这种情况不再发生？​

在固件层面，RainMaker 不再仅使用单个的服务器证书，而是支持证书包，证书包中包含所有标准认证机构的证书。具体请参考此提交。

1.1.16 (2022.5.10)​

请在升级后端服务之后，将节点注册模块升级到 v9。

  • 新增 OTA 任务的延迟状态 (delayed) 与拒绝状态 (rejected)。
  • 修改通用自定义数据 API（详见 Swagger 文档）。
  • 允许终端用户对其所关联的节点添加标签（详见 Swagger 文档）。
  • 新增从数据库中获取 SES 邮件发送状态的 API（详见 Swagger 文档）。
  • 修复了用户节点关联过程中添加标签时出现的问题。
  • 支持使用自定义数据中的标签完成用户关联（esp.location 下的所有 esp.key）。详见 Swagger 文档。
  • 修复了时间序列数据获取过程中出现的问题。请按照这些步骤 升级到最新版本。
  • 优化了批量生成节点的 API，支持返回节点组的详细信息。

1.1.15 (2022.4.21)​

请在升级后端服务之后，将节点注册模块升级到 v9。

  • 在时间序列 DB 服务中新增时区 (Time Zone) 参数（详见 Swagger 文档）。请按照这些步骤 升级到最新版本。
  • 支持基础的 MQTT 主题获取功能，以降低 AWS IoT 成本。
  • 支持 Alexa 异步通信。

1.1.13 和 1.1.14 (2022.4.8)​

请在升级后端服务之后，将节点注册模块升级到 v9。

  • 针对推送通知 API，修复了基于角色的访问控制 (RBAC)。
  • 修复了用户自定义数据 API 的相关问题。
  • 为自动化触发器增加推送通知服务。
  • 支持关联用户与节点时添加节点标签和附加元数据。
  • 支持在节点注册时基于 type、model 和 fw_version 自动添加到节点组。
  • 支持管理员用户使用 RBAC 查看或管理由其他管理员用户注册的节点。
  • 支持基于时间戳对 OTA 任务 进行排序。
  • 支持在新标签添加至节点时生成 WebHook 事件。
  • 优化了统计服务以解决删除用户事件。

1.1.12 (2022.3.8)​

请在升级后端服务之后，将节点注册模块升级到 v9。

  • 基于标签和 RBAC 策略，优化了节点搜索 API。
  • 支持基于标签过滤器创建 RBAC 策略。

1.1.11 (2022.2.25)​

请在升级后端服务之后，将节点注册模块升级到 v8。

  • 为管理员 API 引入基于角色的访问控制 (RBAC)。
    • 支持管理访问控制的角色和策略。
    • 增加了适用于 RBAC 的默认策略。
    • 支持创建具有管理权限的额外用户。
  • 增加了对常用自定义数据的支持（Swagger API 链接）。
  • 支持的 OTA 镜像最大尺寸增加为 16 MB（Swagger API 链接）。

1.1.10 (2022.2.9)​

请在升级后端服务之后，将节点注册模块升级到 v8。

  • 支持节点标签和标签过滤器（Swagger API 链接）。
  • 支持在创建新管理员或注册新节点时生成 WebHook 事件。
  • **时间序列服务：**增加了新查询参数 aggregation_interval。目前，RainMaker 同时支持查询参数 time_interval 和 aggregation_interval，但建议使用 aggregation_interval.（Swagger API 链接）请参照这些步骤升级到最新版本。

1.1.9 (2022.1.28)​

  • 新增 API，支持上传更大的 OTA 镜像，最大可达 16 MB。
  • 支持在节点注册时创建节点组。
  • 支持 OTA 镜像按时间戳排序。
  • 优化了 OTA 状态摘要 API。
  • 支持管理员用户根据 user_id 或 user_name 寻找与用户相关的节点。
  • 修复了与节点自动化触发器服务相关的问题。
  • 支持持久化保存从设备组共享请求中接收的元数据。
  • 改进了更改密码和忘记密码 API 的错误信息。

2021 年后端发布版本​

1.1.8 (2021.12.31)​

请在升级后端服务之后，将节点注册模块升级到 v5。

  • 优化了 ESP RainMaker 证书服务。
  • 优化了用户管理 API 的性能。
  • 优化了 OTA，支持向设备发送额外的自定义元数据。
  • 支持网络访问防火墙服务 (Web Access Firewall Service, WAF)。
  • 在时间序列数据查询中新增了对数据类型属性选择的支持。
  • 支持根据用户数据自动填充用户位置（如果在用户节点关联 API 请求中未提供用户位置）。
  • 在节点组共享中提供额外的元数据。
  • 支持在用户节点关联时存储位置信息。
  • 支持基于 type、model 和 fw_version 查询管理员节点组。
  • 修复了 API 响应和 Swagger 文件描述不一致的问题。
  • 时间序列：修复了每周数据中最新数据时间戳不匹配的问题。
  • 时间序列：为时间序列提取服务新增了数据类型验证功能。
  • 对基于 model 或 type 的图片搜索新增了分页支持。
  • 在共享节点组信息查询 API 中新增了父节点组信息。
  • 支持运行用户批准的 OTA 任务。

1.1.7 (2021.11.2)​

  • 支持节点自动触发功能（参考 API：Node Automation Trigger API 文档）。
  • 支持捕获 API 错误日志。
  • 修复了 Webhooks 配置 API 的相关问题。
  • 修复了推送通知服务自定义模板的相关问题。
  • 支持次要用户删除共享节点组。
  • 支持 Device Defender 服务以防止 DDoS 攻击。
  • 优化了与状态服务、用户、用户节点关联和节点组共享相关的 API。
  • 支持获取与 OTA 镜像相关的 OTA 任务。
  • 支持互斥节点组。
  • 修复了与获取节点 API 相关的问题。

1.1.6 (2021.10.1)​

  • 优化了节点批量注册模块。
  • 修复了 OTA 任务 API 响应的相关问题。
  • 优化了用户 API 以获取自定义用户数据。

1.1.5 (2021.9.28)​

  • 增加了对时间序列数据的支持（参考 API：Time Series Data APIs 文档）。
  • 在节点批量注册服务中增加了对节点类型 (type) 与模型 (model) 的支持。
  • 将节点参数逻辑从 ThingShadow 转移至 DynamoDB，其行为逻辑不变。
  • 修复了 RainMaker 管理面板中多重要素验证的相关问题。
  • 支持通过节点（组）共享将用户添加为主要用户。

1.1.4 (2021.9.16)​

  • 支持创建和维护用户特定的自定义数据（参考 API：User Custom Data APIs 文档）。
  • 支持备份和恢复 Cognito 客户端配置。
  • 修复了节点组 API 的相关问题。

1.1.2 (2021.8.30)​

  • 修复了设备在恢复出厂设置后用户节点映射流程中的安全漏洞。需在固件中启用支持。
  • 推出了移动端推送通知。
  • 改进了节点参数运行 API 的执行时间。

注意： 在升级 SAR 仓库前，请对 Cognito 相关配置（回调 URL 和邮件消息模板）进行备份。Cognito 配置的详细步骤，请参阅在哪里可以找到 Alexa 和 GVA 的 Client ID 和回调 URL 和如何在 Cognito 中找到自定义消息模板。

1.1.1 (2021.8.3)​

  • 修改了忘记密码 API 的错误提示信息。
  • 完善了 OTA 服务，增加了 "finished" OTA 任务状态和 "rejected" 节点 OTA 状态。
  • 改进了删除用户 API。
  • 支持处理 RainMaker 用户许可证。

1.1.0 (2021.7.7)​

  • 支持基于 type、model 和 fw_version 创建节点群组。
  • 支持节点群组共享。
  • 支持存档 OTA 镜像。
  • 优化了设置节点参数 API 的执行时间。
  • 支持基于名称搜索 OTA 镜像文件和 OTA 任务。
  • 支持终端用户启动 OTA 任务。

1.0.18 (2021.6.4)​

  • 完善了节点搜索 API。
  • 支持终端用户删除账号信息。

1.0.17 (2021.6.2)​

完善了节点、节点群组及 OTA 相关的 API。

1.0.16 (2021.5.24)​

  • 改进了后端 API。
  • 增加了获取 Cognito 详细信息的 API。
  • 支持存档已取消的 OTA 任务。

1.0.15 (2021.5.19)​

  • 修改了后端 API 的响应代码和信息。
  • 支持卸载 SAR 仓库。
  • 优化了节点 API，可获取节点状态。

1.0.14 (2021.5.4)​

  • 完善了没有 force_push 选项的 OTA 配置。
  • 将刷新令牌 (refresh token) 的有效期从一个月延长至五年。
  • 增加了获取部署细节的 API。

1.0.13 (2021.4.14)​

  • 修改了注销 API。
  • 确定了节点断开时系统断开连接的原因。
  • 更新了与 OTA force_push 功能相关的 API。
  • 优化了 IoT 会话创建过程。
  • 完善了节点共享 API。

1.0.12 (2021.4.5)​

  • 增加了节点共享 API，支持接受或拒绝节点共享请求等功能。
  • 支持在 RainMaker 后端升级时自动升级 API Gateway。

1.0.11 (2021.3.19)​

  • 更新了后端 API 的状态代码和错误信息。
  • 优化了断开连接后的解决方案。

1.0.10 (2021.3.1)​

  • 修复了与控制台更新相关的问题。
  • 修复了后端 API 相关问题并更新了响应。
  • 移除了 AWS EC2 队列服务。

On this page