Add new sensor types. (9a8df4dc) · Commits · e / os / android_frameworks_base

api/current.txt

+17 −0

core/java/android/hardware/Sensor.java

+80 −2

Original line number	Original line	Diff line number	Diff line
	@@ -114,11 +114,90 @@ public final class Sensor {
	/** A constant describing an ambient temperature sensor type */		/** A constant describing an ambient temperature sensor type */
	public static final int TYPE_AMBIENT_TEMPERATURE = 13;		public static final int TYPE_AMBIENT_TEMPERATURE = 13;

			/**
			* A constant describing a magnetic field uncalibrated sensor type. See
			* {@link android.hardware.SensorEvent#values SensorEvent.values} for more
			* details.
			* <p>
			* No periodic calibration is performed (ie: there are no discontinuities
			* in the data stream while using this sensor). Assumptions that the
			* magnetic field is due to the Earth's poles is avoided. Factory calibration
			* and temperature compensation is still performed.
			* </p>
			*/
			public static final int TYPE_MAGNETIC_FIELD_UNCALIBRATED = 14;

			/**
			* Identical to {@link #TYPE_ROTATION_VECTOR} except that it doesn't
			* use the geomagnetic field. Therefore the Y axis doesn't
			* point north, but instead to some other reference, that reference is
			* allowed to drift by the same order of magnitude as the gyroscope
			* drift around the Z axis.
			* <p>
			* In the ideal case, a phone rotated and returning to the same real-world
			* orientation should report the same game rotation vector
			* (without using the earth's geomagnetic field). However, the orientation
			* may drift somewhat over time.
			* </p>
			*/

			public static final int TYPE_GAME_ROTATION_VECTOR = 15;

			/**
			* A constant describing a gyroscope uncalibrated sensor type. See
			* {@link android.hardware.SensorEvent#values SensorEvent.values} for more
			* details.
			* <p>
			* No gyro-drift compensation is performed.
			* Factory calibration and temperature compensation is still applied
			* to the rate of rotation (angular speeds).
			* </p>
			*/
			public static final int TYPE_GYROSCOPE_UNCALIBRATED = 16;

			/**
			* A constant describing the significant motion trigger sensor.
			* See {@link android.hardware.SensorEvent#values} for more details.
			* <p>
			* It triggers when an event occurs and then automatically disables
			* itself. The sensor continues to operate while the device is asleep
			* and will automatically wake the device to notify when significant
			* motion is detected. The application does not need to hold any wake
			* locks for this sensor to trigger.
			* </p>
			*/
			public static final int TYPE_SIGNIFICANT_MOTION = 17;

	/**		/**
	* A constant describing all sensor types.		* A constant describing all sensor types.
	*/		*/
	public static final int TYPE_ALL = -1;		public static final int TYPE_ALL = -1;

			/* Reporting mode constants for sensors. Each sensor will have exactly one
			reporting mode associated with it. */
			// Events are reported at a constant rate.
			static int REPORTING_MODE_CONTINUOUS = 1;

			// Events are reported only when the value changes.
			static int REPORTING_MODE_ON_CHANGE = 2;

			// Upon detection of an event, the sensor deactivates itself and then sends a single event.
			static int REPORTING_MODE_ONE_SHOT = 3;

			// Note: This needs to be updated, whenever a new sensor is added.
			private static int[] sSensorReportingModes = {
			REPORTING_MODE_CONTINUOUS, REPORTING_MODE_CONTINUOUS, REPORTING_MODE_CONTINUOUS,
			REPORTING_MODE_CONTINUOUS, REPORTING_MODE_ON_CHANGE, REPORTING_MODE_CONTINUOUS,
			REPORTING_MODE_ON_CHANGE, REPORTING_MODE_ON_CHANGE, REPORTING_MODE_CONTINUOUS,
			REPORTING_MODE_CONTINUOUS, REPORTING_MODE_CONTINUOUS, REPORTING_MODE_ON_CHANGE,
			REPORTING_MODE_ON_CHANGE, REPORTING_MODE_CONTINUOUS, REPORTING_MODE_CONTINUOUS,
			REPORTING_MODE_CONTINUOUS, REPORTING_MODE_ONE_SHOT };

			static int getReportingMode(Sensor sensor) {
			// mType starts from offset 1.
			return sSensorReportingModes[sensor.mType - 1];
			}

	/* Some of these fields are set only by the native bindings in		/* Some of these fields are set only by the native bindings in
	* SensorManager.		* SensorManager.
	*/		*/
	@@ -132,7 +211,6 @@ public final class Sensor {
	private float mPower;		private float mPower;
	private int mMinDelay;		private int mMinDelay;


	Sensor() {		Sensor() {
	}		}

core/java/android/hardware/SensorEvent.java

+61 −61

Original line number	Original line	Diff line number	Diff line
	@@ -17,11 +17,9 @@
	package android.hardware;		package android.hardware;

	/**		/**
	* <p>
	* This class represents a {@link android.hardware.Sensor Sensor} event and		* This class represents a {@link android.hardware.Sensor Sensor} event and
	* holds informations such as the sensor's type, the time-stamp, accuracy and of		* holds informations such as the sensor's type, the time-stamp, accuracy and of
	* course the sensor's {@link SensorEvent#values data}.		* course the sensor's {@link SensorEvent#values data}.
	* </p>
	*		*
	* <p>		* <p>
	* <u>Definition of the coordinate system used by the SensorEvent API.</u>		* <u>Definition of the coordinate system used by the SensorEvent API.</u>
	@@ -67,15 +65,9 @@ public class SensorEvent {
	* Sensor.TYPE_ACCELEROMETER}:</h4> All values are in SI units (m/s^2)		* Sensor.TYPE_ACCELEROMETER}:</h4> All values are in SI units (m/s^2)
	*		*
	* <ul>		* <ul>
	* <p>		* <li> values[0]: Acceleration minus Gx on the x-axis </li>
	* values[0]: Acceleration minus Gx on the x-axis		* <li> values[1]: Acceleration minus Gy on the y-axis </li>
	* </p>		* <li> values[2]: Acceleration minus Gz on the z-axis </li>
	* <p>
	* values[1]: Acceleration minus Gy on the y-axis
	* </p>
	* <p>
	* values[2]: Acceleration minus Gz on the z-axis
	* </p>
	* </ul>		* </ul>
	*		*
	* <p>		* <p>
	@@ -165,15 +157,9 @@ public class SensorEvent {
	* definition of positive rotation and does not agree with the definition of		* definition of positive rotation and does not agree with the definition of
	* roll given earlier.		* roll given earlier.
	* <ul>		* <ul>
	* <p>		* <li> values[0]: Angular speed around the x-axis </li>
	* values[0]: Angular speed around the x-axis		* <li> values[1]: Angular speed around the y-axis </li>
	* </p>		* <li> values[2]: Angular speed around the z-axis </li>
	* <p>
	* values[1]: Angular speed around the y-axis
	* </p>
	* <p>
	* values[2]: Angular speed around the z-axis
	* </p>
	* </ul>		* </ul>
	* <p>		* <p>
	* Typically the output of the gyroscope is integrated over time to		* Typically the output of the gyroscope is integrated over time to
	@@ -233,22 +219,19 @@ public class SensorEvent {
	* </p>		* </p>
	* <h4>{@link android.hardware.Sensor#TYPE_LIGHT Sensor.TYPE_LIGHT}:</h4>		* <h4>{@link android.hardware.Sensor#TYPE_LIGHT Sensor.TYPE_LIGHT}:</h4>
	* <ul>		* <ul>
	* <p>		* <li>values[0]: Ambient light level in SI lux units </li>
	* values[0]: Ambient light level in SI lux units
	* </ul>		* </ul>
	*		*
	* <h4>{@link android.hardware.Sensor#TYPE_PRESSURE Sensor.TYPE_PRESSURE}:</h4>		* <h4>{@link android.hardware.Sensor#TYPE_PRESSURE Sensor.TYPE_PRESSURE}:</h4>
	* <ul>		* <ul>
	* <p>		* <li>values[0]: Atmospheric pressure in hPa (millibar) </li>
	* values[0]: Atmospheric pressure in hPa (millibar)
	* </ul>		* </ul>
	*		*
	* <h4>{@link android.hardware.Sensor#TYPE_PROXIMITY Sensor.TYPE_PROXIMITY}:		* <h4>{@link android.hardware.Sensor#TYPE_PROXIMITY Sensor.TYPE_PROXIMITY}:
	* </h4>		* </h4>
	*		*
	* <ul>		* <ul>
	* <p>		* <li>values[0]: Proximity sensor distance measured in centimeters </li>
	* values[0]: Proximity sensor distance measured in centimeters
	* </ul>		* </ul>
	*		*
	* <p>		* <p>
	@@ -304,39 +287,23 @@ public class SensorEvent {
	* </p>		* </p>
	*		*
	* <ul>		* <ul>
	* <p>		* <li> values[0]: x*sin(&#952/2) </li>
	* values[0]: x*sin(&#952/2)		* <li> values[1]: y*sin(&#952/2) </li>
	* </p>		* <li> values[2]: z*sin(&#952/2) </li>
	* <p>		* <li> values[3]: cos(&#952/2) <i>(optional: only if value.length = 4)</i> </li>
	* values[1]: y*sin(&#952/2)
	* </p>
	* <p>
	* values[2]: z*sin(&#952/2)
	* </p>
	* <p>
	* values[3]: cos(&#952/2) <i>(optional: only if value.length = 4)</i>
	* </p>
	* </ul>		* </ul>
	*		*
	* <h4>{@link android.hardware.Sensor#TYPE_ORIENTATION		* <h4>{@link android.hardware.Sensor#TYPE_ORIENTATION
	* Sensor.TYPE_ORIENTATION}:</h4> All values are angles in degrees.		* Sensor.TYPE_ORIENTATION}:</h4> All values are angles in degrees.
	*		*
	* <ul>		* <ul>
	* <p>		* <li> values[0]: Azimuth, angle between the magnetic north direction and the
	* values[0]: Azimuth, angle between the magnetic north direction and the
	* y-axis, around the z-axis (0 to 359). 0=North, 90=East, 180=South,		* y-axis, around the z-axis (0 to 359). 0=North, 90=East, 180=South,
	* 270=West		* 270=West </li>
	* </p>		* <li> values[1]: Pitch, rotation around x-axis (-180 to 180), with positive
	*		* values when the z-axis moves <b>toward</b> the y-axis. </li>
	* <p>		* <li> values[2]: Roll, rotation around y-axis (-90 to 90), with positive values
	* values[1]: Pitch, rotation around x-axis (-180 to 180), with positive		* when the x-axis moves <b>toward</b> the z-axis. </li>
	* values when the z-axis moves <b>toward</b> the y-axis.
	* </p>
	*
	* <p>
	* values[2]: Roll, rotation around y-axis (-90 to 90), with positive values
	* when the x-axis moves <b>toward</b> the z-axis.
	* </p>
	* </ul>		* </ul>
	*		*
	* <p>		* <p>
	@@ -364,9 +331,7 @@ public class SensorEvent {
	* <h4>{@link android.hardware.Sensor#TYPE_RELATIVE_HUMIDITY		* <h4>{@link android.hardware.Sensor#TYPE_RELATIVE_HUMIDITY
	* Sensor.TYPE_RELATIVE_HUMIDITY}:</h4>		* Sensor.TYPE_RELATIVE_HUMIDITY}:</h4>
	* <ul>		* <ul>
	* <p>		* <li> values[0]: Relative ambient air humidity in percent </li>
	* values[0]: Relative ambient air humidity in percent
	* </p>
	* </ul>		* </ul>
	* <p>		* <p>
	* When relative ambient air humidity and ambient temperature are		* When relative ambient air humidity and ambient temperature are
	@@ -423,14 +388,51 @@ public class SensorEvent {
	* </h4>		* </h4>
	*		*
	* <ul>		* <ul>
	* <p>		* <li> values[0]: ambient (room) temperature in degree Celsius.</li>
	* values[0]: ambient (room) temperature in degree Celsius.
	* </ul>		* </ul>
	*		*
	* @see SensorEvent		* @see SensorEvent
	* @see GeomagneticField		* @see GeomagneticField
			*
			* <h4>{@link android.hardware.Sensor#TYPE_MAGNETIC_FIELD_UNCALIBRATED} </h4>
			* All values are in micro-Tesla (uT) and measure the ambient magnetic field
			* in the X, Y and Z axis.
			* <p>
			* No periodic calibration is performed (ie: there are no discontinuities
			* in the data stream while using this sensor). Assumptions that the the
			* magnetic field is due to the Earth's poles is avoided. Factory calibration
			* and temperature compensation is still performed.
			* </p>
			*
			* <h4> {@link android.hardware.Sensor#TYPE_GYROSCOPE_UNCALIBRATED} </h4>
			* All values are in radians/second and measure the rate of rotation
			* around the X, Y and Z axis. An estimation of the drift on each axis is
			* reported as well.
			* <p>
			* No gyro-drift compensation is performed. Factory calibration and temperature
			* compensation is still applied to the rate of rotation (angular speeds).
			* </p>
			* <p>
			* The coordinate system is the same as is used for the
			* {@link android.hardware.Sensor#TYPE_ACCELEROMETER}
			* Rotation is positive in the counter-clockwise direction (right-hand rule).
			* That is, an observer looking from some positive location on the x, y or z axis
			* at a device positioned on the origin would report positive rotation if the device
			* appeared to be rotating counter clockwise.
			* The range would at least be 17.45 rad/s (ie: ~1000 deg/s).
			* <ul>
			* <li> values[0] : angular speed (w/o drift compensation) around the X axis in rad/s </li>
			* <li> values[1] : angular speed (w/o drift compensation) around the Y axis in rad/s </li>
			* <li> values[2] : angular speed (w/o drift compensation) around the Z axis in rad/s </li>
			* <li> values[3] : estimated drift around X axis in rad/s </li>
			* <li> values[4] : estimated drift around Y axis in rad/s </li>
			* <li> values[5] : estimated drift around Z axis in rad/s </li>
			* </ul>
			* </p>
			* <h4></h4>
			* <h4> Pro Tip: Always use the length of the values array while performing operations
			* on it. In earlier versions, this used to be always 3 which has changed now. </h4>
	*/		*/

	public final float[] values;		public final float[] values;

	/**		/**
	@@ -445,13 +447,11 @@ public class SensorEvent {
	*/		*/
	public int accuracy;		public int accuracy;


	/**		/**
	* The time in nanosecond at which the event happened		* The time in nanosecond at which the event happened
	*/		*/
	public long timestamp;		public long timestamp;


	SensorEvent(int size) {		SensorEvent(int size) {
	values = new float[size];		values = new float[size];
	}		}

core/java/android/hardware/SensorManager.java

+88 −1

Original line number	Original line	Diff line number	Diff line
	@@ -38,7 +38,11 @@ import java.util.List;
	* hours. Note that the system will <i>not</i> disable sensors automatically when		* hours. Note that the system will <i>not</i> disable sensors automatically when
	* the screen turns off.		* the screen turns off.
	* </p>		* </p>
	*		* <p class="note">
			* Note: Don't use this mechanism with a Trigger Sensor, have a look
			* at {@link TriggerEventListener}. {@link Sensor#TYPE_SIGNIFICANT_MOTION}
			* is an example of a trigger sensor.
			* </p>
	* <pre class="prettyprint">		* <pre class="prettyprint">
	* public class SensorActivity extends Activity, implements SensorEventListener {		* public class SensorActivity extends Activity, implements SensorEventListener {
	* private final SensorManager mSensorManager;		* private final SensorManager mSensorManager;
	@@ -515,6 +519,12 @@ public abstract class SensorManager {
	/**		/**
	* Unregisters a listener for the sensors with which it is registered.		* Unregisters a listener for the sensors with which it is registered.
	*		*
			* <p class="note"></p>
			* Note: Don't use this method with a one shot trigger sensor such as
			* {@link Sensor#TYPE_SIGNIFICANT_MOTION}.
			* Use {@link #cancelTriggerSensor(TriggerEventListener, Sensor)} instead.
			* </p>
			*
	* @param listener		* @param listener
	* a SensorEventListener object		* a SensorEventListener object
	*		*
	@@ -524,6 +534,7 @@ public abstract class SensorManager {
	* @see #unregisterListener(SensorEventListener)		* @see #unregisterListener(SensorEventListener)
	* @see #registerListener(SensorEventListener, Sensor, int)		* @see #registerListener(SensorEventListener, Sensor, int)
	*		*
			* @throws IllegalArgumentException when sensor is a trigger sensor.
	*/		*/
	public void unregisterListener(SensorEventListener listener, Sensor sensor) {		public void unregisterListener(SensorEventListener listener, Sensor sensor) {
	if (listener == null \|\| sensor == null) {		if (listener == null \|\| sensor == null) {
	@@ -558,6 +569,12 @@ public abstract class SensorManager {
	* Registers a {@link android.hardware.SensorEventListener		* Registers a {@link android.hardware.SensorEventListener
	* SensorEventListener} for the given sensor.		* SensorEventListener} for the given sensor.
	*		*
			* <p class="note"></p>
			* Note: Don't use this method with a one shot trigger sensor such as
			* {@link Sensor#TYPE_SIGNIFICANT_MOTION}.
			* Use {@link #requestTriggerSensor(TriggerEventListener, Sensor)} instead.
			* </p>
			*
	* @param listener		* @param listener
	* A {@link android.hardware.SensorEventListener SensorEventListener}		* A {@link android.hardware.SensorEventListener SensorEventListener}
	* object.		* object.
	@@ -584,6 +601,7 @@ public abstract class SensorManager {
	* @see #unregisterListener(SensorEventListener)		* @see #unregisterListener(SensorEventListener)
	* @see #unregisterListener(SensorEventListener, Sensor)		* @see #unregisterListener(SensorEventListener, Sensor)
	*		*
			* @throws IllegalArgumentException when sensor is null or a trigger sensor
	*/		*/
	public boolean registerListener(SensorEventListener listener, Sensor sensor, int rate) {		public boolean registerListener(SensorEventListener listener, Sensor sensor, int rate) {
	return registerListener(listener, sensor, rate, null);		return registerListener(listener, sensor, rate, null);
	@@ -593,6 +611,12 @@ public abstract class SensorManager {
	* Registers a {@link android.hardware.SensorEventListener		* Registers a {@link android.hardware.SensorEventListener
	* SensorEventListener} for the given sensor.		* SensorEventListener} for the given sensor.
	*		*
			* <p class="note"></p>
			* Note: Don't use this method with a one shot trigger sensor such as
			* {@link Sensor#TYPE_SIGNIFICANT_MOTION}.
			* Use {@link #requestTriggerSensor(TriggerEventListener, Sensor)} instead.
			* </p>
			*
	* @param listener		* @param listener
	* A {@link android.hardware.SensorEventListener SensorEventListener}		* A {@link android.hardware.SensorEventListener SensorEventListener}
	* object.		* object.
	@@ -623,6 +647,7 @@ public abstract class SensorManager {
	* @see #unregisterListener(SensorEventListener)		* @see #unregisterListener(SensorEventListener)
	* @see #unregisterListener(SensorEventListener, Sensor)		* @see #unregisterListener(SensorEventListener, Sensor)
	*		*
			* @throws IllegalArgumentException when sensor is null or a trigger sensor
	*/		*/
	public boolean registerListener(SensorEventListener listener, Sensor sensor, int rate,		public boolean registerListener(SensorEventListener listener, Sensor sensor, int rate,
	Handler handler) {		Handler handler) {
	@@ -1310,6 +1335,68 @@ public abstract class SensorManager {
	Q[3] = rv[2];		Q[3] = rv[2];
	}		}

			/**
			* Requests receiving trigger events for a trigger sensor.
			*
			* <p>
			* When the sensor detects a trigger event condition, such as significant motion in
			* the case of the {@link Sensor#TYPE_SIGNIFICANT_MOTION}, the provided trigger listener
			* will be invoked once and then its request to receive trigger events will be canceled.
			* To continue receiving trigger events, the application must request to receive trigger
			* events again.
			* </p>
			*
			* @param listener The listener on which the
			* {@link TriggerEventListener#onTrigger(TriggerEvent)} will be delivered.
			* @param sensor The sensor to be enabled.
			*
			* @return true if the sensor was successfully enabled.
			*
			* @throws IllegalArgumentException when sensor is null or not a trigger sensor.
			*/
			public boolean requestTriggerSensor(TriggerEventListener listener, Sensor sensor) {
			return requestTriggerSensorImpl(listener, sensor);
			}

			/**
			* @hide
			*/
			protected abstract boolean requestTriggerSensorImpl(TriggerEventListener listener,
			Sensor sensor);

			/**
			* Cancels receiving trigger events for a trigger sensor.
			*
			* <p>
			* Note that a Trigger sensor will be auto disabled if
			* {@link TriggerEventListener#onTrigger(TriggerEvent)} has triggered.
			* This method is provided in case the user wants to explicitly cancel the request
			* to receive trigger events.
			* </p>
			*
			* @param listener The listener on which the
			* {@link TriggerEventListener#onTrigger(TriggerEvent)}
			* is delivered.It should be the same as the one used
			* in {@link #requestTriggerSensor(TriggerEventListener, Sensor)}
			* @param sensor The sensor for which the trigger request should be canceled.
			* If null, it cancels receiving trigger for all sensors associated
			* with the listener.
			*
			* @return true if successfully canceled.
			*
			* @throws IllegalArgumentException when sensor is a trigger sensor.
			*/
			public boolean cancelTriggerSensor(TriggerEventListener listener, Sensor sensor) {
			return cancelTriggerSensorImpl(listener, sensor);
			}

			/**
			* @hide
			*/
			protected abstract boolean cancelTriggerSensorImpl(TriggerEventListener listener,
			Sensor sensor);


	private LegacySensorManager getLegacySensorManager() {		private LegacySensorManager getLegacySensorManager() {
	synchronized (mSensorListByType) {		synchronized (mSensorListByType) {
	if (mLegacySensorManager == null) {		if (mLegacySensorManager == null) {

core/java/android/hardware/SystemSensorManager.java

+159 −150

File changed.

Preview size limit exceeded, changes collapsed.