Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit fb1c9413 authored by Peng Xu's avatar Peng Xu
Browse files

Fix a few known issue in sensor framework 

  * Resolve issues pointed out by API Consul:
      . Privacy concern about sensor UUID
      . Callback name consistency,
      . A few document error and typo.
  * New API to tell app if the sensor system support dynamic sensor
    discovery.
  * Added API to make dynamically connected sensor directly
    identifiable.
  * Explicitly indicate sensor additional information support for a
    sensor

Bugs:
b/27715564
b/27911274

Change-Id: Ie93ab4c07fea82002f3f107b7c35827a088312be
parent 394d3dfb

api/current.txt

+9 −6
Original line number Diff line number Diff line
@@ -13504,6 +13504,7 @@ package android.hardware { 
  public final class Sensor {

    method public int getFifoMaxEventCount();

    method public int getFifoReservedEventCount();

    method public int getId();

    method public int getMaxDelay();

    method public float getMaximumRange();

    method public int getMinDelay();
@@ -13513,9 +13514,10 @@ package android.hardware { 
    method public float getResolution();

    method public java.lang.String getStringType();

    method public int getType();

    method public java.util.UUID getUuid();

    method public java.lang.String getVendor();

    method public int getVersion();

    method public boolean isAdditionalInfoSupported();

    method public boolean isDynamicSensor();

    method public boolean isWakeUpSensor();

    field public static final int REPORTING_MODE_CONTINUOUS = 0; // 0x0

    field public static final int REPORTING_MODE_ONE_SHOT = 2; // 0x2
@@ -13634,8 +13636,9 @@ package android.hardware { 
    method public static void getRotationMatrixFromVector(float[], float[]);

    method public java.util.List<android.hardware.Sensor> getSensorList(int);

    method public deprecated int getSensors();

    method public void registerDynamicSensorCallback(android.hardware.SensorManager.DynamicSensorConnectionCallback);

    method public void registerDynamicSensorCallback(android.hardware.SensorManager.DynamicSensorConnectionCallback, android.os.Handler);

    method public boolean isDynamicSensorDiscoverySupported();

    method public void registerDynamicSensorCallback(android.hardware.SensorManager.DynamicSensorCallback);

    method public void registerDynamicSensorCallback(android.hardware.SensorManager.DynamicSensorCallback, android.os.Handler);

    method public deprecated boolean registerListener(android.hardware.SensorListener, int);

    method public deprecated boolean registerListener(android.hardware.SensorListener, int, int);

    method public boolean registerListener(android.hardware.SensorEventListener, android.hardware.Sensor, int);
@@ -13644,7 +13647,7 @@ package android.hardware { 
    method public boolean registerListener(android.hardware.SensorEventListener, android.hardware.Sensor, int, int, android.os.Handler);

    method public static boolean remapCoordinateSystem(float[], int, int, float[]);

    method public boolean requestTriggerSensor(android.hardware.TriggerEventListener, android.hardware.Sensor);

    method public void unregisterDynamicSensorCallback(android.hardware.SensorManager.DynamicSensorConnectionCallback);

    method public void unregisterDynamicSensorCallback(android.hardware.SensorManager.DynamicSensorCallback);

    method public deprecated void unregisterListener(android.hardware.SensorListener);

    method public deprecated void unregisterListener(android.hardware.SensorListener, int);

    method public void unregisterListener(android.hardware.SensorEventListener, android.hardware.Sensor);
@@ -13709,8 +13712,8 @@ package android.hardware { 
    field public static final float STANDARD_GRAVITY = 9.80665f;

  }













  public static abstract class SensorManager.DynamicSensorConnectionCallback {













    ctor public SensorManager.DynamicSensorConnectionCallback();













  public static abstract class SensorManager.DynamicSensorCallback {













    ctor public SensorManager.DynamicSensorCallback();















    method public void onDynamicSensorConnected(android.hardware.Sensor);















    method public void onDynamicSensorDisconnected(android.hardware.Sensor);















  }

























api/system-current.txt



+9
−5




























Original line number
Diff line number
Diff line








@@ -13902,6 +13902,7 @@ package android.hardware {













  public final class Sensor {















    method public int getFifoMaxEventCount();















    method public int getFifoReservedEventCount();













    method public int getId();















    method public int getMaxDelay();















    method public float getMaximumRange();















    method public int getMinDelay();









@@ -13914,7 +13915,9 @@ package android.hardware {













    method public java.util.UUID getUuid();















    method public java.lang.String getVendor();















    method public int getVersion();













    method public boolean isAdditionalInfoSupported();















    method public boolean isDataInjectionSupported();













    method public boolean isDynamicSensor();















    method public boolean isWakeUpSensor();















    field public static final int REPORTING_MODE_CONTINUOUS = 0; // 0x0















    field public static final int REPORTING_MODE_ONE_SHOT = 2; // 0x2










@@ -14039,8 +14042,9 @@ package android.hardware {













    method public deprecated int getSensors();















    method public boolean initDataInjection(boolean);















    method public boolean injectSensorData(android.hardware.Sensor, float[], int, long);













    method public void registerDynamicSensorCallback(android.hardware.SensorManager.DynamicSensorConnectionCallback);













    method public void registerDynamicSensorCallback(android.hardware.SensorManager.DynamicSensorConnectionCallback, android.os.Handler);













    method public boolean isDynamicSensorDiscoverySupported();













    method public void registerDynamicSensorCallback(android.hardware.SensorManager.DynamicSensorCallback);













    method public void registerDynamicSensorCallback(android.hardware.SensorManager.DynamicSensorCallback, android.os.Handler);















    method public deprecated boolean registerListener(android.hardware.SensorListener, int);















    method public deprecated boolean registerListener(android.hardware.SensorListener, int, int);















    method public boolean registerListener(android.hardware.SensorEventListener, android.hardware.Sensor, int);









@@ -14049,7 +14053,7 @@ package android.hardware {













    method public boolean registerListener(android.hardware.SensorEventListener, android.hardware.Sensor, int, int, android.os.Handler);















    method public static boolean remapCoordinateSystem(float[], int, int, float[]);















    method public boolean requestTriggerSensor(android.hardware.TriggerEventListener, android.hardware.Sensor);













    method public void unregisterDynamicSensorCallback(android.hardware.SensorManager.DynamicSensorConnectionCallback);













    method public void unregisterDynamicSensorCallback(android.hardware.SensorManager.DynamicSensorCallback);















    method public deprecated void unregisterListener(android.hardware.SensorListener);















    method public deprecated void unregisterListener(android.hardware.SensorListener, int);















    method public void unregisterListener(android.hardware.SensorEventListener, android.hardware.Sensor);










@@ -14114,8 +14118,8 @@ package android.hardware {













    field public static final float STANDARD_GRAVITY = 9.80665f;















  }



























  public static abstract class SensorManager.DynamicSensorConnectionCallback {













    ctor public SensorManager.DynamicSensorConnectionCallback();













  public static abstract class SensorManager.DynamicSensorCallback {













    ctor public SensorManager.DynamicSensorCallback();















    method public void onDynamicSensorConnected(android.hardware.Sensor);















    method public void onDynamicSensorDisconnected(android.hardware.Sensor);















  }

























api/test-current.txt



+9
−6




























Original line number
Diff line number
Diff line








@@ -13514,6 +13514,7 @@ package android.hardware {













  public final class Sensor {















    method public int getFifoMaxEventCount();















    method public int getFifoReservedEventCount();













    method public int getId();















    method public int getMaxDelay();















    method public float getMaximumRange();















    method public int getMinDelay();









@@ -13523,9 +13524,10 @@ package android.hardware {













    method public float getResolution();















    method public java.lang.String getStringType();















    method public int getType();













    method public java.util.UUID getUuid();















    method public java.lang.String getVendor();















    method public int getVersion();













    method public boolean isAdditionalInfoSupported();













    method public boolean isDynamicSensor();















    method public boolean isWakeUpSensor();















    field public static final int REPORTING_MODE_CONTINUOUS = 0; // 0x0















    field public static final int REPORTING_MODE_ONE_SHOT = 2; // 0x2










@@ -13644,8 +13646,9 @@ package android.hardware {













    method public static void getRotationMatrixFromVector(float[], float[]);















    method public java.util.List<android.hardware.Sensor> getSensorList(int);















    method public deprecated int getSensors();













    method public void registerDynamicSensorCallback(android.hardware.SensorManager.DynamicSensorConnectionCallback);













    method public void registerDynamicSensorCallback(android.hardware.SensorManager.DynamicSensorConnectionCallback, android.os.Handler);













    method public boolean isDynamicSensorDiscoverySupported();













    method public void registerDynamicSensorCallback(android.hardware.SensorManager.DynamicSensorCallback);













    method public void registerDynamicSensorCallback(android.hardware.SensorManager.DynamicSensorCallback, android.os.Handler);















    method public deprecated boolean registerListener(android.hardware.SensorListener, int);















    method public deprecated boolean registerListener(android.hardware.SensorListener, int, int);















    method public boolean registerListener(android.hardware.SensorEventListener, android.hardware.Sensor, int);









@@ -13654,7 +13657,7 @@ package android.hardware {













    method public boolean registerListener(android.hardware.SensorEventListener, android.hardware.Sensor, int, int, android.os.Handler);















    method public static boolean remapCoordinateSystem(float[], int, int, float[]);















    method public boolean requestTriggerSensor(android.hardware.TriggerEventListener, android.hardware.Sensor);













    method public void unregisterDynamicSensorCallback(android.hardware.SensorManager.DynamicSensorConnectionCallback);













    method public void unregisterDynamicSensorCallback(android.hardware.SensorManager.DynamicSensorCallback);















    method public deprecated void unregisterListener(android.hardware.SensorListener);















    method public deprecated void unregisterListener(android.hardware.SensorListener, int);















    method public void unregisterListener(android.hardware.SensorEventListener, android.hardware.Sensor);










@@ -13719,8 +13722,8 @@ package android.hardware {













    field public static final float STANDARD_GRAVITY = 9.80665f;















  }



























  public static abstract class SensorManager.DynamicSensorConnectionCallback {













    ctor public SensorManager.DynamicSensorConnectionCallback();













  public static abstract class SensorManager.DynamicSensorCallback {













    ctor public SensorManager.DynamicSensorCallback();















    method public void onDynamicSensorConnected(android.hardware.Sensor);















    method public void onDynamicSensorDisconnected(android.hardware.Sensor);















  }

























core/java/android/hardware/Sensor.java



+71
−15




























Original line number
Diff line number
Diff line








@@ -431,7 +431,7 @@ public final class Sensor {













     * A constant string describing a wake up tilt detector sensor type.















     *















     * @hide













     * @see #TYPE_WAKE_UP_TILT_DETECTOR













     * @see #TYPE_TILT_DETECTOR















     */















    public static final String SENSOR_STRING_TYPE_TILT_DETECTOR =















            "android.sensor.tilt_detector";










@@ -706,6 +706,14 @@ public final class Sensor {













    private static final int DATA_INJECTION_MASK = 0x10;















    private static final int DATA_INJECTION_SHIFT = 4;





























    // MASK for dynamic sensor (sensor that added during runtime), bit 6.













    private static final int DYNAMIC_SENSOR_MASK = 0x20;













    private static final int DYNAMIC_SENSOR_SHIFT = 5;



























    // MASK for indication bit of sensor additional information support (bit 7).













    private static final int ADDITIONAL_INFO_MASK = 0x40;













    private static final int ADDITIONAL_INFO_SHIFT = 6;





























    // TODO(): The following arrays are fragile and error-prone. This needs to be refactored.































    // Note: This needs to be updated, whenever a new sensor is added.










@@ -887,12 +895,36 @@ public final class Sensor {













    }































    /**













     * @return The type of this sensor as a string.













     * @return The UUID of the sensor. If the sensor does not support UUID, the returned value will













     * be an all zero UUID; if the sensor's combination of type and name is guaranteed to be unique













     * in system, the return value will be an all "F" UUID.













     *













     * @hide















     */













    @SystemApi















    public UUID getUuid() {















        return mUuid;















    }





























    /**













     * @return The unique id of sensor. Return value of 0 means this sensor does not support UUID;













     * return value of -1 means this sensor can be uniquely identified in system by combination of













     * its type and name.













     */













    public int getId() {













        if (mUuid == ALL_0_UUID) {













            return 0;













        } else if (mUuid == ALL_F_UUID) {













            return -1;













        } else {













            int id = Math.abs(mUuid.hashCode()) + 1;













            if (id <= 0) { // catch corner case when hash is Integer.MIN_VALUE and Integer.MAX_VALUE













                id = 1;













            }













            return id;













        }













    }





























    /**















     * @hide















     * @return The permission required to access this sensor. If empty, no permission is required.










@@ -960,6 +992,26 @@ public final class Sensor {













        return (mFlags & SENSOR_FLAG_WAKE_UP_SENSOR) != 0;















    }





























    /**













     * Returns true if the sensor is a dynamic sensor.













     *













     * @return <code>true</code> if the sensor is a dynamic sensor (sensor added at runtime).













     * @see SensorManager.DynamicSensorCallback













     */













    public boolean isDynamicSensor() {













        return (mFlags & DYNAMIC_SENSOR_MASK) != 0;













    }



























    /**













     * Returns true if the sensor supports sensor additional information API













     *













     * @return <code>true</code> if the sensor supports sensor additional information API













     * @see SensorAdditionalInfo













     */













    public boolean isAdditionalInfoSupported() {













        return (mFlags & ADDITIONAL_INFO_MASK) != 0;













    }





























    /**















     * Returns true if the sensor supports data injection when the















     * HAL is set to data injection mode.









@@ -986,6 +1038,10 @@ public final class Sensor {













                + ", power=" + mPower + ", minDelay=" + mMinDelay + "}";















    }





























    //special UUID hash constant













    private final static UUID ALL_0_UUID = new UUID(0,0);













    private final static UUID ALL_F_UUID = new UUID(~0L, ~0L);





























    /**















     * Sets the Type associated with the sensor.















     * NOTE: to be used only by native bindings in SensorManager.

































core/java/android/hardware/SensorAdditionalInfo.java



+2
−2




























Original line number
Diff line number
Diff line








@@ -27,7 +27,7 @@ import java.lang.annotation.RetentionPolicy;













 * android.hardware.SensorEventCallback#onSensorAdditionalInfo onSensorAdditionalInfo}.















 *















 * @see SensorManager













 * @see SensorEventListener3













 * @see SensorEventCallback















 * @see Sensor















 *















 */










@@ -106,7 +106,7 @@ public class SensorAdditionalInfo {













     * such as accelerometer, gyro, etc.















     *















     * Payload:













     *     floatValues[0..11]: First 3 rows of a homogenous matrix in row major order that captures













     *     floatValues[0..11]: First 3 rows of a homogeneous matrix in row major order that captures















     *     any linear transformation, including rotation, scaling, shear, shift.















     */















    public static final int TYPE_VEC3_CALIBRATION = 0x10002;