react-native-attitude

react-native-attitude provides real-time device orientation for React Native apps:

• Roll and pitch in degrees (for horizon/level style UIs)
• Heading in degrees (0-360)
• Configurable update interval (1Hz to 40Hz in the example app)
• Runtime controls for zero() and reset() calibration

The module is designed for sensor-driven experiences such as camera overlays, horizon indicators, motion dashboards, and instrumentation UIs where low-latency orientation updates matter.

Version 3.x requires React Native 0.82+ with the New Architecture enabled. It is implemented as a Turbo Module, using Core Motion + compass on iOS and the rotation vector sensor on Android.

Install

npm install react-native-attitude
# or
yarn add react-native-attitude

Autolinking applies from RN 0.60+. Rebuild the native app after installing.

iOS

Add to your app Info.plist when using heading:

<key>NSLocationWhenInUseUsageDescription</key>
<string>Heading uses the device compass.</string>

Then cd ios && pod install.

Usage

import Attitude from 'react-native-attitude';

const watchId = Attitude.watch((payload) => {
  // payload.timestamp — ms wall clock time
  // payload.roll      — degrees, -180 to 180, negative left wing down
  // payload.pitch     — degrees, -90 to 90, positive nose up
  // payload.heading   — degrees, 0 to 360
});

Attitude.setInterval(500);       // minimum 25 ms (~40 Hz max)
Attitude.setRotation('none');    // 'none' | 'left' | 'right'
Attitude.setOutput('both');      // 'both' | 'attitude' | 'heading'
Attitude.zero();
Attitude.reset();
Attitude.clearWatch(watchId);
Attitude.stopObserving();

const supported = await Attitude.isSupported();

Example app

cd example
npm install
cd ios && bundle exec pod install && cd ..
npm run android
# or
npm run ios

The example shows live roll/pitch/heading, an artificial horizon, and controls for zero/reset plus update-rate presets (1/5/10/20/40 Hz).

License

MIT