Quellcode durchsuchen

short README for gps_minder

clementinecomputing vor 6 Jahren
Ursprung
Commit
a8ac125ccb
1 geänderte Dateien mit 30 neuen und 0 gelöschten Zeilen
  1. 30 0
      busunit/gps/README.md

+ 30 - 0
busunit/gps/README.md

@@ -0,0 +1,30 @@
+`gps_minder`
+===
+
+This file listens on the GPS `tty` interface (`/dev/ttyGPS`) for GPS
+messages and sends messages to the Inter Process Communications (IPC) hub
+with GPS updates.
+
+Note that the `/dev/ttyGPS` should be setup system wide before this program is run.
+This is done by the Popufare system by creating a symbolic link to the appropriate
+underlying `tty` device that the GPS is connected to.
+
+`gps_minder` listens for `GPRMC` and `GPGGA` NMEA messages to update it's GPS position.
+
+Once received, the `gps_minder` will send a `GPS_MESSAGE` to the IPC so other services
+can get the GPS update.
+
+GPS updates will only occur once at least 3 satellites have been found.
+
+Building
+---
+
+```
+$ ./buildit_native.sh
+```
+
+---
+
+| Value | Description |
+|---|---|
+| `/dev/ttyGPS` | Serial interface (`8N1`, `115200`) to listen for GPS NMEA message updates |