---
description: Capacitor plugin to read the device compass heading on Android and iOS. Get the current heading, listen for live updates, and read true north on iOS.
title: Capacitor Compass Plugin for Android & iOS - Capawesome
image: https://capawesome.io/docs/assets/images/social/sdks/capacitor/compass.png
---
[Skip to content ](#capacitor-compass-plugin)
[π Introducing the **Capacitor Vault** plugin β store secrets behind biometrics or a device passcode. ](/blog/announcing-the-capacitor-vault-plugin/)
* [ SDKs ](/docs/sdks/)
* [ Configuration ](#configuration)
* [ Usage ](#usage)
* [ API ](#api)
* [ Type Aliases ](#type-aliases)
* [ FAQ ](#faq)
* [ Related Plugins ](#related-plugins)
* [ Newsletter ](#newsletter)
* [ Changelog ](#changelog)
* [ License ](#license)
* [ Contacts ](/docs/sdks/capacitor/contacts/)
* [ Datetime Picker ](/docs/sdks/capacitor/datetime-picker/)
* [ Device Info ](/docs/sdks/capacitor/device-info/)
* [ Dialog ](/docs/sdks/capacitor/dialog/)
* [ Exif ](/docs/sdks/capacitor/exif/)
* [ Facebook Sign-In ](/docs/sdks/capacitor/facebook-sign-in/)
* [ File Compressor ](/docs/sdks/capacitor/file-compressor/)
* [ File Opener ](/docs/sdks/capacitor/file-opener/)
* [ File Picker ](/docs/sdks/capacitor/file-picker/)
* [ Firebase ](/docs/sdks/capacitor/firebase/)
* [ Formbricks ](/docs/sdks/capacitor/formbricks/)
* [ Geocoder ](/docs/sdks/capacitor/geocoder/)
* [ Google Sign-In ](/docs/sdks/capacitor/google-sign-in/)
* [ Grafana Faro ](/docs/sdks/capacitor/grafana-faro/)
* [ Gyroscope ](/docs/sdks/capacitor/gyroscope/)
* [ Haptics ](/docs/sdks/capacitor/haptics/)
* [ Home Indicator ](/docs/sdks/capacitor/home-indicator/)
* [ In-App Browser ](/docs/sdks/capacitor/in-app-browser/)
* [ Install Referrer ](/docs/sdks/capacitor/install-referrer/)
* [ Keep Awake ](/docs/sdks/capacitor/keep-awake/)
* [ libSQL ](/docs/sdks/capacitor/libsql/)
* [ Light Sensor ](/docs/sdks/capacitor/light-sensor/)
* [ Live Update ](/docs/sdks/capacitor/live-update/)
* [ Localization ](/docs/sdks/capacitor/localization/)
* [ Mail Composer ](/docs/sdks/capacitor/mail-composer/)
* [ Managed Configurations ](/docs/sdks/capacitor/managed-configurations/)
* [ Maps Launcher ](/docs/sdks/capacitor/maps-launcher/)
* [ Media Session ](/docs/sdks/capacitor/media-session/)
* [ ML Kit ](/docs/sdks/capacitor/mlkit/)
* [ Navigation Bar ](/docs/sdks/capacitor/navigation-bar/)
* [ Network ](/docs/sdks/capacitor/network/)
* [ NFC ](/docs/sdks/capacitor/nfc/)
* [ Node.js ](/docs/sdks/capacitor/nodejs/)
* [ OAuth ](/docs/sdks/capacitor/oauth/)
* [ Passkeys ](/docs/sdks/capacitor/passkeys/)
* [ Password Autofill ](/docs/sdks/capacitor/password-autofill/)
* [ PDF Generator ](/docs/sdks/capacitor/pdf-generator/)
* [ PDF Viewer ](/docs/sdks/capacitor/pdf-viewer/)
* [ Pedometer ](/docs/sdks/capacitor/pedometer/)
* [ Permissions ](/docs/sdks/capacitor/permissions/)
* [ Phone Dialer ](/docs/sdks/capacitor/phone-dialer/)
* [ Photo Editor ](/docs/sdks/capacitor/photo-editor/)
* [ Photo Manipulator ](/docs/sdks/capacitor/photo-manipulator/)
* [ PixLive ](/docs/sdks/capacitor/pixlive/)
* [ PostHog ](/docs/sdks/capacitor/posthog/)
* [ Printer ](/docs/sdks/capacitor/printer/)
* [ Privacy Screen ](/docs/sdks/capacitor/privacy-screen/)
* [ Proximity Sensor ](/docs/sdks/capacitor/proximity-sensor/)
* [ Purchases ](/docs/sdks/capacitor/purchases/)
* [ RealtimeKit ](/docs/sdks/capacitor/realtimekit/)
* [ Root Detection ](/docs/sdks/capacitor/root-detection/)
* [ Screen Brightness ](/docs/sdks/capacitor/screen-brightness/)
* [ Screen Orientation ](/docs/sdks/capacitor/screen-orientation/)
* [ Screen Reader ](/docs/sdks/capacitor/screen-reader/)
* [ Screenshot ](/docs/sdks/capacitor/screenshot/)
* [ Secure Preferences ](/docs/sdks/capacitor/secure-preferences/)
* [ Settings Launcher ](/docs/sdks/capacitor/settings-launcher/)
* [ Shake ](/docs/sdks/capacitor/shake/)
* [ Silent Mode ](/docs/sdks/capacitor/silent-mode/)
* [ SIM ](/docs/sdks/capacitor/sim/)
* [ SMS Composer ](/docs/sdks/capacitor/sms-composer/)
* [ Speech Recognition ](/docs/sdks/capacitor/speech-recognition/)
* [ Speech Synthesis ](/docs/sdks/capacitor/speech-synthesis/)
* [ Share Target ](/docs/sdks/capacitor/share-target/)
* [ Square Mobile Payments ](/docs/sdks/capacitor/square-mobile-payments/)
* [ SQLite ](/docs/sdks/capacitor/sqlite/)
* [ Superwall ](/docs/sdks/capacitor/superwall/)
* [ System WebView ](/docs/sdks/capacitor/system-webview/)
* [ Text Interaction ](/docs/sdks/capacitor/text-interaction/)
* [ Text Zoom ](/docs/sdks/capacitor/text-zoom/)
* [ Thermal State ](/docs/sdks/capacitor/thermal-state/)
* [ Toast ](/docs/sdks/capacitor/toast/)
* [ Torch ](/docs/sdks/capacitor/torch/)
* [ Vault ](/docs/sdks/capacitor/vault/)
* [ Volume ](/docs/sdks/capacitor/volume/)
* [ Wallet ](/docs/sdks/capacitor/wallet/)
* [ Wifi ](/docs/sdks/capacitor/wifi/)
* [ Zip ](/docs/sdks/capacitor/zip/)
* [ Cordova ](/docs/sdks/cordova/)
* [ Cloud ](/docs/cloud/)
* [ Integrations ](/docs/cloud/live-updates/integrations/)
* Concepts
* Reference
* [ Troubleshooting ](/docs/cloud/live-updates/troubleshooting/)
* [ FAQ ](/docs/cloud/live-updates/faq/)
* [ Native Builds ](/docs/cloud/native-builds/)
* [ Set Up Environments ](/docs/cloud/native-builds/environments/)
* [ Overwrite Native Configurations ](/docs/cloud/native-builds/native-configurations/)
* [ Auto-Increment Build Numbers ](/docs/cloud/native-builds/auto-incrementing-build-numbers/)
* [ Configure the Web Build Script ](/docs/cloud/native-builds/web-build-script/)
* [ Build from a Monorepo ](/docs/cloud/native-builds/monorepo/)
* [ Use pnpm, Yarn, or bun ](/docs/cloud/native-builds/package-managers/)
* [ Install Private npm Packages ](/docs/cloud/native-builds/npm-private-registry/)
* [ Override the Java Version ](/docs/cloud/native-builds/override-java-version/)
* [ Custom iOS Provisioning Profiles ](/docs/cloud/native-builds/custom-ios-provisioning-profiles/)
* [ Build without Git ](/docs/cloud/native-builds/build-without-git/)
* [ Access Git Behind a Firewall ](/docs/cloud/native-builds/firewall-access/)
* [ Integrations ](/docs/cloud/native-builds/integrations/)
* Reference
* [ Troubleshooting ](/docs/cloud/native-builds/troubleshooting/)
* [ FAQ ](/docs/cloud/native-builds/faq/)
* [ App Store Publishing ](/docs/cloud/app-store-publishing/)
* [ Submit a Build ](/docs/cloud/app-store-publishing/submit-a-build/)
* [ Submit Automatically After a Build ](/docs/cloud/app-store-publishing/submit-automatically/)
* [ Troubleshooting ](/docs/cloud/app-store-publishing/troubleshooting/)
* [ FAQ ](/docs/cloud/app-store-publishing/faq/)
* [ Automations ](/docs/cloud/automations/)
* [ Reference ](/docs/cloud/automations/reference/)
* [ Troubleshooting ](/docs/cloud/automations/troubleshooting/)
* [ FAQ ](/docs/cloud/automations/faq/)
* [ Assist ](/docs/cloud/assist/)
* [ CLI ](/docs/cloud/cli/)
* APIs and SDKs
* [ Webhooks ](/docs/cloud/webhooks/)
* [ Integrations ](/docs/cloud/integrations/)
* Account
* [ Organization ](/docs/cloud/organizations/)
* [ Two-Factor Enforcement ](/docs/cloud/organizations/two-factor-authentication/)
* [ Audit Logs ](/docs/cloud/organizations/audit-logs/)
* [ Billing ](/docs/cloud/organizations/billing/)
* [ License Keys ](/docs/cloud/license-keys/)
* [ AI ](/docs/ai/)
* [ Insiders ](/docs/insiders/)
* [ Billing & Plans ](/docs/insiders/billing-and-plans/)
* [ FAQ ](/docs/insiders/faq/)
* [ License ](https://capawesome.io/legal/eula/)
* [ Support ](/docs/support/)
* [ Contributing ](/docs/contributing/)
* Contributing code
* [ Code of Conduct ](/docs/contributing/code-of-conduct/)
* [ Questions ](https://docs.github.com/en/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion#creating-a-discussion)
* [ Blog ](/blog/)
* Categories
* [ Configuration ](#configuration)
* [ Usage ](#usage)
* [ API ](#api)
* [ Type Aliases ](#type-aliases)
* [ FAQ ](#faq)
* [ Related Plugins ](#related-plugins)
* [ Newsletter ](#newsletter)
* [ Changelog ](#changelog)
* [ License ](#license)
# Capacitor Compass Plugin[ΒΆ](#capacitor-compass-plugin "Permanent link")
Capacitor plugin for reading the device compass heading.
[  ](https://cloud.capawesome.io/)
## Features[ΒΆ](#features "Permanent link")
* π§ **Heading**: Read the current compass heading on demand.
* π **Live updates**: Listen for continuous heading changes.
* π **True north**: Read the true (geographic) north heading on iOS.
* π¦ **CocoaPods & SPM**: Supports CocoaPods and Swift Package Manager for iOS.
* π **Up-to-date**: Always supports the latest Capacitor version.
Missing a feature? Just [open an issue](https://github.com/capawesome-team/capacitor-plugins/issues) and we'll take a look!
## Use Cases[ΒΆ](#use-cases "Permanent link")
The Compass plugin is typically used whenever an app needs to know which direction the device is pointing, for example:
* **Compass apps**: Build a classic compass UI that rotates with live heading updates.
* **Navigation**: Rotate a map or show the direction the user is currently facing.
* **Outdoor activities**: Guide hikers or geocachers towards a target bearing.
* **Points of interest**: Point the user towards a fixed geographic direction, such as a landmark or a prayer direction.
## Compatibility[ΒΆ](#compatibility "Permanent link")
| Plugin Version | Capacitor Version | Status |
| -------------- | ----------------- | -------------- |
| 0.x.x | \>=8.x.x | Active support |
## Installation[ΒΆ](#installation "Permanent link")
You can use our **AI-Assisted Setup** to install the plugin. Add the [Capawesome Skills](https://github.com/capawesome-team/skills) to your AI tool using the following command:
`[](#%5F%5Fcodelineno-0-1)npx skills add capawesome-team/skills --skill capacitor-plugins
`
Then use the following prompt:
`` [](#%5F%5Fcodelineno-1-1) Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capawesome/capacitor-compass` plugin in my project.
``
If you prefer **Manual Setup**, install the plugin by running the following commands and follow the platform-specific instructions below:
`[](#%5F%5Fcodelineno-2-1)npm install @capawesome/capacitor-compass
[](#%5F%5Fcodelineno-2-2)npx cap sync
`
This plugin is only available on **Android** and **iOS**. On the Web, all methods reject as unimplemented.
### iOS[ΒΆ](#ios "Permanent link")
#### Privacy Descriptions[ΒΆ](#privacy-descriptions "Permanent link")
The magnetic heading is available without any permission. To also read the true (geographic) north heading, location services must be enabled and the `NSLocationWhenInUseUsageDescription` key must be added to the `Info.plist` file of your app.
`[](#%5F%5Fcodelineno-3-1)NSLocationWhenInUseUsageDescription
[](#%5F%5Fcodelineno-3-2)Your location is used to determine the true (geographic) north heading.
`
If the key is missing or location permission is not granted, the `trueHeading` value is `null`.
## Configuration[ΒΆ](#configuration "Permanent link")
No configuration required for this plugin.
## Usage[ΒΆ](#usage "Permanent link")
The following examples show how to check if the compass sensor is available, read the current heading, and listen for heading changes.
### Check if the compass sensor is available[ΒΆ](#check-if-the-compass-sensor-is-available "Permanent link")
Before reading the heading, you can check whether the device has a compass sensor. Only available on Android and iOS:
`[](#%5F%5Fcodelineno-4-1)import { Compass } from '@capawesome/capacitor-compass';
[](#%5F%5Fcodelineno-4-2)
[](#%5F%5Fcodelineno-4-3)const isAvailable = async () => {
[](#%5F%5Fcodelineno-4-4) const { available } = await Compass.isAvailable();
[](#%5F%5Fcodelineno-4-5) return available;
[](#%5F%5Fcodelineno-4-6)};
`
### Read the current heading[ΒΆ](#read-the-current-heading "Permanent link")
Get the most recent heading reading from the device's compass sensor. The result contains the magnetic heading, the true (geographic) heading if available, and the accuracy. Only available on Android and iOS:
`[](#%5F%5Fcodelineno-5-1)import { Compass } from '@capawesome/capacitor-compass';
[](#%5F%5Fcodelineno-5-2)
[](#%5F%5Fcodelineno-5-3)const getHeading = async () => {
[](#%5F%5Fcodelineno-5-4) const heading = await Compass.getHeading();
[](#%5F%5Fcodelineno-5-5) return heading;
[](#%5F%5Fcodelineno-5-6)};
`
### Listen for heading changes[ΒΆ](#listen-for-heading-changes "Permanent link")
Call `startHeadingUpdates()` to start emitting `headingChange` events and add a listener to receive continuous heading updates, for example to rotate a compass UI. Stop the updates when you no longer need them. Only available on Android and iOS:
`[](#%5F%5Fcodelineno-6-1)import { Compass } from '@capawesome/capacitor-compass';
[](#%5F%5Fcodelineno-6-2)
[](#%5F%5Fcodelineno-6-3)const startHeadingUpdates = async () => {
[](#%5F%5Fcodelineno-6-4) await Compass.startHeadingUpdates();
[](#%5F%5Fcodelineno-6-5)};
[](#%5F%5Fcodelineno-6-6)
[](#%5F%5Fcodelineno-6-7)const addHeadingChangeListener = async () => {
[](#%5F%5Fcodelineno-6-8) await Compass.addListener('headingChange', heading => {
[](#%5F%5Fcodelineno-6-9) console.log(heading);
[](#%5F%5Fcodelineno-6-10) });
[](#%5F%5Fcodelineno-6-11)};
[](#%5F%5Fcodelineno-6-12)
[](#%5F%5Fcodelineno-6-13)const stopHeadingUpdates = async () => {
[](#%5F%5Fcodelineno-6-14) await Compass.stopHeadingUpdates();
[](#%5F%5Fcodelineno-6-15)};
[](#%5F%5Fcodelineno-6-16)
[](#%5F%5Fcodelineno-6-17)const removeAllListeners = async () => {
[](#%5F%5Fcodelineno-6-18) await Compass.removeAllListeners();
[](#%5F%5Fcodelineno-6-19)};
`
## API[ΒΆ](#api "Permanent link")
* [getHeading()](#getheading)
* [isAvailable()](#isavailable)
* [startHeadingUpdates()](#startheadingupdates)
* [stopHeadingUpdates()](#stopheadingupdates)
* [addListener('headingChange', ...)](#addlistenerheadingchange-)
* [removeAllListeners()](#removealllisteners)
* [Interfaces](#interfaces)
* [Type Aliases](#type-aliases)
### getHeading()[ΒΆ](#getheading "Permanent link")
`[](#%5F%5Fcodelineno-7-1)getHeading() => Promise
`
Get the current device heading.
This method returns the most recent heading reading from the device's compass sensor.
Only available on Android and iOS.
**Returns:** `Promise<[Heading](#heading)>`
**Since:** 0.1.0
---
### isAvailable()[ΒΆ](#isavailable "Permanent link")
`[](#%5F%5Fcodelineno-8-1)isAvailable() => Promise
`
Check if the compass sensor is available on the device.
Only available on Android and iOS.
**Returns:** `Promise<[IsAvailableResult](#isavailableresult)>`
**Since:** 0.1.0
---
### startHeadingUpdates()[ΒΆ](#startheadingupdates "Permanent link")
`[](#%5F%5Fcodelineno-9-1)startHeadingUpdates() => Promise
`
Start emitting `headingChange` events.
Only available on Android and iOS.
**Since:** 0.1.0
---
### stopHeadingUpdates()[ΒΆ](#stopheadingupdates "Permanent link")
`[](#%5F%5Fcodelineno-10-1)stopHeadingUpdates() => Promise
`
Stop emitting `headingChange` events.
Only available on Android and iOS.
**Since:** 0.1.0
---
### addListener('headingChange', ...)[ΒΆ](#addlistenerheadingchange "Permanent link")
`[](#%5F%5Fcodelineno-11-1)addListener(eventName: 'headingChange', listenerFunc: (event: HeadingChangeEvent) => void) => Promise
`
Add a listener for heading changes.
Only available on Android and iOS.
| Param | Type |
| ---------------- | ------------------------------------ |
| **eventName** | 'headingChange' |
| **listenerFunc** | (event: [Heading](#heading)) => void |
**Returns:** `Promise<[PluginListenerHandle](#pluginlistenerhandle)>`
**Since:** 0.1.0
---
### removeAllListeners()[ΒΆ](#removealllisteners "Permanent link")
`[](#%5F%5Fcodelineno-12-1)removeAllListeners() => Promise
`
Remove all listeners for this plugin.
Only available on Android and iOS.
**Since:** 0.1.0
---
### Interfaces[ΒΆ](#interfaces "Permanent link")
#### Heading[ΒΆ](#heading "Permanent link")
| Prop | Type | Description | Since |
| ------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- |
| **accuracy** | number \| null | The maximum deviation between the reported heading and the true heading in degrees. A negative value or null indicates that the accuracy is invalid or unknown. | 0.1.0 |
| **magneticHeading** | number | The heading relative to magnetic north in degrees. The value ranges from 0 to 360, where 0 means the device is pointing towards magnetic north. | 0.1.0 |
| **trueHeading** | number \| null | The heading relative to true (geographic) north in degrees. The value ranges from 0 to 360, where 0 means the device is pointing towards true north. Returns null if the true heading cannot be determined. On Android, this value is always null. On iOS, this value requires location services to be enabled and the NSLocationWhenInUseUsageDescription key to be set. Otherwise, it is null. | 0.1.0 |
#### IsAvailableResult[ΒΆ](#isavailableresult "Permanent link")
| Prop | Type | Description | Since |
| ------------- | ------- | ------------------------------------------------------ | ----- |
| **available** | boolean | Whether the compass sensor is available on the device. | 0.1.0 |
#### PluginListenerHandle[ΒΆ](#pluginlistenerhandle "Permanent link")
| Prop | Type |
| ---------- | ------------------- |
| **remove** | () => Promise |
### Type Aliases[ΒΆ](#type-aliases "Permanent link")
#### GetHeadingResult[ΒΆ](#getheadingresult "Permanent link")
`[Heading](#heading)`
#### HeadingChangeEvent[ΒΆ](#headingchangeevent "Permanent link")
`[Heading](#heading)`
## FAQ[ΒΆ](#faq "Permanent link")
### How is this plugin different from other similar plugins?[ΒΆ](#how-is-this-plugin-different-from-other-similar-plugins "Permanent link")
It reads the device compass heading both on demand and as a continuous stream of updates, returning the magnetic heading, the accuracy, and β on iOS with location services β the true geographic heading. An `isAvailable()` check lets you confirm the sensor is present before you rely on it, and the whole surface is fully typed. It supports CocoaPods and Swift Package Manager on iOS and is actively maintained against the latest Capacitor version, giving you consistent heading data across Android and iOS.
### What is the difference between the magnetic heading and the true heading?[ΒΆ](#what-is-the-difference-between-the-magnetic-heading-and-the-true-heading "Permanent link")
The `magneticHeading` value is the heading relative to magnetic north, while the `trueHeading` value is the heading relative to true (geographic) north. Both range from `0` to `360` degrees. The magnetic heading is always available, whereas the true heading can only be determined on iOS and may be `null`.
### Why is the `trueHeading` value always `null`?[ΒΆ](#why-is-the-trueheading-value-always-null "Permanent link")
On Android, the true heading is not supported and the value is always `null`. On iOS, reading the true heading requires location services to be enabled and the `NSLocationWhenInUseUsageDescription` key to be added to your app's `Info.plist` file, as described in the [Installation](#installation) section. If the key is missing or location permission is not granted, the value is `null`.
### Does this plugin work on the Web?[ΒΆ](#does-this-plugin-work-on-the-web "Permanent link")
No, this plugin is only available on Android and iOS. On the Web, all methods reject as unimplemented. You can use the `isAvailable()` method to check whether the compass sensor is available on the current device.
### Do I need any permissions to read the compass heading?[ΒΆ](#do-i-need-any-permissions-to-read-the-compass-heading "Permanent link")
The magnetic heading is available without any permission on both Android and iOS. Only if you also want to read the true (geographic) north heading on iOS, location services must be enabled and the `NSLocationWhenInUseUsageDescription` key must be present in your `Info.plist` file.
### Can I use this plugin with Ionic, React, Vue or Angular?[ΒΆ](#can-i-use-this-plugin-with-ionic-react-vue-or-angular "Permanent link")
Yes, the plugin is framework-agnostic. It works in any Capacitor app regardless of the web framework, including Ionic with Angular, React, or Vue, as well as plain JavaScript projects.
## Related Plugins[ΒΆ](#related-plugins "Permanent link")
* [Accelerometer](https://capawesome.io/docs/sdks/capacitor/accelerometer/): Capture the acceleration force along the x, y, and z axes.
* [Gyroscope](https://capawesome.io/docs/sdks/capacitor/gyroscope/): Read the device's gyroscope sensor.
* [Barometer](https://capawesome.io/docs/sdks/capacitor/barometer/): Obtain the static air pressure measured in hectopascals.
## Newsletter[ΒΆ](#newsletter "Permanent link")
Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our [Capawesome Newsletter](https://cloud.capawesome.io/newsletter/).
## Changelog[ΒΆ](#changelog "Permanent link")
See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/compass/CHANGELOG.md).
## License[ΒΆ](#license "Permanent link")
See [LICENSE](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/compass/LICENSE).
July 8, 2026
Back to top
```json
{"@context": "https://schema.org", "@graph": [{"@type": "TechArticle", "@id": "https://capawesome.io/docs/sdks/capacitor/compass/#article", "headline": "Capacitor Compass Plugin for Android & iOS", "name": "Capacitor Compass Plugin for Android & iOS", "description": "Capacitor plugin to read the device compass heading on Android and iOS. Get the current heading, listen for live updates, and read true north on iOS.", "inLanguage": "en", "url": "https://capawesome.io/docs/sdks/capacitor/compass/", "mainEntityOfPage": "https://capawesome.io/docs/sdks/capacitor/compass/", "author": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "publisher": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "about": {"@id": "https://capawesome.io/docs/sdks/capacitor/compass/#software"}}, {"@type": "SoftwareSourceCode", "@id": "https://capawesome.io/docs/sdks/capacitor/compass/#software", "name": "Capacitor Compass Plugin for Android & iOS", "description": "Capacitor plugin to read the device compass heading on Android and iOS. Get the current heading, listen for live updates, and read true north on iOS.", "url": "https://capawesome.io/docs/sdks/capacitor/compass/", "programmingLanguage": "TypeScript", "runtimePlatform": "Capacitor", "codeRepository": "https://github.com/capawesome-team", "author": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "publisher": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}}]}
{"@context": "https://schema.org", "@type": "FAQPage", "mainEntity": [{"@type": "Question", "name": "How is this plugin different from other similar plugins?", "acceptedAnswer": {"@type": "Answer", "text": "It reads the device compass heading both on demand and as a continuous stream of updates, returning the magnetic heading, the accuracy, and β on iOS with location services β the true geographic heading. An isAvailable() check lets you confirm the sensor is present before you rely on it, and the whole surface is fully typed. It supports CocoaPods and Swift Package Manager on iOS and is actively maintained against the latest Capacitor version, giving you consistent heading data across Android and iOS."}}, {"@type": "Question", "name": "What is the difference between the magnetic heading and the true heading?", "acceptedAnswer": {"@type": "Answer", "text": "The magneticHeading value is the heading relative to magnetic north, while the trueHeading value is the heading relative to true (geographic) north. Both range from 0 to 360 degrees. The magnetic heading is always available, whereas the true heading can only be determined on iOS and may be null."}}, {"@type": "Question", "name": "Why is the trueHeading value always null?", "acceptedAnswer": {"@type": "Answer", "text": "On Android, the true heading is not supported and the value is always null. On iOS, reading the true heading requires location services to be enabled and the NSLocationWhenInUseUsageDescription key to be added to your app's Info.plist file, as described in the Installation section. If the key is missing or location permission is not granted, the value is null."}}, {"@type": "Question", "name": "Does this plugin work on the Web?", "acceptedAnswer": {"@type": "Answer", "text": "No, this plugin is only available on Android and iOS. On the Web, all methods reject as unimplemented. You can use the isAvailable() method to check whether the compass sensor is available on the current device."}}, {"@type": "Question", "name": "Do I need any permissions to read the compass heading?", "acceptedAnswer": {"@type": "Answer", "text": "The magnetic heading is available without any permission on both Android and iOS. Only if you also want to read the true (geographic) north heading on iOS, location services must be enabled and the NSLocationWhenInUseUsageDescription key must be present in your Info.plist file."}}, {"@type": "Question", "name": "Can I use this plugin with Ionic, React, Vue or Angular?", "acceptedAnswer": {"@type": "Answer", "text": "Yes, the plugin is framework-agnostic. It works in any Capacitor app regardless of the web framework, including Ionic with Angular, React, or Vue, as well as plain JavaScript projects."}}], "url": "https://capawesome.io/docs/sdks/capacitor/compass/"}
```