Pedometer_2

*Base on Pedometer & Pedometer_plus (references at the bottom)

This plugin allows to get this info in both Android and IOS:

• Get step count "from:to" specific dates
• Get step count since last system boot
• Get real time step count (Stream)
• Get real time pedestrian status: Awaking, Stopped (Stream)
• Get real time step count since a date (Stream) (Only on IOS)
  *Alternative for Android explained under

*Yes all of this is supported in both Android and IOS
*It uses the Sensors API (on Android & IOS) and the Recording API (Android).

Configuration

Permissions

For both Android and IOS you need to request permission to track users activity. I recommend using the package Permission_handler, but you can use others if it suits you better.

Using Permission handler you need to: (adapt for other packages)

How to Use it

1. Request Permissions

   - Using the *Permission_handler* plugin, you can request permission for both platforms. - This plugin includes a very handy function to open the system setting for the app and make it easier for the user to change them in case the prompt is not shown. #### Behavior - The first time you request a permission to the user, a dialog should pop requesting access to the his activity. The following times the permission request will automatically return an answer based on the previous answer or the current setting of the app if the user has set them from the setting screen in the OS. - Take this into consideration to show the user a dialog of snackbar and request him to update the permissions. **Please make sure the previous "Permissions" step has been implemented correctly as you may get false positives or negatives if not* #### Example: ```dart import 'package:permission_handler/permission_handler.dart'; PermissionStatus perm = Platform.isAndroid ? await Permission.activityRecognition.request() : await Permission.sensors.request(); print('perm: $perm'); if (perm.isDenied || perm.isPermanentlyDenied || perm.isRestricted) { ScaffoldMessenger.of(context).showSnackBar( SnackBar( content: Text( 'You need to approve the permissions to use the pedometer', style: TextStyle( color: Theme.of(context).colorScheme.onError, fontWeight: FontWeight.bold, ), ), backgroundColor: Theme.of(context).colorScheme.errorContainer, shape: RoundedRectangleBorder( borderRadius: BorderRadius.circular(themeBorderRadius), ), // Open the system settings to allow the permissions action: SnackBarAction( label: 'Settings', textColor: Theme.of(context).colorScheme.onError, onPressed: () => openAppSettings(), ), ), ); } else { // Call the functions your need to read stepCount } ```
2. Get Step count

   - You can request the total amount of steps taken by the user in an specific time period (from/to). - If `from` or `to` is not proportioned it defaults to the max amount of days recorded. In IOS is 7 days, in Android is 10. - If `from:to` range is higher than the maximum number of days recorded in each platform, the number of steps will represent only the max number recorded. Meaning, if `from:to` range represents the last 20 days, the number returned will actually only represent 7 days in IOS and 10 days in Android. #### Behavior - The first time you request tracking the users Activity after installing the app it will return `0`, as the phone starts recording since the app is installed and has requested permission. *(This means that if you uninstall and reinstall the app, the steps count will also return `0` the first time).* - This number will be the exact same, or almost, as the Google Fit app/ Health APP (Android/IOS). *(In tests shows more consistency than the Fit API on Android and does not require a Google Account or connection to the Health API in IOS).* #### Example: ```dart DateTime now = DateTime.now(); // Start of the week - Monday DateTime from = now.subtract(Duration(days: now.weekday - 1)); //End of the week - Sunday DateTime to = now.add(Duration(days: DateTime.daysPerWeek - now.weekday)); int steps = await Pedometer().getStepCount(from: from, to: to); print('steps: $steps'); ```
3. Get real time step count (Stream) & Steps since last system boot

   - When called it will first return the steps recorded since the last system boot. If the user moves it will keep streaming the updated number of steps. - If the number of steps is `0` it wont fire the stream until the user starts walking. #### Behavior - As with the `getStepCount` call, the first time you request tracking the users Activity after installing the app the value will be `0`. But unlike the `getStepCount` call, if the phone is turned off, when called again the value will be `0` again. - Also if the user changes the date of the phone manually it will also reset the step count to `0`. #### Example: ````dart StreamSubscription? _subStepCount; @override void initState() { super.initState(); _listenToSteps(); } @override void dispose() { // Don't forget to close the stream _subStepCount?.cancel(); super.dispose(); } _listenToSteps() { _subStepCount = Pedometer().stepCountStream().listen((steps) => print('Steps: $steps')); } ````
4. Get real time pedestrian status: Awaking, Stopped (Stream)

   - When called it will return the current pedestrian status, either `stopped` or `walking`. In case of an error it will return `unknown`. #### Behavior - When the stream is initialized it may not fire a result until the status changes. So assume the user is stopped from start as it will fire every 1/2 seconds. #### Example: ````dart StreamSubscription? _subPedestrianStatus; @override void initState() { super.initState(); _listenToStatus(); } @override void dispose() { _subPedestrianStatus?.cancel(); super.dispose(); } _listenToStatus() { _subPedestrianStatus = Pedometer().pedestrianStatusStream().listen((status) => print('Status: $status')); } ````
5. [IOS] Get real time step count since a date (Stream)

   - ***(Android alternative)** Use a combination of the `getStepCount` and `stepCountStream`. Example in the `Example App`* - It will return the total amount of steps taken by the user `from` a specific date to `now()`, and then keep streaming as the number of steps increase. #### Behavior - It behaves as the `stepCountStream`, so the first is called the value will be `0` as it won't start recording until you have permission. If the value is `0` it may not fire until the user starts walking. - As with `getStepCount` the max. number of days recorded is 7, so if `from` date is earlier the value returned will only represent the past 7 days. #### Example: ````dart StreamSubscription? _subStepFrom; @override void initState() { super.initState(); _listenToSteps(); } @override void dispose() { _subStepFrom?.cancel(); super.dispose(); } _listenToSteps() { DateTime now = DateTime.now(); // Start of the week - Monday DateTime from = now.subtract(Duration(days: now.weekday - 1)); _subStepFrom = Pedometer().stepCountStreamFrom(from: from).listen((steps) => print('Steps: $steps')); } ````

Things to consider

The APIs used may not be available in some phones or may behave in different ways. Ex:

• It was found that some Samsung phones do not support the Sensors API.
• Older iPhones do not support Pedestrian Status in particular
• Manufacturers use different sensors and variation of the OS, this will result in Steps being measured in very different ways. (This obviously applies mainly to Android)

In the case that the step sensor is not available, an error will be thrown. The application needs to handle this error.

Thanks and credits

This package was originally forked from:

• Pedometer_plus by akaboshinit.dev

*Which was originally forked and inspired by:

• Pedometer by cachet.dk
• Simple_pedometer by bookm.me

*The example app was inspired by Purrweb Agency - Dribbble

Package Status & Contribute

Pub v.	Points	Popularity	Issues	Pull requests