This is the official iOS app for ESP RainMaker, an end-to-end solution offered by Espressif to enable remote control and monitoring for ESP32-S2 and ESP32 based products without any configuration required in the Cloud.
For more details :
Local Control feature is optional but enabled by default. It can be disabled from the Configuration.plist by setting Enable Local Control key from App Configuration to NO.
Schedules allow you to automate a device by setting it to trigger an action at the same time on a specified day or days of the week. List of operations that are supported for scheduling :
Schedule feature is optional but enabled by default. Schedule can be disabled from the Configuration.plist by setting Enable Schedule key from App Configuration to NO.
Scene is a group of parameters with specific values, for one or more devices (optionally) spanning across multiple nodes. As an example, an "Evening" scene may turn on all the lights and set them to a warm colour. A "Night" scene may turn off all the lights, turn on a bedside lamp set to minimal brightness and turn on the fan/ac. List of operations that are supported for scene :
Scene feature is optional but enabled by default. Scenes can be disabled from the Configuration.plist by setting Enable Scene key from App Configuration to NO.
Node Grouping allows you to create abstract or logical groups of devices like lights, switches, fans etc. List of operations that are supported in node grouping :
Node Grouping is optional but enabled by default. It can be disabled from the Configuration.plist by setting Enable Grouping key from App Configuration to NO.
Node Sharing allows a user to share nodes with other registered users and allow them to monitor and control these nodes. List of operations that are supported in node sharing :
For primary users:
Register requests to share nodes.
View pending requests.
Cancel a pending request, if required.
Remove node sharing.
For secondary users:
View pending requests.
Accept/decline pending requests.
Node Sharing is optional but enabled by default. It can be disabled from the Configuration.plist by setting Enable Sharing key from App Configuration to NO.
Device Automation is a set of actions that will be triggered based on the completion of certain events. For example, the user can set an event as the Temperature sensor equals 35 degrees celsius. Then based on this event user can trigger different actions like Switching on AC or Setting the AC temperature to 20 degrees celsius or a combination of both.
Users will be allowed to perform different automation operations in the app as mentioned below:
Device automation is optional but enabled by default. It can be disabled from the Configuration.plist by setting Enable Device Automation key from App Configuration to NO.
ESPRainMaker app supports remote notifiations in order to notify app in realtime for any updates. Types of notification enabled in the app :
Alert notification: User will be updated by sending alert notification in case of below events:
Actionable notification: In case a node sharing request is received, user will be be alerted with an actionable notification. This will enable the user to accept or decline the sharing request from the notification center.
Silent notifications: This notification is triggered at the time when any of the user device param changes. It will update the app with latest param value in case when app is in foreground.
This account linking flow enables users to link their Alexa user identity with their Rainmaker identity by starting from Rainmaker app. When they start the account linking flow from the app, users can:
Note : Time series feature requires support in firmware. It will be available only for the parameters that have "time_series" property.
System service allows a primary user of the node to perform node operations like:
Note : System service feature requires support in firmware. It will be available for nodes that has "esp.service.system" configured.
OTA update is optional and disabled by default. It can be enabled from the Configuration.plist by setting Enable OTA Update key from App Configuration to YES.
Configuration.plist by setting Enable Continuous Updates key from App Configuration to NO.Continuous Update Interval under App Configuration in Configuration.plist. This value is considered in milliseconds and acceptable value is in range 400 - 1000.Matter is a unifying standard that provides reliable, secure connectivity across smart home devices. It is being developed by Matter Working Group within the Connectivity Standards Alliance (CSA) as a new, royalty-free connectivity standard to increase compatibility among smart home products, with security as a fundamental design tenet. The project is built around a shared belief that smart home devices should be secure, reliable, and seamless to use. By building upon Internet Protocol (IP), the project aims to enable communication across smart home devices, mobile apps, and cloud services and to define a specific set of IP-based networking technologies for device certification.
Please refer to this file Matter.md for the following:
[Note: app supports Matter for iOS 16.4+]
To support Custom Matter Fabric on the app do the following:
Note: This app with ESPRainmakerMatter configuration cannot be run on iOS simulators.To build app for Rainmaker only devcies:
In order to build the Rainmaker only app for simulator user needs to do the following:
- On Xcode select ESPRainmaker project from navigator.
- Select General tab.
- Scroll down to Frameworks, Libraries and Embedded Content
- Delete Matter.farmework from the list.
- User will be able to run the app on simulator.
If user wants to rerun the app for Matter:
- On Xcode go to Scheme selection dropdown.
- Select ESPRainmakerMatter scheme.
- Go to General tab under main project.
- Go to Frameworks section.
- Select + button at the bottom.
- Go to ESPRainMaker/Matter/ESPMTRCommissioner/Framework and select Matter.framework and click Open.
- Under embed section select Embed and Sign from dropdown for the Matter framework.
- Run the app.iOS 13.0 or greater.
Xcode 13.0
Swift 5+
Run pod install from ESPRainMaker folder in the terminal.
After pod installation open ESPRainMaker.xcworkspace project.
Build and run the project.
Settings associated with provisioning a device can be modified in the Configuration.plist file under Provision Settings dictionary. Description of each key can be found below.
| Key | Type | Description |
|---|---|---|
| ESP Transport | String | Possible values: Both(Default) : Supports both BLE and SoftAP device provisioning. SoftAP : supports only SoftAP device provisioning. BLE : supports only BLE device provisioning. |
| BLE Device Prefix | String | Search for BLE devices with this prefix in name. |
| ESP Allow Prefix Search | Bool | Prefix search allows you to filter available BLE device list based on prefix value. |
| ESP Security Mode | String | Possible values: Secure(Default) : for secure/encrypted communication between device and app. Unsecure : for unsecure/unencrypted communication between device and app. |
Licensed under Apache License Version 2.0.