Skip to content

Colota - Android GPS Location tracker

docs: fix Node.js version, screen count, condition types, permissions and class name

Max Dietrich3ebb64cfc6ab
diff --git a/apps/docs/docs/development/architecture.md b/apps/docs/docs/development/architecture.md
index e9d329d7..63cde701 100644
--- a/apps/docs/docs/development/architecture.md
+++ b/apps/docs/docs/development/architecture.md
@@ -145,7 +145,7 @@ When both WiFi and motionless pause are enabled, GPS only resumes when both cond
### ProfileManager
-Evaluates tracking profile conditions and switches GPS settings automatically. Supports four condition types: charging, Android Auto / car mode, speed above threshold, and speed below threshold. Uses a rolling speed buffer for averaged speed readings, deactivation delays (hysteresis) to prevent rapid toggling, and priority-based resolution when multiple profiles match.
+Evaluates tracking profile conditions and switches GPS settings automatically. Supports five condition types: charging, Android Auto / car mode, speed above threshold, speed below threshold, and stationary. Uses a rolling speed buffer for averaged speed readings, deactivation delays (hysteresis) to prevent rapid toggling, and priority-based resolution when multiple profiles match.
### ProfileHelper
@@ -157,7 +157,7 @@ Monitors charging state via `BroadcastReceiver` and Android Auto connection via
### ProfileConstants
-Centralized constants for condition type strings (`charging`, `android_auto`, `speed_above`, `speed_below`), event types (`activated`, `deactivated`), cache TTL, speed buffer size, and minimum interval.
+Centralized constants for condition type strings (`charging`, `android_auto`, `speed_above`, `speed_below`, `stationary`), event types (`activated`, `deactivated`), cache TTL, speed buffer size, and minimum interval.
### SecureStorageHelper
@@ -167,7 +167,7 @@ Wraps Android's `EncryptedSharedPreferences` for encrypted credential storage (A
| Module | Purpose |
| --- | --- |
-| `BootReceiver` | Auto-restarts tracking after device reboot |
+| `LocationBootReceiver` | Auto-restarts tracking after device reboot |
| `MotionDetector` | Wraps `TYPE_SIGNIFICANT_MOTION` sensor - arms a one-shot hardware trigger that fires when the device starts moving, used to resume GPS after a stationary pause |
| `DeviceInfoHelper` | Device metadata and battery status with caching |
| `FileOperations` | File I/O, sharing via FileProvider, and clipboard access |
diff --git a/apps/docs/docs/development/local-setup.md b/apps/docs/docs/development/local-setup.md
index 0764a07a..2916368e 100644
--- a/apps/docs/docs/development/local-setup.md
+++ b/apps/docs/docs/development/local-setup.md
@@ -6,7 +6,7 @@ sidebar_position: 2
## Prerequisites
-- **Node.js** ≥ 22
+- **Node.js** ≥ 20
- **npm** ≥ 9 (ships with Node.js)
- **Java Development Kit** (JDK) 17
- **Android SDK** (API level 36)
@@ -118,7 +118,7 @@ colota/
│ │ │ ├── gms/java/com/colota/location/ # GMS implementation
│ │ │ └── foss/java/com/colota/location/ # Native implementation
│ │ ├── src/
-│ │ │ ├── screens/ # 14 app screens
+│ │ │ ├── screens/ # 17 app screens
│ │ │ ├── components/ # UI and feature components
│ │ │ ├── hooks/ # Custom React hooks
│ │ │ ├── services/ # Native bridge services
diff --git a/apps/docs/docs/development/permissions.md b/apps/docs/docs/development/permissions.md
index 924bb469..d336448f 100644
--- a/apps/docs/docs/development/permissions.md
+++ b/apps/docs/docs/development/permissions.md
@@ -14,6 +14,7 @@ These are the permissions Colota uses and why. None are related to analytics, ad
| Coarse Location | Yes | Network-based location fallback |
| Background Location | Yes | Track while app is in the background |
| Foreground Service | Yes | Required by Android for background services |
+| Foreground Service (Data Sync) | Yes | Auto-export background processing |
| Internet | Yes | Send locations to your server |
| Network State | Yes | Check connectivity before syncing |
| Boot Completed | Yes | Auto-restart tracking after device reboot |
@@ -51,9 +52,10 @@ android.permission.ACCESS_BACKGROUND_LOCATION
```
android.permission.FOREGROUND_SERVICE
android.permission.FOREGROUND_SERVICE_LOCATION
+android.permission.FOREGROUND_SERVICE_DATA_SYNC
```
-Android requires apps to declare a foreground service with a persistent notification to run in the background. The `FOREGROUND_SERVICE_LOCATION` type specifically indicates the service accesses location data. This is what keeps the "Colota is tracking" notification visible.
+Android requires apps to declare a foreground service with a persistent notification to run in the background. The `FOREGROUND_SERVICE_LOCATION` type specifically indicates the service accesses location data. This is what keeps the "Colota is tracking" notification visible. The `FOREGROUND_SERVICE_DATA_SYNC` type is used by the auto-export WorkManager service for scheduled background exports.
### Network
diff --git a/apps/docs/docs/getting-started/build-from-source.md b/apps/docs/docs/getting-started/build-from-source.md
index a76ad260..dfd29bf9 100644
--- a/apps/docs/docs/getting-started/build-from-source.md
+++ b/apps/docs/docs/getting-started/build-from-source.md
@@ -6,7 +6,7 @@ sidebar_position: 3
## Requirements
-- Node.js >= 22
+- Node.js >= 20
- Android SDK
- JDK 17+
diff --git a/apps/docs/docs/guides/deep-link-setup.md b/apps/docs/docs/guides/deep-link-setup.md
index 2be234d6..0d3e6960 100644
--- a/apps/docs/docs/guides/deep-link-setup.md
+++ b/apps/docs/docs/guides/deep-link-setup.md
@@ -58,27 +58,27 @@ The `config` parameter is a base64-encoded JSON object. Only include the setting
### Parameter Reference
-| Parameter | Type | Description |
-| --------------------------- | ------- | ----------------------------------------------------------------------- |
-| `endpoint` | string | Server URL to send location data to |
-| `interval` | number | GPS polling interval in seconds (must be > 0) |
-| `distance` | number | Minimum movement in meters before recording a new location |
-| `syncInterval` | number | Batch sync interval in seconds (0 = instant) |
-| `maxRetries` | number | Max retry attempts for failed uploads |
-| `retryInterval` | number | Seconds between retry attempts |
-| `accuracyThreshold` | number | Discard locations less accurate than this (meters) |
-| `filterInaccurateLocations` | boolean | Enable accuracy filtering |
-| `isOfflineMode` | boolean | Store locally only, never sync |
-| `isWifiOnlySync` | boolean | Only sync on Wi-Fi |
-| `apiTemplate` | string | `custom`, `dawarich`, `owntracks`, `phonetrack`, `reitti`, or `traccar` |
-| `httpMethod` | string | `POST` or `GET` |
-| `fieldMap` | object | Custom field name mapping for the JSON payload |
-| `customFields` | array | Static key-value pairs added to every payload |
-| `auth.type` | string | `none`, `basic`, or `bearer` |
-| `auth.username` | string | Username for Basic Auth |
-| `auth.password` | string | Password for Basic Auth |
-| `auth.bearerToken` | string | Token for Bearer Auth |
-| `customHeaders` | object | Custom HTTP headers (e.g. Cloudflare Access) |
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `endpoint` | string | Server URL to send location data to |
+| `interval` | number | GPS polling interval in seconds (must be > 0) |
+| `distance` | number | Minimum movement in meters before recording a new location |
+| `syncInterval` | number | Batch sync interval in seconds (0 = instant) |
+| `maxRetries` | number | Max retry attempts for failed uploads |
+| `retryInterval` | number | Seconds between retry attempts |
+| `accuracyThreshold` | number | Discard locations less accurate than this (meters) |
+| `filterInaccurateLocations` | boolean | Enable accuracy filtering |
+| `isOfflineMode` | boolean | Store locally only, never sync |
+| `isWifiOnlySync` | boolean | Only sync on Wi-Fi |
+| `apiTemplate` | string | `custom`, `dawarich`, `geopulse`, `owntracks`, `phonetrack`, `reitti`, or `traccar` |
+| `httpMethod` | string | `POST` or `GET` |
+| `fieldMap` | object | Custom field name mapping for the JSON payload |
+| `customFields` | array | Static key-value pairs added to every payload |
+| `auth.type` | string | `none`, `basic`, or `bearer` |
+| `auth.username` | string | Username for Basic Auth |
+| `auth.password` | string | Password for Basic Auth |
+| `auth.bearerToken` | string | Token for Bearer Auth |
+| `customHeaders` | object | Custom HTTP headers (e.g. Cloudflare Access) |
## Generating a Setup Link