docs: simplify README with marketing, move technical details to DEVELOP.md

This commit is contained in:
fiatcode 2026-04-30 18:05:41 +07:00
parent 2305b92b2b
commit 2f12826386
No known key found for this signature in database
2 changed files with 107 additions and 35 deletions

View file

@ -1,48 +1,37 @@
# Traccar Client
# TracPulse
Flutter Android app for background GPS location tracking, sending data to a Traccar server.
**Location tracking that just works.**
## Build
TracPulse runs silently in the background on your Android device, keeping your Traccar server updated with real-time location data. No complicated setup — configure your server once, and TracPulse handles the rest.
```bash
flutter build apk --debug
```
---
The APK is output to `build/app/outputs/flutter-apk/app-debug.apk`.
## Features
## Project Structure
- **Background tracking** — GPS updates continue even when the app is minimized
- **Offline buffering** — Locations stored locally when offline, synced automatically when connected
- **Configurable intervals** — Adjust how often TracPulse checks your location
- **Heartbeat mode** — Periodic location reports keep your server alive during inactivity
- **Battery optimized** — Designed to run efficiently without draining your battery
```
lib/
main.dart # App entry, dark theme, routing
main_screen.dart # Tracking toggle + live coordinates
permission_screen.dart # Pre-flight permission setup
settings_screen.dart # Server URL, device ID, accuracy config
status_screen.dart # Event log (LOCATION, SYNC, ERROR, etc.)
preferences.dart # SharedPreferences wrapper
bridge/
location_bridge.dart # Dart↔Native MethodChannel (com.traccar.client/tracking)
---
android/app/src/main/kotlin/com/traccar/traccar_client/
BridgeModule.kt # Method channel handler
service/LocationTrackingService.kt
location/HeartbeatScheduler.kt # AlarmManager heartbeat
network/TraccarHttpClient.kt # POST to server
network/ConnectivityReceiver.kt
```
## Getting Started
## Configuration
1. **Install** — Grab the APK from releases and install on your Android device
2. **Configure** — Enter your Traccar server URL and device ID
3. **Start tracking** — Tap the toggle and TracPulse begins reporting
On first launch, `PermissionScreen` guides through:
1. **Location**`locationWhenInUse` then `locationAlways` (background)
2. **Notification** — required for tracking alerts
3. **Battery** — disable Doze optimization so tracking works reliably
---
Then set server URL and device ID in Settings before starting tracking.
## Requirements
## Server Request Format
- Android device with GPS
- Traccar server (self-hosted or cloud)
- Android 8.0 or higher
POST to `https://yourserver/?id=DEVICE_ID&lat=...&lon=...&timestamp=...&is_moving=0`
---
- `is_moving` = `speed > 1.0 m/s` (3.6 km/h threshold)
- Server URL and device ID come from `Preferences` (configured in Settings screen)
## Support
Need help? Open an issue on [Codeberg](https://codeberg.org/fiatcode/tracpulse).