Go to file

Timo Volkmann 7fc0588e4e docs		2021-04-19 17:21:04 +02:00
.idea	clean up js code	2021-01-13 13:16:59 +01:00
backups	readme updated	2021-01-15 13:49:51 +01:00
cmd	readme updated	2021-01-15 13:49:51 +01:00
core	comments	2021-01-15 17:37:24 +01:00
static	added JSDoc to refull.js and websocket.js	2021-01-15 19:08:08 +01:00
storage	added readme, commented functionality, cleaned up	2021-01-06 17:05:30 +01:00
templates	comments and fixes	2021-01-15 12:18:09 +01:00
ublox	added credits for ublox package	2021-01-15 14:03:15 +01:00
web	added http logger	2021-01-11 00:00:00 +01:00
.gitignore	readme updated	2021-01-15 13:49:51 +01:00
.gitmodules	added submodule	2021-01-11 09:42:30 +01:00
devdocs.pdf	added devdocs	2021-04-19 17:18:24 +02:00
example_config.yml	added readme, commented functionality, cleaned up	2021-01-06 17:05:30 +01:00
go.mod	updated dependecy to support apple silicon	2021-04-19 17:11:02 +02:00
go.sum	updated dependecy to support apple silicon	2021-04-19 17:11:02 +02:00
readme.md	docs	2021-04-19 17:21:04 +02:00

readme.md

gyropsc ⚡

Realtime Location Dashboard 🚀

Comprehensive documentation can be found here.

Quickstart

First copy example_config.yml to gpsconfig.yml and adjust your parameters. if you intend to use this tool with ublox over USB or Serial, you need to set the name of your port in this config file. otherwise the program will panic.

Requirements

Win, Linux or Mac Computer, ideally with serial port and WiFi
GPS device (Android or iOS smartphone and/or ublox 8/M8 series module)
download latest release and unzip it

Preparation

Make sure you prepared your GPS device like described in chapter 3.3 of the Documentation. Start gyrogpsc before connecting your smartphone via TCP. Make sure you updated the config file with the correct COM port for your ublox device, before starting the Serial Collector from the UI.

Run

Execute gyropgsc-$OS, according to your operating system. Make sure the containing folder is your working directory.

Build and run from source

Requirements

git
go >1.15

Run

git clone --recursive https://git.timovolkmann.de/tvolkmann/gyrogpsc.git
run go install from project root
run go run cmd/server/server.go from project root to start application or just go build cmd/server/server.go for building it only
open http://localhost:3011

Build

For your platform only: go build cmd/server/server.go

Cross-Platform Builds:

For Windows 64-bit: GOOS=windows GOARCH=amd64 go build -o gyrogpsc-win.exe cmd/server/server.go

For MacOS: GOOS=darwin GOARCH=amd64 go build -o gyrogpsc-mac cmd/server/server.go

For Linux: GOOS=linux GOARCH=arm64 go build -o gyrogpsc-linux cmd/server/server.go

Make sure that binaries have execute permissions on Mac and Linux. Currently only working on 64-bit systems. Cross Platform commands only working on Mac & Linux.

Static files and demo database

Demo database

To use demo data, copy backups/_db-210115-01/ to folder _db/ in project root. The prebuilt binaries zip-file already contains demo data.

Static files

All static files (static/ and templates/) must be in the root of working directory when running gyrogpsc. That's already the case if you follow "Run" instructions.