@dreiver1/capacitor-step-counter 0.0.2 → 0.0.3

package/README.md

@@ -1,96 +1,113 @@
 # step-counter
 
-A Capacitor plugin that provides access to the device step counter sensor on Androi, with a web fallback.
+A Capacitor plugin that provides access to the **Android Step Counter sensor**
+(`TYPE_STEP_COUNTER`), allowing apps to read step count data and receive real-time
+step updates. Includes a web fallback for non-Android platforms.
 
-## Install
+---
+
+## ⚠️ Platform Support
+
+| Platform | Supported |
+|---------|-----------|
+| Android | ✅ Yes |
+| Web     | ⚠️ Fallback (no real sensor) |
+| iOS     | ❌ Not supported |
+
+> This plugin relies on Android’s `TYPE_STEP_COUNTER` sensor, which is **not available on iOS**.
+
+---
+
+## 📦 Installation
 
 ```bash
 npm install step-counter
 npx cap sync
-```
 
-## API
 
-<docgen-index>
+🔐 Android Permissions
 
-* [`start()`](#start)
-* [`stop()`](#stop)
-* [`getCurrentSteps()`](#getcurrentsteps)
-* [`addListener('step', ...)`](#addlistenerstep-)
-* [Interfaces](#interfaces)
+On Android 10 (API 29) and above, this plugin requires the
+ACTIVITY_RECOGNITION permission.
 
-</docgen-index>
+The permission is:
 
-<docgen-api>
-<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+Automatically requested when calling start()
 
-### start()
+Mandatory for accessing step counter data
 
-```typescript
-start() => Promise<void>
-```
+🧠 How the Step Counter Works
 
-Starts listening to the step counter sensor
+Uses Sensor.TYPE_STEP_COUNTER
 
---------------------
+The step count represents total steps since the device last rebooted
 
+The value cannot be reset programmatically
 
-### stop()
+For daily or session-based steps, store a baseline value in your app
 
-```typescript
-stop() => Promise<void>
-```
+🚀 API
+start()
+start() => Promise<void>
 
-Stops listening to the step counter sensor
 
---------------------
+Starts listening to the Android step counter sensor.
 
+Requests ACTIVITY_RECOGNITION permission if required
 
-### getCurrentSteps()
+Throws an error if the sensor is not available on the device
 
-```typescript
-getCurrentSteps() => Promise<StepCounterData>
-```
+stop()
+stop() => Promise<void>
 
-Returns the current step count since device boot
 
-**Returns:** <code>Promise&lt;<a href="#stepcounterdata">StepCounterData</a>&gt;</code>
+Stops listening to the step counter sensor.
 
---------------------
+getCurrentSteps()
+getCurrentSteps() => Promise<StepCounterData>
 
 
-### addListener('step', ...)
+Returns the current number of steps since the device last boot.
 
-```typescript
-addListener(eventName: 'step', listenerFunc: (data: StepCounterData) => void) => Promise<PluginListenerHandle>
-```
+addListener('step', ...)
+addListener(
+  eventName: 'step',
+  listenerFunc: (data: StepCounterData) => void
+) => Promise<PluginListenerHandle>
 
-Emits step updates
 
-| Param              | Type                                                                           |
-| ------------------ | ------------------------------------------------------------------------------ |
-| **`eventName`**    | <code>'step'</code>                                                            |
-| **`listenerFunc`** | <code>(data: <a href="#stepcounterdata">StepCounterData</a>) =&gt; void</code> |
+Emits step updates whenever the system sensor reports a change.
 
-**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+Emits the total accumulated steps since boot
 
---------------------
+Triggered in real time
 
+🧩 Interfaces
+StepCounterData
+Prop	Type	Description
+steps	number	Total number of steps since device boot
+PluginListenerHandle
+Prop	Type
+remove	() => Promise<void>
+📝 Example Usage
+import { StepCounter } from 'step-counter';
 
-### Interfaces
+await StepCounter.start();
 
+const listener = await StepCounter.addListener('step', data => {
+  console.log('Steps:', data.steps);
+});
 
-#### StepCounterData
+// Stop listening
+await StepCounter.stop();
+await listener.remove();
 
-| Prop        | Type                |
-| ----------- | ------------------- |
-| **`steps`** | <code>number</code> |
+❗ Notes & Limitations
 
+Step count resets when the device restarts
 
-#### PluginListenerHandle
+Not all Android devices include a step counter sensor
 
-| Prop         | Type                                      |
-| ------------ | ----------------------------------------- |
-| **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |
+This plugin does not manage background execution
 
-</docgen-api>
+Background behavior depends on OS and app lifecycle

package/android/src/main/java/com/davidnascimento/plugins/stepcounter/StepCounterPlugin.java

@@ -7,11 +7,11 @@ import android.hardware.SensorEventListener;
 import android.hardware.SensorManager;
 import android.os.Build;
 
-import androidx.core.app.ActivityCompat;
-
 import com.getcapacitor.*;
 import com.getcapacitor.annotation.CapacitorPlugin;
 import com.getcapacitor.annotation.Permission;
+import com.getcapacitor.annotation.PermissionCallback;
+
 
 @CapacitorPlugin(
   name = "StepCounter",
@@ -22,8 +22,7 @@ import com.getcapacitor.annotation.Permission;
     )
   }
 )
-public class StepCounterPlugin extends Plugin
-  implements SensorEventListener {
+public class StepCounterPlugin extends Plugin implements SensorEventListener {
 
   private SensorManager sensorManager;
   private Sensor stepSensor;
@@ -31,20 +30,45 @@ public class StepCounterPlugin extends Plugin
 
   @Override
   public void load() {
-    sensorManager =
-      (SensorManager) getContext().getSystemService(Context.SENSOR_SERVICE);
-    stepSensor =
-      sensorManager.getDefaultSensor(Sensor.TYPE_STEP_COUNTER);
+    sensorManager = (SensorManager)
+      getContext().getSystemService(Context.SENSOR_SERVICE);
+    stepSensor = sensorManager.getDefaultSensor(Sensor.TYPE_STEP_COUNTER);
+  }
+
+  @PermissionCallback
+  private void permissionCallback(PluginCall call) {
+
+    if (getPermissionState("activityRecognition") == PermissionState.GRANTED) {
+      startSensor(call);
+    } else {
+      call.reject("ACTIVITY_RECOGNITION permission denied");
+    }
   }
 
   @PluginMethod
   public void start(PluginCall call) {
+    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q &&
+      !getPermissionState("activityRecognition").equals(PermissionState.GRANTED)) {
+      requestPermissionForAlias("activityRecognition", call, "permissionCallback");
+      return;
+    }
 
-    if (getPermissionState("activityRecognition") != PermissionState.GRANTED) {
-      requestPermissionForAlias("activityRecognition", call);
+    if (stepSensor == null) {
+      call.reject("Step Counter sensor not available");
       return;
     }
 
+    sensorManager.registerListener(
+      this,
+      stepSensor,
+      SensorManager.SENSOR_DELAY_NORMAL
+    );
+
+    call.resolve();
+  }
+
+  private void startSensor(PluginCall call) {
+
     if (stepSensor == null) {
       call.reject("Step Counter sensor not available");
       return;
@@ -59,6 +83,7 @@ public class StepCounterPlugin extends Plugin
     call.resolve();
   }
 
+
   @PluginMethod
   public void stop(PluginCall call) {
     sensorManager.unregisterListener(this);
@@ -78,6 +103,7 @@ public class StepCounterPlugin extends Plugin
 
     JSObject data = new JSObject();
     data.put("steps", currentSteps);
+
     notifyListeners("step", data);
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dreiver1/capacitor-step-counter",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "A Capacitor plugin that provides access to the device step counter sensor on Android and iOS, with a web fallback.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",