readme updated
This commit is contained in:
parent
3cc6264f2a
commit
435bf451a5
1
.gitignore
vendored
1
.gitignore
vendored
@ -162,3 +162,4 @@ Temporary Items
|
||||
gpsconfig.yml
|
||||
config.yml
|
||||
_db
|
||||
/build
|
||||
|
||||
BIN
backups/_db-210115-01/raw/000000.vlog
Normal file
BIN
backups/_db-210115-01/raw/000000.vlog
Normal file
Binary file not shown.
1
backups/_db-210115-01/raw/KEYREGISTRY
Normal file
1
backups/_db-210115-01/raw/KEYREGISTRY
Normal file
@ -0,0 +1 @@
|
||||
ˆ‰œœ+¥¶Îz {Hello Badger
|
||||
1
backups/_db-210115-01/raw/LOCK
Normal file
1
backups/_db-210115-01/raw/LOCK
Normal file
@ -0,0 +1 @@
|
||||
38895
|
||||
BIN
backups/_db-210115-01/raw/MANIFEST
Normal file
BIN
backups/_db-210115-01/raw/MANIFEST
Normal file
Binary file not shown.
BIN
backups/_db-210115-01/records/000000.vlog
Normal file
BIN
backups/_db-210115-01/records/000000.vlog
Normal file
Binary file not shown.
1
backups/_db-210115-01/records/KEYREGISTRY
Normal file
1
backups/_db-210115-01/records/KEYREGISTRY
Normal file
@ -0,0 +1 @@
|
||||
;µÐÕ0.Ñþý|uG…Hello Badger
|
||||
1
backups/_db-210115-01/records/LOCK
Normal file
1
backups/_db-210115-01/records/LOCK
Normal file
@ -0,0 +1 @@
|
||||
38895
|
||||
BIN
backups/_db-210115-01/records/MANIFEST
Normal file
BIN
backups/_db-210115-01/records/MANIFEST
Normal file
Binary file not shown.
BIN
backups/_db-210115-01/sensor/000000.vlog
Normal file
BIN
backups/_db-210115-01/sensor/000000.vlog
Normal file
Binary file not shown.
1
backups/_db-210115-01/sensor/KEYREGISTRY
Normal file
1
backups/_db-210115-01/sensor/KEYREGISTRY
Normal file
@ -0,0 +1 @@
|
||||
枯華虌𤥢崱v叐<76>Hello Badger
|
||||
1
backups/_db-210115-01/sensor/LOCK
Normal file
1
backups/_db-210115-01/sensor/LOCK
Normal file
@ -0,0 +1 @@
|
||||
6958
|
||||
BIN
backups/_db-210115-01/sensor/MANIFEST
Normal file
BIN
backups/_db-210115-01/sensor/MANIFEST
Normal file
Binary file not shown.
BIN
backups/_db-210115-01/trackings/000000.vlog
Normal file
BIN
backups/_db-210115-01/trackings/000000.vlog
Normal file
Binary file not shown.
1
backups/_db-210115-01/trackings/KEYREGISTRY
Normal file
1
backups/_db-210115-01/trackings/KEYREGISTRY
Normal file
@ -0,0 +1 @@
|
||||
ßÁuðÓJäe»|?^<5E>¢˜Hello Badger
|
||||
1
backups/_db-210115-01/trackings/LOCK
Normal file
1
backups/_db-210115-01/trackings/LOCK
Normal file
@ -0,0 +1 @@
|
||||
6958
|
||||
BIN
backups/_db-210115-01/trackings/MANIFEST
Normal file
BIN
backups/_db-210115-01/trackings/MANIFEST
Normal file
Binary file not shown.
@ -1,3 +1,7 @@
|
||||
/**
|
||||
only for testing purposes
|
||||
*/
|
||||
|
||||
package main
|
||||
|
||||
import (
|
||||
|
||||
29
readme.md
29
readme.md
@ -1,27 +1,42 @@
|
||||
# gyropsc ⚡
|
||||
**Realtime Location Dashboard 🚀**
|
||||
## Quickstart
|
||||
# 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
|
||||
## 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
|
||||
## 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.
|
||||
|
||||
### Run
|
||||
## Run
|
||||
Execute `gyropgsc-$OS`, according to your operating system.
|
||||
|
||||
|
||||
## Build from source
|
||||
### Requirements
|
||||
# Build and run from source
|
||||
## Requirements
|
||||
* git
|
||||
* go >1.15
|
||||
|
||||
### Build Steps
|
||||
## 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
|
||||
|
||||
## Build
|
||||
For Windows 64-bit: `GOOS=windows GOARCH=amd64 go build -o build/gyrogpsc-win.exe cmd/server/server.go`
|
||||
|
||||
For MacOS: `GOOS=darwin GOARCH=amd64 go build -o build/gyrogpsc-mac cmd/server/server.go`
|
||||
|
||||
For Linux: `GOOS=linux GOARCH=arm64 go build -o build/gyrogpsc-linux cmd/server/server.go`
|
||||
|
||||
Make sure that binaries have execute permissions on Mac and Linux. Currently only working on 64-bit systems.
|
||||
|
||||
## 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.
|
||||
|
||||
@ -98,7 +98,6 @@ window.addEventListener("load", function(evt) {
|
||||
document.getElementById("yellow").style.backgroundColor = 'rgb(157,117,25)'
|
||||
document.getElementById("redlamp").style.backgroundColor = 'rgb(255,14,14)'
|
||||
}
|
||||
|
||||
}
|
||||
tempTCPCoords = null
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user