--- description: Capacitor plugin to read the device's gyroscope sensor with real-time rotation rate measurements. Supports Android, iOS, and the web. title: Capacitor Gyroscope Plugin - Capawesome image: https://capawesome.io/docs/assets/images/social/sdks/capacitor/gyroscope.png --- [Skip to content ](#capacitor-gyroscope-plugin) [πŸ“² Introducing **Build Sharing** β€” get your builds onto testers' devices with a link & QR code. No account required. ](/blog/share-mobile-app-builds-with-testers/) * [ SDKs ](/docs/sdks/) * [ 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 [ Gyroscope ](/docs/sdks/capacitor/gyroscope/) * [ iOS ](#ios) * [ Configuration ](#configuration) * [ Usage ](#usage) * [ API ](#api) * [ Type Aliases ](#type-aliases) * [ FAQ ](#faq) * [ Related Plugins ](#related-plugins) * [ Newsletter ](#newsletter) * [ Changelog ](#changelog) * [ License ](#license) * [ 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/) * [ Intercom ](/docs/sdks/capacitor/intercom/) * [ Intune ](/docs/sdks/capacitor/intune/) * [ 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/) * [ Tauri ](/docs/sdks/capacitor/tauri/) * [ 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/) * [ YouTube Player ](/docs/sdks/capacitor/youtube-player/) * [ 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/) * Notifications * 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 * [ iOS ](#ios) * [ Configuration ](#configuration) * [ Usage ](#usage) * [ API ](#api) * [ Type Aliases ](#type-aliases) * [ FAQ ](#faq) * [ Related Plugins ](#related-plugins) * [ Newsletter ](#newsletter) * [ Changelog ](#changelog) * [ License ](#license) # Capacitor Gyroscope Plugin[ΒΆ](#capacitor-gyroscope-plugin "Permanent link") Capacitor plugin to read the device's gyroscope sensor. [ ![Deliver Live Updates to your Capacitor app with Capawesome Cloud](../../../assets/external/cloud.capawesome.io/assets/banners/cloud-build-and-deploy-capacitor-apps.69628c3f.png) ](https://cloud.capawesome.io/) ## Features[ΒΆ](#features "Permanent link") The Capacitor Gyroscope plugin is one of the most complete motion sensing solutions for Capacitor apps. Here are some of the key features: * πŸ–₯️ **Cross-platform**: Supports Android and iOS. * ⚑ **Real-time measurements**: Continuous gyroscope data with event listeners. * πŸ“Š **Rotation rate**: Accurate x, y, and z-axis rotation rate in rad/s. * πŸ”’ **Permission handling**: Built-in permission management for sensor access. * 🀝 **Compatibility**: Works alongside the [Accelerometer](https://capawesome.io/docs/sdks/capacitor/accelerometer/), [Barometer](https://capawesome.io/docs/sdks/capacitor/barometer/) and [Pedometer](https://capawesome.io/docs/sdks/capacitor/pedometer/) plugins. * πŸ“¦ **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 Gyroscope plugin is typically used whenever an app needs to react to the rotation of the device, for example: * **Motion-controlled games**: Use the real-time rotation rate to steer a character or vehicle by tilting the device. * **Immersive experiences**: Rotate 360Β° views or augmented reality scenes based on the device's rotation. * **Gesture detection**: Detect rotation gestures such as twisting the device to trigger actions in your app. * **Motion analysis**: Record the rotation rate around the x, y, and z axes to analyze movement patterns. ## Compatibility[ΒΆ](#compatibility "Permanent link") | Plugin Version | Capacitor Version | Status | | -------------- | ----------------- | -------------- | | 0.x.x | \>=8.x.x | Active support | ## Guides[ΒΆ](#guides "Permanent link") * [The Complete Guide to Capacitor Device Sensors](https://capawesome.io/blog/capacitor-device-sensors-guide/): How rotation data powers tilt-to-steer game mechanics and AR features together with the Accelerometer. ## 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-gyroscope` 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-gyroscope [](#%5F%5Fcodelineno-2-2)npx cap sync ` ### Android[ΒΆ](#android "Permanent link") #### Proguard[ΒΆ](#proguard "Permanent link") If you are using Proguard, you need to add the following rules to your `proguard-rules.pro` file: `[](#%5F%5Fcodelineno-3-1)-keep class io.capawesome.capacitorjs.plugins.** { *; } ` ### iOS[ΒΆ](#ios "Permanent link") #### Privacy Descriptions[ΒΆ](#privacy-descriptions "Permanent link") Add the `NSMotionUsageDescription` key to the `ios/App/App/Info.plist` file, which tells the user why your app needs access to the device's motion data: `[](#%5F%5Fcodelineno-4-1)NSMotionUsageDescription [](#%5F%5Fcodelineno-4-2)The app needs to access the motion activity. ` ## Configuration[ΒΆ](#configuration "Permanent link") No configuration required for this plugin. ## Usage[ΒΆ](#usage "Permanent link") The following examples show how to check if the gyroscope is available, get a single measurement, receive continuous measurement updates, check and request permissions, and remove all listeners. ### Check if the gyroscope is available[ΒΆ](#check-if-the-gyroscope-is-available "Permanent link") Check whether the device has a gyroscope sensor before using the other methods: `[](#%5F%5Fcodelineno-5-1)import { Gyroscope } from '@capawesome/capacitor-gyroscope'; [](#%5F%5Fcodelineno-5-2) [](#%5F%5Fcodelineno-5-3)const isAvailable = async () => { [](#%5F%5Fcodelineno-5-4) const result = await Gyroscope.isAvailable(); [](#%5F%5Fcodelineno-5-5) return result.available; [](#%5F%5Fcodelineno-5-6)}; ` ### Get a single measurement[ΒΆ](#get-a-single-measurement "Permanent link") Get the most recent measurement from the gyroscope sensor. The rotation rate around the x, y, and z axes is reported in radians per second (rad/s): `[](#%5F%5Fcodelineno-6-1)import { Gyroscope } from '@capawesome/capacitor-gyroscope'; [](#%5F%5Fcodelineno-6-2) [](#%5F%5Fcodelineno-6-3)const getMeasurement = async () => { [](#%5F%5Fcodelineno-6-4) const measurement = await Gyroscope.getMeasurement(); [](#%5F%5Fcodelineno-6-5) console.log('X: ', measurement.x); [](#%5F%5Fcodelineno-6-6) console.log('Y: ', measurement.y); [](#%5F%5Fcodelineno-6-7) console.log('Z: ', measurement.z); [](#%5F%5Fcodelineno-6-8)}; ` ### Receive continuous measurement updates[ΒΆ](#receive-continuous-measurement-updates "Permanent link") Add a listener for the `measurement` event and start the measurement updates to receive the rotation rate in real time. The `measurement` event is only available on Android and iOS: `[](#%5F%5Fcodelineno-7-1)import { Gyroscope } from '@capawesome/capacitor-gyroscope'; [](#%5F%5Fcodelineno-7-2) [](#%5F%5Fcodelineno-7-3)const startMeasurementUpdates = async () => { [](#%5F%5Fcodelineno-7-4) await Gyroscope.addListener('measurement', measurement => { [](#%5F%5Fcodelineno-7-5) console.log('X: ', measurement.x); [](#%5F%5Fcodelineno-7-6) console.log('Y: ', measurement.y); [](#%5F%5Fcodelineno-7-7) console.log('Z: ', measurement.z); [](#%5F%5Fcodelineno-7-8) }); [](#%5F%5Fcodelineno-7-9) await Gyroscope.startMeasurementUpdates(); [](#%5F%5Fcodelineno-7-10)}; [](#%5F%5Fcodelineno-7-11) [](#%5F%5Fcodelineno-7-12)const stopMeasurementUpdates = async () => { [](#%5F%5Fcodelineno-7-13) await Gyroscope.stopMeasurementUpdates(); [](#%5F%5Fcodelineno-7-14)}; ` ### Check and request permissions[ΒΆ](#check-and-request-permissions "Permanent link") Check and request the permission to access the gyroscope sensor: `[](#%5F%5Fcodelineno-8-1)import { Gyroscope } from '@capawesome/capacitor-gyroscope'; [](#%5F%5Fcodelineno-8-2) [](#%5F%5Fcodelineno-8-3)const checkPermissions = async () => { [](#%5F%5Fcodelineno-8-4) const result = await Gyroscope.checkPermissions(); [](#%5F%5Fcodelineno-8-5) return result; [](#%5F%5Fcodelineno-8-6)}; [](#%5F%5Fcodelineno-8-7) [](#%5F%5Fcodelineno-8-8)const requestPermissions = async () => { [](#%5F%5Fcodelineno-8-9) const result = await Gyroscope.requestPermissions(); [](#%5F%5Fcodelineno-8-10) return result; [](#%5F%5Fcodelineno-8-11)}; ` ### Remove all listeners[ΒΆ](#remove-all-listeners "Permanent link") Remove all listeners when you no longer need them: `[](#%5F%5Fcodelineno-9-1)import { Gyroscope } from '@capawesome/capacitor-gyroscope'; [](#%5F%5Fcodelineno-9-2) [](#%5F%5Fcodelineno-9-3)const removeAllListeners = async () => { [](#%5F%5Fcodelineno-9-4) await Gyroscope.removeAllListeners(); [](#%5F%5Fcodelineno-9-5)}; ` ## API[ΒΆ](#api "Permanent link") * [checkPermissions()](#checkpermissions) * [getMeasurement()](#getmeasurement) * [isAvailable()](#isavailable) * [requestPermissions()](#requestpermissions) * [startMeasurementUpdates()](#startmeasurementupdates) * [stopMeasurementUpdates()](#stopmeasurementupdates) * [addListener('measurement', ...)](#addlistenermeasurement-) * [removeAllListeners()](#removealllisteners) * [Interfaces](#interfaces) * [Type Aliases](#type-aliases) ### checkPermissions()[ΒΆ](#checkpermissions "Permanent link") `[](#%5F%5Fcodelineno-10-1)checkPermissions() => Promise ` Check if the app has permission to access the gyroscope sensor. **Returns:** `Promise<[PermissionStatus](#permissionstatus)>` **Since:** 0.1.0 --- ### getMeasurement()[ΒΆ](#getmeasurement "Permanent link") `[](#%5F%5Fcodelineno-11-1)getMeasurement() => Promise ` Get the latest measurement. This method returns the most recent measurement from the gyroscope sensor. **Returns:** `Promise<[Measurement](#measurement)>` **Since:** 0.1.0 --- ### isAvailable()[ΒΆ](#isavailable "Permanent link") `[](#%5F%5Fcodelineno-12-1)isAvailable() => Promise ` Check if the gyroscope sensor is available on the device. **Returns:** `Promise<[IsAvailableResult](#isavailableresult)>` **Since:** 0.1.0 --- ### requestPermissions()[ΒΆ](#requestpermissions "Permanent link") `[](#%5F%5Fcodelineno-13-1)requestPermissions() => Promise ` Request permission to access the gyroscope sensor. **Returns:** `Promise<[PermissionStatus](#permissionstatus)>` **Since:** 0.1.0 --- ### startMeasurementUpdates()[ΒΆ](#startmeasurementupdates "Permanent link") `[](#%5F%5Fcodelineno-14-1)startMeasurementUpdates() => Promise ` Start emitting `measurement` events. **Since:** 0.1.0 --- ### stopMeasurementUpdates()[ΒΆ](#stopmeasurementupdates "Permanent link") `[](#%5F%5Fcodelineno-15-1)stopMeasurementUpdates() => Promise ` Stop emitting `measurement` events. **Since:** 0.1.0 --- ### addListener('measurement', ...)[ΒΆ](#addlistenermeasurement "Permanent link") `[](#%5F%5Fcodelineno-16-1)addListener(eventName: 'measurement', listenerFunc: (event: MeasurementEvent) => void) => Promise ` Called when a new measurement is available. Only available on Android and iOS. | Param | Type | | ---------------- | -------------------------------------------- | | **eventName** | 'measurement' | | **listenerFunc** | (event: [Measurement](#measurement)) => void | **Returns:** `Promise<[PluginListenerHandle](#pluginlistenerhandle)>` **Since:** 0.1.0 --- ### removeAllListeners()[ΒΆ](#removealllisteners "Permanent link") `[](#%5F%5Fcodelineno-17-1)removeAllListeners() => Promise ` Remove all listeners for this plugin. **Since:** 0.1.0 --- ### Interfaces[ΒΆ](#interfaces "Permanent link") #### PermissionStatus[ΒΆ](#permissionstatus "Permanent link") | Prop | Type | Description | Since | | ------------- | ----------------------------------------------------- | ---------------------------------------------- | ----- | | **gyroscope** | [GyroscopePermissionState](#gyroscopepermissionstate) | The permission status of the gyroscope sensor. | 0.1.0 | #### Measurement[ΒΆ](#measurement "Permanent link") | Prop | Type | Description | Since | | ----- | ------ | ------------------------------------------------------------------ | ----- | | **x** | number | The rotation rate around the x-axis in radians per second (rad/s). | 0.1.0 | | **y** | number | The rotation rate around the y-axis in radians per second (rad/s). | 0.1.0 | | **z** | number | The rotation rate around the z-axis in radians per second (rad/s). | 0.1.0 | #### IsAvailableResult[ΒΆ](#isavailableresult "Permanent link") | Prop | Type | Description | Since | | ------------- | ------- | -------------------------------------------------------- | ----- | | **available** | boolean | Whether the gyroscope sensor is available on the device. | 0.1.0 | #### PluginListenerHandle[ΒΆ](#pluginlistenerhandle "Permanent link") | Prop | Type | | ---------- | ------------------- | | **remove** | () => Promise | ### Type Aliases[ΒΆ](#type-aliases "Permanent link") #### GyroscopePermissionState[ΒΆ](#gyroscopepermissionstate "Permanent link") `[PermissionState](#permissionstate) | 'limited'` #### PermissionState[ΒΆ](#permissionstate "Permanent link") `'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'` #### GetMeasurementResult[ΒΆ](#getmeasurementresult "Permanent link") `[Measurement](#measurement)` #### MeasurementEvent[ΒΆ](#measurementevent "Permanent link") `[Measurement](#measurement)` ## 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 delivers accurate x, y, and z-axis rotation rate in rad/s with both one-off readings via `getMeasurement()` and continuous real-time updates via the `measurement` event, plus built-in permission handling for sensor access on Android and iOS. The API is fully typed and actively maintained against the latest Capacitor and OS versions, and it pairs cleanly with our Accelerometer, Barometer, and Pedometer plugins so a single, consistent motion-sensing story is covered. If you only need an occasional reading, a simpler setup is perfectly fine; if you need continuous, low-level rotation data, this plugin is built for exactly that. ### Which platforms does the plugin support?[ΒΆ](#which-platforms-does-the-plugin-support "Permanent link") The plugin supports Android and iOS. The continuous `measurement` event is only emitted on Android and iOS, so there is no gyroscope support in the browser. ### What units are the measurements reported in?[ΒΆ](#what-units-are-the-measurements-reported-in "Permanent link") Each measurement contains the rotation rate around the x, y, and z axes in radians per second (rad/s). ### What is the difference between `getMeasurement` and the `measurement` event?[ΒΆ](#what-is-the-difference-between-getmeasurement-and-the-measurement-event "Permanent link") The `getMeasurement()` method returns the most recent measurement from the gyroscope sensor once. If you need continuous real-time updates instead, add a listener for the `measurement` event and call `startMeasurementUpdates()`. Call `stopMeasurementUpdates()` when you no longer need updates. ### Do I need any permissions to read the gyroscope?[ΒΆ](#do-i-need-any-permissions-to-read-the-gyroscope "Permanent link") The plugin provides the `checkPermissions()` and `requestPermissions()` methods to manage access to the gyroscope sensor. On iOS, you also have to add the `NSMotionUsageDescription` key to your `Info.plist` file, which tells the user why your app needs access to the device's motion data (see [Installation](#installation)). ### How do I know if the device has a gyroscope sensor?[ΒΆ](#how-do-i-know-if-the-device-has-a-gyroscope-sensor "Permanent link") Call the `isAvailable()` method. It returns whether the gyroscope sensor is available on the device, so you can hide or disable motion features on devices without a gyroscope. ### 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. * [Barometer](https://capawesome.io/docs/sdks/capacitor/barometer/): Obtain the static air pressure measured in hectopascals (hPa). * [Compass](https://capawesome.io/docs/sdks/capacitor/compass/): Read the device compass heading. * [Pedometer](https://capawesome.io/docs/sdks/capacitor/pedometer/): Retrieve motion data such as the number of steps and the distance traveled. ## 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/gyroscope/CHANGELOG.md). ## License[ΒΆ](#license "Permanent link") See [LICENSE](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/gyroscope/LICENSE). July 8, 2026 Back to top ```json {"@context": "https://schema.org", "@graph": [{"@type": "TechArticle", "@id": "https://capawesome.io/docs/sdks/capacitor/gyroscope/#article", "headline": "Capacitor Gyroscope Plugin", "name": "Capacitor Gyroscope Plugin", "description": "Capacitor plugin to read the device's gyroscope sensor with real-time rotation rate measurements. Supports Android, iOS, and the web.", "inLanguage": "en", "url": "https://capawesome.io/docs/sdks/capacitor/gyroscope/", "mainEntityOfPage": "https://capawesome.io/docs/sdks/capacitor/gyroscope/", "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/gyroscope/#software"}}, {"@type": "SoftwareSourceCode", "@id": "https://capawesome.io/docs/sdks/capacitor/gyroscope/#software", "name": "Capacitor Gyroscope Plugin", "description": "Capacitor plugin to read the device's gyroscope sensor with real-time rotation rate measurements. Supports Android, iOS, and the web.", "url": "https://capawesome.io/docs/sdks/capacitor/gyroscope/", "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 delivers accurate x, y, and z-axis rotation rate in rad/s with both one-off readings via getMeasurement() and continuous real-time updates via the measurement event, plus built-in permission handling for sensor access on Android and iOS. The API is fully typed and actively maintained against the latest Capacitor and OS versions, and it pairs cleanly with our Accelerometer, Barometer, and Pedometer plugins so a single, consistent motion-sensing story is covered. If you only need an occasional reading, a simpler setup is perfectly fine; if you need continuous, low-level rotation data, this plugin is built for exactly that."}}, {"@type": "Question", "name": "Which platforms does the plugin support?", "acceptedAnswer": {"@type": "Answer", "text": "The plugin supports Android and iOS. The continuous measurement event is only emitted on Android and iOS, so there is no gyroscope support in the browser."}}, {"@type": "Question", "name": "What units are the measurements reported in?", "acceptedAnswer": {"@type": "Answer", "text": "Each measurement contains the rotation rate around the x, y, and z axes in radians per second (rad/s)."}}, {"@type": "Question", "name": "What is the difference between getMeasurement and the measurement event?", "acceptedAnswer": {"@type": "Answer", "text": "The getMeasurement() method returns the most recent measurement from the gyroscope sensor once. If you need continuous real-time updates instead, add a listener for the measurement event and call startMeasurementUpdates(). Call stopMeasurementUpdates() when you no longer need updates."}}, {"@type": "Question", "name": "Do I need any permissions to read the gyroscope?", "acceptedAnswer": {"@type": "Answer", "text": "The plugin provides the checkPermissions() and requestPermissions() methods to manage access to the gyroscope sensor. On iOS, you also have to add the NSMotionUsageDescription key to your Info.plist file, which tells the user why your app needs access to the device's motion data (see Installation)."}}, {"@type": "Question", "name": "How do I know if the device has a gyroscope sensor?", "acceptedAnswer": {"@type": "Answer", "text": "Call the isAvailable() method. It returns whether the gyroscope sensor is available on the device, so you can hide or disable motion features on devices without a gyroscope."}}, {"@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/gyroscope/"} ```