52 lines
2.2 KiB
Markdown
52 lines
2.2 KiB
Markdown
# gyropsc ⚡
|
|
**Realtime Location Dashboard 🚀**
|
|
|
|
Comprehensive documentation can be found [here](/tvolkmann/gyrogpsc/src/branch/develop/devdocs.pdf).
|
|
|
|
# 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
|
|
1. `git clone --recursive https://git.timovolkmann.de/tvolkmann/gyrogpsc.git`
|
|
2. run `go install` from project root
|
|
3. 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
|
|
4. 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.
|