Improve digimode configuration (#492)

* use DIGIMODE if FLDIGI is set

* use rig_parse_mode() for DIGI_RIG_MODE

this value is transparent to TLF, let Hamlib do the parsing
allowing any supported mode

* add DIGITAL_MODE configuration for ADIF export

it's value is used in the MODE tag

reused and renamed modem_mode variable (it was used for RTTY only)

* use RY/DG for digimode in cabrillo depending on DIGITAL_MODE

Author: zcsahok

src/gettxinfo.c

@@ -250,7 +250,7 @@ void gettxinfo(void) {
 	}
 
     } else if (reqf == SETDIGIMODE) {
-	rmode_t new_mode = digi_mode;
+	rmode_t new_mode = digi_rig_mode;
 	if (new_mode == RIG_MODE_NONE) {
 	    if (digikeyer == FLDIGI)
 		new_mode = RIG_MODE_USB;

src/globalvars.h

@@ -130,7 +130,7 @@ extern int new_cty;
 extern int new_zone;
 extern bool new_pfx;
 extern bool no_rst;
-extern rmode_t digi_mode;
+extern rmode_t digi_rig_mode;
 extern int minitest;    // minitest period length in seconds, 0 if not used
 extern int portnum;
 extern int lan_port;
@@ -222,7 +222,7 @@ extern char markerfile[];
 extern char countrylist[255][6];
 extern char continent_multiplier_list[7][3];
 extern char controllerport[];           // port for multi-mode controller
-extern char modem_mode[];
+extern char digital_mode[];
 extern char sc_volume[];
 extern char clusterlogin[];
 extern char rigconf[];

src/main.c

@@ -316,7 +316,7 @@ bool keyer_backspace = false;   // disabled
 
 char controllerport[80] = "/dev/ttyS0"; // for GMFSK or MFJ-1278
 char rttyoutput[120];		// where to GMFSK digimode output
-rmode_t digi_mode = RIG_MODE_NONE;
+rmode_t digi_rig_mode = RIG_MODE_NONE;
 
 int txdelay = 0;
 int weight = 0;
@@ -326,7 +326,7 @@ int k_pin14 = 0;
 int k_ptt = 0;
 
 int miniterm = 0;		/* is miniterm for digimode active? */
-char modem_mode[8];
+char digital_mode[8];
 int commentfield = 0;		/* 1 if we are in comment/exchange input */
 
 /*-------------------------------------packet-------------------------------*/

src/parse_logcfg.c

@@ -1033,6 +1033,7 @@ static int cfg_gmfsk(const cfg_arg_t arg) {
 	return rc;
     }
     digikeyer = GMFSK;
+    trxmode = DIGIMODE;
     return PARSE_OK;
 }
 
@@ -1060,7 +1061,7 @@ static int cfg_change_rst(const cfg_arg_t arg) {
 
 static int cfg_rttymode(const cfg_arg_t arg) {
     trxmode = DIGIMODE;
-    strcpy(modem_mode, "RTTY");
+    strcpy(digital_mode, "RTTY");
     return PARSE_OK;
 }
 
@@ -1183,6 +1184,7 @@ static int cfg_fldigi(const cfg_arg_t arg) {
     if (!fldigi_isenabled()) {
 	fldigi_toggle();
     }
+    trxmode = DIGIMODE;
 #endif
 
     return PARSE_OK;
@@ -1242,17 +1244,11 @@ static int cfg_digi_rig_mode(const cfg_arg_t arg) {
     char *str = g_ascii_strup(parameter, -1);
     g_strstrip(str);
 
-    if (strcmp(str, "USB") == 0) {
-	digi_mode = RIG_MODE_USB;
-    } else if (strcmp(str, "LSB") == 0) {
-	digi_mode = RIG_MODE_LSB;
-    } else if (strcmp(str, "RTTY") == 0) {
-	digi_mode = RIG_MODE_RTTY;
-    } else if (strcmp(str, "RTTYR") == 0) {
-	digi_mode = RIG_MODE_RTTYR;
-    } else {
+    digi_rig_mode = rig_parse_mode(str);
+
+    if (digi_rig_mode == RIG_MODE_NONE) {
+	error_details = g_strdup_printf("invalid mode %s", str);
 	g_free(str);
-	error_details = g_strdup("must be USB, LSB, RTTY, or RTTYR");
 	return PARSE_WRONG_PARAMETER;
     }
 
@@ -1419,6 +1415,7 @@ static config_t logcfg_configs[] = {
     {"SYNCFILE",        CFG_STRING_STATIC(synclogfile, 120)},
     {"INITIAL_EXCHANGE",       CFG_STRING_STATIC(exchange_list, 40)},
     {"DIGIMODEM",       CFG_STRING_STATIC(rttyoutput, 120)},
+    {"DIGITAL_MODE",    CFG_STRING_STATIC(digital_mode, 8)},
     {"FKEY-HEADER",     CFG_STRING_STATIC(fkey_header, sizeof(fkey_header))},
 
     {"CABRILLO",    CFG_STRING(cabrillo)},

src/writecabrillo.c

@@ -243,10 +243,17 @@ void info(char *s) {
 }
 
 
-const char *to_mode[] = {
-    "CW",
-    "PH",
-    "RY"
+static const char *cabrillo_mode(int mode) {
+    if (mode == CWMODE)
+	return "CW";
+    if (mode == SSBMODE)
+	return "PH";
+
+    // for digimode: either RY for RTTY or else DG for generic digital mode
+    if (strcmp(digital_mode, "RTTY") == 0)
+	return "RY";
+
+    return "DG";
 };
 
 /* add 'src' to 'dst' with max. 'len' chars left padded */
@@ -364,7 +371,7 @@ void prepare_line(struct linedata_t *qso, struct cabrillo_desc *desc,
 		add_lpadded(buf, tmp, item->len);
 		break;
 	    case MODE:
-		sprintf(tmp, "%s", to_mode[qso->mode]);
+		sprintf(tmp, "%s", cabrillo_mode(qso->mode));
 		add_lpadded(buf, tmp, item->len);
 		break;
 	    case DATE:
@@ -731,8 +738,8 @@ void prepare_adif_line(char *buffer, struct linedata_t *qso) {
 	tmp = "CW";
     else if (qso->mode == SSBMODE)
 	tmp = "SSB";
-    else if (strcmp(modem_mode, "RTTY") == 0)
-	tmp = "RTTY";
+    else if (digital_mode[0])
+	tmp = digital_mode;
     else
 	/* \todo DIGI is no allowed mode */
 	tmp = "DIGI";

test/data.c

@@ -138,7 +138,7 @@ int multi = 0;			/* 0 = SO , 1 = MOST, 2 = MM */
 int trxmode = CWMODE;
 /* RIG_MODE_NONE in hamlib/rig.h, but if hamlib not compiled, then no dependency */
 rmode_t rigmode = 0;
-rmode_t digi_mode = 0;
+rmode_t digi_rig_mode = 0;
 bool mixedmode = false;
 char sent_rst[4] = "599";
 char recvd_rst[4] = "599";
@@ -288,7 +288,7 @@ int k_pin14;
 int k_ptt;
 char controllerport[80] = "/dev/ttyS0";
 int miniterm = 0;		/* is miniterm for digimode active? */
-char modem_mode[8];
+char digital_mode[8];
 int commentfield = 0;		/* 1 if we are in comment/exchange input */
 
 /*-------------------------------------packet-------------------------------*/

test/test_parse_logcfg.c

@@ -201,7 +201,7 @@ int setup_default(void **state) {
     markerfile[0] = 0;
     synclogfile[0] = 0;
     sc_volume[0] = 0;
-    modem_mode[0] = 0;
+    digital_mode[0] = 0;
     controllerport[0] = 0;
     clusterlogin[0] = 0;
     exchange_list[0] = 0;
@@ -211,7 +211,7 @@ int setup_default(void **state) {
     qtcrec_record_command_shutdown[0] = 0;
     unique_call_multi = MULT_NONE;
     generic_mult = MULT_NONE;
-    digi_mode = -1;
+    digi_rig_mode = -1;
 
     for (int i = 0; i < SP_CALL_MSG; ++i) {
 	message[i][0] = 0;
@@ -1300,14 +1300,21 @@ void test_gmfsk(void **state) {
     int rc = call_parse_logcfg("GMFSK=jkl\n");
     assert_int_equal(rc, PARSE_OK);
     assert_int_equal(digikeyer, GMFSK);
+    assert_int_equal(trxmode, DIGIMODE);
     assert_string_equal(controllerport, "jkl");
 }
 
 void test_rttymode(void **state) {
     int rc = call_parse_logcfg("RTTYMODE\n");
     assert_int_equal(rc, PARSE_OK);
     assert_int_equal(trxmode, DIGIMODE);
-    assert_string_equal(modem_mode, "RTTY");
+    assert_string_equal(digital_mode, "RTTY");
+}
+
+void test_digital_mode(void **state) {
+    int rc = call_parse_logcfg("DIGITAL_MODE=PSK\n");
+    assert_int_equal(rc, PARSE_OK);
+    assert_string_equal(digital_mode, "PSK");
 }
 
 void test_digimodem(void **state) {
@@ -1521,25 +1528,25 @@ void test_generic_mult_band(void **state) {
 void test_digi_rig_mode_usb(void **state) {
     int rc = call_parse_logcfg("DIGI_RIG_MODE=USB");
     assert_int_equal(rc, PARSE_OK);
-    assert_int_equal(digi_mode, RIG_MODE_USB);
+    assert_int_equal(digi_rig_mode, RIG_MODE_USB);
 }
 
 void test_digi_rig_mode_lsb(void **state) {
     int rc = call_parse_logcfg("DIGI_RIG_MODE=LSB");
     assert_int_equal(rc, PARSE_OK);
-    assert_int_equal(digi_mode, RIG_MODE_LSB);
+    assert_int_equal(digi_rig_mode, RIG_MODE_LSB);
 }
 
 void test_digi_rig_mode_rtty(void **state) {
     int rc = call_parse_logcfg("DIGI_RIG_MODE=RTTY");
     assert_int_equal(rc, PARSE_OK);
-    assert_int_equal(digi_mode, RIG_MODE_RTTY);
+    assert_int_equal(digi_rig_mode, RIG_MODE_RTTY);
 }
 
 void test_digi_rig_mode_rttyr(void **state) {
     int rc = call_parse_logcfg("DIGI_RIG_MODE=RTTYR");
     assert_int_equal(rc, PARSE_OK);
-    assert_int_equal(digi_mode, RIG_MODE_RTTYR);
+    assert_int_equal(digi_rig_mode, RIG_MODE_RTTYR);
 }
 
 void test_band40_ok(void **state) {

tlf.1.in

@@ -996,7 +996,7 @@ Restore previous CQ frequency from MEM and send message
 .
 .TP
 .B F2-F11
-Send CW, RTTY or VOICE messages 2 through 11. If the callsign field is empty
+Send CW, digital or voice messages 2 through 11. If the callsign field is empty
 the messages will be sent with the preceding qso data.
 .
 .TP
@@ -1079,7 +1079,7 @@ instead.
 .BR ?\  (Query)
 In CW or DIGIMODE sends the partial call followed by \(lq ?\(rq.
 .
-In VOICE mode sends recorded message 5 (F5).
+In voice mode sends recorded message 5 (F5).
 .
 .TP
 .BR ;\  (Semicolon)
@@ -1135,11 +1135,11 @@ Confirm last exchange.
 .
 .TP
 .BR {\  "(Open brace)"
-In RTTY (DIGIMODE), keyboard mode switch TX on.
+In digital mode, keyboard mode switch TX on.
 .
 .TP
 .BR }\  "(Close brace)"
-In RTTY (DIGIMODE), keyboard mode switch TX off (RX).
+In digital mode, keyboard mode switch TX off (RX).
 .
 .TP
 .BR \e\  (Backslash)
@@ -1163,11 +1163,11 @@ Pop MEM frequency: MEM \(-> transceiver VFO frequency and clear MEM.
 Swap transceiver VFO frequency and MEM.
 .
 .TP
-.B ^  (Circumflex, mnemonic: arrow)
+.B ^  \fR(Circumflex, mnemonic: arrow)
 Rotate antenna towards the country of the current call, if a rotator is configured.
 .
 .TP
-.B &  (Ampersand)
+.BR &\  (Ampersand)
 Rotate antenna long-path towards the country of the current call, if a rotator is configured.
 (This is 180° opposite of the short-path direction.)
 .
@@ -1748,7 +1748,11 @@ Start @PACKAGE_NAME@ in SSB mode (default is CW).
 .
 .TP
 .B RTTYMODE
-Start @PACKAGE_NAME@ in RTTY mode (default is CW)
+Start @PACKAGE_NAME@ in digital mode (default is CW)
+assuming RTTY modulation (see
+.BR DIGITAL_MODE ).
+.
+The radio mode (\fBDIGI_RIG_MODE\fR) is not affected.
 .
 .TP
 \fBGMFSK\fR=\fI$HOME/gMFSK.log\fR
@@ -2115,11 +2119,21 @@ mode is selected.
 .
 .IP
 .I mode
-may be one of \(lqUSB\(rq, \(lqLSB\(rq, \(lqRTTY\(rq, or \(lqRTTYR\(rq.
+may be \(lqUSB\(rq, \(lqLSB\(rq, \(lqRTTY\(rq,
+or any radio mode supported by Hamlib.
 .
 If this parameter is not set, \(lqUSB\(rq is used if the Fldigi parameter is
 set else \(lqLSB\(rq is used.
 .
+.TP
+\fBDIGITAL_MODE\fR=\fImode\fR
+The digital mode (modulation type) to be used as MODE in ADIF export.
+.
+.IP
+If this parameter is not set, then the non-ADIF compliant generic
+\(lqDIGI\(rq is used. The user shall then edit the ADIF file to match
+the actually used mode or modes.
+.
 .SS Rotator Control Commands
 .
 .TP
@@ -2575,7 +2589,7 @@ If you work RTTY (or any other digital modes), you can communicate with Fldigi
 through
 .BR XMLRPC .
 .
-This parameter activates the interface.
+This parameter activates the interface and sets start-up mode to DIGIMODE.
 .
 .IP
 By default @PACKAGE_NAME@ connects to: