This documentation is available as Markdown for AI agents and LLMs. See the full Markdown index or append .md to any documentation URL.
Expo Magnetometer
A library that provides access to the device's magnetometer sensor.
Magnetometer from expo-sensors provides access to the device magnetometer sensor(s) to respond to and measure the changes in the magnetic field measured in microtesla (μT).
You can access the calibrated values with Magnetometer and uncalibrated raw values with MagnetometerUncalibrated.
Installation
If you are installing this in an existing React Native app, make sure to install expo in your project.
Usage
API
import { Magnetometer, MagnetometerUncalibrated } from 'expo-sensors';
Classes
Type: Class extends DeviceSensor<MagnetometerMeasurement>
Magnetometer Methods
Subscribe for updates to the magnetometer.
EventSubscriptionA subscription that you can call remove() on when you would like to unsubscribe the listener.
Checks user's permissions for accessing sensor.
Promise<PermissionResponse>Returns boolean which signifies if sensor has any listeners registered.
booleanYou should always check the sensor availability before attempting to use it.
Check the availability of the device magnetometer. Requires at least Android 2.3 (API Level 9) and iOS 8.
Promise<boolean>A promise that resolves to a boolean denoting the availability of the sensor.
Deprecated: use subscription.remove() instead.
voidAsks the user to grant permissions for accessing sensor.
Promise<PermissionResponse>Interfaces
A subscription object that allows to conveniently remove an event listener from the emitter.
Types
Each of these keys represents the strength of magnetic field along that particular axis measured in microteslas (μT).
Literal type: union
Permission expiration time. Currently, all permissions are granted permanently.
Acceptable values are: 'never' | number