SensorExt

sensors.SensorExt

Wrapper returned by getSensor. It extends Android’s Sensor with helpers to subscribe to streaming events—mainly enableSensorEvent and disableSensorEvent.

Inheritance

• unknown

  ↳ SensorExt

Table of contents

Methods

• disableSensorEvent
• enableSensorEvent

Events

• on

Methods

disableSensorEvent

▸ disableSensorEvent(): SensorExt

Stop delivering change and accuracy_change events for this sensor.

Returns

SensorExt

---

enableSensorEvent

▸ enableSensorEvent(delay?): SensorExt

Start delivering sensor events. Until this is called, no change / accuracy_change callbacks fire.

Parameters

Name	Type	Description
delay?	SensorDelay	Delivery rate (see SensorDelay).

Returns

SensorExt

Events

on

▸ on(event, listener): SensorExt

change — new sensor sample. The first argument is an Android SensorEvent; additional numeric arguments depend on the sensor type.

Common shapes:

• accelerometer: (event: SensorEvent, ax: number, ay: number, az: number) — acceleration along each axis (m/s²).
• magnetic_field: (event: SensorEvent, hx: number, hy: number, hz: number) — magnetic field (µT).
• orientation: (event: SensorEvent, azimuth: number, pitch: number, roll: number) — device orientation; see SensorEvent.values.
• gyroscope: (event: SensorEvent, axisX: number, axisY: number, axisZ: number) — angular velocity (rad/s).
• light: (event: SensorEvent, lux: number) — illuminance (lx).
• pressure: (event: SensorEvent, pressure: number) — atmospheric pressure (hPa).
• temperature: (event: SensorEvent, temperature: number) — temperature (°C).
• proximity: (event: SensorEvent, distance: number) — proximity (cm).
• gravity: (event: SensorEvent, gx: number, gy: number, gz: number) — gravity vector (m/s²).
• linear_acceleration: (event: SensorEvent, ax: number, ay: number, az: number) — linear acceleration excluding gravity (m/s²).

See also

SensorEvent

Parameters

Name	Type
event	"change"
listener	(event: SensorEvent, ...args: any) => void

Returns

SensorExt

▸ on(event, listener): SensorExt

accuracy_change — reported when the hardware changes accuracy. accuracy is in 0…3: 0 means unreliable; 1–3 maps from low to high quality.

See also

onAccuracyChanged

Parameters

Name	Type
event	"accuracy_change"
listener	(event: SensorEvent, accuracy: number) => void

Returns

SensorExt