SensorManager

AXIS_MINUS_X

static val AXIS_MINUS_X: Int

see remapCoordinateSystem

Value: 129

AXIS_MINUS_Y

static val AXIS_MINUS_Y: Int

see remapCoordinateSystem

Value: 130

AXIS_MINUS_Z

static val AXIS_MINUS_Z: Int

see remapCoordinateSystem

Value: 131

AXIS_X

static val AXIS_X: Int

see remapCoordinateSystem

Value: 1

AXIS_Y

static val AXIS_Y: Int

see remapCoordinateSystem

Value: 2

AXIS_Z

static val AXIS_Z: Int

see remapCoordinateSystem

Value: 3

DATA_X

static val DATA_X: Int

Deprecated: use Sensor instead.

Index of the X value in the array returned by android.hardware.SensorListener#onSensorChanged

Value: 0

DATA_Y

static val DATA_Y: Int

Deprecated: use Sensor instead.

Index of the Y value in the array returned by android.hardware.SensorListener#onSensorChanged

Value: 1

DATA_Z

static val DATA_Z: Int

Deprecated: use Sensor instead.

Index of the Z value in the array returned by android.hardware.SensorListener#onSensorChanged

Value: 2

GRAVITY_DEATH_STAR_I

static val GRAVITY_DEATH_STAR_I: Float

Gravity (estimate) on the first Death Star in Empire units (m/s^2)

Value: 3.5303614E-7f

GRAVITY_EARTH

static val GRAVITY_EARTH: Float

Earth's gravity in SI units (m/s^2)

Value: 9.80665f

GRAVITY_JUPITER

static val GRAVITY_JUPITER: Float

Jupiter's gravity in SI units (m/s^2)

Value: 23.12f

GRAVITY_MARS

static val GRAVITY_MARS: Float

Mars' gravity in SI units (m/s^2)

Value: 3.71f

GRAVITY_MERCURY

static val GRAVITY_MERCURY: Float

Mercury's gravity in SI units (m/s^2)

Value: 3.7f

GRAVITY_MOON

static val GRAVITY_MOON: Float

The Moon's gravity in SI units (m/s^2)

Value: 1.6f

GRAVITY_NEPTUNE

static val GRAVITY_NEPTUNE: Float

Neptune's gravity in SI units (m/s^2)

Value: 11.0f

GRAVITY_PLUTO

static val GRAVITY_PLUTO: Float

Pluto's gravity in SI units (m/s^2)

Value: 0.6f

GRAVITY_SATURN

static val GRAVITY_SATURN: Float

Saturn's gravity in SI units (m/s^2)

Value: 8.96f

GRAVITY_SUN

static val GRAVITY_SUN: Float

Sun's gravity in SI units (m/s^2)

Value: 275.0f

GRAVITY_THE_ISLAND

static val GRAVITY_THE_ISLAND: Float

Gravity on the island

Value: 4.815162f

GRAVITY_URANUS

static val GRAVITY_URANUS: Float

Uranus' gravity in SI units (m/s^2)

Value: 8.69f

GRAVITY_VENUS

static val GRAVITY_VENUS: Float

Venus' gravity in SI units (m/s^2)

Value: 8.87f

LIGHT_CLOUDY

static val LIGHT_CLOUDY: Float

luminance under a cloudy sky in lux

Value: 100.0f

LIGHT_FULLMOON

static val LIGHT_FULLMOON: Float

luminance at night with full moon in lux

Value: 0.25f

LIGHT_NO_MOON

static val LIGHT_NO_MOON: Float

luminance at night with no moon in lux

Value: 0.001f

LIGHT_OVERCAST

static val LIGHT_OVERCAST: Float

luminance under an overcast sky in lux

Value: 10000.0f

LIGHT_SHADE

static val LIGHT_SHADE: Float

luminance in shade in lux

Value: 20000.0f

LIGHT_SUNLIGHT

static val LIGHT_SUNLIGHT: Float

luminance of sunlight in lux

Value: 110000.0f

LIGHT_SUNLIGHT_MAX

static val LIGHT_SUNLIGHT_MAX: Float

Maximum luminance of sunlight in lux

Value: 120000.0f

LIGHT_SUNRISE

static val LIGHT_SUNRISE: Float

luminance at sunrise in lux

Value: 400.0f

MAGNETIC_FIELD_EARTH_MAX

static val MAGNETIC_FIELD_EARTH_MAX: Float

Maximum magnetic field on Earth's surface

Value: 60.0f

MAGNETIC_FIELD_EARTH_MIN

static val MAGNETIC_FIELD_EARTH_MIN: Float

Minimum magnetic field on Earth's surface

Value: 30.0f

PRESSURE_STANDARD_ATMOSPHERE

static val PRESSURE_STANDARD_ATMOSPHERE: Float

Standard atmosphere, or average sea-level pressure in hPa (millibar)

Value: 1013.25f

RAW_DATA_INDEX

static val RAW_DATA_INDEX: Int

Deprecated: use Sensor instead.

Offset to the untransformed values in the array returned by android.hardware.SensorListener#onSensorChanged

Value: 3

RAW_DATA_X

static val RAW_DATA_X: Int

Deprecated: use Sensor instead.

Index of the untransformed X value in the array returned by android.hardware.SensorListener#onSensorChanged

Value: 3

RAW_DATA_Y

static val RAW_DATA_Y: Int

Deprecated: use Sensor instead.

Index of the untransformed Y value in the array returned by android.hardware.SensorListener#onSensorChanged

Value: 4

RAW_DATA_Z

static val RAW_DATA_Z: Int

Deprecated: use Sensor instead.

Index of the untransformed Z value in the array returned by android.hardware.SensorListener#onSensorChanged

Value: 5

SENSOR_ACCELEROMETER

static val SENSOR_ACCELEROMETER: Int

Deprecated: use Sensor instead.

A constant describing an accelerometer. See SensorListener for more details.

Value: 2

SENSOR_ALL

static val SENSOR_ALL: Int

Deprecated: use Sensor instead.

A constant that includes all sensors

Value: 127

SENSOR_DELAY_FASTEST

static val SENSOR_DELAY_FASTEST: Int

get sensor data as fast as possible

Value: 0

SENSOR_DELAY_GAME

static val SENSOR_DELAY_GAME: Int

rate suitable for games

Value: 1

SENSOR_DELAY_NORMAL

static val SENSOR_DELAY_NORMAL: Int

rate (default) suitable for screen orientation changes

Value: 3

SENSOR_DELAY_UI

static val SENSOR_DELAY_UI: Int

rate suitable for the user interface

Value: 2

SENSOR_LIGHT

static val SENSOR_LIGHT: Int

Deprecated: use Sensor instead.

A constant describing an ambient light sensor See SensorListener for more details.

Value: 16

SENSOR_MAGNETIC_FIELD

static val SENSOR_MAGNETIC_FIELD: Int

Deprecated: use Sensor instead.

A constant describing a magnetic sensor See SensorListener for more details.

Value: 8

SENSOR_MAX

static val SENSOR_MAX: Int

Deprecated: use Sensor instead.

Largest sensor ID

Value: 64

SENSOR_MIN

static val SENSOR_MIN: Int

Deprecated: use Sensor instead.

Smallest sensor ID

Value: 1

SENSOR_ORIENTATION

static val SENSOR_ORIENTATION: Int

Deprecated: use Sensor instead.

A constant describing an orientation sensor. See SensorListener for more details.

Value: 1

SENSOR_ORIENTATION_RAW

static val SENSOR_ORIENTATION_RAW: Int

Deprecated: use Sensor instead.

A constant describing an orientation sensor. See SensorListener for more details.

Value: 128

SENSOR_PROXIMITY

static val SENSOR_PROXIMITY: Int

Deprecated: use Sensor instead.

A constant describing a proximity sensor See SensorListener for more details.

Value: 32

SENSOR_STATUS_ACCURACY_HIGH

static val SENSOR_STATUS_ACCURACY_HIGH: Int

This sensor is reporting data with maximum accuracy

Value: 3

SENSOR_STATUS_ACCURACY_LOW

static val SENSOR_STATUS_ACCURACY_LOW: Int

This sensor is reporting data with low accuracy, calibration with the environment is needed

Value: 1

SENSOR_STATUS_ACCURACY_MEDIUM

static val SENSOR_STATUS_ACCURACY_MEDIUM: Int

This sensor is reporting data with an average level of accuracy, calibration with the environment may improve the readings

Value: 2

SENSOR_STATUS_NO_CONTACT

static val SENSOR_STATUS_NO_CONTACT: Int

The values returned by this sensor cannot be trusted because the sensor had no contact with what it was measuring (for example, the heart rate monitor is not in contact with the user).

Value: -1

SENSOR_STATUS_UNRELIABLE

static val SENSOR_STATUS_UNRELIABLE: Int

The values returned by this sensor cannot be trusted, calibration is needed or the environment doesn't allow readings

Value: 0

SENSOR_TEMPERATURE

static val SENSOR_TEMPERATURE: Int

Deprecated: use Sensor instead.

A constant describing a temperature sensor See SensorListener for more details.

Value: 4

SENSOR_TRICORDER

static val SENSOR_TRICORDER: Int

Deprecated: use Sensor instead.

A constant describing a Tricorder See SensorListener for more details.

Value: 64

STANDARD_GRAVITY

static val STANDARD_GRAVITY: Float

Standard gravity (g) on Earth. This value is equivalent to 1G

Value: 9.80665f

cancelTriggerSensor

open fun cancelTriggerSensor(
    listener: TriggerEventListener!, 
    sensor: Sensor!
): Boolean

Cancels receiving trigger events for a trigger sensor.

Note that a Trigger sensor will be auto disabled if TriggerEventListener#onTrigger(TriggerEvent) has triggered. This method is provided in case the user wants to explicitly cancel the request to receive trigger events.

createDirectChannel

open fun createDirectChannel(mem: MemoryFile!): SensorDirectChannel!

Create a sensor direct channel backed by shared memory wrapped in MemoryFile object. The resulting channel can be used for delivering sensor events to native code, other processes, GPU/DSP or other co-processors without CPU intervention. This is the recommended for high performance sensor applications that use high sensor rates (e.g. greater than 200Hz) and cares about sensor event latency. Use the returned android.hardware.SensorDirectChannel object to configure direct report of sensor events. After use, call android.hardware.SensorDirectChannel#close() to free up resource in sensor system associated with the direct channel.

createDirectChannel

open fun createDirectChannel(mem: HardwareBuffer!): SensorDirectChannel!

Create a sensor direct channel backed by shared memory wrapped in HardwareBuffer object. The resulting channel can be used for delivering sensor events to native code, other processes, GPU/DSP or other co-processors without CPU intervention. This is the recommended for high performance sensor applications that use high sensor rates (e.g. greater than 200Hz) and cares about sensor event latency. Use the returned android.hardware.SensorDirectChannel object to configure direct report of sensor events. After use, call android.hardware.SensorDirectChannel#close() to free up resource in sensor system associated with the direct channel.

flush

open fun flush(listener: SensorEventListener!): Boolean

Flushes the FIFO of all the sensors registered for this listener. If there are events in the FIFO of the sensor, they are returned as if the maxReportLatency of the FIFO has expired. Events are returned in the usual way through the SensorEventListener. This call doesn't affect the maxReportLatency for this sensor. This call is asynchronous and returns immediately. onFlushCompleted is called after all the events in the batch at the time of calling this method have been delivered successfully. If the hardware doesn't support flush, it still returns true and a trivial flush complete event is sent after the current event for all the clients registered for this sensor.

getAltitude

open static fun getAltitude(
    p0: Float, 
    p: Float
): Float

Computes the Altitude in meters from the atmospheric pressure and the pressure at sea level.

Typically the atmospheric pressure is read from a Sensor#TYPE_PRESSURE sensor. The pressure at sea level must be known, usually it can be retrieved from airport databases in the vicinity. If unknown, you can use PRESSURE_STANDARD_ATMOSPHERE as an approximation, but absolute altitudes won't be accurate.

To calculate altitude differences, you must calculate the difference between the altitudes at both points. If you don't know the altitude as sea level, you can use PRESSURE_STANDARD_ATMOSPHERE instead, which will give good results considering the range of pressure typically involved.

float altitude_difference = getAltitude(SensorManager.PRESSURE_STANDARD_ATMOSPHERE, pressure_at_point2) - getAltitude(SensorManager.PRESSURE_STANDARD_ATMOSPHERE, pressure_at_point1);

getAngleChange

open static fun getAngleChange(
    angleChange: FloatArray!, 
    R: FloatArray!, 
    prevR: FloatArray!
): Unit

Helper function to compute the angle change between two rotation matrices. Given a current rotation matrix (R) and a previous rotation matrix (prevR) computes the intrinsic rotation around the z, x, and y axes which transforms prevR to R. outputs a 3 element vector containing the z, x, and y angle change at indexes 0, 1, and 2 respectively.

Each input matrix is either as a 3x3 or 4x4 row-major matrix depending on the length of the passed array:

If the array length is 9, then the array elements represent this matrix

/  R[ 0]   R[ 1]   R[ 2]   \
    |  R[ 3]   R[ 4]   R[ 5]   |
    \  R[ 6]   R[ 7]   R[ 8]   /
 

If the array length is 16, then the array elements represent this matrix

/  R[ 0]   R[ 1]   R[ 2]   R[ 3]  \
    |  R[ 4]   R[ 5]   R[ 6]   R[ 7]  |
    |  R[ 8]   R[ 9]   R[10]   R[11]  |
    \  R[12]   R[13]   R[14]   R[15]  /
 

getDefaultSensor

open fun getDefaultSensor(type: Int): Sensor?

Use this method to get the default sensor for a given type. Note that the returned sensor could be a composite sensor, and its data could be averaged or filtered. If you need to access the raw sensors use getSensorList.

getDefaultSensor

open fun getDefaultSensor(
    type: Int, 
    wakeUp: Boolean
): Sensor?

Return a Sensor with the given type and wakeUp properties. If multiple sensors of this type exist, any one of them may be returned.

For example,

• getDefaultSensor(Sensor#TYPE_ACCELEROMETER, true) returns a wake-up accelerometer sensor if it exists.
• getDefaultSensor(Sensor#TYPE_PROXIMITY, false) returns a non wake-up proximity sensor if it exists.
• getDefaultSensor(Sensor#TYPE_PROXIMITY, true) returns a wake-up proximity sensor which is the same as the Sensor returned by getDefaultSensor(int).

Note: Sensors like Sensor#TYPE_PROXIMITY and Sensor#TYPE_SIGNIFICANT_MOTION are declared as wake-up sensors by default.

getDynamicSensorList

open fun getDynamicSensorList(type: Int): MutableList<Sensor!>!

Use this method to get a list of available dynamic sensors of a certain type. Make multiple calls to get sensors of different types or use Sensor.TYPE_ALL to get all dynamic sensors.

NOTE: Both wake-up and non wake-up sensors matching the given type are returned. Check Sensor#isWakeUpSensor() to know the wake-up properties of the returned Sensor.

getInclination

open static fun getInclination(I: FloatArray!): Float

Computes the geomagnetic inclination angle in radians from the inclination matrix I returned by getRotationMatrix.

getOrientation

open static fun getOrientation(
    R: FloatArray!, 
    values: FloatArray!
): FloatArray!

Computes the device's orientation based on the rotation matrix.

When it returns, the array values are as follows:

• values[0]: Azimuth, angle of rotation about the -z axis. This value represents the angle between the device's y axis and the magnetic north pole. When facing north, this angle is 0, when facing south, this angle is π. Likewise, when facing east, this angle is π/2, and when facing west, this angle is -π/2. The range of values is -π to π.
• values[1]: Pitch, angle of rotation about the x axis. This value represents the angle between a plane parallel to the device's screen and a plane parallel to the ground. Assuming that the bottom edge of the device faces the user and that the screen is face-up, tilting the top edge of the device toward the ground creates a positive pitch angle. The range of values is -π/2 to π/2.
• values[2]: Roll, angle of rotation about the y axis. This value represents the angle between a plane perpendicular to the device's screen and a plane perpendicular to the ground. Assuming that the bottom edge of the device faces the user and that the screen is face-up, tilting the left edge of the device toward the ground creates a positive roll angle. The range of values is -π to π.

Applying these three rotations in the azimuth, pitch, roll order transforms an identity matrix to the rotation matrix passed into this method. Also, note that all three orientation angles are expressed in radians.

getQuaternionFromVector

open static fun getQuaternionFromVector(
    Q: FloatArray!, 
    rv: FloatArray!
): Unit

Helper function to convert a rotation vector to a normalized quaternion. Given a rotation vector (presumably from a ROTATION_VECTOR sensor), returns a normalized quaternion in the array Q. The quaternion is stored as [w, x, y, z]

getRotationMatrix

open static fun getRotationMatrix(
    R: FloatArray!, 
    I: FloatArray!, 
    gravity: FloatArray!, 
    geomagnetic: FloatArray!
): Boolean

Computes the inclination matrix I as well as the rotation matrix R transforming a vector from the device coordinate system to the world's coordinate system which is defined as a direct orthonormal basis, where:

• X is defined as the vector product Y.Z (It is tangential to the ground at the device's current location and roughly points East).
• Y is tangential to the ground at the device's current location and points towards the magnetic North Pole.
• Z points towards the sky and is perpendicular to the ground.

By definition:

[0 0 g] = R * gravity (g = magnitude of gravity)

[0 m 0] = I * R * geomagnetic (m = magnitude of geomagnetic field)

R is the identity matrix when the device is aligned with the world's coordinate system, that is, when the device's X axis points toward East, the Y axis points to the North Pole and the device is facing the sky.

I is a rotation matrix transforming the geomagnetic vector into the same coordinate space as gravity (the world's coordinate space). I is a simple rotation around the X axis. The inclination angle in radians can be computed with getInclination.

Each matrix is returned either as a 3x3 or 4x4 row-major matrix depending on the length of the passed array:

If the array length is 16:

/  M[ 0]   M[ 1]   M[ 2]   M[ 3]  \
    |  M[ 4]   M[ 5]   M[ 6]   M[ 7]  |
    |  M[ 8]   M[ 9]   M[10]   M[11]  |
    \  M[12]   M[13]   M[14]   M[15]  /
 

Note that because OpenGL matrices are column-major matrices you must transpose the matrix before using it. However, since the matrix is a rotation matrix, its transpose is also its inverse, conveniently, it is often the inverse of the rotation that is needed for rendering; it can therefore be used with OpenGL ES directly.

Also note that the returned matrices always have this form:

/  M[ 0]   M[ 1]   M[ 2]   0  \
    |  M[ 4]   M[ 5]   M[ 6]   0  |
    |  M[ 8]   M[ 9]   M[10]   0  |
    \      0       0       0   1  /
 

If the array length is 9:

/  M[ 0]   M[ 1]   M[ 2]  \
    |  M[ 3]   M[ 4]   M[ 5]  |
    \  M[ 6]   M[ 7]   M[ 8]  /
 

The inverse of each matrix can be computed easily by taking its transpose.

The matrices returned by this function are meaningful only when the device is not free-falling and it is not close to the magnetic north. If the device is accelerating, or placed into a strong magnetic field, the returned matrices may be inaccurate.

getRotationMatrixFromVector

open static fun getRotationMatrixFromVector(
    R: FloatArray!, 
    rotationVector: FloatArray!
): Unit

Helper function to convert a rotation vector to a rotation matrix. Given a rotation vector (presumably from a ROTATION_VECTOR sensor), returns a 9 or 16 element rotation matrix in the array R. R must have length 9 or 16. If R.length == 9, the following matrix is returned:

/  R[ 0]   R[ 1]   R[ 2]   \
    |  R[ 3]   R[ 4]   R[ 5]   |
    \  R[ 6]   R[ 7]   R[ 8]   /
 

/  R[ 0]   R[ 1]   R[ 2]   0  \
    |  R[ 4]   R[ 5]   R[ 6]   0  |
    |  R[ 8]   R[ 9]   R[10]   0  |
    \  0       0       0       1  /
 

getSensorList

open fun getSensorList(type: Int): MutableList<Sensor!>!

Use this method to get the list of available sensors of a certain type. Make multiple calls to get sensors of different types or use Sensor.TYPE_ALL to get all the sensors. Note that the android.hardware.Sensor#getName() is expected to yield a value that is unique across any sensors that return the same value for android.hardware.Sensor#getType().

NOTE: Both wake-up and non wake-up sensors matching the given type are returned. Check Sensor#isWakeUpSensor() to know the wake-up properties of the returned Sensor.

getSensors

open fun getSensors(): Int

Deprecated: This method is deprecated, use SensorManager#getSensorList(int) instead

isDynamicSensorDiscoverySupported

open fun isDynamicSensorDiscoverySupported(): Boolean

Tell if dynamic sensor discovery feature is supported by system.

registerDynamicSensorCallback

open fun registerDynamicSensorCallback(callback: SensorManager.DynamicSensorCallback!): Unit

Add a DynamicSensorCallback to receive dynamic sensor connection callbacks. Repeat registration with the already registered callback object will have no additional effect.

registerDynamicSensorCallback

open fun registerDynamicSensorCallback(
    callback: SensorManager.DynamicSensorCallback!, 
    handler: Handler!
): Unit

Add a DynamicSensorCallback to receive dynamic sensor connection callbacks. Repeat registration with the already registered callback object will have no additional effect.

registerListener

open fun registerListener(
    listener: SensorListener!, 
    sensors: Int
): Boolean

Deprecated: This method is deprecated, use SensorManager#registerListener(SensorEventListener, Sensor, int) instead.

Registers a listener for given sensors.

registerListener

open fun registerListener(
    listener: SensorListener!, 
    sensors: Int, 
    rate: Int
): Boolean

Deprecated: This method is deprecated, use SensorManager#registerListener(SensorEventListener, Sensor, int) instead.

Registers a SensorListener for given sensors.

registerListener

open fun registerListener(
    listener: SensorEventListener!, 
    sensor: Sensor!, 
    samplingPeriodUs: Int
): Boolean

Registers a SensorEventListener for the given sensor at the given sampling frequency.

The events will be delivered to the provided SensorEventListener as soon as they are available. To reduce the power consumption, applications can use registerListener(android.hardware.SensorEventListener,android.hardware.Sensor,int,int) instead and specify a positive non-zero maximum reporting latency.

In the case of non-wake-up sensors, the events are only delivered while the Application Processor (AP) is not in suspend mode. See Sensor#isWakeUpSensor() for more details. To ensure delivery of events from non-wake-up sensors even when the screen is OFF, the application registering to the sensor must hold a partial wake-lock to keep the AP awake, otherwise some events might be lost while the AP is asleep. Note that although events might be lost while the AP is asleep, the sensor will still consume power if it is not explicitly deactivated by the application. Applications must unregister their SensorEventListeners in their activity's onPause() method to avoid consuming power while the device is inactive. See registerListener(android.hardware.SensorEventListener,android.hardware.Sensor,int,int) for more details on hardware FIFO (queueing) capabilities and when some sensor events might be lost.

In the case of wake-up sensors, each event generated by the sensor will cause the AP to wake-up, ensuring that each event can be delivered. Because of this, registering to a wake-up sensor has very significant power implications. Call Sensor#isWakeUpSensor() to check whether a sensor is a wake-up sensor. See registerListener(android.hardware.SensorEventListener,android.hardware.Sensor,int,int) for information on how to reduce the power impact of registering to wake-up sensors.

Note: Don't use this method with one-shot trigger sensors such as Sensor#TYPE_SIGNIFICANT_MOTION. Use requestTriggerSensor(android.hardware.TriggerEventListener,android.hardware.Sensor) instead. Use Sensor#getReportingMode() to obtain the reporting mode of a given sensor.

registerListener

open fun registerListener(
    listener: SensorEventListener!, 
    sensor: Sensor!, 
    samplingPeriodUs: Int, 
    maxReportLatencyUs: Int
): Boolean

Registers a SensorEventListener for the given sensor at the given sampling frequency and the given maximum reporting latency.

This function is similar to registerListener(android.hardware.SensorEventListener,android.hardware.Sensor,int) but it allows events to stay temporarily in the hardware FIFO (queue) before being delivered. The events can be stored in the hardware FIFO up to maxReportLatencyUs microseconds. Once one of the events in the FIFO needs to be reported, all of the events in the FIFO are reported sequentially. This means that some events will be reported before the maximum reporting latency has elapsed.

When maxReportLatencyUs is 0, the call is equivalent to a call to registerListener(android.hardware.SensorEventListener,android.hardware.Sensor,int), as it requires the events to be delivered as soon as possible.

When sensor.maxFifoEventCount() is 0, the sensor does not use a FIFO, so the call will also be equivalent to registerListener(android.hardware.SensorEventListener,android.hardware.Sensor,int).

Setting maxReportLatencyUs to a positive value allows to reduce the number of interrupts the AP (Application Processor) receives, hence reducing power consumption, as the AP can switch to a lower power state while the sensor is capturing the data. This is especially important when registering to wake-up sensors, for which each interrupt causes the AP to wake up if it was in suspend mode. See Sensor#isWakeUpSensor() for more information on wake-up sensors.

registerListener

open fun registerListener(
    listener: SensorEventListener!, 
    sensor: Sensor!, 
    samplingPeriodUs: Int, 
    handler: Handler!
): Boolean

Registers a SensorEventListener for the given sensor. Events are delivered in continuous mode as soon as they are available. To reduce the power consumption, applications can use registerListener(android.hardware.SensorEventListener,android.hardware.Sensor,int,int) instead and specify a positive non-zero maximum reporting latency.

registerListener

open fun registerListener(
    listener: SensorEventListener!, 
    sensor: Sensor!, 
    samplingPeriodUs: Int, 
    maxReportLatencyUs: Int, 
    handler: Handler!
): Boolean

Registers a SensorEventListener for the given sensor at the given sampling frequency and the given maximum reporting latency.

remapCoordinateSystem

open static fun remapCoordinateSystem(
    inR: FloatArray!, 
    X: Int, 
    Y: Int, 
    outR: FloatArray!
): Boolean

Rotates the supplied rotation matrix so it is expressed in a different coordinate system. This is typically used when an application needs to compute the three orientation angles of the device (see getOrientation) in a different coordinate system.

When the rotation matrix is used for drawing (for instance with OpenGL ES), it usually doesn't need to be transformed by this function, unless the screen is physically rotated, in which case you can use Display.getRotation() to retrieve the current rotation of the screen. Note that because the user is generally free to rotate their screen, you often should consider the rotation in deciding the parameters to use here.

Examples:

• Using the camera (Y axis along the camera's axis) for an augmented reality application where the rotation angles are needed:
remapCoordinateSystem(inR, AXIS_X, AXIS_Z, outR);
• Using the device as a mechanical compass when rotation is Surface.ROTATION_90:
remapCoordinateSystem(inR, AXIS_Y, AXIS_MINUS_X, outR);
Beware of the above example. This call is needed only to account for a rotation from its natural orientation when calculating the rotation angles (see getOrientation). If the rotation matrix is also used for rendering, it may not need to be transformed, for instance if your Activity is running in landscape mode.

Since the resulting coordinate system is orthonormal, only two axes need to be specified.

requestTriggerSensor

open fun requestTriggerSensor(
    listener: TriggerEventListener!, 
    sensor: Sensor!
): Boolean

Requests receiving trigger events for a trigger sensor.

When the sensor detects a trigger event condition, such as significant motion in the case of the 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.

unregisterDynamicSensorCallback

open fun unregisterDynamicSensorCallback(callback: SensorManager.DynamicSensorCallback!): Unit

Remove a DynamicSensorCallback to stop sending dynamic sensor connection events to that callback.

unregisterListener

open fun unregisterListener(listener: SensorListener!): Unit

Deprecated: This method is deprecated, use SensorManager#unregisterListener(SensorEventListener) instead.

Unregisters a listener for all sensors.

unregisterListener

open fun unregisterListener(
    listener: SensorListener!, 
    sensors: Int
): Unit

Deprecated: This method is deprecated, use SensorManager#unregisterListener(SensorEventListener, Sensor) instead.

Unregisters a listener for the sensors with which it is registered.

unregisterListener

open fun unregisterListener(
    listener: SensorEventListener!, 
    sensor: Sensor!
): Unit

Unregisters a listener for the sensors with which it is registered.

Note: Don't use this method with a one shot trigger sensor such as Sensor#TYPE_SIGNIFICANT_MOTION. Use cancelTriggerSensor(android.hardware.TriggerEventListener,android.hardware.Sensor) instead.

unregisterListener

open fun unregisterListener(listener: SensorEventListener!): Unit

Unregisters a listener for all sensors.