MotorSignal-App/README.md

35 lines
1.7 KiB
Markdown

# Motorcycle Digital Dashboard 🏍️
A high-performance, dark-themed telemetry and analytics dashboard for motorcycles, built with Flutter.
## Features
* **Real-time Telemetry:** Uses GPS and IMU sensors to calculate speed, lean angle (bank), and acceleration/braking G-forces.
* **Automatic Ride Recording:** Automatically starts tracking when movement is detected and logs your trip.
* **Performance Analysis:** Automatically measures 0-60 MPH and 0-100 MPH acceleration times.
* **Ride History & Replay:** View past rides, replay telemetry synchronized with a Google Map.
* **Audio Alerts:** Text-to-speech alerts for milestones and ride states to keep your eyes on the road.
* **Data Export:** Export your ride telemetry to `.csv` or `.gpx` for external analysis.
## Setup & Building
1. Ensure you have the Flutter SDK installed.
2. Clone this repository.
3. Run `flutter pub get` to fetch dependencies.
4. Add your Google Maps API key in `android/app/src/main/AndroidManifest.xml` (replace `YOUR_API_KEY_HERE`).
5. Run `flutter run` or `flutter build apk`.
## Architecture
* **Framework:** Flutter (Material 3).
* **State Management:** Riverpod for reactive UI state.
* **Database:** Drift (SQLite) for robust, local storage.
* **Sensor Fusion:** Complementary filter combining accelerometer and gyroscope for precise lean angles.
## Documentation
The active documentation map and dated evidence archive are indexed in [docs/README.md](docs/README.md).
## Disclaimer
This application relies on the accuracy of your smartphone's internal sensors. It should be securely mounted to the motorcycle using a rigid mount. Do not interact with the screen while riding. Ride safely!