aboutsummaryrefslogtreecommitdiffstats
path: root/doc/gps-track.md
diff options
context:
space:
mode:
authorGravatar Christian Hesse <mail@eworm.de>2020-03-27 22:15:43 +0100
committerGravatar Christian Hesse <mail@eworm.de>2020-03-27 22:15:43 +0100
commit54a8f2839dd32d9c8bd60c2edbbca3606b250bbb (patch)
treeb8164b53f21696c30869ca2b4c3699efd3eb1579 /doc/gps-track.md
parenta87fbb4be1e1e090b01db9eebd7799a0e1d62771 (diff)
parent1d93e92dcda753b855e89295f74dafae4743bb80 (diff)
Merge branch 'documentation'
Diffstat (limited to 'doc/gps-track.md')
-rw-r--r--doc/gps-track.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/doc/gps-track.md b/doc/gps-track.md
new file mode 100644
index 0000000..a7b3d7f
--- /dev/null
+++ b/doc/gps-track.md
@@ -0,0 +1,34 @@
+Send GPS position to server
+===========================
+
+[◀ Go back to main README](../README.md)
+
+Description
+-----------
+
+This script is supposed to run periodically from scheduler and send GPS
+position data to a server for tracking.
+
+A hardware GPS antenna is required.
+
+Requirements and installation
+-----------------------------
+
+Just install the script:
+
+ $ScriptInstallUpdate gps-track;
+
+... and create a scheduler:
+
+ / system scheduler add interval=1m name=gps-track on-event="/ system script run gps-track;" start-time=startup;
+
+Configuration
+-------------
+
+The configuration goes to `global-config-overlay`, the only parameter is:
+
+* `GpsTrackUrl`: the url to send json data to
+
+---
+[◀ Go back to main README](../README.md)
+[▲ Go back to top](#top)