accurate_step_counter 1.3.0
accurate_step_counter: ^1.3.0 copied to clipboard
A highly accurate step counter plugin using accelerometer-based detection with low-pass filtering and peak detection. Includes Hive database logging with warmup validation. Supports foreground, backgr [...]
Changelog #
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
1.3.0 - 2026-01-07 #
Added #
-
💾 Hive Database Logging: Local persistent storage for step data
StepLogEntrymodel with Hive adapter for efficient storageStepLogSourceenum:foreground,background,terminatedStepLogDatabaseservice with Health Connect-like API
-
🔥 Warmup Validation: Buffer and validate walking before logging
- Configurable warmup duration before first log
- Minimum step threshold to confirm real walking
- Step rate validation to reject shaking/noise
- Buffered steps logged once walking is validated
-
⚙️ Logging Config Presets: New
StepLoggingConfigclasswalking()- Casual walking (5s warmup, 3 steps/sec max)running()- Jogging/running (3s warmup, 5 steps/sec max)sensitive()- Quick detection (no warmup)conservative()- Strict accuracy (10s warmup)noValidation()- Raw data logging
-
📊 New Query APIs:
getTotalSteps({from, to})- Aggregate step countgetStepsBySource(source, {from, to})- Steps by source typegetStepLogs({from, to, source})- Get all log entriesgetStepStats({from, to})- Statistics breakdown
-
📡 Real-Time Streams:
watchTotalSteps({from, to})- Live total updateswatchStepLogs({from, to, source})- Live log entries
-
🔄 App Lifecycle Tracking:
setAppState(state)- Track foreground/background state- Automatic step logging before app goes to background
- Proper source detection based on lifecycle
-
🐛 Debug Logging Control: New
debugLoggingparameterinitializeLogging(debugLogging: bool)to control console output- Set to
kDebugModefor debug-only logging - Default:
false(no console messages)
Complete Example #
import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'package:accurate_step_counter/accurate_step_counter.dart';
class StepTrackerPage extends StatefulWidget {
@override
State<StepTrackerPage> createState() => _StepTrackerPageState();
}
class _StepTrackerPageState extends State<StepTrackerPage>
with WidgetsBindingObserver {
final _stepCounter = AccurateStepCounter();
int _totalSteps = 0;
@override
void initState() {
super.initState();
WidgetsBinding.instance.addObserver(this);
_init();
}
Future<void> _init() async {
// Initialize with debug logging (only in debug builds)
await _stepCounter.initializeLogging(debugLogging: kDebugMode);
// Start step detection
await _stepCounter.start();
// Start logging with walking preset
await _stepCounter.startLogging(config: StepLoggingConfig.walking());
// Listen to total steps in real-time
_stepCounter.watchTotalSteps().listen((total) {
setState(() => _totalSteps = total);
});
}
@override
void didChangeAppLifecycleState(AppLifecycleState state) {
_stepCounter.setAppState(state); // Track foreground/background
}
@override
void dispose() {
WidgetsBinding.instance.removeObserver(this);
_stepCounter.dispose();
super.dispose();
}
@override
Widget build(BuildContext context) {
return Center(
child: Text('Total: $_totalSteps steps'),
);
}
}
Query Examples #
// Get total steps for today
final today = DateTime.now();
final startOfDay = DateTime(today.year, today.month, today.day);
final todaySteps = await stepCounter.getTotalSteps(from: startOfDay);
// Get steps by source
final foreground = await stepCounter.getStepsBySource(StepLogSource.foreground);
final background = await stepCounter.getStepsBySource(StepLogSource.background);
final terminated = await stepCounter.getStepsBySource(StepLogSource.terminated);
// Get detailed stats
final stats = await stepCounter.getStepStats();
print('Total: ${stats['totalSteps']}');
print('Average per day: ${stats['averagePerDay']}');
Dependencies Added #
hive: ^2.2.3- Local NoSQL databasehive_flutter: ^1.1.0- Flutter integrationhive_generator: ^2.0.1(dev) - Code generationbuild_runner: ^2.4.12(dev) - Build tool
Migration Guide #
No breaking changes! The new logging features are opt-in.
To use logging, call initializeLogging() before start().
1.2.1 - 2026-01-02 #
Added #
- ⚙️ Configurable Foreground Service API Level: New
foregroundServiceMaxApiLevelconfig option- Allows users to specify the maximum Android API level for foreground service usage
- Default:
29(Android 10) - same behavior as before - Set to higher values (e.g.,
31for Android 12) to use foreground service on newer devices - Common API levels:
- 29 = Android 10 (default)
- 30 = Android 11
- 31 = Android 12
- 32 = Android 12L
- 33 = Android 13
- 34 = Android 14
Example Usage #
// Use foreground service for Android 12 and below (API ≤ 31)
await stepCounter.start(
config: StepDetectorConfig(
useForegroundServiceOnOldDevices: true,
foregroundServiceMaxApiLevel: 31,
),
);
// Use default behavior (foreground service for Android ≤10 only)
await stepCounter.start(); // Uses default API level 29
Changed #
- 📖 Updated documentation to reflect configurable API level
- 🔧 Improved logging to show configured max API level
Migration Guide #
No breaking changes! The default behavior remains the same (API ≤29).
To use foreground service on newer Android versions, set foregroundServiceMaxApiLevel to the desired API level.
1.2.0 - 2025-12-30 #
Added #
-
🔔 Foreground Service Support: Reliable step counting on Android ≤10
- Automatically detects Android version and uses foreground service when needed
- Persistent notification keeps step counting active even when app is minimized
- Customizable notification title and text via
StepDetectorConfig - No additional code required - works automatically!
-
📱 New Config Options in
StepDetectorConfig:useForegroundServiceOnOldDevices- Enable/disable foreground service mode (default:true)foregroundNotificationTitle- Custom notification title (default: "Step Counter")foregroundNotificationText- Custom notification text (default: "Tracking your steps...")
-
🔍 New API Properties:
isUsingForegroundService- Check if foreground service mode is active
-
📄 New Platform Methods (internal):
getAndroidVersion()- Get device Android API levelstartForegroundService()/stopForegroundService()- Control the servicegetForegroundStepCount()- Read steps from serviceresetForegroundStepCount()- Reset service step counter
Changed #
-
🔧 Smart Mode Selection: Package now auto-detects Android version:
- Android 11+ (API 30+): Uses native step detection + terminated state sync
- Android 10 and below (API ≤29): Uses foreground service with notification
-
🚀 Native Step Detection: Replaced
sensors_pluswith native Kotlin implementation- Uses
TYPE_STEP_DETECTORsensor for hardware-optimized step counting - Falls back to accelerometer with software algorithm if unavailable
- Zero third-party dependencies
- Better battery efficiency
- Uses
Removed #
-
🗑️ Dependency Cleanup: Removed
sensors_pluspackage- Step detection now handled entirely in native Kotlin code
- Reduces package size and dependency complexity
-
🗑️ Removed
plugin_platform_interface: Now zero external dependencies- Removed unused boilerplate platform interface files
- Package now only depends on Flutter SDK
-
📱 iOS Support Removed: Package is now Android-only
- Removed iOS platform declaration and all iOS files
- Package will not crash on iOS but step detection won't function
Technical Details #
- New File:
StepCounterForegroundService.kt- Kotlin foreground service implementation - New File:
NativeStepDetector.kt- Native step detection with TYPE_STEP_DETECTOR - Notification: Uses low-priority, silent notification to minimize user impact
- Wake Lock: Keeps CPU active for accurate sensor reading
- EventChannel: Real-time step events from native to Flutter
Migration Guide #
No breaking changes! Existing code works without modification.
// The foreground service is automatic for Android ≤10
await stepCounter.start();
// Customize notification (optional)
await stepCounter.start(config: StepDetectorConfig(
foregroundNotificationTitle: 'Walking Tracker',
foregroundNotificationText: 'Counting your steps...',
));
// Disable foreground service if desired (not recommended for Android ≤10)
await stepCounter.start(config: StepDetectorConfig(
useForegroundServiceOnOldDevices: false,
));
Android Manifest Changes #
The following permissions are now included in the plugin:
<uses-permission android:name="android.permission.FOREGROUND_SERVICE"/>
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_HEALTH"/>
<uses-permission android:name="android.permission.POST_NOTIFICATIONS"/>
<uses-permission android:name="android.permission.WAKE_LOCK"/>
Note: On Android 13+, users may need to grant notification permission for the foreground service notification to appear.
1.1.1 - 2025-12-03 #
Removed #
- 🗑️ Dependency Cleanup: Removed unnecessary
healthpackage dependency- The
healthpackage was included but never used in the plugin code - Removed unused
health_connect_service.dartfile - Reduces package size and eliminates unnecessary dependencies
- Users can still integrate with health platforms by adding the
healthpackage to their own app
- The
Added #
-
📊 Comprehensive Logging System: Added detailed logging throughout the package
- Android Kotlin: Enhanced logging in all methods with structured tags
AccurateStepCounter: Plugin lifecycle and method callsStepCounter: Sensor events and step dataStepSync: Terminated state synchronization with detailed validation logs
- Dart: Added logging to platform channel calls and error handling
- Logs include sensor details (name, vendor, version)
- Step sync logs show elapsed time, step rate, and validation results
- Makes debugging and troubleshooting much easier for developers
- Android Kotlin: Enhanced logging in all methods with structured tags
-
📖 Debugging Documentation: Added comprehensive debugging section to README
- How to view logs using
adb logcat - Explanation of all log tags
- Example log output for common scenarios
- Commands for filtered logging
- How to view logs using
Changed #
-
📖 Documentation Updates:
- Updated README with clear guidance on optional health platform integration
- Updated TERMINATED_STATE_USAGE.md with health integration examples as optional feature
- Clarified that health platform integration is the responsibility of the consuming app
- Added example code showing how to integrate with health platforms if needed
- Added "Debugging & Logging" section with practical examples
- Updated GitHub repository URLs to use
rahulshahDEVusername
-
🔧 Code Quality: Fixed lint warning about unnecessary library name
Improved #
-
🎯 Package Focus: Narrowed package scope to core step counting functionality
- Package now focuses exclusively on accurate step detection and counting
- Health platform integrations are left to the consuming application
- Provides better separation of concerns and flexibility for users
-
🔍 Enhanced Error Tracking: Improved error handling and logging
- Platform exceptions are caught and logged with details
- Better sensor availability detection and reporting
- Validation failures in sync process are clearly logged with reasons
-
🛠️ Developer Experience: Package is now much easier to debug
- Clear log messages at every step
- Sensor information logged on initialization
- Detailed terminated state sync process with timestamps and calculations
- All validation checks logged with pass/fail reasons
Migration Guide #
No breaking changes! Existing code continues to work without modifications.
If you were expecting health platform integration:
- Add
health: ^13.1.4to your app'spubspec.yaml(not the plugin) - Use the
onTerminatedStepsDetectedcallback to write steps to health platforms - See README and TERMINATED_STATE_USAGE.md for complete examples
Debugging #
Use these commands to view logs:
# View all plugin logs
adb logcat -s AccurateStepCounter StepCounter StepSync
# View only sync logs
adb logcat -s StepSync
1.1.0 - 2025-01-27 #
Fixed #
- 🐛 Critical Fix: Terminated state step sync now works correctly when app returns from killed state
- Fixed issue where
syncStepsFromTerminated()was never called from Dart side - Enhanced Kotlin sensor handling to wait for fresh sensor data when app resumes
- Added sensor re-registration with 1.5-second wait loop to ensure data availability
- Improved fallback to SharedPreferences when sensor doesn't respond immediately
- Fixed issue where
Added #
- ✨ New Feature:
onTerminatedStepsDetectedcallback for handling missed steps- Automatically triggered during
start()when steps from terminated state are detected - Provides
(missedSteps, startTime, endTime)parameters for easy Health Connect integration - Example:
stepCounter.onTerminatedStepsDetected = (steps, start, end) { ... }
- Automatically triggered during
- 📚 New Method:
syncTerminatedSteps()- Manual sync for terminated state steps- Returns
Map<String, dynamic>?with missed steps data - Useful for on-demand synchronization scenarios
- Returns
- 📖 Documentation: Added comprehensive
TERMINATED_STATE_USAGE.mdguide- Complete API documentation with examples
- Health Connect integration patterns
- Troubleshooting guide and best practices
- Device reboot handling explanation
Improved #
- 🔍 Enhanced Logging: Added detailed debug logs to Kotlin plugin
StepCountertag for sensor events and data retrievalAccurateStepCountertag for Dart-side sync operations- Helps diagnose issues when steps aren't syncing
- ⚡ Better Sensor Handling: Improved reliability when returning from terminated state
- Re-registers sensor listener to trigger immediate callbacks
- Implements retry logic with configurable wait time
- Falls back gracefully to cached data if sensor unavailable
- 🎯 Automatic Sync: Terminated state sync now happens automatically on
start()- No manual intervention required
- Only triggers when
enableOsLevelSync: true(default) - Validates data before returning results
Changed #
- 📦 Internal: Added
dart:developerimport for logging inAccurateStepCounterImpl - 🔧 Behavior:
start()method now includes terminated state sync in initialization flow- Maintains backward compatibility - no breaking changes
- Existing code continues to work without modifications
Technical Details #
- Sensor Wait Logic: Kotlin plugin now waits up to 1500ms for sensor data with 50ms check intervals
- Validation: All existing validation checks remain in place (max steps, step rate, time checks)
- Thread Safety: Sensor wait loop properly handles interruptions
- Fallback Chain: Sensor → Wait for callback → SharedPreferences → null
Migration Guide #
No breaking changes! Existing implementations continue to work. To use the new callback feature:
// Before starting, register the callback
stepCounter.onTerminatedStepsDetected = (missedSteps, startTime, endTime) {
// Handle missed steps (e.g., write to Health Connect)
print('Synced $missedSteps steps from terminated state');
};
// Start as usual - sync happens automatically
await stepCounter.start();
Performance Impact #
- Minimal: Adds ~0-1.5 seconds to app startup only when terminated state data exists
- No impact during normal operation or when no missed steps are found
- Sensor wait timeout is configurable in Kotlin code if needed
Testing #
Verified fix with test scenario:
- Start app → step counter active
- Walk 100 steps → confirmed counted
- Force kill app → terminate completely
- Walk 50 steps while terminated
- Reopen app → automatic sync triggers
- ✅ Callback receives ~50 missed steps correctly
Known Issues #
- None identified in this release
1.0.0 - 2025-01-20 #
Added #
- ✨ Initial release of Accurate Step Counter plugin
- 📱 Accelerometer-based step detection with advanced filtering algorithms
- 🔧 Configurable sensitivity with preset modes (walking, running)
- 📊 Real-time step count event stream
- 🛡️ Comprehensive state management:
- Foreground tracking with real-time updates
- Background tracking support
- Terminated state recovery (syncs steps taken while app was closed)
- 🔒 Validated step data with safety checks:
- Maximum reasonable step count (50,000)
- Maximum step rate validation (3 steps/second)
- Device reboot detection
- Time validation
- 📱 Android native integration:
- OS-level step counter synchronization
- SharedPreferences for state persistence
- TYPE_STEP_COUNTER sensor support
- 📚 Complete documentation:
- Comprehensive README with examples
- API reference documentation
- Integration tests
- Example application
- 🎯 Core features:
- Low-pass filtering to reduce noise
- Peak detection algorithm
- Minimum time between steps validation
- Configurable threshold and filter parameters
- Battery-efficient implementation
Supported Platforms #
- ✅ Android (Full support)
- 🚧 iOS (Planned for future release)
Requirements #
- Flutter SDK: >=3.3.0
- Dart SDK: ^3.9.0
- Android: API 19+ (Android 4.4 KitKat)
Dependencies #
sensors_plus: ^6.0.1 - For accelerometer accessplugin_platform_interface: ^2.0.2 - For plugin architecture
Known Limitations #
- iOS support not yet implemented
- Requires ACTIVITY_RECOGNITION permission on Android 10+
- Background tracking may be limited by device-specific battery optimization settings
Breaking Changes #
- None (initial release)
Migration Guide #
- None (initial release)
Future Roadmap #
Planned for v1.2.0 #
- 📊 Step history tracking with daily/weekly summaries
- 🔔 Configurable step goal notifications
- 📈 Calorie estimation based on step count
- 🎨 Additional preset configurations (stairs, hiking, etc.)
Planned for v2.0.0 #
- 🍎 iOS support with CoreMotion integration
- 🔄 Cloud sync capabilities
- 📊 Advanced analytics and insights
- 🏃 Activity type detection (walking, running, cycling)
Contributing #
Found a bug or have a feature request? Please open an issue.
Want to contribute? Check out our contributing guidelines.
Version History #
- 1.2.1 (2026-01-02) - Configurable foreground service API level
- 1.2.0 (2025-12-30) - Foreground service support for Android ≤10
- 1.1.1 (2025-12-03) - Removed unnecessary health dependency, added logging
- 1.1.0 (2025-01-27) - Fixed terminated state sync + added callback feature
- 1.0.0 (2025-01-20) - Initial release with Android support