@capgo/capacitor-accelerometer 7.0.0

package/CapgoCapacitorAccelerometer.podspec

@@ -0,0 +1,17 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name = 'CapgoCapacitorAccelerometer'
+  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/Sources/**/*.{swift,h,m,c,cc,mm,cpp}'
+  s.ios.deployment_target = '14.0'
+  s.dependency 'Capacitor'
+  s.swift_version = '5.1'
+end

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Capgo
+
+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: "CapgoCapacitorAccelerometer",
+    platforms: [.iOS(.v14)],
+    products: [
+        .library(
+            name: "CapgoCapacitorAccelerometer",
+            targets: ["CapacitorAccelerometerPlugin"])
+    ],
+    dependencies: [
+        .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", from: "7.0.0")
+    ],
+    targets: [
+        .target(
+            name: "CapacitorAccelerometerPlugin",
+            dependencies: [
+                .product(name: "Capacitor", package: "capacitor-swift-pm"),
+                .product(name: "Cordova", package: "capacitor-swift-pm")
+            ],
+            path: "ios/Sources/CapacitorAccelerometerPlugin"),
+        .testTarget(
+            name: "CapacitorAccelerometerPluginTests",
+            dependencies: ["CapacitorAccelerometerPlugin"],
+            path: "ios/Tests/CapacitorAccelerometerPluginTests")
+    ]
+)

package/README.md

@@ -0,0 +1,243 @@
+# @capgo/capacitor-accelerometer
+ <a href="https://capgo.app/"><img src='https://raw.githubusercontent.com/Cap-go/capgo/main/assets/capgo_banner.png' alt='Capgo - Instant updates for capacitor'/></a>
+
+<div align="center">
+  <h2><a href="https://capgo.app/?ref=plugin"> ➡️ Get Instant updates for your App with Capgo</a></h2>
+  <h2><a href="https://capgo.app/consulting/?ref=plugin"> Missing a feature? We’ll build the plugin for you 💪</a></h2>
+</div>
+
+
+Access raw accelerometer measurements across iOS, Android, and the Web.
+
+WIP: the plugin is not yet ready for production
+
+## Documentation
+
+The most complete doc is available here: https://capgo.app/docs/plugins/accelerometer/
+
+## Install
+
+```bash
+npm install @capgo/capacitor-accelerometer
+npx cap sync
+```
+
+## API
+
+<docgen-index>
+
+* [`getMeasurement()`](#getmeasurement)
+* [`isAvailable()`](#isavailable)
+* [`startMeasurementUpdates()`](#startmeasurementupdates)
+* [`stopMeasurementUpdates()`](#stopmeasurementupdates)
+* [`checkPermissions()`](#checkpermissions)
+* [`requestPermissions()`](#requestpermissions)
+* [`addListener('measurement', ...)`](#addlistenermeasurement-)
+* [`removeAllListeners()`](#removealllisteners)
+* [Interfaces](#interfaces)
+* [Type Aliases](#type-aliases)
+
+</docgen-index>
+
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+Capacitor plugin contract for working with the device accelerometer.
+
+### getMeasurement()
+
+```typescript
+getMeasurement() => Promise<GetMeasurementResult>
+```
+
+Get the most recent accelerometer sample that was recorded by the native layer.
+
+**Returns:** <code>Promise&lt;<a href="#measurement">Measurement</a>&gt;</code>
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### isAvailable()
+
+```typescript
+isAvailable() => Promise<IsAvailableResult>
+```
+
+Check if the current device includes an accelerometer sensor.
+
+**Returns:** <code>Promise&lt;<a href="#isavailableresult">IsAvailableResult</a>&gt;</code>
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### startMeasurementUpdates()
+
+```typescript
+startMeasurementUpdates() => Promise<void>
+```
+
+Begin streaming accelerometer updates to the JavaScript layer.
+
+Call {@link addListener} with the `measurement` event to receive the updates.
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### stopMeasurementUpdates()
+
+```typescript
+stopMeasurementUpdates() => Promise<void>
+```
+
+Stop streaming accelerometer updates started via {@link startMeasurementUpdates}.
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### checkPermissions()
+
+```typescript
+checkPermissions() => Promise<PermissionStatus>
+```
+
+Return the current permission state for accessing motion data.
+
+On platforms without explicit permissions this resolves to `granted`.
+
+**Returns:** <code>Promise&lt;<a href="#permissionstatus">PermissionStatus</a>&gt;</code>
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### requestPermissions()
+
+```typescript
+requestPermissions() => Promise<PermissionStatus>
+```
+
+Request permission to access motion data if supported by the platform.
+
+**Returns:** <code>Promise&lt;<a href="#permissionstatus">PermissionStatus</a>&gt;</code>
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### addListener('measurement', ...)
+
+```typescript
+addListener(eventName: 'measurement', listenerFunc: (event: MeasurementEvent) => void) => Promise<PluginListenerHandle>
+```
+
+Listen for measurement updates.
+
+| Param              | Type                                                                    | Description                                |
+| ------------------ | ----------------------------------------------------------------------- | ------------------------------------------ |
+| **`eventName`**    | <code>'measurement'</code>                                              | Only the `measurement` event is supported. |
+| **`listenerFunc`** | <code>(event: <a href="#measurement">Measurement</a>) =&gt; void</code> | Callback invoked with each measurement.    |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### removeAllListeners()
+
+```typescript
+removeAllListeners() => Promise<void>
+```
+
+Remove all listeners that have been registered on the plugin.
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### Interfaces
+
+
+#### Measurement
+
+The x, y and z axis acceleration values reported by the device motion sensors.
+
+| Prop    | Type                | Description                            | Since |
+| ------- | ------------------- | -------------------------------------- | ----- |
+| **`x`** | <code>number</code> | The acceleration on the x-axis in G's. | 1.0.0 |
+| **`y`** | <code>number</code> | The acceleration on the y-axis in G's. | 1.0.0 |
+| **`z`** | <code>number</code> | The acceleration on the z-axis in G's. | 1.0.0 |
+
+
+#### IsAvailableResult
+
+Result returned by {@link CapacitorAccelerometerPlugin.isAvailable}.
+
+| Prop              | Type                 | Description                                                 | Since |
+| ----------------- | -------------------- | ----------------------------------------------------------- | ----- |
+| **`isAvailable`** | <code>boolean</code> | Whether an accelerometer sensor is available on the device. | 1.0.0 |
+
+
+#### PermissionStatus
+
+Permission information returned by {@link CapacitorAccelerometerPlugin.checkPermissions}
+and {@link CapacitorAccelerometerPlugin.requestPermissions}.
+
+| Prop                | Type                                                                                  | Description                                                             | Since |
+| ------------------- | ------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----- |
+| **`accelerometer`** | <code><a href="#accelerometerpermissionstate">AccelerometerPermissionState</a></code> | The permission state for accessing motion data on the current platform. | 1.0.0 |
+
+
+#### PluginListenerHandle
+
+| Prop         | Type                                      |
+| ------------ | ----------------------------------------- |
+| **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |
+
+
+### Type Aliases
+
+
+#### GetMeasurementResult
+
+Alias for the most recent measurement.
+
+<code><a href="#measurement">Measurement</a></code>
+
+
+#### AccelerometerPermissionState
+
+Permission state union including `limited` for platforms that can throttle motion access.
+
+<code><a href="#permissionstate">PermissionState</a> | 'limited'</code>
+
+
+#### PermissionState
+
+<code>'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'</code>
+
+
+#### MeasurementEvent
+
+Event payload emitted when {@link CapacitorAccelerometerPlugin.startMeasurementUpdates}
+is active.
+
+<code><a href="#measurement">Measurement</a></code>
+
+</docgen-api>
+
+### Credit
+
+This plugin was inspired from: https://github.com/kesha-antonov/react-native-background-downloader

package/android/build.gradle

@@ -0,0 +1,57 @@
+ext {
+    junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.7.0'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.2.1'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.6.1'
+}
+
+buildscript {
+    repositories {
+        google()
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:8.7.2'
+    }
+}
+
+apply plugin: 'com.android.library'
+
+android {
+    namespace "app.capgo.accelerometer"
+    compileSdk project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 35
+    defaultConfig {
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 23
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 35
+        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/app/capgo/accelerometer/CapacitorAccelerometerPlugin.java

@@ -0,0 +1,160 @@
+package app.capgo.accelerometer;
+
+import android.content.Context;
+import android.hardware.Sensor;
+import android.hardware.SensorEvent;
+import android.hardware.SensorEventListener;
+import android.hardware.SensorManager;
+import androidx.annotation.Nullable;
+import com.getcapacitor.JSObject;
+import com.getcapacitor.Plugin;
+import com.getcapacitor.PluginCall;
+import com.getcapacitor.PluginMethod;
+import com.getcapacitor.annotation.CapacitorPlugin;
+
+@CapacitorPlugin(name = "CapacitorAccelerometer")
+public class CapacitorAccelerometerPlugin extends Plugin implements SensorEventListener {
+
+    private static final String PERMISSION_GRANTED = "granted";
+    private static final String PERMISSION_DENIED = "denied";
+
+    @Nullable
+    private SensorManager sensorManager;
+
+    @Nullable
+    private Sensor accelerometer;
+
+    private final JSObject lastMeasurement = new JSObject();
+
+    private boolean updatesActive = false;
+
+    @Override
+    public void load() {
+        Context context = getContext();
+        sensorManager = (SensorManager) context.getSystemService(Context.SENSOR_SERVICE);
+        if (sensorManager != null) {
+            accelerometer = sensorManager.getDefaultSensor(Sensor.TYPE_ACCELEROMETER);
+        }
+        lastMeasurement.put("x", 0);
+        lastMeasurement.put("y", 0);
+        lastMeasurement.put("z", 0);
+    }
+
+    @PluginMethod
+    public void getMeasurement(PluginCall call) {
+        if (accelerometer == null) {
+            call.reject("Accelerometer sensor not available on this device.");
+            return;
+        }
+        call.resolve(snapshotMeasurement());
+    }
+
+    @PluginMethod
+    public void isAvailable(PluginCall call) {
+        JSObject result = new JSObject();
+        result.put("isAvailable", accelerometer != null);
+        call.resolve(result);
+    }
+
+    @PluginMethod
+    public void startMeasurementUpdates(PluginCall call) {
+        if (accelerometer == null) {
+            call.reject("Accelerometer sensor not available on this device.");
+            return;
+        }
+        if (updatesActive) {
+            call.resolve();
+            return;
+        }
+        if (sensorManager != null && sensorManager.registerListener(this, accelerometer, SensorManager.SENSOR_DELAY_GAME)) {
+            updatesActive = true;
+            call.resolve();
+        } else {
+            call.reject("Failed to register accelerometer listener.");
+        }
+    }
+
+    @PluginMethod
+    public void stopMeasurementUpdates(PluginCall call) {
+        if (sensorManager != null && updatesActive) {
+            sensorManager.unregisterListener(this);
+            updatesActive = false;
+        }
+        call.resolve();
+    }
+
+    @PluginMethod
+    public void checkPermissions(PluginCall call) {
+        JSObject result = new JSObject();
+        result.put("accelerometer", accelerometer != null ? PERMISSION_GRANTED : PERMISSION_DENIED);
+        call.resolve(result);
+    }
+
+    @PluginMethod
+    public void requestPermissions(PluginCall call) {
+        // No explicit runtime permission is required for accelerometer access.
+        checkPermissions(call);
+    }
+
+    @PluginMethod
+    public void removeAllListeners(PluginCall call) {
+        super.removeAllListeners(call);
+    }
+
+    @Override
+    public void handleOnPause() {
+        if (sensorManager != null && updatesActive) {
+            sensorManager.unregisterListener(this);
+        }
+        super.handleOnPause();
+    }
+
+    @Override
+    public void handleOnResume() {
+        super.handleOnResume();
+        if (updatesActive && sensorManager != null && accelerometer != null) {
+            sensorManager.registerListener(this, accelerometer, SensorManager.SENSOR_DELAY_GAME);
+        }
+    }
+
+    @Override
+    public void handleOnDestroy() {
+        if (sensorManager != null) {
+            sensorManager.unregisterListener(this);
+        }
+        super.handleOnDestroy();
+    }
+
+    @Override
+    public void onSensorChanged(SensorEvent event) {
+        if (event.sensor.getType() != Sensor.TYPE_ACCELEROMETER) {
+            return;
+        }
+        double x = event.values[0] / SensorManager.GRAVITY_EARTH;
+        double y = event.values[1] / SensorManager.GRAVITY_EARTH;
+        double z = event.values[2] / SensorManager.GRAVITY_EARTH;
+
+        lastMeasurement.put("x", x);
+        lastMeasurement.put("y", y);
+        lastMeasurement.put("z", z);
+
+        JSObject payload = new JSObject();
+        payload.put("x", x);
+        payload.put("y", y);
+        payload.put("z", z);
+        notifyListeners("measurement", payload);
+    }
+
+    @Override
+    public void onAccuracyChanged(Sensor sensor, int accuracy) {
+        // No-op
+    }
+
+    private JSObject snapshotMeasurement() {
+        JSObject copy = new JSObject();
+        copy.put("x", lastMeasurement.optDouble("x", 0));
+        copy.put("y", lastMeasurement.optDouble("y", 0));
+        copy.put("z", lastMeasurement.optDouble("z", 0));
+        return copy;
+    }
+}