@capawesome/capacitor-gyroscope 0.0.1

package/CapawesomeCapacitorGyroscope.podspec

@@ -0,0 +1,17 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name = 'CapawesomeCapacitorGyroscope'
+  s.version = package['version']
+  s.summary = package['description']
+  s.license = package['license']
+  s.homepage = package['repository']['url']
+  s.author = package['author']
+  s.source = { :git => package['repository']['url'], :tag => s.version.to_s }
+  s.source_files = 'ios/Plugin/**/*.{swift,h,m,c,cc,mm,cpp}'
+  s.ios.deployment_target = '15.0'
+  s.dependency 'Capacitor'
+  s.swift_version = '5.1'
+end

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Robin Genz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/Package.swift

@@ -0,0 +1,28 @@
+// swift-tools-version: 5.9
+import PackageDescription
+
+let package = Package(
+    name: "CapawesomeCapacitorGyroscope",
+    platforms: [.iOS(.v15)],
+    products: [
+        .library(
+            name: "CapawesomeCapacitorGyroscope",
+            targets: ["GyroscopePlugin"])
+    ],
+    dependencies: [
+        .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", from: "8.0.0")
+    ],
+    targets: [
+        .target(
+            name: "GyroscopePlugin",
+            dependencies: [
+                .product(name: "Capacitor", package: "capacitor-swift-pm"),
+                .product(name: "Cordova", package: "capacitor-swift-pm")
+            ],
+            path: "ios/Plugin"),
+        .testTarget(
+            name: "GyroscopePluginTests",
+            dependencies: ["GyroscopePlugin"],
+            path: "ios/PluginTests")
+    ]
+)

package/README.md

@@ -0,0 +1,333 @@
+# @capawesome/capacitor-gyroscope
+
+Capacitor plugin to read the device's gyroscope sensor.
+
+<div class="capawesome-z29o10a">
+  <a href="https://cloud.capawesome.io/" target="_blank">
+    <img alt="Deliver Live Updates to your Capacitor app with Capawesome Cloud" src="https://cloud.capawesome.io/assets/banners/cloud-build-and-deploy-capacitor-apps.png?t=1" />
+  </a>
+</div>
+
+## Features
+
+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/plugins/accelerometer/), [Barometer](https://capawesome.io/plugins/barometer/) and [Pedometer](https://capawesome.io/plugins/pedometer/) plugins.
+
+Missing a feature? Just [open an issue](https://github.com/capawesome-team/capacitor-plugins/issues) and we'll take a look!
+
+## Newsletter
+
+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
+
+| Plugin Version | Capacitor Version | Status         |
+| -------------- | ----------------- | -------------- |
+| 0.x.x          | >=8.x.x           | Active support |
+
+## Installation
+
+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:
+
+```bash
+npx skills add capawesome-team/skills --skill capacitor-plugins
+```
+
+Then use the following prompt:
+
+```
+ 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:
+
+```bash
+npm install @capawesome/capacitor-gyroscope
+npx cap sync
+```
+
+### Android
+
+#### Proguard
+
+If you are using Proguard, you need to add the following rules to your `proguard-rules.pro` file:
+
+```
+-keep class io.capawesome.capacitorjs.plugins.** { *; }
+```
+
+### iOS
+
+#### Privacy Descriptions
+
+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:
+
+```xml
+<key>NSMotionUsageDescription</key>
+<string>The app needs to access the motion activity.</string>
+```
+
+## Configuration
+
+No configuration required for this plugin.
+
+## Usage
+
+```typescript
+import { Gyroscope } from '@capawesome/capacitor-gyroscope';
+
+const getMeasurement = async () => {
+  const measurement = await Gyroscope.getMeasurement();
+  console.log('X: ', measurement.x);
+  console.log('Y: ', measurement.y);
+  console.log('Z: ', measurement.z);
+};
+
+const isAvailable = async () => {
+  const result = await Gyroscope.isAvailable();
+  return result.isAvailable;
+};
+
+const startMeasurementUpdates = async () => {
+  await Gyroscope.addListener('measurement', measurement => {
+    console.log('X: ', measurement.x);
+    console.log('Y: ', measurement.y);
+    console.log('Z: ', measurement.z);
+  });
+  await Gyroscope.startMeasurementUpdates();
+};
+
+const stopMeasurementUpdates = async () => {
+  await Gyroscope.stopMeasurementUpdates();
+};
+
+const checkPermissions = async () => {
+  const result = await Gyroscope.checkPermissions();
+  return result;
+};
+
+const requestPermissions = async () => {
+  const result = await Gyroscope.requestPermissions();
+  return result;
+};
+
+const removeAllListeners = async () => {
+  await Gyroscope.removeAllListeners();
+};
+```
+
+## API
+
+<docgen-index>
+
+* [`addListener('measurement', ...)`](#addlistenermeasurement-)
+* [`checkPermissions()`](#checkpermissions)
+* [`getMeasurement()`](#getmeasurement)
+* [`isAvailable()`](#isavailable)
+* [`removeAllListeners()`](#removealllisteners)
+* [`requestPermissions()`](#requestpermissions)
+* [`startMeasurementUpdates()`](#startmeasurementupdates)
+* [`stopMeasurementUpdates()`](#stopmeasurementupdates)
+* [Interfaces](#interfaces)
+* [Type Aliases](#type-aliases)
+
+</docgen-index>
+
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+### addListener('measurement', ...)
+
+```typescript
+addListener(eventName: 'measurement', listenerFunc: (event: MeasurementEvent) => void) => Promise<PluginListenerHandle>
+```
+
+Called when a new measurement is available.
+
+Only available on Android and iOS.
+
+| Param              | Type                                                                    |
+| ------------------ | ----------------------------------------------------------------------- |
+| **`eventName`**    | <code>'measurement'</code>                                              |
+| **`listenerFunc`** | <code>(event: <a href="#measurement">Measurement</a>) =&gt; void</code> |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+
+**Since:** 0.1.0
+
+--------------------
+
+
+### checkPermissions()
+
+```typescript
+checkPermissions() => Promise<PermissionStatus>
+```
+
+Check if the app has permission to access the gyroscope sensor.
+
+**Returns:** <code>Promise&lt;<a href="#permissionstatus">PermissionStatus</a>&gt;</code>
+
+**Since:** 0.1.0
+
+--------------------
+
+
+### getMeasurement()
+
+```typescript
+getMeasurement() => Promise<GetMeasurementResult>
+```
+
+Get the latest measurement.
+
+This method returns the most recent measurement from the gyroscope sensor.
+
+**Returns:** <code>Promise&lt;<a href="#measurement">Measurement</a>&gt;</code>
+
+**Since:** 0.1.0
+
+--------------------
+
+
+### isAvailable()
+
+```typescript
+isAvailable() => Promise<IsAvailableResult>
+```
+
+Check if the gyroscope sensor is available on the device.
+
+**Returns:** <code>Promise&lt;<a href="#isavailableresult">IsAvailableResult</a>&gt;</code>
+
+**Since:** 0.1.0
+
+--------------------
+
+
+### removeAllListeners()
+
+```typescript
+removeAllListeners() => Promise<void>
+```
+
+Remove all listeners for this plugin.
+
+**Since:** 0.1.0
+
+--------------------
+
+
+### requestPermissions()
+
+```typescript
+requestPermissions() => Promise<PermissionStatus>
+```
+
+Request permission to access the gyroscope sensor.
+
+**Returns:** <code>Promise&lt;<a href="#permissionstatus">PermissionStatus</a>&gt;</code>
+
+**Since:** 0.1.0
+
+--------------------
+
+
+### startMeasurementUpdates()
+
+```typescript
+startMeasurementUpdates() => Promise<void>
+```
+
+Start emitting `measurement` events.
+
+**Since:** 0.1.0
+
+--------------------
+
+
+### stopMeasurementUpdates()
+
+```typescript
+stopMeasurementUpdates() => Promise<void>
+```
+
+Stop emitting `measurement` events.
+
+**Since:** 0.1.0
+
+--------------------
+
+
+### Interfaces
+
+
+#### PluginListenerHandle
+
+| Prop         | Type                                      |
+| ------------ | ----------------------------------------- |
+| **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |
+
+
+#### Measurement
+
+| Prop    | Type                | Description                                                        | Since |
+| ------- | ------------------- | ------------------------------------------------------------------ | ----- |
+| **`x`** | <code>number</code> | The rotation rate around the x-axis in radians per second (rad/s). | 0.1.0 |
+| **`y`** | <code>number</code> | The rotation rate around the y-axis in radians per second (rad/s). | 0.1.0 |
+| **`z`** | <code>number</code> | The rotation rate around the z-axis in radians per second (rad/s). | 0.1.0 |
+
+
+#### PermissionStatus
+
+| Prop            | Type                                                                          | Description                                    | Since |
+| --------------- | ----------------------------------------------------------------------------- | ---------------------------------------------- | ----- |
+| **`gyroscope`** | <code><a href="#gyroscopepermissionstate">GyroscopePermissionState</a></code> | The permission status of the gyroscope sensor. | 0.1.0 |
+
+
+#### IsAvailableResult
+
+| Prop              | Type                 | Description                                              | Since |
+| ----------------- | -------------------- | -------------------------------------------------------- | ----- |
+| **`isAvailable`** | <code>boolean</code> | Whether the gyroscope sensor is available on the device. | 0.1.0 |
+
+
+### Type Aliases
+
+
+#### MeasurementEvent
+
+<code><a href="#measurement">Measurement</a></code>
+
+
+#### GyroscopePermissionState
+
+<code><a href="#permissionstate">PermissionState</a> | 'limited'</code>
+
+
+#### PermissionState
+
+<code>'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'</code>
+
+
+#### GetMeasurementResult
+
+<code><a href="#measurement">Measurement</a></code>
+
+</docgen-api>
+
+## Changelog
+
+See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/gyroscope/CHANGELOG.md).
+
+## License
+
+See [LICENSE](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/gyroscope/LICENSE).

package/android/build.gradle

@@ -0,0 +1,58 @@
+ext {
+    junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.7.1'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.3.0'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.7.0'
+}
+
+buildscript {
+    repositories {
+        google()
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:8.13.0'
+    }
+}
+
+apply plugin: 'com.android.library'
+
+android {
+    namespace = "io.capawesome.capacitorjs.plugins.gyroscope"
+    compileSdk = project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 36
+    defaultConfig {
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 24
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 36
+        versionCode 1
+        versionName "1.0"
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+    lintOptions {
+        abortOnError = false
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_21
+        targetCompatibility JavaVersion.VERSION_21
+    }
+}
+
+repositories {
+    google()
+    mavenCentral()
+}
+
+
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+    implementation project(':capacitor-android')
+    implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
+    testImplementation "junit:junit:$junitVersion"
+    androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
+    androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,2 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+</manifest>

package/android/src/main/java/io/capawesome/capacitorjs/plugins/gyroscope/Gyroscope.java

@@ -0,0 +1,97 @@
+package io.capawesome.capacitorjs.plugins.gyroscope;
+
+import android.content.Context;
+import android.hardware.Sensor;
+import android.hardware.SensorEvent;
+import android.hardware.SensorEventListener;
+import android.hardware.SensorManager;
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import io.capawesome.capacitorjs.plugins.gyroscope.classes.Measurement;
+import io.capawesome.capacitorjs.plugins.gyroscope.classes.interfaces.EmptyCallback;
+import io.capawesome.capacitorjs.plugins.gyroscope.classes.interfaces.NonEmptyResultCallback;
+import io.capawesome.capacitorjs.plugins.gyroscope.classes.results.GetMeasurementResult;
+import io.capawesome.capacitorjs.plugins.gyroscope.classes.results.IsAvailableResult;
+
+public class Gyroscope {
+
+    @NonNull
+    private final GyroscopePlugin plugin;
+
+    private boolean isRunning = false;
+
+    @Nullable
+    private SensorEventListener sensorEventListener;
+
+    public Gyroscope(@NonNull GyroscopePlugin plugin) {
+        this.plugin = plugin;
+    }
+
+    public void getMeasurement(@NonNull NonEmptyResultCallback<GetMeasurementResult> callback) throws Exception {
+        SensorManager sensorManager = (SensorManager) plugin.getContext().getSystemService(Context.SENSOR_SERVICE);
+        Sensor gyroscopeSensor = sensorManager.getDefaultSensor(Sensor.TYPE_GYROSCOPE);
+
+        if (gyroscopeSensor == null) {
+            throw new Exception(GyroscopePlugin.ERROR_GYROSCOPE_UNAVAILABLE);
+        }
+
+        final SensorEventListener listener = new SensorEventListener() {
+            @Override
+            public void onSensorChanged(SensorEvent event) {
+                sensorManager.unregisterListener(this);
+                Measurement measurement = new Measurement(event);
+                callback.success(new GetMeasurementResult(measurement));
+            }
+
+            @Override
+            public void onAccuracyChanged(Sensor sensor, int accuracy) {}
+        };
+
+        sensorManager.registerListener(listener, gyroscopeSensor, SensorManager.SENSOR_DELAY_NORMAL);
+    }
+
+    public void isAvailable(@NonNull NonEmptyResultCallback<IsAvailableResult> callback) {
+        SensorManager sensorManager = (SensorManager) plugin.getContext().getSystemService(Context.SENSOR_SERVICE);
+        Sensor gyroscopeSensor = sensorManager.getDefaultSensor(Sensor.TYPE_GYROSCOPE);
+        boolean isAvailable = gyroscopeSensor != null;
+        callback.success(new IsAvailableResult(isAvailable));
+    }
+
+    public void startMeasurementUpdates(@NonNull EmptyCallback callback) {
+        if (isRunning) {
+            callback.success();
+            return;
+        }
+
+        SensorManager sensorManager = (SensorManager) plugin.getContext().getSystemService(Context.SENSOR_SERVICE);
+        Sensor gyroscopeSensor = sensorManager.getDefaultSensor(Sensor.TYPE_GYROSCOPE);
+        if (gyroscopeSensor == null) {
+            callback.error(new Exception(GyroscopePlugin.ERROR_GYROSCOPE_UNAVAILABLE));
+            return;
+        }
+
+        sensorEventListener = new SensorEventListener() {
+            @Override
+            public void onSensorChanged(SensorEvent event) {
+                Measurement measurement = new Measurement(event);
+                plugin.notifyMeasurementEventListeners(measurement);
+            }
+
+            @Override
+            public void onAccuracyChanged(Sensor sensor, int accuracy) {}
+        };
+
+        sensorManager.registerListener(sensorEventListener, gyroscopeSensor, SensorManager.SENSOR_DELAY_NORMAL);
+        isRunning = true;
+        callback.success();
+    }
+
+    public void stopMeasurementUpdates(@Nullable EmptyCallback callback) {
+        SensorManager sensorManager = (SensorManager) plugin.getContext().getSystemService(Context.SENSOR_SERVICE);
+        sensorManager.unregisterListener(sensorEventListener);
+        isRunning = false;
+        if (callback != null) {
+            callback.success();
+        }
+    }
+}