true_compass library
Compass heading for Flutter with magnetic and true north, calibration events, smoothing and a themeable dial.
Classes
- Angles
- Helpers for working with compass angles in degrees.
- CircularAverageSmoothing
- Sliding-window circular mean; see CompassSmoothing.circularAverage.
- CompassHeading
- One compass reading.
- CompassLocation
- A place on Earth, used to look up the magnetic declination for true north.
- CompassOptions
-
Configuration of a
TrueCompassstream. - CompassSmoothing
- Strategy used to calm down a jittery heading.
- CompassTheme
-
Colors, sizes and text styles of a
CompassView. - CompassView
- A themeable compass dial.
- HeadingSmoother
- A stateful filter created by CompassSmoothing.createSmoother.
- LowPassSmoothing
- Exponential low-pass filter; see CompassSmoothing.lowPass.
- MagneticDeclination
- Magnetic declination from the NOAA World Magnetic Model 2025 (WMM2025), computed in pure Dart. No network, no location plugin, no assets.
- MagneticField
- The result of evaluating the World Magnetic Model at one place and time.
- NoSmoothing
- No smoothing.
- OrientationMath
- Pure functions that turn raw sensor data into a compass heading.
- RawSensorConfig
- Sensor settings handed to the native side.
- TrueCompass
- Compass heading stream with magnetic and true north.
- TrueCompassPlatform
- The interface platform implementations must extend.
Enums
- CompassAccuracy
- How trustworthy the magnetometer currently is.
- CompassAvailability
- Whether and how the compass can be used on this device.