--- 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 the **Capacitor Vault** plugin β€” store secrets behind biometrics or a device passcode. ](/blog/announcing-the-capacitor-vault-plugin/) * [ 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) * [ Changelog ](#changelog) * [ License ](#license) * [ 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/) * [ 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/) * [ 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/) * [ Pedometer ](/docs/sdks/capacitor/pedometer/) * [ Photo Editor ](/docs/sdks/capacitor/photo-editor/) * [ PixLive ](/docs/sdks/capacitor/pixlive/) * [ PostHog ](/docs/sdks/capacitor/posthog/) * [ Printer ](/docs/sdks/capacitor/printer/) * [ Privacy Screen ](/docs/sdks/capacitor/privacy-screen/) * [ 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/) * [ Screenshot ](/docs/sdks/capacitor/screenshot/) * [ Secure Preferences ](/docs/sdks/capacitor/secure-preferences/) * [ 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/) * [ Thermal State ](/docs/sdks/capacitor/thermal-state/) * [ 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 * [ iOS ](#ios) * [ Configuration ](#configuration) * [ Usage ](#usage) * [ API ](#api) * [ Type Aliases ](#type-aliases) * [ 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") We are proud to offer one of the most complete and feature-rich Capacitor plugins for gyroscope measurements. 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. * πŸ“¦ **CocoaPods & SPM**: Supports CocoaPods and Swift Package Manager for iOS. * πŸ” **Up-to-date**: Always supports the latest Capacitor version. * 🀝 **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. Missing a feature? Just [open an issue](https://github.com/capawesome-team/capacitor-plugins/issues) and we'll take a look! ## 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/). ## 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-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") `[](#%5F%5Fcodelineno-5-1)import { Gyroscope } from '@capawesome/capacitor-gyroscope'; [](#%5F%5Fcodelineno-5-2) [](#%5F%5Fcodelineno-5-3)const getMeasurement = async () => { [](#%5F%5Fcodelineno-5-4) const measurement = await Gyroscope.getMeasurement(); [](#%5F%5Fcodelineno-5-5) console.log('X: ', measurement.x); [](#%5F%5Fcodelineno-5-6) console.log('Y: ', measurement.y); [](#%5F%5Fcodelineno-5-7) console.log('Z: ', measurement.z); [](#%5F%5Fcodelineno-5-8)}; [](#%5F%5Fcodelineno-5-9) [](#%5F%5Fcodelineno-5-10)const isAvailable = async () => { [](#%5F%5Fcodelineno-5-11) const result = await Gyroscope.isAvailable(); [](#%5F%5Fcodelineno-5-12) return result.isAvailable; [](#%5F%5Fcodelineno-5-13)}; [](#%5F%5Fcodelineno-5-14) [](#%5F%5Fcodelineno-5-15)const startMeasurementUpdates = async () => { [](#%5F%5Fcodelineno-5-16) await Gyroscope.addListener('measurement', measurement => { [](#%5F%5Fcodelineno-5-17) console.log('X: ', measurement.x); [](#%5F%5Fcodelineno-5-18) console.log('Y: ', measurement.y); [](#%5F%5Fcodelineno-5-19) console.log('Z: ', measurement.z); [](#%5F%5Fcodelineno-5-20) }); [](#%5F%5Fcodelineno-5-21) await Gyroscope.startMeasurementUpdates(); [](#%5F%5Fcodelineno-5-22)}; [](#%5F%5Fcodelineno-5-23) [](#%5F%5Fcodelineno-5-24)const stopMeasurementUpdates = async () => { [](#%5F%5Fcodelineno-5-25) await Gyroscope.stopMeasurementUpdates(); [](#%5F%5Fcodelineno-5-26)}; [](#%5F%5Fcodelineno-5-27) [](#%5F%5Fcodelineno-5-28)const checkPermissions = async () => { [](#%5F%5Fcodelineno-5-29) const result = await Gyroscope.checkPermissions(); [](#%5F%5Fcodelineno-5-30) return result; [](#%5F%5Fcodelineno-5-31)}; [](#%5F%5Fcodelineno-5-32) [](#%5F%5Fcodelineno-5-33)const requestPermissions = async () => { [](#%5F%5Fcodelineno-5-34) const result = await Gyroscope.requestPermissions(); [](#%5F%5Fcodelineno-5-35) return result; [](#%5F%5Fcodelineno-5-36)}; [](#%5F%5Fcodelineno-5-37) [](#%5F%5Fcodelineno-5-38)const removeAllListeners = async () => { [](#%5F%5Fcodelineno-5-39) await Gyroscope.removeAllListeners(); [](#%5F%5Fcodelineno-5-40)}; ` ## API[ΒΆ](#api "Permanent link") * [addListener('measurement', ...)](#addlistenermeasurement-) * [checkPermissions()](#checkpermissions) * [getMeasurement()](#getmeasurement) * [isAvailable()](#isavailable) * [removeAllListeners()](#removealllisteners) * [requestPermissions()](#requestpermissions) * [startMeasurementUpdates()](#startmeasurementupdates) * [stopMeasurementUpdates()](#stopmeasurementupdates) * [Interfaces](#interfaces) * [Type Aliases](#type-aliases) ### addListener('measurement', ...)[ΒΆ](#addlistenermeasurement "Permanent link") `[](#%5F%5Fcodelineno-6-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 --- ### checkPermissions()[ΒΆ](#checkpermissions "Permanent link") `[](#%5F%5Fcodelineno-7-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-8-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-9-1)isAvailable() => Promise ` Check if the gyroscope sensor is available on the device. **Returns:** `Promise<[IsAvailableResult](#isavailableresult)>` **Since:** 0.1.0 --- ### removeAllListeners()[ΒΆ](#removealllisteners "Permanent link") `[](#%5F%5Fcodelineno-10-1)removeAllListeners() => Promise ` Remove all listeners for this plugin. **Since:** 0.1.0 --- ### requestPermissions()[ΒΆ](#requestpermissions "Permanent link") `[](#%5F%5Fcodelineno-11-1)requestPermissions() => Promise ` Request permission to access the gyroscope sensor. **Returns:** `Promise<[PermissionStatus](#permissionstatus)>` **Since:** 0.1.0 --- ### startMeasurementUpdates()[ΒΆ](#startmeasurementupdates "Permanent link") `[](#%5F%5Fcodelineno-12-1)startMeasurementUpdates() => Promise ` Start emitting `measurement` events. **Since:** 0.1.0 --- ### stopMeasurementUpdates()[ΒΆ](#stopmeasurementupdates "Permanent link") `[](#%5F%5Fcodelineno-13-1)stopMeasurementUpdates() => Promise ` Stop emitting `measurement` events. **Since:** 0.1.0 --- ### Interfaces[ΒΆ](#interfaces "Permanent link") #### PluginListenerHandle[ΒΆ](#pluginlistenerhandle "Permanent link") | Prop | Type | | ---------- | ------------------- | | **remove** | () => Promise | #### 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 | #### PermissionStatus[ΒΆ](#permissionstatus "Permanent link") | Prop | Type | Description | Since | | ------------- | ----------------------------------------------------- | ---------------------------------------------- | ----- | | **gyroscope** | [GyroscopePermissionState](#gyroscopepermissionstate) | The permission status of the gyroscope sensor. | 0.1.0 | #### IsAvailableResult[ΒΆ](#isavailableresult "Permanent link") | Prop | Type | Description | Since | | --------------- | ------- | -------------------------------------------------------- | ----- | | **isAvailable** | boolean | Whether the gyroscope sensor is available on the device. | 0.1.0 | ### Type Aliases[ΒΆ](#type-aliases "Permanent link") #### MeasurementEvent[ΒΆ](#measurementevent "Permanent link") `[Measurement](#measurement)` #### GyroscopePermissionState[ΒΆ](#gyroscopepermissionstate "Permanent link") `[PermissionState](#permissionstate) | 'limited'` #### PermissionState[ΒΆ](#permissionstate "Permanent link") `'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'` #### GetMeasurementResult[ΒΆ](#getmeasurementresult "Permanent link") `[Measurement](#measurement)` ## 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 7, 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"}}}]} ```