Skip to content

Colota - Android GPS Location tracker

docs: update API reference, GPS settings, and changelog accuracy

Max Dietrich261ea369a0f2
diff --git a/apps/docs/README.md b/apps/docs/README.md
index b28211a9..2cdf7458 100644
--- a/apps/docs/README.md
+++ b/apps/docs/README.md
@@ -5,13 +5,13 @@ This website is built using [Docusaurus](https://docusaurus.io/), a modern stati
## Installation
```bash
-yarn
+npm install
```
## Local Development
```bash
-yarn start
+npm start
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
@@ -19,7 +19,7 @@ This command starts a local development server and opens up a browser window. Mo
## Build
```bash
-yarn build
+npm run build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
@@ -29,13 +29,13 @@ This command generates static content into the `build` directory and can be serv
Using SSH:
```bash
-USE_SSH=true yarn deploy
+USE_SSH=true npm run deploy
```
Not using SSH:
```bash
-GIT_USER=<Your GitHub username> yarn deploy
+GIT_USER=<Your GitHub username> npm run deploy
```
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
diff --git a/apps/docs/docs/api-reference.md b/apps/docs/docs/api-reference.md
index 72321753..d9ded166 100644
--- a/apps/docs/docs/api-reference.md
+++ b/apps/docs/docs/api-reference.md
@@ -59,13 +59,13 @@ All field names are [customizable](/docs/configuration/field-mapping).
| `lon` | Double | Degrees | Yes |
| `acc` | Integer | Meters (rounded) | Yes |
| `alt` | Integer | Meters (rounded) | No - only if device has altitude data |
-| `vel` | Integer | m/s (rounded) | Yes - `0` when stationary |
+| `vel` | Double | m/s (1 decimal) | No - only if device has speed data |
| `batt` | Integer | Percent (0–100) | Yes |
| `bs` | Integer | 0=unknown, 1=unplugged, 2=charging, 3=full | Yes |
| `tst` | Long | Unix seconds (not milliseconds) | Yes |
| `bear` | Double | Degrees (0–360) | No - only if device has bearing data |
-**Important:** `alt` and `bear` are conditionally included. Your server should not reject payloads missing these fields.
+**Important:** `alt`, `vel`, and `bear` are conditionally included. Your server should not reject payloads missing these fields.
### Custom Fields
diff --git a/apps/docs/docs/configuration/gps-settings.md b/apps/docs/docs/configuration/gps-settings.md
index bb1323ec..d893130e 100644
--- a/apps/docs/docs/configuration/gps-settings.md
+++ b/apps/docs/docs/configuration/gps-settings.md
@@ -10,7 +10,7 @@ sidebar_position: 2
| ------------------ | ------------------------------------ | --------- | ---------- |
| Tracking Interval | Time between GPS fixes | 5 seconds | 1s - hours |
| Movement Threshold | Minimum movement to trigger update | 0 meters | 0m - 1000m |
-| Accuracy Threshold | Filter out fixes above this accuracy | 50 meters | 0m - 1000m |
+| Accuracy Threshold | Filter out fixes above this accuracy | 50 meters | 1m - 1000m |
| Filter Inaccurate | Enable/disable accuracy filtering | Disabled | On/Off |
## Tracking Interval
diff --git a/apps/mobile/android/app/fastlane/metadata/android/en-US/changelogs/20.txt b/apps/mobile/android/app/fastlane/metadata/android/en-US/changelogs/20.txt
index d9861665..d6300732 100644
--- a/apps/mobile/android/app/fastlane/metadata/android/en-US/changelogs/20.txt
+++ b/apps/mobile/android/app/fastlane/metadata/android/en-US/changelogs/20.txt
@@ -2,5 +2,5 @@
- Fixed speed data: guard with hasSpeed() and calculate fallback from GPS points
- Fixed sync retry-forever mode dropping locations after repeated failures
- Hardened security: restrict HTTP to private networks, narrowed ProGuard rules
-- Lowered minimum accuracy threshold from 50m to 1m
+- Lowered minimum accuracy threshold input to 1m (default remains 50m)
- Speed is now sent with one decimal precision instead of rounded to integer
\ No newline at end of file