Fix AccelerometerSensor component for Tablets

Fix the AcclerometerSensor component for tablets that use Landscape mode
by default. Add a “LegacyMode” designer property so people can revert
this behavior for apps where they have performed the needed compensation
in their own blocks (though we would prefer they just fix their blocks).

Change-Id: I29157612d54dd28ec0e85a822ef47f6ddd73b05c

appinventor/appengine/src/com/google/appinventor/client/OdeMessages.java

@@ -1075,6 +1075,10 @@ public interface OdeMessages extends Messages {
   @Description("Text for accelerometer sensitivity choice 'strong'")
   String strongAccelerometerSensitivity();
 
+  @DefaultMessage("LegacyMode")
+  @Description("")
+  String LegacyModeProperties();
+
   // Used in editor/youngandroid/properties/YoungAndroidSizingChoicePropertyEditor.java
 
   @DefaultMessage("Fixed")

appinventor/appengine/src/com/google/appinventor/client/youngandroid/YoungAndroidFormUpgrader.java

@@ -412,6 +412,11 @@ public final class YoungAndroidFormUpgrader {
       // No properties need to be modified to upgrade to version 3.
       srcCompVersion = 3;
     }
+    if (srcCompVersion < 4) {
+      // The LegacyMode property was added
+      // No properties need to be modified to upgrade to version 4.
+      srcCompVersion = 4;
+    }
     return srcCompVersion;
   }
 

appinventor/blocklyeditor/src/versioning.js

@@ -1091,7 +1091,10 @@ Blockly.Versioning.AllUpgradeMaps =
     2: "noUpgrade",
 
     // AI2: AccelerometerSensor.Sensitivty property was added.
-    3: "noUpgrade"
+    3: "noUpgrade",
+
+    // AI2: LegacyMode property was added.
+    4: "noUpgrade"
 
   }, // End Accelerometer upgraders
 

appinventor/components/src/com/google/appinventor/components/common/YaVersion.java

@@ -397,12 +397,14 @@ public class YaVersion {
   // Added HorizontalScrollArrangement and VerticalScrollArrangement
   // For YOUNG_ANDROID_VERSION 159:
   // - FORM_COMPONENT_VERSION was incremented to 20
-  // For YOUNG_ANDROID_VERSION_160:
+  // For YOUNG_ANDROID_VERSION 160:
   // - FORM_COMPONENT_VERSION was incremented to 21
-  // For YOUNG_ANDROID_VERSION_161:
+  // For YOUNG_ANDROID_VERSION 161:
   // - BLOCKS_LANGUAGE_VERSION was incremented to 21
+  // For YOUNG_ANDROID_VERSION 162:
+  // - ACCELEROMETERSENSOR_COMPONENT_VERSION was incremented to 4
 
-  public static final int YOUNG_ANDROID_VERSION = 161;
+  public static final int YOUNG_ANDROID_VERSION = 162;
 
   // ............................... Blocks Language Version Number ...............................
 
@@ -510,7 +512,9 @@ public class YaVersion {
   //   the minimum interval to elapse before calling a shaking event when necessary.
   //For ACCELEROMETERSENSOR_COMPONENT_VERSION 3:
   // - AccelerometerSensor.Sensitivty property was added.
-  public static final int ACCELEROMETERSENSOR_COMPONENT_VERSION = 3;
+  //For ACCELEROMETERSENSOR_COMPONENT_VERSION 4:
+  // - Added the LegacyMode property.
+  public static final int ACCELEROMETERSENSOR_COMPONENT_VERSION = 4;
 
   // For ACTIVITYSTARTER_COMPONENT_VERSION 2:
   // - The ActivityStarter.DataType, ActivityStarter.ResultType, and ActivityStarter.ResultUri

appinventor/components/src/com/google/appinventor/components/runtime/AccelerometerSensor.java

@@ -11,6 +11,7 @@ import com.google.appinventor.components.annotations.DesignerComponent;
 import com.google.appinventor.components.annotations.DesignerProperty;
 import com.google.appinventor.components.annotations.PropertyCategory;
 import com.google.appinventor.components.annotations.SimpleEvent;
+import com.google.appinventor.components.annotations.SimpleFunction;
 import com.google.appinventor.components.annotations.SimpleObject;
 import com.google.appinventor.components.annotations.SimpleProperty;
 import com.google.appinventor.components.common.ComponentCategory;
@@ -25,6 +26,11 @@ import android.hardware.Sensor;
 import android.hardware.SensorEvent;
 import android.hardware.SensorEventListener;
 import android.hardware.SensorManager;
+
+import android.os.Handler;
+
+import android.util.Log;
+
 import android.view.Surface;
 import android.view.WindowManager;
 
@@ -74,6 +80,10 @@ import java.util.Queue;
 public class AccelerometerSensor extends AndroidNonvisibleComponent
     implements OnStopListener, OnResumeListener, SensorComponent, SensorEventListener, Deleteable {
 
+  // Logging and Debugging
+  private final static String LOG_TAG = "AccelerometerSensor";
+  private final static boolean DEBUG = true;
+
   // Shake thresholds - derived by trial
   private static final double weakShakeThreshold = 5.0;
   private static final double moderateShakeThreshold = 13.0;
@@ -92,7 +102,7 @@ public class AccelerometerSensor extends AndroidNonvisibleComponent
 
   private int accuracy;
   private int sensitivity;
-  private int deviceDefaultOrientation;
+  private volatile int deviceDefaultOrientation;
 
   private final SensorManager sensorManager;
 
@@ -110,12 +120,11 @@ public class AccelerometerSensor extends AndroidNonvisibleComponent
 
   private Sensor accelerometerSensor;
 
-  // temporary flag. true == compensate for default landscape devices
-  // 10/16/2017: We set this to false in the branding for our Hong
-  // Kong servers because the tutorials we are using there already
-  // compensate and this change will break them. We will remove this
-  // "feature" after those tutorials are updated.
-  private static boolean handleDefaultRotation = true;
+  // Set to true to disable landscape mode tablet fix
+  private boolean legacyMode = false;
+
+  // Used to launch Runnables on the UI Thread after a delay
+  private final Handler androidUIHandler;
 
   /**
    * Creates a new AccelerometerSensor component.
@@ -132,11 +141,10 @@ public class AccelerometerSensor extends AndroidNonvisibleComponent
     windowManager = (WindowManager) container.$context().getSystemService(Context.WINDOW_SERVICE);
     sensorManager = (SensorManager) container.$context().getSystemService(Context.SENSOR_SERVICE);
     accelerometerSensor = sensorManager.getDefaultSensor(Sensor.TYPE_ACCELEROMETER);
+    androidUIHandler = new Handler();
     startListening();
     MinimumInterval(400);
     Sensitivity(Component.ACCELEROMETER_SENSITIVITY_MODERATE);
-    // save the device default orientation (portrait or landscape)
-    deviceDefaultOrientation = getDeviceDefaultOrientation();    
   }
 
 
@@ -235,12 +243,18 @@ public class AccelerometerSensor extends AndroidNonvisibleComponent
 public int getDeviceDefaultOrientation() {
     Configuration config = resources.getConfiguration();
     int rotation = windowManager.getDefaultDisplay().getRotation();
+    if (DEBUG) {
+      Log.d(LOG_TAG, "rotation = " + rotation);
+      Log.d(LOG_TAG, "config.orientation = " + config.orientation);
+    }
+    // return config.orientation;
+
     if ( ((rotation == Surface.ROTATION_0 || rotation == Surface.ROTATION_180) &&
             config.orientation == Configuration.ORIENTATION_LANDSCAPE)
-        || ((rotation == Surface.ROTATION_90 || rotation == Surface.ROTATION_270) &&    
+        || ((rotation == Surface.ROTATION_90 || rotation == Surface.ROTATION_270) &&
             config.orientation == Configuration.ORIENTATION_PORTRAIT)) {
       return Configuration.ORIENTATION_LANDSCAPE;
-    } else { 
+    } else {
       return Configuration.ORIENTATION_PORTRAIT;
     }
 }
@@ -281,6 +295,19 @@ public int getDeviceDefaultOrientation() {
 
   // Assumes that sensorManager has been initialized, which happens in constructor
   private void startListening() {
+    // save the device default orientation (portrait or landscape)
+    androidUIHandler.postDelayed(new Runnable() {
+        @Override
+        public void run() {
+          AccelerometerSensor.this.deviceDefaultOrientation = getDeviceDefaultOrientation();
+          if (DEBUG) {
+            Log.d(LOG_TAG, "deviceDefaultOrientation = " + AccelerometerSensor.this.deviceDefaultOrientation);
+            Log.d(LOG_TAG, "Configuration.ORIENTATION_LANDSCAPE = " + Configuration.ORIENTATION_LANDSCAPE);
+            Log.d(LOG_TAG, "Configuration.ORIENTATION_PORTRAIT = " + Configuration.ORIENTATION_PORTRAIT);
+          }
+        }
+      }, 32);                   // Wait 32ms for the UI to settle down
+
     sensorManager.registerListener(this, accelerometerSensor, SensorManager.SENSOR_DELAY_GAME);
   }
 
@@ -382,6 +409,30 @@ public int getDeviceDefaultOrientation() {
     }
   }
 
+  @DesignerProperty(editorType = PropertyTypeConstants.PROPERTY_TYPE_BOOLEAN,
+    defaultValue = "False")
+  @SimpleProperty(userVisible = false,
+    description="Prior to the release that added this property the AccelerometerSensor " +
+    "component passed through sensor values directly as received from the " +
+    "Android system. However these values do not compensate for tablets " +
+    "that default to Landscape mode, requiring the MIT App Inventor " +
+    "programmer to compensate. However compensating would result in " +
+    "incorrect results in Portrait mode devices such as phones. " +
+    "We now detect Landscape mode tablets and perform the compensation. " +
+    "However if your project is already compensating for the change, you " +
+    "will now get incorrect results. Although our preferred solution is for " +
+    "you to update your project, you can also just set this property to “true” " +
+    "and our compensation code will be deactivated. Note: We recommend that " +
+    "you update your project as we may remove this property in a future " +
+    "release.")
+  public void LegacyMode(boolean legacyMode) {
+    this.legacyMode = legacyMode;
+  }
+
+  public boolean LegacyMode() {
+    return legacyMode;
+  }
+
   // SensorListener implementation
   @Override
   public void onSensorChanged(SensorEvent sensorEvent) {
@@ -389,10 +440,10 @@ public int getDeviceDefaultOrientation() {
       final float[] values = sensorEvent.values;
       // make landscapePrimary devices report acceleration as if they were
       // portraitPrimary
-      if ((deviceDefaultOrientation == Configuration.ORIENTATION_LANDSCAPE)
-          && handleDefaultRotation) {
-        xAccel = -values[1];
-        yAccel = values[0];
+      if ((deviceDefaultOrientation == Configuration.ORIENTATION_LANDSCAPE) &&
+          !legacyMode) {
+        xAccel = values[1];
+        yAccel = -values[0];
       } else {
         xAccel = values[0];
         yAccel = values[1];

appinventor/docs/reference/components/sensors.html

@@ -475,6 +475,20 @@
   <dd></dd>
   <dt><code>Enabled</code></dt>
   <dd></dd>
+  <dt><code>LegacyMode</code> (designer only)</dt>
+  <dd>Prior to the release that added this property the AccelerometerSensor
+    component passed through sensor values directly as received from the
+    Android system. However these values do not compensate for tablets
+    that default to Landscape mode, requiring the MIT App Inventor
+    programmer to compensate. However compensating would result in
+    incorrect results in Portrait mode devices such as phones.
+    We now detect Landscape mode tablets and perform the compensation.
+    However if your project is already compensating for the change, you
+    will now get incorrect results. Although our preferred solution is for
+    you to update your project, you can also just set this property to “true”
+    and our compensation code will be deactivated. Note: We recommend that
+    you update your project as we may remove this property in a future
+    release.</dd>
   <dt><code>MinimumInterval</code></dt>
   <dd>The minimum interval, in milliseconds, between phone shakes</dd>
   <dt><code>Sensitivity</code></dt>