turbo87 / ogn-web-gateway

OpenGliderNet Web-Gateway

ogn-web-gateway

OpenGliderNet Web-Gateway

This project contains a webserver that connects to the OpenGliderNet, saves the received records to a database for 24 hours and relays all data to any connected WebSocket clients.

Installation & Usage

ogn-web-gateway is using the in-memory database Redis as the data store for the History API. Before attempting to install ogn-web-gateway make sure to have a working Redis server running.

Next, you should clone this repository using git:

git clone https://github.com/Turbo87/ogn-web-gateway.git

Before continuing make sure to set the REDIS_URL environment variable so that ogn-web-gateway known what Redis server it should try to connect to:

export REDIS_URL=redis://localhost

Finally we can use cargo to download all necessary dependencies, compile the application and then run it:

cargo run --release

By default ogn-web-gateway does not produce any console output when running, so don't be surprised. Once it is running you should be able to visit http://127.0.0.1:8080/api/status to verify that everything runs correctly.

API Documentation

For the API documentation please have a look at the docs folder.

License

This project is licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)

• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

ogn-web-gateway's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update chrono crate to 0.4.31
• Update serde crate to 1.0.193
• Update systemstat crate to 0.1.12
• Update actix crate to 0.13.1
• Update actix-cors crate to 0.6.4
• Update actix-files crate to 0.6.2
• Update itertools crate to 0.12
• Update pretty_env_logger crate to 0.5
• Update r2d2_redis crate to 0.14
• Update sentry crate to 0.32
• Update systemstat crate to 0.2.3
• Update actions/checkout action to v4
• Update actix-web crate to v4
• Update actix-web-actors crate to v4
• Update clap crate to v4
• Lock file maintenance
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

cargo

Cargo.toml

• actix 0.10.0
• actix-cors 0.3.0
• actix-files 0.3.0
• actix-ogn 0.4.0
• actix-web 3.3.3
• actix-web-actors 3.0.0
• anyhow 1.0.75
• bincode 1.3.3
• chrono 0.4.24
• clap 2.34.0
• itertools 0.10
• lazy_static 1.4.0
• log 0.4
• pretty_env_logger 0.4
• r2d2_redis 0.13
• regex 1
• sentry 0.20
• serde 1.0.156
• serde_json 1.0
• systemstat 0.1.11
• approx 0.5.1

github-actions

.github/workflows/ci.yml

• actions/checkout v2
• actions-rs/toolchain v1
• actions-rs/cargo v1
• actions-rs/cargo v1
• actions-rs/cargo v1
• actions-rs/cargo v1

---

• Check this box to trigger a request for Renovate to run again on this repository

Add Documentation

This project should at least have a README describing the project, and a description of the APIs it provides.

• Add README file
• Add LICENSE file(s)
• Add HTTP API description
• Add WebSocket API description

API: Add `/api/latest` route

This route should show the latest OGN records for all OGN IDs that were active in the last ~30 min. It should accept (possible require) a bounding box parameter either as query param or path param that scopes the request.

History API returns timestamps outside of requested window

The History API currently has a bug where it returns records with timestamps outside of the requested time window. It only uses the time window to figure out which redis buckets to query, but it is missing the final filtering step, as the buckets may include more records then requested.

Add CORS headers

The API responses should contain CORS headers to allow the data to be used on other webpages, including http://localhost:4200.

Capture more metrics

We might want to integrate https://github.com/magnet/metered-rs to capture a few more metrics, like incoming/outgoing messages/second, etc.

WebSocket: Implement bounding box subscriptions

details tbd

API: Allow IGC file downloads

We could query the database for all records of a certain ID and output it as an IGC file.

WebSocket: Improve record serialization format

Messages received from the websocket at /api/live are prefixed with $ followed by the message type. Since OGN position records are most common those are explicitly not prefixed and don't carry the message type to save bytes.

The fields in an OGN position records are separated by the | character and are sent in the following order:

• APRS sender ID (e.g. FLRDD87AC)
• Unix timestamp (in seconds)
• WGS84 longitude (in degrees)
• WGS84 latitude (in degrees)
• Course (in degrees from North)
• Altitude (in meters)

Example:

FLRC04EFE|1531605102|-75.117233|45.493900|16|743

API: Provide OGN Device Database data

We should probably hold that data locally in our own database and sync them regularly.

References:

• https://github.com/glidernet/ogn-ddb
• http://ddb.glidernet.org/download/?t=1

API: Improve `/api/records` route

The /api/{id}/positions route should be renamed and improved:

• rename to /api/records/{id}
• add before and after query parameters corresponding to UNIX timestamps scoping the request
• find a better output format...

WebSocket: Move to `/api/live`

• change the websocket route from /ws to /api/live for consistency