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

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

Implementation of sensor additioanl info report 

This implements a mechanism for sensor hardware/HAL to deliver additional information beside sensor
readings to application. It includes internal temperature reading, untracked delay of sample,
location and pose of sensor device placement in phone frame, etc. This is also a very expandable
frame to account for future need.

Change-Id: Ifd52ff315ef675086326f118eab773b0194bae23
Note: sensor additional information report used to be called sensor meta data.
parent 4f93c58b

api/current.txt

+23 −0
Original line number Diff line number Diff line
@@ -13436,6 +13436,21 @@ package android.hardware { 
    field public static final deprecated int TYPE_TEMPERATURE = 7; // 0x7

  }













  public class SensorAdditionalInfo {













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













    field public static final int TYPE_FRAME_END = 1; // 0x1













    field public static final int TYPE_INTERNAL_TEMPERATURE = 65537; // 0x10001













    field public static final int TYPE_SAMPLING = 65540; // 0x10004













    field public static final int TYPE_SENSOR_PLACEMENT = 65539; // 0x10003













    field public static final int TYPE_UNTRACKED_DELAY = 65536; // 0x10000













    field public static final int TYPE_VEC3_CALIBRATION = 65538; // 0x10002













    field public final float[] floatValues;













    field public final int[] intValues;













    field public final android.hardware.Sensor sensor;













    field public final int serial;













    field public final int type;













  }



























  public class SensorEvent {















    field public int accuracy;















    field public android.hardware.Sensor sensor;









@@ -13443,6 +13458,14 @@ package android.hardware {













    field public final float[] values;















  }



























  public abstract class SensorEventCallback implements android.hardware.SensorEventListener2 {













    ctor public SensorEventCallback();













    method public void onAccuracyChanged(android.hardware.Sensor, int);













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













    method public void onSensorAdditionalInfo(android.hardware.SensorAdditionalInfo);













    method public void onSensorChanged(android.hardware.SensorEvent);













  }



























  public abstract interface SensorEventListener {















    method public abstract void onAccuracyChanged(android.hardware.Sensor, int);















    method public abstract void onSensorChanged(android.hardware.SensorEvent);

























api/system-current.txt



+23
−0






























Original line number
Diff line number
Diff line








@@ -13841,6 +13841,21 @@ package android.hardware {













    field public static final int TYPE_WRIST_TILT_GESTURE = 26; // 0x1a















  }



























  public class SensorAdditionalInfo {













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













    field public static final int TYPE_FRAME_END = 1; // 0x1













    field public static final int TYPE_INTERNAL_TEMPERATURE = 65537; // 0x10001













    field public static final int TYPE_SAMPLING = 65540; // 0x10004













    field public static final int TYPE_SENSOR_PLACEMENT = 65539; // 0x10003













    field public static final int TYPE_UNTRACKED_DELAY = 65536; // 0x10000













    field public static final int TYPE_VEC3_CALIBRATION = 65538; // 0x10002













    field public final float[] floatValues;













    field public final int[] intValues;













    field public final android.hardware.Sensor sensor;













    field public final int serial;













    field public final int type;













  }



























  public class SensorEvent {















    field public int accuracy;















    field public android.hardware.Sensor sensor;









@@ -13848,6 +13863,14 @@ package android.hardware {













    field public final float[] values;















  }



























  public abstract class SensorEventCallback implements android.hardware.SensorEventListener2 {













    ctor public SensorEventCallback();













    method public void onAccuracyChanged(android.hardware.Sensor, int);













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













    method public void onSensorAdditionalInfo(android.hardware.SensorAdditionalInfo);













    method public void onSensorChanged(android.hardware.SensorEvent);













  }



























  public abstract interface SensorEventListener {















    method public abstract void onAccuracyChanged(android.hardware.Sensor, int);















    method public abstract void onSensorChanged(android.hardware.SensorEvent);

























api/test-current.txt



+23
−0






























Original line number
Diff line number
Diff line








@@ -13444,6 +13444,21 @@ package android.hardware {













    field public static final deprecated int TYPE_TEMPERATURE = 7; // 0x7















  }



























  public class SensorAdditionalInfo {













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













    field public static final int TYPE_FRAME_END = 1; // 0x1













    field public static final int TYPE_INTERNAL_TEMPERATURE = 65537; // 0x10001













    field public static final int TYPE_SAMPLING = 65540; // 0x10004













    field public static final int TYPE_SENSOR_PLACEMENT = 65539; // 0x10003













    field public static final int TYPE_UNTRACKED_DELAY = 65536; // 0x10000













    field public static final int TYPE_VEC3_CALIBRATION = 65538; // 0x10002













    field public final float[] floatValues;













    field public final int[] intValues;













    field public final android.hardware.Sensor sensor;













    field public final int serial;













    field public final int type;













  }



























  public class SensorEvent {















    field public int accuracy;















    field public android.hardware.Sensor sensor;









@@ -13451,6 +13466,14 @@ package android.hardware {













    field public final float[] values;















  }



























  public abstract class SensorEventCallback implements android.hardware.SensorEventListener2 {













    ctor public SensorEventCallback();













    method public void onAccuracyChanged(android.hardware.Sensor, int);













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













    method public void onSensorAdditionalInfo(android.hardware.SensorAdditionalInfo);













    method public void onSensorChanged(android.hardware.SensorEvent);













  }



























  public abstract interface SensorEventListener {















    method public abstract void onAccuracyChanged(android.hardware.Sensor, int);















    method public abstract void onSensorChanged(android.hardware.SensorEvent);

























core/java/android/hardware/SensorAdditionalInfo.java
0 → 100644



+142
−0






























Original line number
Diff line number
Diff line













/*













 * Copyright (C) 2016 The Android Open Source Project













 *













 * Licensed under the Apache License, Version 2.0 (the "License");













 * you may not use this file except in compliance with the License.













 * You may obtain a copy of the License at













 *













 *      http://www.apache.org/licenses/LICENSE-2.0













 *













 * Unless required by applicable law or agreed to in writing, software













 * distributed under the License is distributed on an "AS IS" BASIS,













 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.













 * See the License for the specific language governing permissions and













 * limitations under the License.













 */



























package android.hardware;



























import android.annotation.IntDef;



























import java.lang.annotation.Retention;













import java.lang.annotation.RetentionPolicy;



























/**













 * This class represents a {@link android.hardware.Sensor Sensor} additional information frame,













 * which is reported through listener callback {@link













 * android.hardware.SensorEventCallback#onSensorAdditionalInfo onSensorAdditionalInfo}.













 *













 * @see SensorManager













 * @see SensorEventListener3













 * @see Sensor













 *













 */



























public class SensorAdditionalInfo {



























    /**













     * The sensor that generated this event. See













     * {@link android.hardware.SensorManager SensorManager} for details.













     */













    public final Sensor sensor;



























    /**













     * Type of this additional info frame.













     */













    public final int type;



























    /**













     * Sequence number of frame for a certain type.













     */













    public final int serial;



























    /**













     * Additional info payload data represented in float values. Depending on the type of













     * information, this may be null.













     */













    public final float[] floatValues;



























    /**













     * Additional info payload data represented in int values. Depending on the type of information,













     * this may be null.













     */













    public final int[] intValues;



























    /**













     * Typical values of additional infomation type. The set of values is subject to extension in













     * newer versions and vendors have the freedom of define their own custom values.













     *













     * @hide













     */













    @IntDef({TYPE_FRAME_BEGIN, TYPE_FRAME_END, TYPE_UNTRACKED_DELAY, TYPE_INTERNAL_TEMPERATURE,













             TYPE_VEC3_CALIBRATION, TYPE_SENSOR_PLACEMENT, TYPE_SAMPLING})













    @Retention(RetentionPolicy.SOURCE)













    public @interface AdditionalInfoType {}



























    /**













     * Mark the beginning of a set of additional info frames.













     */













    public static final int TYPE_FRAME_BEGIN = 0;



























    /**













     * Mark the end of a set of additional info frames.













     */













    public static final int TYPE_FRAME_END = 1;



























    /**













     * Untracked delay. Delays that are introduced by data processing, such as filtering, which is













     * not taken into account by sensor timestamps.













     *













     * Payload:













     *     floatValues[0]: delay estimation in seconds













     *     floatValues[1]: delay estimation standard deviation













     */













    public static final int TYPE_UNTRACKED_DELAY = 0x10000;



























    /**













     * Internal temperature. Sensor hardware device internal temperature.













     *













     * Payload:













     *     floatValues[0]: internal temperature in Celsius.













     */













    public static final int TYPE_INTERNAL_TEMPERATURE = 0x10001;



























    /**













     * Vector calibration parameter. Calibration applied to a sensor with 3 elements vector output,













     * such as accelerometer, gyro, etc.













     *













     * Payload:













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













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













     */













    public static final int TYPE_VEC3_CALIBRATION = 0x10002;



























    /**













     * Sensor placement. Describes location and installation angle of the sensor device.













     *













     * Payload:













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













     *     the location and orientation of the sensor. Origin of reference will be the mobile device













     *     geometric sensor. Reference frame is defined as the same as Android sensor frame.













     */













    public static final int TYPE_SENSOR_PLACEMENT = 0x10003;



























    /**













     * Sampling parameter. Describes the raw sample period and estimated jitter of sample time in













     * terms of standard deviation.













     *













     * Payload:













     *     floatValues[0]: raw sample period in seconds.













     *     floatValues[1]: standard deviation of sampling period.













     */













    public static final int TYPE_SAMPLING = 0x10004;



























    SensorAdditionalInfo(













            Sensor aSensor, int aType, int aSerial, int [] aIntValues, float [] aFloatValues) {













        sensor = aSensor;













        type = aType;













        serial = aSerial;













        intValues = aIntValues;













        floatValues = aFloatValues;













    }













}
























core/java/android/hardware/SensorEventCallback.java
0 → 100644



+55
−0






























Original line number
Diff line number
Diff line













/*













 * Copyright (C) 2016 The Android Open Source Project













 *













 * Licensed under the Apache License, Version 2.0 (the "License");













 * you may not use this file except in compliance with the License.













 * You may obtain a copy of the License at













 *













 *      http://www.apache.org/licenses/LICENSE-2.0













 *













 * Unless required by applicable law or agreed to in writing, software













 * distributed under the License is distributed on an "AS IS" BASIS,













 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.













 * See the License for the specific language governing permissions and













 * limitations under the License.













 */



























package android.hardware;



























/**













 * Used for receiving sensor additional information frames.













 */













public abstract class SensorEventCallback implements SensorEventListener2 {



























    /**













     * Called when sensor values have changed.













     *













     * @see android.hardware.SensorEventListener#onSensorChanged(SensorEvent)













     */













    @Override













    public void onSensorChanged(SensorEvent event) {}



























    /**













     * Called when the accuracy of the registered sensor has changed.













     *













     * @see android.hardware.SensorEventListener#onAccuracyChanged(Sensor, int)













     */













    @Override













    public void onAccuracyChanged(Sensor sensor, int accuracy) {}



























    /**













     * Called after flush() is completed.













     *













     * @see android.hardware.SensorEventListener2#onFlushCompleted(Sensor)













     */













    @Override













    public void onFlushCompleted(Sensor sensor) {}



























    /**













     * Called when a sensor additional information frame is available.













     *













     * @param info A {@link android.hardware.SensorAdditionalInfo SensorAdditionalInfo} frame













     * reported from sensor hardware.













     */













    public void onSensorAdditionalInfo(SensorAdditionalInfo info) {}













}