ogn-client-rs

This crate provides a Rust client for the OGN (Open Glider Network). A default parser is provided which parses the OGN messages (which are in an extended APRS format) to a corresponding Rust data structure.

The default parser should be fine for most use cases. To separate the library from users' libraries the resulting data structure can be converted if needed.

In case a parse for your custom data structure is desired simply the Parse trait.

Usage

Messages can be read by passing a callback to the client like in the following simple example:

use ogn_client_rs::{APRSClient, PORT};

fn main() {

  // create a closure which takes a &str as parameter. Can also be a regular function.
  let callback = |message: &str| {
    println!("from callback: {}", message);
  }

  let client = APRSClient::new("aprs.glidernet.org", PORT::FULLLFEED, Box::new(callback));

  // keep the client alive for 5s
  std::thread::sleep(std::time::Duration::from_secs(5));

  // client runs out of scope and gets destroyed
}

example using the parser and setting a afilter

mod parser;
use parse::Parse;

use std::io::Error;

use ogn_client_rs::{APRSClient, LoginData, PORT};

fn main() -> Result<(), Error> {

  // callback triggered on ogn message reception
  let callback = |message: &str| {
    let result = parser::OgnTransmission::parse(message);
    if let Some(value) = result {
      println!("{:#?}", value);
    }
  };

  let client = APRSClient::new("aprs.glidernet.org", PORT::FILTER, Box::new(callback));

  // try to connect until connected
  while !client.lock().unwrap().is_connectd() {
    let _ = client.lock().unwrap().connect();

    std::thread::sleep(std::time::Duration::from_secs(1));
  }

  // login
  let login_data = LoginData::new().user_name("YOUR_USER_NAME").pass_code("YOUR_PASSCODE");
  client.lock().unwrap().login(&login_data);

  // start listening
  APRSClient::run(client.clone());

  // set the filter at lat: 47, lon: 4 with radius of 100km
  client.lock().unwrap().set_filter("r/47/7/100").unwrap();

  // keep the client alive
  loop {
    std::thread::sleep(std::time::Duration::from_secs(1));
  }
}

TODO:

Library

check for login status
check for connection status
add send status
add passcode generation
add documentation for library

parsing

Make sure the lat/long conversion to coordinate is correct
create an example with a parser

Further Details

aprs-is notes:

ogn aprs protocol
ogn-wiki
constant information should only be sent every 5 minutes
After every 20s a heartbeat is sent from the server, try to reconnect after 1min of not receiving the heartbeat

an example of a ogn message looks as follows:

OGN82149C>OGNTRK,qAS,OxfBarton:/130208h5145.95N/00111.50W'232/000/A=000295 !W33! id3782149C +000fpm -4.3rot FL000.00 55.0dB 0e -3.7kHz gps3x5

where the header OGN82149C>OGNTRK,qAS,OxfBarton and message /130208h5145.95N/00111.50W'232/000/A=000295 !W52! id3782149C +000fpm -4.3rot FL000.00 55.0dB 0e -3.7kHz gps3x5 are seperated with a :. The fields until !W52!, where 5 is the third decimal digit of latitude minutes and 2 is the added digit of longitude minutes, are pure APRS format and after are "comments" which carry ogn specific extra information.

The following table should also give an overview of the fields:

Field	Meaning	Possible fields
OGN82149C	Sender	string
OGNTRK	Target	string
qAS	Transmission Method	`qAS`, `TCPIP*`, others?
OxfBarton	Receiver	string
1300280h	Time	HHMMSS
5145.95N	Latitude
00111.50W	Longitude
232	ground track	0-360 `[degrees]`
000	ground speed	>0 `[kmh]`
!W52!	APRS precision enhancement, `5` is the third decimal digit of latitude minutes, `2` is the added digit of longitude minutes	[0-9]
id3782149C	OGN id	see id specifications
+000fpm	climb rate	`[feet]`
-4.3rot	rotation rate	angular speed in `[1 half-turn per minute]`
FL000	standard flight level	>0 `[FL]`
55.0dB	signal to noise ratio	>0 `[dB]`
0e	number of bit error corrected upon receiption	>0 `[bit]`
-3.7kHz	frequency offset measured upon receiption	`[kHz]`
gps3x5	gps accuracy 3m horizontal, 5m vertical	horizontal x vertical in `[m]`

For the processing of the received messages a callback approach is used. This mitigates the responsibility of the client which should only be responsible for receiving and sending the data.

BeatScherrer / ogn-client-rs