Skip to main content

2025 Backend Release

3.1.0-alpha.3 (22-Mar-2205)​

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.

Please upgrade the Node Registration module to v24 after upgrading the backend.

Important, before upgrade

We have observed that some of the Cognito settings are getting reset to default after the RainMaker upgrade. Please make sure to take the backup of Cognito settings before the upgrade. Steps are documented here.

Important, after upgrade

  1. Please reset the default email sender to AWS SES instead of Cognito. Steps are documented here.

  2. Please set the value of Cognito-assisted verification and confirmation attribute to Send SMS message if phone number is available, otherwise send email message. Steps are documented here

New Features:

  • OTA serialisation: Serialise OTA delivery for Thread nodes in same network to avoid failures due to network bandwidth limitations.
  • Added support to customize mobile push notification template for node alerts.

Bug fixes:

  • Fixed OTA status error encountered when lower priority OTA job is forced push but there is already a higher priority available for the node.

3.0.0 (04-Mar-2025)​

DOWNTIME

Due to some optimizations, please be aware that there will be downtime (for Core and Base stacks) if you are upgrading to this version. It is advised to upgrade to this version during off-peak hours. Here, downtime means the following resources will be impacted:

  • Devices will be disconnected from Cloud for approximately 3-4 hours depending on the number of registered nodes. However, they will immediately reconnect once the upgrade is complete.
  • Node operations from phone-apps will not function during the entire downtime. Other APIs might fail intermittently.
  • The downtime is applicable during the upgrades of only these stacks: ESP-Rainmaker-Base & ESP-Rainmaker-Core.

If custom AWS-IoT policies are attached, they will continue to function.

Please contact your account manager or Espressif support at esp-rainmaker-support@espressif.com for assistance if you have any questions regarding the upgrade.

note

Once you have completed the RainMaker upgrade to this version Follow Step 3 from Important, after upgrade section below for verification.
If your upgrade fails for whatsoever reason then follow Step 5 to Revert to older IoT policy so that there will not be any downtime.

Please upgrade the Node Registration module to v24 after upgrading the backend.

Important, before upgrade

If you want to notify end-users about the downtime, please follow the steps here.
If you have device defender enabled, you can get flooded with violation emails as the devices in field will keep trying to connect during the downtime. To check if device defender is enabled and change rules to avoid this, check out the steps here.

Important, before upgrade

We have observed that some of the Cognito settings are getting reset to default after the RainMaker upgrade. Please make sure to take the backup of Cognito settings before the upgrade. Steps are documented here.

Important, after upgrade

  1. Please reset the default email sender to AWS SES instead of Cognito. Steps are documented here.

  2. Please set the value of Cognito-assisted verification and confirmation attribute to Send SMS message if phone number is available, otherwise send email message. Steps are documented here

  3. Check if upgrade is complete and there is No Downtime

  • Optimisation

    • Cost Optimisation: Node config and param updates are optimised to reduce the DynamoDB costs approximately by 40%.

  • New features

    • OTA: JSON payload sent to node on /otaurl will include an additional key file_md5, which is MD5 checksum of the OTA image.
important

Deprecations in the upcoming releases for cost and performance optimisation.

  1. For all paginated admin APIs, the total field from the API response will be omitted. Please contact your account manager or Espressif support at esp-rainmaker-support@espressif.com for assistance if you have a custom dashboard that consumes Admin APIs.
  2. Node count summary (Active, Inactive and Not activated) will be emailed to the superadmin (Swagger).

2.8.1 (31-Jan-2025)​

Please upgrade the Node Registration module to v23 after upgrading the backend.

Important, before upgrade

We have observed that some of the Cognito settings are getting reset to default after the RainMaker upgrade. Please make sure to take the backup of Cognito settings before the upgrade. Steps are documented here.

Important, after upgrade

  1. Please reset the default email sender to AWS SES instead of Cognito. Steps are documented here.

  2. Please set the value of Cognito-assisted verification and confirmation attribute to Send SMS message if phone number is available, otherwise send email message. Steps are documented here

  • New features

    • OTA: Firmware Image files are no more restricted to .bin files. You can use "raw" as image type to upload any file type and use in OTA Job. Refer OTA Image API to upload any type of file.

  • Bug fixes

    • OTA job: OTA job counts were not getting updated when a new node was added to the dynamic group which was linked to an OTA Job. This also fixes some nodes that may not get OTA due to incorrect counts.
    • OAuth only RainMaker: Add Identity provider API was giving an error.

Deprecations in the upcoming releases for cost and performance optimisation:

  • For all paginated admin APIs, the total field will be omitted.
  • Node count summary (Active, Inactive and Not activated) will be emailed to the superadmin (Swagger).

2.8.0 (3-Jan-2025)​

Please upgrade the Node Registration module to v23 after upgrading the backend.

Important, before upgrade

We have observed that some of the Cognito settings are getting reset to default after the RainMaker upgrade. Please make sure to take the backup of Cognito settings before the upgrade. Steps are documented here.

Important, after upgrade
  1. Please reset the default email sender to AWS SES instead of Cognito. Steps are documented here.
  2. Please set the value of Cognito-assisted verification and confirmation attribute to Send SMS message if phone number is available, otherwise send email message. Steps are documented here

  • New features

    • Admin user: Admins can now filter users using case-insensitive email prefix. Refer Admin User Management APIs for more details.
    • Tags:
      • Admins can now filter on multiple tags using and/or operators. Refer Tag Service APIs for more details.
      • Admins can now read and delete Tags added by end users using Tag Service APIs. Alternatively, this can be achieved using GET Admin Node tags and Delete Admin Node tags APIs.
      • End users can now view the tags added during user node association using GET User Nodes API.
      • Tag values with # character are now supported. Refer Tag Service API for more details.
    • User files: Users now have the option to upload files in either private or public mode. Refer User File APIs for more details. This can be used for public profile picture.
    • Deployment: Sender email used for sending user notifications can be changed. Refer Sender Email Update API for more details.
    • OTA Job: The force push and user approval flags will now be returned in Get API. Refer OTA Job API for more details.

  • Bug fixes

    • OTA job: When more than 100 nodes were added explicitly, the Create Ota Job API was giving server error. Now a validation error will be returned. Refer OTA Create API for more details.
    • Third-party sign-in: Sign-ins were not functioning following RainMaker's upgrade. However, this was sporadic.
    • Node Group: The node count was incorrect in Get Node group API when a node was part of a shared group and later remapped to other user.
    • Admin CLI: Common/Per node tags added for nodes while device cert registration were getting removed after user node mapping. To re-attach the tags, refer new --update option supported in 2.7.1 release
    • OAuth only RainMaker:
      • oidc_url to oidc_issuer were getting used interchangeably causing confusion, Renamed oidc_url to oidc_issuer in request and response for clarity. Refer Identity Provider API for more details.
      • Identity provider with invalid name was allowed to be created. Now, a validation error will be returned. Refer Identity Provider API for more details.

  • Other changes

    • Node registration: Modifications have been made to ensure that only one node registration job is ongoing, all other jobs will be queued.
    • OAuth only RainMaker: Cognito Identity pool backup and restore will now be automatic

  • Known issues

    • OTA job summary count could be incorrect in certains scenarios which may also result in some nodes not getting OTA.

Deprecations in the upcoming releases for cost and performance optimisation:

  • For all paginated admin APIs, the total field will be omitted.
  • Node count summary (Active, Inactive and Not activated) will be emailed to the superadmin (Swagger).

On this page