Device Orientation #

A Flutter package for calculating device orientation using the device's accelerometer and compass sensors.

device_orientation provides a simple API for reading the device's current orientation and listening to orientation changes through a stream.

Features #

📱 Read the current device orientation.
🧭 Use compass heading information.
📐 Use accelerometer data to calculate device orientation.
🔄 Listen to continuous orientation updates through a stream.
🧩 Simple API with minimal setup.
⚡ Built specifically for Flutter.

Getting started #

Add device_orientation to your pubspec.yaml:

dependencies:
  device_orientation: ^0.1.0

Then import the package:

import 'package:device_orientation/device_orientation.dart';

Make sure the required platform permissions and sensor capabilities are available on the target device.

Usage #

Create a DeviceOrientation instance and start listening for orientation updates:

final orientation = DeviceOrientation();

orientation.start();

orientation.stream.listen((data) {
  print(data);
});

You can also access the most recently calculated orientation synchronously:

final currentOrientation = orientation.data;

When the orientation service is no longer needed, stop it and release its resources:

orientation.stop();
orientation.dispose();

Complete example #

import 'package:device_orientation/device_orientation.dart';

void main() {
  final orientation = DeviceOrientation();

  orientation.start();

  orientation.stream.listen((data) {
    print(data);
  });

  // Access the latest value at any time.
  print(orientation.data);
}

`SensorService` #

Responsible for collecting raw sensor data from:

Accelerometer
Compass

It does not perform orientation calculations.

`OrientationEngine` #

Receives the raw sensor data and calculates the resulting orientation.