Merge branch 'feature/device_automation' into 'master'

Feature: Device Automation

See merge request app-frameworks/esp-rainmaker-android!51

Author: shahpiyushv

README.md

@@ -119,6 +119,22 @@ Sharing can be enabled/disabled by setting true/false value of `isNodeSharingSup
 Sharing feature is optional but enabled by default.
 Add `isNodeSharingSupported=false` in `local.properties` file to disable this feature.
 
+### Device Automation
+
+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:
+
+1. Adding new automation.
+2. Updating existing automation.
+3. Enabling/disabling automation triggers.
+4. Deleting automation.
+5. Receiving notifications related to triggered automation.
+
+Device automation can be enabled/disabled by setting true/false value of `isAutomationSupported` field in `local.properties`.
+Device automation is optional but enabled by default.
+Add `isAutomationSupported=false` in `local.properties` file to disable this feature.
+
 ### Time Series
 
 - Time series allows a user to see historical values of parameters plotted as a bar or line chart.

app/build.gradle

@@ -44,8 +44,8 @@ android {
         applicationId "com.espressif.rainmaker"
         minSdkVersion 23
         targetSdkVersion 31
-        versionCode 64
-        versionName "2.7.0 - ${getGitHash()}"
+        versionCode 70
+        versionName "2.8.0 - ${getGitHash()}"
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
 
         buildConfigField "String", "GitHash", "\"${getGitHash()}\""
@@ -89,6 +89,7 @@ android {
         buildConfigField "boolean", "isLocalControlSupported", localProperties.getProperty("isLocalControlSupported", "true")
         buildConfigField "boolean", "isNodeGroupingSupported", localProperties.getProperty("isNodeGroupingSupported", "true")
         buildConfigField "boolean", "isNodeSharingSupported", localProperties.getProperty("isNodeSharingSupported", "true")
+        buildConfigField "boolean", "isAutomationSupported", localProperties.getProperty("isAutomationSupported", "true")
 
         def clientId = localProperties.getProperty("clientId", defaultClientId)
         def authUrl = localProperties.getProperty("authUrl", defaultAuthUrl)

app/src/main/AndroidManifest.xml

@@ -131,6 +131,7 @@
             android:configChanges="keyboard|keyboardHidden|orientation|screenSize"
             android:label="@string/app_name"
             android:screenOrientation="portrait"
+            android:windowSoftInputMode="adjustPan"
             android:theme="@style/AppTheme.NoActionBar" />
         <activity
             android:name="com.espressif.ui.activities.EspDeviceActivity"
@@ -254,6 +255,21 @@
             android:screenOrientation="portrait"
             android:theme="@style/AppTheme.NoActionBar"
             android:windowSoftInputMode="adjustPan" />
+        <activity
+            android:name="com.espressif.ui.activities.EventDeviceActivity"
+            android:label="@string/title_activity_automations"
+            android:screenOrientation="portrait"
+            android:theme="@style/AppTheme.NoActionBar" />
+        <activity
+            android:name="com.espressif.ui.activities.AutomationActionsActivity"
+            android:label="@string/title_activity_automations"
+            android:screenOrientation="portrait"
+            android:theme="@style/AppTheme.NoActionBar" />
+        <activity
+            android:name="com.espressif.ui.activities.AutomationDetailActivity"
+            android:label="@string/title_activity_automations"
+            android:screenOrientation="portrait"
+            android:theme="@style/AppTheme.NoActionBar" />
 
         <receiver android:name="com.espressif.NodeSharingActionReceiver" />
 

app/src/main/java/com/espressif/AppConstants.java

@@ -90,6 +90,8 @@ public enum UpdateEventType {
             + AppConstants.CURRENT_VERSION + "/user/nodes/sharing";
     public static final String URL_USER_NODES_TS = BuildConfig.BASE_URL + AppConstants.PATH_SEPARATOR
             + AppConstants.CURRENT_VERSION + "/user/nodes/tsdata";
+    public static final String URL_USER_NODE_AUTOMATION = BuildConfig.BASE_URL + AppConstants.PATH_SEPARATOR
+            + AppConstants.CURRENT_VERSION + "/user/node_automation";
 
     // UI Types of Device
     public static final String UI_TYPE_TOGGLE = "esp.ui.toggle";
@@ -200,6 +202,8 @@ public enum UpdateEventType {
     public static final String KEY_SCENE = "Scene";
     public static final String KEY_ACTION = "action";
     public static final String KEY_ACTIONS = "actions";
+    public static final String KEY_EVENTS = "events";
+    public static final String KEY_CHECK = "check";
     public static final String KEY_DAYS = "d";
     public static final String KEY_MINUTES = "m";
     public static final String KEY_ENABLED = "enabled";
@@ -270,6 +274,11 @@ public enum UpdateEventType {
     public static final String KEY_SKILL = "skill";
     public static final String KEY_STATUS_LINKED = "LINKED";
     public static final String KEY_RESPONSE = "response";
+    public static final String KEY_AUTOMATION_ID = "automation_id";
+    public static final String KEY_AUTOMATION_NAME = "automation_name";
+    public static final String KEY_AUTOMATION_TRIGGER_ACTIONS = "automation_trigger_actions";
+    public static final String KEY_AUTOMATION = "automation";
+    public static final String KEY_LOAD_AUTOMATION_PAGE = "load_automation";
 
     public static final String KEY_OPERATION = "operation";
     public static final String KEY_OPERATION_ADD = "add";
@@ -303,6 +312,7 @@ public enum UpdateEventType {
     public static final String EVENT_NODE_SHARING_ADD = "rmaker.event.user_node_sharing_add";
     public static final String EVENT_NODE_PARAM_MODIFIED = "rmaker.event.node_params_changed";
     public static final String EVENT_ALERT = "rmaker.event.alert";
+    public static final String EVENT_NODE_AUTOMATION_TRIGGER = "rmaker.event.node_automation_trigger";
 
     // Notification channel IDs
     public static final String CHANNEL_NODE_ONLINE_ID = "notify_node_online_id";
@@ -311,6 +321,7 @@ public enum UpdateEventType {
     public static final String CHANNEL_NODE_REMOVED = "notify_node_removed_id";
     public static final String CHANNEL_ALERT = "notify_alert_id";
     public static final String CHANNEL_NODE_SHARING = "notify_node_sharing_id";
+    public static final String CHANNEL_NODE_AUTOMATION_TRIGGER = "notify_node_automation_trigger";
 
     public static final String ACTION_ACCEPT = "com.espressif.rainmaker.ACTION_ACCEPT";
     public static final String ACTION_DECLINE = "com.espressif.rainmaker.ACTION_DECLINE";

app/src/main/java/com/espressif/EspApplication.java

@@ -30,13 +30,15 @@
 import com.espressif.cloudapi.ApiManager;
 import com.espressif.cloudapi.ApiResponseListener;
 import com.espressif.db.EspDatabase;
-import com.espressif.local_control.LocalControlApiManager;
 import com.espressif.local_control.EspLocalDevice;
+import com.espressif.local_control.LocalControlApiManager;
 import com.espressif.local_control.mDNSManager;
 import com.espressif.provisioning.ESPProvisionManager;
 import com.espressif.rainmaker.BuildConfig;
 import com.espressif.rainmaker.R;
 import com.espressif.ui.activities.ConsentActivity;
+import com.espressif.ui.models.Automation;
+import com.espressif.ui.models.Device;
 import com.espressif.ui.models.EspNode;
 import com.espressif.ui.models.Group;
 import com.espressif.ui.models.Param;
@@ -56,6 +58,8 @@
 
 import java.util.ArrayList;
 import java.util.HashMap;
+import java.util.Iterator;
+import java.util.Map;
 
 public class EspApplication extends Application {
 
@@ -68,6 +72,7 @@ public class EspApplication extends Application {
     public HashMap<String, Scene> sceneMap;
     public HashMap<String, EspLocalDevice> localDeviceMap;
     public HashMap<String, Group> groupMap;
+    public HashMap<String, Automation> automations;
 
     private SharedPreferences appPreferences;
     private ApiManager apiManager;
@@ -92,6 +97,8 @@ public void onCreate() {
         sceneMap = new HashMap<>();
         localDeviceMap = new HashMap<>();
         groupMap = new HashMap<>();
+        automations = new HashMap<>();
+
         appPreferences = getSharedPreferences(AppConstants.ESP_PREFERENCES, Context.MODE_PRIVATE);
         apiManager = ApiManager.getInstance(this);
         ESPProvisionManager.getInstance(this);
@@ -327,6 +334,7 @@ private void clearData() {
         sceneMap.clear();
         localDeviceMap.clear();
         groupMap.clear();
+        automations.clear();
     }
 
     private void startLocalDeviceDiscovery() {
@@ -343,6 +351,27 @@ public void stopLocalDeviceDiscovery() {
         }
     }
 
+    /**
+     * This method is used to get copy of all devices.
+     *
+     * @return Copy of all devices array for the user.
+     */
+    public ArrayList<Device> getAllDevices() {
+        ArrayList<Device> devices = new ArrayList<>();
+        for (Map.Entry<String, EspNode> entry : nodeMap.entrySet()) {
+
+            EspNode node = entry.getValue();
+            if (node != null) {
+                ArrayList<Device> espDevices = node.getDevices();
+                Iterator<Device> iterator = espDevices.iterator();
+                while (iterator.hasNext()) {
+                    devices.add(new Device(iterator.next()));
+                }
+            }
+        }
+        return devices;
+    }
+
     mDNSManager.mDNSEvenListener listener = new mDNSManager.mDNSEvenListener() {
 
         @Override
@@ -506,13 +535,17 @@ private void setupNotificationChannels() {
             NotificationChannel alertChannel = new NotificationChannel(AppConstants.CHANNEL_ALERT,
                     getString(R.string.channel_node_alert), NotificationManager.IMPORTANCE_HIGH);
 
+            NotificationChannel automationChannel = new NotificationChannel(AppConstants.CHANNEL_NODE_AUTOMATION_TRIGGER,
+                    getString(R.string.channel_node_automation_trigger), NotificationManager.IMPORTANCE_HIGH);
+
             NotificationManager notificationManager = getSystemService(NotificationManager.class);
             notificationManager.createNotificationChannel(nodeConnectedChannel);
             notificationManager.createNotificationChannel(nodeDisconnectedChannel);
             notificationManager.createNotificationChannel(nodeAddedChannel);
             notificationManager.createNotificationChannel(nodeRemovedChannel);
             notificationManager.createNotificationChannel(nodeSharingChannel);
             notificationManager.createNotificationChannel(alertChannel);
+            notificationManager.createNotificationChannel(automationChannel);
         }
     }
 

app/src/main/java/com/espressif/JsonDataParser.java

@@ -72,15 +72,17 @@ public static void setDeviceParamValue(JSONObject deviceJson, Device device, Par
                 labelValue = deviceJson.optString(paramName);
                 param.setLabelValue(labelValue);
             }
-        } else if (AppConstants.UI_TYPE_TOGGLE.equalsIgnoreCase(param.getUiType())) {
+        } else if (AppConstants.UI_TYPE_TOGGLE.equalsIgnoreCase(param.getUiType())
+                || AppConstants.UI_TYPE_TRIGGER.equalsIgnoreCase(param.getUiType())) {
 
             boolean value = deviceJson.optBoolean(paramName);
             param.setSwitchStatus(value);
 
-        } else if (AppConstants.UI_TYPE_TRIGGER.equalsIgnoreCase(param.getUiType())) {
-
-            boolean value = deviceJson.optBoolean(paramName);
-            param.setSwitchStatus(value);
+            if (value) {
+                param.setLabelValue("true");
+            } else {
+                param.setLabelValue("false");
+            }
 
         } else if (AppConstants.UI_TYPE_DROP_DOWN.equalsIgnoreCase(param.getUiType())) {
 
@@ -102,6 +104,7 @@ public static void setDeviceParamValue(JSONObject deviceJson, Device device, Par
             if (dataType.equalsIgnoreCase("bool") || dataType.equalsIgnoreCase("boolean")) {
 
                 boolean value = deviceJson.optBoolean(paramName);
+                param.setSwitchStatus(value);
                 if (value) {
                     param.setLabelValue("true");
                 } else {