path: root/listen/opentracdump.c

/* OpenTRAC packet decoding by Scott Miller, N1VG
   Copyright (c) 2003 Scott Miller
   Protocol v1.0 draft, Modified 19 Jun 2003
   Released under the Modified BSD license
*/

#include <stdio.h>
#include <time.h>
#include <string.h>
#include "listen.h"

#define MAX_UNIT_INDEX 28

static const char *units[] ={
	"Volts","Amperes","Watts","Kelvins","Meters","Seconds",
	"Meters/Second","Liters","Kilograms","Bits/Second","Bytes","Radians",
	"Radians/Second","Square Meters","Joules","Newtons","Pascals","Hertz",
	"Meters/Sec^2","Grays","Lumens","Cubic Meters/Second",
	"Pascal Seconds","Kilograms/Meter^3","Radians/Second^2","Coulombs",
	"Farads","Siemens","Count"
};

static char origin_call[7]; /* Who's talking  */
static unsigned char origin_ssid;
static char entity_call[7]; /* What they're talking about  */
static unsigned char entity_ssid;
static unsigned int  entity_serial;
static unsigned int  entity_sequence;

static int extract_ssid(char *call)
{
	/* Strip the SSID from the callsign and return it  */
	int c, ssid;

   for (c=ssid=0;c<6;c++) {
      ssid |= (call[c] & 0x80) >> (c+2);
      call[c] &= 0x7f;
   }

	return ssid;
}

/* Return values: 0 = OK, -1 = Couldn't Decode, -2 = Invalid Data  */

static int decode_sequence(unsigned char *element, int element_len)
{
	/* 0x00 Sequence number - 16 bit integer  */
	if (element_len != 2 && element_len != 0) return -1;

	if (!element_len) {
		entity_sequence++;
	}
	else {
		entity_sequence = get16(element);
	}

	lprintf(T_OPENTRAC,"Sequence: %d\r\n",entity_sequence);

	return 0;
}

static int decode_origination(unsigned char *element, int element_len)
{
	/* 0x01 Originating Station - Callsign, SSID, and Sequence  */
	memcpy(origin_call, element, 6);
	origin_call[6]=0;
	origin_ssid = extract_ssid(origin_call);
	if (element_len == 8) entity_sequence = get16(element+6);
	else entity_sequence = 0;
	strcpy(entity_call, origin_call);
	entity_ssid = origin_ssid;
	entity_serial = 0;
	lprintf(T_OPENTRAC, "Origin: %s-%d seq %d\r\n",origin_call,origin_ssid,entity_sequence);

	return 0;
}

static int decode_entityid(unsigned char *element, int element_len)
{
	/* 0x02 Entity ID  */
	if (element_len > 5) {
		memcpy(entity_call, element, 6);
		entity_call[6]=0;
		entity_ssid = extract_ssid(entity_call);
	}
	else {
		strcpy(entity_call, origin_call);
	}

	switch (element_len) {
	case 0:
		entity_serial++;
		entity_sequence = 0;
		break;
	case 2:
		entity_serial = get16(element);
		entity_sequence = 0;
		break;
	case 4:
		entity_serial = get16(element);
		entity_sequence = get16(element+2);
		break;
	case 6:
		entity_serial = 0;
		break;
	case 8:
		entity_serial = get16(element+6);
		entity_sequence = 0;
		break;
	case 10:
		entity_serial = get16(element+6);
		entity_sequence = get16(element+8);
		break;
	default:
		return -1;
	}

	lprintf(T_OPENTRAC, "Entity %s-%d:%04x #%d\r\n", entity_call, entity_ssid, entity_serial, entity_sequence);

	return 0;
}

static int decode_position(unsigned char *element, int element_len)
{
	/*
	 * 0x10 Position Report - Lat/Lon/<Alt>
	 * Lat/Lon is WGS84, 180/2^31 degrees,  Alt is 1/100 meter
	 */
	const double semicircles = 11930464.71111111111;
	double lat, lon;
	float alt = 0;

	lat = get32(element) / semicircles;
	lon = get32(element+4) / semicircles;
	if (lat >= 90 || lat <= -90 || lon >= 180 || lon <= -180) return -2;
	if (element_len == 11) {
		alt = ((*(element+8))<<16)+get16(element+9);
		alt = (alt/100)-10000;
		lprintf(T_OPENTRAC, "Position: Lat %f Lon %f Alt %f meters\r\n",
				lat,lon,alt);
	}
	else {
		lprintf(T_OPENTRAC, "Position: Lat %f Lon %f\r\n",lat,lon);
	}
	return 0;
}

static int decode_timestamp(unsigned char *element, int element_len)
{
	/* 0x11 Timestamp - Unix format time (unsigned)  */
	long rawtime = 0;

	rawtime = get32(element);
	lprintf(T_OPENTRAC, "Time: %s", ctime(&rawtime));
	return 0;
}

static int decode_comment(unsigned char *element, int element_len)
{
	/* 0x12 Freeform Comment - ASCII text  */
	char comment[127];

	strncpy(comment, (char *)element, element_len);
	comment[element_len] = 0;
	lprintf(T_OPENTRAC, "Text: %s\r\n", comment);

	return 0;
}

static int decode_courseandspeed(unsigned char *element, int element_len)
{
	/* 0x13 Course and Speed - Course in degrees, speed in 1/50 m/s  */
	unsigned int course;
	unsigned int rawspeed;
	float speed;

	course = (*element<<1) | ((*(element+1)&0x80) >> 7);
	rawspeed = get16(element+1) & 0x7fff;
	speed = (float)rawspeed*0.072; /* km/h  */
	if (course >= 360) return -2;
	lprintf(T_OPENTRAC, "Course: %d Speed: %f kph\r\n", course, speed);

	return 0;
}

static int decode_ambiguity(unsigned char *element, int element_len)
{
	/* 0x14 Positional Ambiguity - 16 bits, in meters  */
	int ambiguity;

	ambiguity = get16(element);
	lprintf(T_OPENTRAC, "Position +/- %d meters\r\n", ambiguity);
	return 0;
}

static int decode_country(unsigned char *element, int element_len)
{
	/* 0x15 Country Code - ISO 3166-1 and optionally -2  */
	char country[3];
	char subdivision[4];

	strncpy(country, (char *)element, 2);
	country[2] = 0;
	if (element_len > 2) {
		strncpy(subdivision, (char *)element+2, element_len-2);
		subdivision[element_len-2] = 0;
		lprintf(T_OPENTRAC, "Country Code %s-%s\r\n", country, subdivision);
	}
	else {
		lprintf(T_OPENTRAC, "Country Code %s\r\n", country);
	}
	return 0;
}

static int decode_displayname(unsigned char *element, int element_len)
{
     char displayname[31];	/* 0x16 - Display Name (UTF-8 text)    */

     strncpy(displayname, (char *)element, element_len);
     displayname[element_len] = 0;

     lprintf(T_OPENTRAC, "Display Name: %s\r\n", displayname);
     return 0;
}

static int decode_waypoint(unsigned char *element, int element_len)
{
	char waypoint[7]; /* 0x17 - Waypoint Name (up to 6 chars, uppercase)  */

	strncpy(waypoint, (char *)element, element_len);
	waypoint[element_len] = 0;

	lprintf(T_OPENTRAC, "Waypoint Name: %s\r\n", waypoint);
	return 0;
}

static int decode_symbol(unsigned char *element, int element_len)
{
	int c;		/* 0x18 Map Symbol - Packed 4-bit integers */

	lprintf(T_OPENTRAC, "Symbol: ");
	for (c=0;c<element_len;c++) {
		if (c>0) lprintf(T_OPENTRAC, ".");
		lprintf(T_OPENTRAC, "%d", element[c] >> 4);
		if (element[c] & 0x0f) lprintf(T_OPENTRAC, ".%d", element[c] & 0x0f);
	}
	lprintf(T_OPENTRAC, "\r\n");

	return 0;
}

static int decode_pathtrace(unsigned char *element, int element_len)
{
	char callsign[7];	/* 0x20 Path Trace - Call/SSID, Network  */
	int ssid, c, network;

	if (element_len % 7) return -1; /* Must be multiple of 7 octets  */
	if (!element_len) {
		lprintf(T_OPENTRAC, "Empty Path\r\n");
		return 0;
	}

	lprintf(T_OPENTRAC, "Path: ");
	for (c=0; c<element_len; c+=7) {
		memcpy(callsign, element+c, 6);
		ssid = extract_ssid(callsign);
		network = (int)*(element+c+6);
		lprintf(T_OPENTRAC, " %s-%d (%d)", callsign, ssid, network);
	}
	lprintf(T_OPENTRAC, "\r\n");

	return 0;
}

static int decode_heardby(unsigned char *element, int element_len)
{
	int c;		/* 0x21 Heard-By List  */

	lprintf(T_OPENTRAC, "Heard By:");
	for (c=0; c<element_len; c++) {
		lprintf(T_OPENTRAC, " %d", (int)*(element+c));
	}
	lprintf(T_OPENTRAC, "\r\n");

	return 0;
}

static int decode_availablenets(unsigned char *element, int element_len)
{
	int c;	/* 0x22 Available Networks  */

	lprintf(T_OPENTRAC, "Available Networks:");
	for (c=0; c<element_len; c++) {
		lprintf(T_OPENTRAC, " %d", (int)*(element+c));
	}
	lprintf(T_OPENTRAC, "\r\n");

	return 0;
}

static int decode_gpsquality(unsigned char *element, int element_len)
{
	/* 0x34 GPS Data Quality - Fix, Validity, Sats, PDOP, HDOP, VDOP  */
	int fixtype, validity, sats;
	const char *fixstr[] = {"Unknown Fix", "No Fix", "2D Fix", "3D Fix"};
	const char *validstr[] = {"Invalid", "Valid SPS", "Valid DGPS",
						 "Valid PPS"};

	fixtype = (element[0] & 0xc0) >> 6;
	validity = (element[0] & 0x30) >> 4;
	sats = (element[0] & 0x0f);
	lprintf(T_OPENTRAC, "GPS: %s %s, %d sats", fixstr[fixtype],
			validstr[validity], sats);
	if (element_len > 1)
		lprintf(T_OPENTRAC, " HDOP=%.1f", (float)element[1]/10);
	if (element_len > 2)
		lprintf(T_OPENTRAC, " PDOP=%.1f", (float)element[2]/10);
	if (element_len > 3)
		lprintf(T_OPENTRAC, " VDOP=%.1f", (float)element[3]/10);
	lprintf(T_OPENTRAC, "\r\n");

	return 0;
}

static int decode_acreg(unsigned char *element, int element_len)
{
	char nnumber[9];	/* 0x35 Aircraft Registration - ASCII text  */

	strncpy(nnumber, (char *)element, element_len);
	nnumber[element_len]=0;
	lprintf(T_OPENTRAC, "Aircraft ID: %s\r\n", nnumber);

	return 0;
}

static int decode_rivergauge(unsigned char *element, int element_len)
{
	unsigned int flow;	/* 0x42 River Flow Gauge - 1/64 m^3/sec	 */
	unsigned int height;	/* centimeters				 */
	float flowm;
	float heightm;

	flow = get16(element);
	height = get16(element+2);
	flowm = (float)flow / 64;
	heightm = (float)height / 100;
	lprintf(T_OPENTRAC, "River flow rate: %f Cu M/Sec  Height: %f M\r\n",
			flowm, heightm);

	return 0;
}

static int decode_units(unsigned int unitnum, unsigned char *element,
	int element_len)
{
	/*
	 * 0x0500 to 0x05ff Generic Measurement Elements
	 * Values may be 8-bit int, 16-bit int, single float, or double float
	 */
	union measurement {
		char c;
		float f;
		double d;
	} *mval;
	int ival; /* too much variation in byte order and size for union */

	if (unitnum > MAX_UNIT_INDEX) return -2; /* Invalid unit name  */
	mval = (void *)element;
	switch (element_len) {
	case 1:
		lprintf(T_OPENTRAC, "%d %s\r\n", mval->c, units[unitnum]);
		break;
	case 2:
		ival = get16(element);
		lprintf(T_OPENTRAC, "%d %s\r\n", ival, units[unitnum]);
		break;
	case 4:
		lprintf(T_OPENTRAC, "%f %s\r\n", mval->f, units[unitnum]);
		break;
	case 8:
		lprintf(T_OPENTRAC, "%f %s\r\n", mval->d, units[unitnum]);
		break;
	default:
		return -1;
	}

	return 0;
}

static int flag_emergency(unsigned char *element, int element_len)
{
	/* 0x0100 - Emergency / Distress Call */
	lprintf(T_ERROR, "* * * EMERGENCY * * *\r\n");
	return 0;
}

static int flag_attention(unsigned char *element, int element_len)
{
	/* 0x0101 - Attention / Ident */
	lprintf(T_PROTOCOL, " - ATTENTION - \r\n");
	return 0;
}

static int decode_hazmat(unsigned char *element, int element_len)
{
	/* 0x0300 - HAZMAT (UN ID in lower 14 bits)  */
	int un_id;

	if (element_len < 2) {
		lprintf(T_OPENTRAC, "HAZMAT: Unknown Material\r\n");
	}
	else {
		un_id = get16(element) & 0x3fff;
		lprintf(T_OPENTRAC, "HAZMAT: UN%04d\r\n", un_id);
	}
	return 0;
}

static int decode_maidenhead(unsigned char *element, int element_len)
{
   /* 0x32 - Maidenhead Locator (4 or 6 chars)  */
   char maidenhead[7];

   if (element_len > 6 || !element_len) return -1;

   strncpy(maidenhead, (char *)element, element_len);
   maidenhead[element_len] = 0;

   lprintf(T_OPENTRAC, "Grid ID: %s\r\n", maidenhead);
   return 0;
}

static struct {
	unsigned int element_id;
	unsigned char min_size;
	unsigned char max_size;
	int (*pDecode)(unsigned char *element, int element_len);
} element_decode[] = {{0x00, 0, 2, decode_sequence},
					  {0x01, 6, 8, decode_origination},
					  {0x02, 0, 10, decode_entityid},
					  {0x10, 8, 11, decode_position},
					  {0x11, 4, 4, decode_timestamp},
					  {0x12, 0, 127, decode_comment},
					  {0x13, 3, 3, decode_courseandspeed},
					  {0x14, 2, 2, decode_ambiguity},
					  {0x15, 2, 5, decode_country},
					  {0x16, 1, 30, decode_displayname},
					  {0x17, 1, 6, decode_waypoint},
					  {0x18, 1, 4, decode_symbol},
					  {0x20, 0, 127, decode_pathtrace},
					  {0x21, 0, 127, decode_heardby},
					  {0x22, 0, 127, decode_availablenets},
					  {0x32, 4, 6, decode_maidenhead},
					  {0x34, 1, 4, decode_gpsquality},
					  {0x35, 1, 8, decode_acreg},
					  {0x42, 4, 4, decode_rivergauge},
					  {0x100, 0, 127, flag_emergency},
					  {0x101, 0, 127, flag_attention},
					  {0x300, 0, 2, decode_hazmat},
					  {0, 0, 0, NULL}}, *element_decode_ptr;

/* Dump an OpenTRAC packet */
void opentrac_dump(unsigned char *data, int length, int hexdump)
{
	int elen;
	int etype;
	int decoded = 0;

	lprintf(T_PROTOCOL, "OpenTRAC decode (%d bytes):\r\n", length);
	strcpy(origin_call, "SENDER"); /* Listen doesn't tell us the sender  */
	origin_ssid = 0;
	entity_serial = 0;
	entity_sequence = 0;
	while (decoded < length) {
		elen = (int)*data;
		decoded += (elen & 0x7f)+1;
		if (elen & 0x80) {  /* See if it's got a 16-bit ID  */
			elen = (elen & 0x7f) - 2; /* Strip the extid flag  */
			etype = get16(++data);
		}
		else {
			elen--; /* Don't count the type byte  */
			etype = (int)*(data+1);
		}
		data+=2; /* Skip to the body  */
		lprintf(T_OPENTRAC, "EID 0x%0x len %d: ", etype, elen);
		for (element_decode_ptr = element_decode; element_decode_ptr->pDecode != NULL; element_decode_ptr++) {
			if (etype == element_decode_ptr->element_id) {
				if (elen < element_decode_ptr->min_size || elen > element_decode_ptr->max_size) {
					lprintf(T_OPENTRAC, "Invalid element length\r\n");
				}
				else {
					if (element_decode_ptr->pDecode(data, elen)) {
						lprintf(T_OPENTRAC, "Unable to decode\r\n");
					}
				}
				break;
			}
		}
		if (element_decode_ptr->pDecode == NULL) {
			if ((etype & 0xff00) == 0x500) {
				decode_units(etype & 0x00ff, data, elen);
			}
			else {
				lprintf(T_OPENTRAC, "Unknown element type - unable to decode.\r\n");
			}
		}
		data+=elen;
	}
}