cap-android-steps

CapAndroidSteps

CapAndroidSteps

cap-android-steps

Capacitor plugin for counting steps on Android devices using the Android ACTIVITY_RECOGNITION permission or sensor. This plugin can function independently without requiring Health Connect.

Installation

npm install cap-android-steps
npx cap sync

Android

Ensure your app has the ACTIVITY_RECOGNITION permission in your AndroidManifest.xml for Android 10+ devices.

Configuration

No configuration required for this plugin.

Demo

TBD

Usage

import { CapAndroidSteps } from 'cap-android-steps';

const requestPermission = async () => {
  const result = await CapAndroidSteps.requestActivityRecognitionPermission();
  return result.granted;
};

const getStepsForPeriod = async (period: 'all') => {
  const result = await CapAndroidSteps.getStepsForPeriod({ period });
  return result.count;
};

const getRawSensorValues = async () => {
  const result = await CapAndroidSteps.getRawSensorValues();
  return result;
};

API

• invertString(...)
• requestActivityRecognitionPermission()
• getStepsForPeriod(...)
• getRawSensorValues()
• Interfaces
• Type Aliases

invertString(...)

invertString(options: InvertStringOptions) => Promise<InvertStringResult>

Inverts the provided string (reverses it). This method has nothing to do with screen orientation.

Param	Type
options	InvertStringOptions

Returns: Promise<InvertStringResult>

requestActivityRecognitionPermission()

requestActivityRecognitionPermission() => Promise<PermissionResult>

Requests the ACTIVITY_RECOGNITION permission on Android 10+ devices. This permission is required for step counting functionality.

Returns: Promise<PermissionResult>

getStepsForPeriod(...)

getStepsForPeriod(options?: StepPeriodOptions | undefined) => Promise<StepCountResult>

Gets the step count for a specified period. Requires activity recognition permission on Android 10+.

Param	Type
options	StepPeriodOptions

Returns: Promise<StepCountResult>

getRawSensorValues()

getRawSensorValues() => Promise<SensorValuesResult>

Gets the raw sensor values from the step counter sensor. Requires activity recognition permission on Android 10+.

Returns: Promise<SensorValuesResult>

Interfaces

InvertStringResult

Prop	Type	Description
value	string	The inverted string.

InvertStringOptions

Prop	Type	Description
value	string	The string to invert.

PermissionResult

Prop	Type	Description
granted	boolean	Whether the permission was granted.

StepCountResult

Prop	Type	Description
count	number	The number of steps counted during the specified period.
period	'hour' | 'day' | 'all'	The period for which the step count was calculated.
startTime	number | null	The start time of the period in milliseconds. For 'all' period, this is the device boot time.
endTime	number	The end time of the period in milliseconds (current time).

StepPeriodOptions

Prop	Type	Description
period	'hour' | 'day' | 'all'	The period for which to get step data. Valid values are "hour", "day", or "all". - "hour": Steps taken in the last hour - "day": Steps taken in the last 24 hours - "all": All steps recorded since device boot (raw step counter value) Defaults to "day" if not specified.

SensorValuesResult

Prop	Type	Description
values	Record<string, number>	Object containing the raw sensor values. The step counter sensor typically only has one value at index "0", but this provides access to all values the sensor might report.
stepCount	number	The step count value (same as values["0"] for convenience).
sensorName	string	The name of the step counter sensor.
sensorVendor	string	The vendor of the step counter sensor.
sensorVersion	number	The version of the step counter sensor.

Type Aliases

Record

Construct a type with a set of properties K of type T

{ [P in K]: T; }

License

See LICENSE.