@capawesome/capacitor-gyroscope 0.0.1

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

@@ -0,0 +1,152 @@
+package io.capawesome.capacitorjs.plugins.gyroscope;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.getcapacitor.JSObject;
+import com.getcapacitor.Logger;
+import com.getcapacitor.Plugin;
+import com.getcapacitor.PluginCall;
+import com.getcapacitor.PluginMethod;
+import com.getcapacitor.annotation.CapacitorPlugin;
+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.interfaces.Result;
+import io.capawesome.capacitorjs.plugins.gyroscope.classes.results.GetMeasurementResult;
+import io.capawesome.capacitorjs.plugins.gyroscope.classes.results.IsAvailableResult;
+
+@CapacitorPlugin(name = "Gyroscope")
+public class GyroscopePlugin extends Plugin {
+
+    public static final String ERROR_GYROSCOPE_UNAVAILABLE = "Not available on this device.";
+    public static final String ERROR_UNKNOWN_ERROR = "An unknown error has occurred.";
+    public static final String EVENT_MEASUREMENT = "measurement";
+    public static final String TAG = "GyroscopePlugin";
+
+    private final Gyroscope implementation = new Gyroscope(this);
+
+    @PluginMethod
+    public void checkPermissions(PluginCall call) {
+        JSObject result = new JSObject();
+        result.put("gyroscope", "granted");
+        call.resolve(result);
+    }
+
+    @PluginMethod
+    public void getMeasurement(PluginCall call) {
+        try {
+            NonEmptyResultCallback<GetMeasurementResult> callback = new NonEmptyResultCallback<>() {
+                @Override
+                public void success(@NonNull GetMeasurementResult result) {
+                    resolveCall(call, result);
+                }
+
+                @Override
+                public void error(Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+
+            implementation.getMeasurement(callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void isAvailable(PluginCall call) {
+        try {
+            NonEmptyResultCallback<IsAvailableResult> callback = new NonEmptyResultCallback<>() {
+                @Override
+                public void success(@NonNull IsAvailableResult result) {
+                    resolveCall(call, result);
+                }
+
+                @Override
+                public void error(Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+
+            implementation.isAvailable(callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    public void notifyMeasurementEventListeners(@NonNull Measurement measurement) {
+        notifyListeners(GyroscopePlugin.EVENT_MEASUREMENT, measurement.toJSObject());
+    }
+
+    @PluginMethod
+    public void removeAllListeners(PluginCall call) {
+        super.removeAllListeners(call);
+        implementation.stopMeasurementUpdates(null);
+    }
+
+    @PluginMethod
+    public void requestPermissions(PluginCall call) {
+        JSObject result = new JSObject();
+        result.put("gyroscope", "granted");
+        call.resolve(result);
+    }
+
+    @PluginMethod
+    public void startMeasurementUpdates(PluginCall call) {
+        try {
+            EmptyCallback callback = new EmptyCallback() {
+                @Override
+                public void success() {
+                    resolveCall(call, null);
+                }
+
+                @Override
+                public void error(Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+
+            implementation.startMeasurementUpdates(callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void stopMeasurementUpdates(PluginCall call) {
+        try {
+            EmptyCallback callback = new EmptyCallback() {
+                @Override
+                public void success() {
+                    resolveCall(call, null);
+                }
+
+                @Override
+                public void error(Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+
+            implementation.stopMeasurementUpdates(callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    private void rejectCall(@NonNull PluginCall call, @NonNull Exception exception) {
+        String message = exception.getMessage();
+        if (message == null) {
+            message = ERROR_UNKNOWN_ERROR;
+        }
+        Logger.error(TAG, message, exception);
+        call.reject(message);
+    }
+
+    private void resolveCall(@NonNull PluginCall call, @Nullable Result result) {
+        if (result == null) {
+            call.resolve();
+        } else {
+            call.resolve(result.toJSObject());
+        }
+    }
+}

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

@@ -0,0 +1,28 @@
+package io.capawesome.capacitorjs.plugins.gyroscope.classes;
+
+import android.hardware.SensorEvent;
+import androidx.annotation.NonNull;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.gyroscope.classes.interfaces.Result;
+
+public class Measurement implements Result {
+
+    final double x;
+    final double y;
+    final double z;
+
+    public Measurement(@NonNull SensorEvent sensorEvent) {
+        this.x = Math.round(sensorEvent.values[0] * 100.0) / 100.0;
+        this.y = Math.round(sensorEvent.values[1] * 100.0) / 100.0;
+        this.z = Math.round(sensorEvent.values[2] * 100.0) / 100.0;
+    }
+
+    @Override
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        result.put("x", x);
+        result.put("y", y);
+        result.put("z", z);
+        return result;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/gyroscope/classes/interfaces/Callback.java

@@ -0,0 +1,5 @@
+package io.capawesome.capacitorjs.plugins.gyroscope.classes.interfaces;
+
+public interface Callback {
+    void error(Exception exception);
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/gyroscope/classes/interfaces/EmptyCallback.java

@@ -0,0 +1,5 @@
+package io.capawesome.capacitorjs.plugins.gyroscope.classes.interfaces;
+
+public interface EmptyCallback extends Callback {
+    void success();
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/gyroscope/classes/interfaces/NonEmptyResultCallback.java

@@ -0,0 +1,7 @@
+package io.capawesome.capacitorjs.plugins.gyroscope.classes.interfaces;
+
+import androidx.annotation.NonNull;
+
+public interface NonEmptyResultCallback<T extends Result> extends Callback {
+    void success(@NonNull T result);
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/gyroscope/classes/interfaces/Result.java

@@ -0,0 +1,7 @@
+package io.capawesome.capacitorjs.plugins.gyroscope.classes.interfaces;
+
+import com.getcapacitor.JSObject;
+
+public interface Result {
+    JSObject toJSObject();
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/gyroscope/classes/results/GetMeasurementResult.java

@@ -0,0 +1,21 @@
+package io.capawesome.capacitorjs.plugins.gyroscope.classes.results;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.gyroscope.classes.Measurement;
+import io.capawesome.capacitorjs.plugins.gyroscope.classes.interfaces.Result;
+
+public class GetMeasurementResult implements Result {
+
+    @NonNull
+    private final Measurement measurement;
+
+    public GetMeasurementResult(@NonNull Measurement measurement) {
+        this.measurement = measurement;
+    }
+
+    @Override
+    public JSObject toJSObject() {
+        return measurement.toJSObject();
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/gyroscope/classes/results/IsAvailableResult.java

@@ -0,0 +1,20 @@
+package io.capawesome.capacitorjs.plugins.gyroscope.classes.results;
+
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.gyroscope.classes.interfaces.Result;
+
+public class IsAvailableResult implements Result {
+
+    private final boolean isAvailable;
+
+    public IsAvailableResult(boolean isAvailable) {
+        this.isAvailable = isAvailable;
+    }
+
+    @Override
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        result.put("isAvailable", isAvailable);
+        return result;
+    }
+}

package/dist/docs.json

@@ -0,0 +1,358 @@
+{
+  "api": {
+    "name": "GyroscopePlugin",
+    "slug": "gyroscopeplugin",
+    "docs": "",
+    "tags": [],
+    "methods": [
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'measurement', listenerFunc: (event: MeasurementEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'measurement'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(event: Measurement) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Called when a new measurement is available.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "MeasurementEvent"
+        ],
+        "slug": "addlistenermeasurement-"
+      },
+      {
+        "name": "checkPermissions",
+        "signature": "() => Promise<PermissionStatus>",
+        "parameters": [],
+        "returns": "Promise<PermissionStatus>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Check if the app has permission to access the gyroscope sensor.",
+        "complexTypes": [
+          "PermissionStatus"
+        ],
+        "slug": "checkpermissions"
+      },
+      {
+        "name": "getMeasurement",
+        "signature": "() => Promise<GetMeasurementResult>",
+        "parameters": [],
+        "returns": "Promise<Measurement>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Get the latest measurement.\n\nThis method returns the most recent measurement from the gyroscope sensor.",
+        "complexTypes": [
+          "Measurement",
+          "GetMeasurementResult"
+        ],
+        "slug": "getmeasurement"
+      },
+      {
+        "name": "isAvailable",
+        "signature": "() => Promise<IsAvailableResult>",
+        "parameters": [],
+        "returns": "Promise<IsAvailableResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Check if the gyroscope sensor is available on the device.",
+        "complexTypes": [
+          "IsAvailableResult"
+        ],
+        "slug": "isavailable"
+      },
+      {
+        "name": "removeAllListeners",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Remove all listeners for this plugin.",
+        "complexTypes": [],
+        "slug": "removealllisteners"
+      },
+      {
+        "name": "requestPermissions",
+        "signature": "() => Promise<PermissionStatus>",
+        "parameters": [],
+        "returns": "Promise<PermissionStatus>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Request permission to access the gyroscope sensor.",
+        "complexTypes": [
+          "PermissionStatus"
+        ],
+        "slug": "requestpermissions"
+      },
+      {
+        "name": "startMeasurementUpdates",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Start emitting `measurement` events.",
+        "complexTypes": [],
+        "slug": "startmeasurementupdates"
+      },
+      {
+        "name": "stopMeasurementUpdates",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Stop emitting `measurement` events.",
+        "complexTypes": [],
+        "slug": "stopmeasurementupdates"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => Promise<void>"
+        }
+      ]
+    },
+    {
+      "name": "Measurement",
+      "slug": "measurement",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "x",
+          "tags": [
+            {
+              "text": "0.12",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The rotation rate around the x-axis in radians per second (rad/s).",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "y",
+          "tags": [
+            {
+              "text": "0.12",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The rotation rate around the y-axis in radians per second (rad/s).",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "z",
+          "tags": [
+            {
+              "text": "0.12",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The rotation rate around the z-axis in radians per second (rad/s).",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
+    {
+      "name": "PermissionStatus",
+      "slug": "permissionstatus",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "gyroscope",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The permission status of the gyroscope sensor.",
+          "complexTypes": [
+            "GyroscopePermissionState"
+          ],
+          "type": "GyroscopePermissionState"
+        }
+      ]
+    },
+    {
+      "name": "IsAvailableResult",
+      "slug": "isavailableresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "isAvailable",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether the gyroscope sensor is available on the device.",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [
+    {
+      "name": "MeasurementEvent",
+      "slug": "measurementevent",
+      "docs": "",
+      "types": [
+        {
+          "text": "Measurement",
+          "complexTypes": [
+            "Measurement"
+          ]
+        }
+      ]
+    },
+    {
+      "name": "GyroscopePermissionState",
+      "slug": "gyroscopepermissionstate",
+      "docs": "",
+      "types": [
+        {
+          "text": "PermissionState",
+          "complexTypes": [
+            "PermissionState"
+          ]
+        },
+        {
+          "text": "'limited'",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "PermissionState",
+      "slug": "permissionstate",
+      "docs": "",
+      "types": [
+        {
+          "text": "'prompt'",
+          "complexTypes": []
+        },
+        {
+          "text": "'prompt-with-rationale'",
+          "complexTypes": []
+        },
+        {
+          "text": "'granted'",
+          "complexTypes": []
+        },
+        {
+          "text": "'denied'",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "GetMeasurementResult",
+      "slug": "getmeasurementresult",
+      "docs": "",
+      "types": [
+        {
+          "text": "Measurement",
+          "complexTypes": [
+            "Measurement"
+          ]
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": []
+}