Generate NMEA waypoint sentences ($PKWDWPL, etc.) for position and object reports.

These can be used by Geosat AvMap or other mapping applications.

Author: wb2osz

CHANGES.md

@@ -3,7 +3,7 @@
 
 ----------
 
-## Version 1.3  -- Beta Test  --  February 2016 ##
+## Version 1.3  -- Beta Test  --  March 2016 ##
 
 ### New Features: ###
 
@@ -40,7 +40,7 @@ command line option.
 
  - When receiving packet with comment of a few hundred characters.
 
- - Address in path, from Internet server. more than 9 characters.
+ - Address in path, from Internet server, more than 9 characters.
 
 - "INTERNAL ERROR: dlq_append NULL packet pointer." when using PASSALL.
 
@@ -51,6 +51,8 @@ command line option.
 - AGW network protocol now works properly for big-endian processors
 such as PowerPC or MIPS.
 
+- Packet filtering treated telemetry metadata as messages rather than telemetry.
+
 ----------
 
 ## Version 1.2  -- June 2015 ##

Makefile.linux

@@ -234,7 +234,7 @@ direwolf : direwolf.o config.o recv.o demod.o dsp.o demod_afsk.o demod_9600.o hd
 		decode_aprs.o symbols.o server.o kiss.o kissnet.o kiss_frame.o hdlc_send.o fcs_calc.o \
 		gen_tone.o audio.o audio_stats.o digipeater.o pfilter.o dedupe.o tq.o xmit.o morse.o \
 		ptt.o beacon.o encode_aprs.o latlong.o encode_aprs.o latlong.o textcolor.o \
-		dtmf.o aprs_tt.o tt_user.o tt_text.o igate.o nmea.o serial_port.o log.o telemetry.o \
+		dtmf.o aprs_tt.o tt_user.o tt_text.o igate.o waypoint.o serial_port.o log.o telemetry.o \
 		dwgps.o dwgpsnmea.o dwgpsd.o dtime_now.o \
 		misc.a geotranz.a
 	$(CC) -o $@ $^ $(LDFLAGS)

Makefile.macosx

@@ -226,7 +226,7 @@ direwolf : direwolf.o aprs_tt.o audio_portaudio.o audio_stats.o ax25_pad.o beaco
 		encode_aprs.o encode_aprs.o fcs_calc.o fcs_calc.o gen_tone.o \
 		geotranz.a hdlc_rec.o hdlc_rec2.o hdlc_send.o igate.o kiss_frame.o \
 		kiss.o kissnet.o latlong.o latlong.o log.o morse.o multi_modem.o \
-		nmea.o serial_port.o pfilter.o ptt.o rdq.o recv.o redecode.o rrbb.o server.o \
+		waypoint.o serial_port.o pfilter.o ptt.o rdq.o recv.o redecode.o rrbb.o server.o \
 		symbols.o telemetry.o textcolor.o tq.o tt_text.o tt_user.o xmit.o \
 		dwgps.o dwgpsnmea.o
 	$(CC) $(CFLAGS) -o $@ $^ -lpthread $(LDLIBS) -lm

Makefile.win

@@ -72,7 +72,7 @@ direwolf : direwolf.o config.o recv.o demod.o dsp.o demod_afsk.o demod_9600.o hd
 		decode_aprs.o symbols.o server.o kiss.o kissnet.o kiss_frame.o hdlc_send.o fcs_calc.o \
 		gen_tone.o morse.o audio_win.o audio_stats.o digipeater.o pfilter.o dedupe.o tq.o xmit.o \
 		ptt.o beacon.o dwgps.o encode_aprs.o latlong.o textcolor.o \
-		dtmf.o aprs_tt.o tt_user.o tt_text.o igate.o nmea.o serial_port.o log.o telemetry.o \
+		dtmf.o aprs_tt.o tt_user.o tt_text.o igate.o waypoint.o serial_port.o log.o telemetry.o \
 		dwgps.o dwgpsnmea.o dtime_now.o \
 		dw-icon.o regex.a misc.a geotranz.a
 	$(CC) $(CFLAGS) -o $@ $^ -lwinmm -lws2_32

README.md

@@ -5,7 +5,7 @@
 
 In the early days of Amateur Packet Radio, it was necessary to use a “Terminal Node Controller” (TNC) with specialized hardware.  Those days are gone.  You can now get better results at lower cost by connecting your radio to the “soundcard” interface of a computer and using software to decode the signals.
 
-Dire Wolf is a software "soundcard" modem/TNC and [APRS](http://www.aprs.org/) encoder/decoder.   It can be used stand-alone to observe APRS traffic, as a digipeater, [APRStt](http://www.aprs.org/aprstt.html) gateway, or Internet Gateway (IGate).    It can also be used as a virtual TNC for other applications such as [APRSIS32](http://aprsisce.wikidot.com/), [UI-View32](http://www.ui-view.net/), [Xastir](http://xastir.org/index.php/Main_Page), [APRS-TW](http://aprstw.blandranch.net/), [YAAC](http://www.ka2ddo.org/ka2ddo/YAAC.html), [UISS](http://users.belgacom.net/hamradio/uiss.htm), [Linux AX25](http://www.linux-ax25.org/wiki/Main_Page), [SARTrack](http://www.sartrack.co.nz/index.html), [RMS Express](http://www.winlink.org/RMSExpress), and many others.
+Dire Wolf is a software "soundcard" modem/TNC and [APRS](http://www.aprs.org/) encoder/decoder.   It can be used stand-alone to observe APRS traffic, as a digipeater, [APRStt](http://www.aprs.org/aprstt.html) gateway, or Internet Gateway (IGate).    It can also be used as a virtual TNC for other applications such as [APRSIS32](http://aprsisce.wikidot.com/), [UI-View32](http://www.ui-view.net/), [Xastir](http://xastir.org/index.php/Main_Page), [APRS-TW](http://aprstw.blandranch.net/), [YAAC](http://www.ka2ddo.org/ka2ddo/YAAC.html), [UISS](http://users.belgacom.net/hamradio/uiss.htm), [Linux AX25](http://www.linux-ax25.org/wiki/Main_Page), [SARTrack](http://www.sartrack.co.nz/index.html), [RMS Express](http://www.winlink.org/RMSExpress), [BPQ32](http://www.cantab.net/users/john.wiseman/Documents/BPQ32.html), and many others.
 
 
 ## Features ##

config.c

@@ -753,8 +753,10 @@ void config_init (char *fname, struct audio_s *p_audio_config,
 
 	//strlcpy (p_misc_config->nullmodem, DEFAULT_NULLMODEM, sizeof(p_misc_config->nullmodem));
 	strlcpy (p_misc_config->nullmodem, "", sizeof(p_misc_config->nullmodem));
+
 	strlcpy (p_misc_config->gpsnmea_port, "", sizeof(p_misc_config->gpsnmea_port));
-	strlcpy (p_misc_config->nmea_port, "", sizeof(p_misc_config->nmea_port));
+	strlcpy (p_misc_config->waypoint_port, "", sizeof(p_misc_config->waypoint_port));
+
 	strlcpy (p_misc_config->logdir, "", sizeof(p_misc_config->logdir));
 
 
@@ -1674,10 +1676,8 @@ void config_init (char *fname, struct audio_s *p_audio_config,
  */
 
 	  else if (strcasecmp(t, "TXINH") == 0) {
-	    int it;
 	    char itname[8];
 
-	    it = ICTYPE_TXINH;
 	    strlcpy (itname, "TXINH", sizeof(itname));
 
 	    t = split(NULL,0);
@@ -1701,14 +1701,14 @@ void config_init (char *fname, struct audio_s *p_audio_config,
 	      }
 
 	      if (*t == '-') {
-	        p_audio_config->achan[channel].ictrl[it].gpio = atoi(t+1);
-		p_audio_config->achan[channel].ictrl[it].invert = 1;
+	        p_audio_config->achan[channel].ictrl[ICTYPE_TXINH].gpio = atoi(t+1);
+		p_audio_config->achan[channel].ictrl[ICTYPE_TXINH].invert = 1;
 	      }
 	      else {
-	        p_audio_config->achan[channel].ictrl[it].gpio = atoi(t);
-		p_audio_config->achan[channel].ictrl[it].invert = 0;
+	        p_audio_config->achan[channel].ictrl[ICTYPE_TXINH].gpio = atoi(t);
+		p_audio_config->achan[channel].ictrl[ICTYPE_TXINH].invert = 0;
 	      }
-	      p_audio_config->achan[channel].ictrl[it].method = PTT_METHOD_GPIO;
+	      p_audio_config->achan[channel].ictrl[ICTYPE_TXINH].method = PTT_METHOD_GPIO;
 #endif
 	    }
 	  }
@@ -3828,18 +3828,46 @@ void config_init (char *fname, struct audio_s *p_audio_config,
 	  }
 
 /*
- * NMEA		- Device name for communication with NMEA device.
- *		  Wasn't documented will probably use WAYPOINT instead.
+ * WAYPOINT		- Generate WPT NMEA sentences for display on map.
+ *
+ * WAYPOINT  serial-device [ formats ]
+ *		  
  */
-	  else if (strcasecmp(t, "nmea") == 0) {
+	  else if (strcasecmp(t, "waypoint") == 0) {
 	    t = split(NULL,0);
 	    if (t == NULL) {
 	      text_color_set(DW_COLOR_ERROR);
-	      dw_printf ("Config file: Missing device name for NMEA port on line %d.\n", line);
+	      dw_printf ("Config file: Missing device name for WAYPOINT on line %d.\n", line);
 	      continue;
 	    }
 	    else {
-	      strlcpy (p_misc_config->nmea_port, t, sizeof(p_misc_config->nmea_port));
+	      strlcpy (p_misc_config->waypoint_port, t, sizeof(p_misc_config->waypoint_port));
+	    }
+	    t = split(NULL,1);
+	    if (t != NULL) {
+	      for ( ; *t != '\0' ; t++ ) {
+	        switch (toupper(*t)) {
+	          case 'N':
+	            p_misc_config->waypoint_formats |= WPT_FORMAT_NMEA_GENERIC;
+	            break;
+	          case 'G':
+	            p_misc_config->waypoint_formats |= WPT_FORMAT_GARMIN;
+	            break;
+	          case 'M':
+	            p_misc_config->waypoint_formats |= WPT_FORMAT_MAGELLAN;
+	            break;
+	          case 'K':
+	            p_misc_config->waypoint_formats |= WPT_FORMAT_KENWOOD;
+	            break;
+	          case ' ':
+	          case ',':
+	            break;
+	          default:
+	            text_color_set(DW_COLOR_ERROR);
+	            dw_printf ("Config file: Invalid output format '%c' for WAYPOINT on line %d.\n", *t, line);   
+	            break;
+	        }
+	      }
 	    }
 	  }
 

config.h

@@ -43,16 +43,27 @@ struct misc_config_s {
 
 	char gpsnmea_port[20];	/* Serial port name for reading NMEA sentences from GPS. */
 				/* e.g. COM22, /dev/ttyACM0 */
+				/* Currently no option for setting non-standard speed. */
 
 	char gpsd_host[20];	/* Host for gpsd server. */
 				/* e.g. localhost, 192.168.1.2 */
 
 	int gpsd_port;		/* Port number for gpsd server. */
 				/* Default is  2947. */
 
+				
+	char waypoint_port[20];	/* Serial port name for sending NMEA waypoint sentences */
+				/* to a GPS map display or other mapping application. */
 				/* e.g. COM22, /dev/ttyACM0 */
-	char nmea_port[20];	/* Serial port name for NMEA communication with GPS */
-				/* receiver and/or mapping application. Change this. */
+				/* Currently no option for setting non-standard speed. */
+
+	int waypoint_formats;	/* Which sentence formats should be generated? */
+
+#define WPT_FORMAT_NMEA_GENERIC 0x01		/* N	$GPWPT */
+#define WPT_FORMAT_GARMIN       0x02		/* G	$PGRMW */
+#define WPT_FORMAT_MAGELLAN     0x04		/* M	$PMGNWPL */
+#define WPT_FORMAT_KENWOOD      0x08		/* K	$PKWDWPL */
+
 
 	char logdir[80];	/* Directory for saving activity logs. */
 

direwolf.c

@@ -89,7 +89,7 @@
 #include "kiss.h"
 #include "kissnet.h"
 #include "kiss_frame.h"
-#include "nmea.h"
+#include "waypoint.h"
 #include "gen_tone.h"
 #include "digipeater.h"
 #include "tq.h"
@@ -103,6 +103,7 @@
 #include "igate.h"
 #include "symbols.h"
 #include "dwgps.h"
+#include "waypoint.h"
 #include "log.h"
 #include "recv.h"
 #include "morse.h"
@@ -162,6 +163,7 @@ static int q_h_opt = 0;			/* "-q h" Quiet, suppress the "heard" line with audio
 static int q_d_opt = 0;			/* "-q d" Quiet, suppress the decoding of APRS packets. */
 
 
+
 static struct misc_config_s misc_config;
 
 
@@ -236,8 +238,8 @@ int main (int argc, char *argv[])
 
 	text_color_init(t_opt);
 	text_color_set(DW_COLOR_INFO);
-	dw_printf ("Dire Wolf version %d.%d (%s) Beta Test\n", MAJOR_VERSION, MINOR_VERSION, __DATE__);
-	//dw_printf ("Dire Wolf DEVELOPMENT version %d.%d %s (%s)\n", MAJOR_VERSION, MINOR_VERSION, "K", __DATE__);
+	//dw_printf ("Dire Wolf version %d.%d (%s) Beta Test\n", MAJOR_VERSION, MINOR_VERSION, __DATE__);
+	dw_printf ("Dire Wolf DEVELOPMENT version %d.%d %s (%s)\n", MAJOR_VERSION, MINOR_VERSION, "A", __DATE__);
 	//dw_printf ("Dire Wolf version %d.%d\n", MAJOR_VERSION, MINOR_VERSION);
 
 #if defined(ENABLE_GPSD) || defined(USE_HAMLIB)
@@ -451,9 +453,9 @@ int main (int argc, char *argv[])
 		// separate out gps & waypoints.
 
 	      case 'g':  d_g_opt++; break;
+	      case 'w':	 waypoint_set_debug (1); break;		// not documented yet.
 	      case 't':  d_t_opt++; beacon_tracker_set_debug (d_t_opt); break;
 
-	      case 'w':	 nmea_set_debug (1); break;		// not documented yet.
 	      case 'p':  d_p_opt = 1; break;			// TODO: packet dump for xmit side.
 	      case 'o':  d_o_opt++; ptt_set_debug(d_o_opt); break;	
 	      case 'i':  d_i_opt++; break;
@@ -698,7 +700,7 @@ int main (int argc, char *argv[])
  */
 	dwgps_init (&misc_config, d_g_opt);
 
-	nmea_init (&misc_config);  //  TODO: revisit.
+	waypoint_init (&misc_config);  
 
 /* 
  * Create thread for trying to salvage frames with bad FCS.
@@ -946,7 +948,7 @@ void app_process_rec_packet (int chan, int subchan, int slice, packet_t pp, alev
 	  // Convert to NMEA waypoint sentence if we have a location.
 
  	  if (A.g_lat != G_UNKNOWN && A.g_lon != G_UNKNOWN) {
-	    nmea_send_waypoint (strlen(A.g_name) > 0 ? A.g_name : A.g_src, 
+	    waypoint_send_sentence (strlen(A.g_name) > 0 ? A.g_name : A.g_src, 
 		A.g_lat, A.g_lon, A.g_symbol_table, A.g_symbol_code, 
 		DW_FEET_TO_METERS(A.g_altitude_ft), A.g_course, DW_MPH_TO_KNOTS(A.g_speed_mph), 
 		A.g_comment);
@@ -1026,6 +1028,7 @@ static BOOL cleanup_win (int ctrltype)
 	  dw_printf ("\nQRT\n");
 	  log_term ();
 	  ptt_term ();
+	  waypoint_term ();
 	  dwgps_term ();
 	  SLEEP_SEC(1);
 	  ExitProcess (0);

dwgpsnmea.c

@@ -47,7 +47,8 @@
 
 static int s_debug = 0;		/* Enable debug output. */
 				/* See dwgpsnmea_init description for values. */
-					
+
+static struct misc_config_s *s_save_configp;					
 
 
 
@@ -109,6 +110,8 @@ int dwgpsnmea_init (struct misc_config_s *pconfig, int debug)
 #endif
 
 	s_debug = debug;
+	s_save_configp = pconfig;
+
 
 	if (s_debug >= 2) {
 	  text_color_set(DW_COLOR_DEBUG);
@@ -160,6 +163,19 @@ int dwgpsnmea_init (struct misc_config_s *pconfig, int debug)
 }  /* end dwgpsnmea_init */
 
 
+/* Return fd to share if waypoint wants same device. */
+/* Currently both are fixed speed at 4800. */
+/* If that ever becomes configurable, that needs to be compared too. */
+
+MYFDTYPE dwgpsnmea_get_fd(char *wp_port_name, int speed)
+{
+	if (strcmp(s_save_configp->gpsnmea_port, wp_port_name) == 0 && speed == 4800) {
+	  return (s_gpsnmea_port_fd);
+	}
+	return (MYFDERROR);
+}
+
+
 /*-------------------------------------------------------------------
  *
  * Name:        read_gpsnmea_thread

dwgpsnmea.h

@@ -1,5 +1,5 @@
 
-/* dwgpsnmea.h   -   For NMEA sentences over serial port */
+/* dwgpsnmea.h   -   For reading NMEA sentences over serial port */
 
 
 
@@ -8,17 +8,21 @@
 
 #include "dwgps.h"		/* for dwfix_t */
 #include "config.h"
+#include "serial_port.h"	/* for MYFDTYPE */
 
 
 int dwgpsnmea_init (struct misc_config_s *pconfig, int debug);
 
+MYFDTYPE dwgpsnmea_get_fd(char *wp_port_name, int speed);
+
 void dwgpsnmea_term (void);
 
 
 dwfix_t dwgpsnmea_gprmc (char *sentence, int quiet, double *odlat, double *odlon, float *oknots, float *ocourse);
 
 dwfix_t dwgpsnmea_gpgga (char *sentence, int quiet, double *odlat, double *odlon, float *oalt, int *onsat);
 
+
 #endif
 
 

man1/direwolf.1

@@ -79,6 +79,8 @@ p = Packet dump in hexadecimal.
 .P
 g = GPS interface.
 .P
+W = Waypoints for position or object reports.
+.P
 t = Tracker beacon.
 .P
 o = Output controls such as PTT and DCD.