Skip to content

Commit 0da1a91

Browse files
wb2oszwb2osz
committed
Add time slots for beacons.
1 parent 979fdf1 commit 0da1a91

File tree

6 files changed

+166
-56
lines changed

6 files changed

+166
-56
lines changed

‎CHANGES.md

+15
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,21 @@
11

22
# Revision History #
33

4+
## Version 1.5 -- Development snapshot B -- June 2017 ##
5+
6+
This is a snapshot of ongoing development towards version of 1.5. Some features might be incomplete or broken or not documented properly.
7+
8+
### New Features: ###
9+
10+
- Time slots for beaconing.
11+
12+
- V20 configuration item for listing stations known not to understaand AX.25 v2.2. This will speed up connection by going right to SABM and not trying SABME first and failing.
13+
14+
- Documentation updates describing cheap SDR frequency inaccuracy and how to compensate for it.
15+
16+
### Bugs Fixed: ###
17+
18+
- PACLEN configuration item no longer restricts length of received frames.
419

520
## Version 1.5 -- Development snapshot A -- May 2017 ##
621

‎beacon.c

+118-54
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
//
22
// This file is part of Dire Wolf, an amateur radio packet TNC.
33
//
4-
// Copyright (C) 2011, 2013, 2014, 2015, 2016 John Langner, WB2OSZ
4+
// Copyright (C) 2011, 2013, 2014, 2015, 2016, 2017 John Langner, WB2OSZ
55
//
66
// This program is free software: you can redistribute it and/or modify
77
// it under the terms of the GNU General Public License as published by
@@ -141,6 +141,7 @@ static void beacon_send (int j, dwgps_info_t *gpsinfo);
141141
void beacon_init (struct audio_s *pmodem, struct misc_config_s *pconfig, struct igate_config_s *pigate)
142142
{
143143
time_t now;
144+
struct tm tm;
144145
int j;
145146
int count;
146147
#if __WIN32__
@@ -270,21 +271,71 @@ void beacon_init (struct audio_s *pmodem, struct misc_config_s *pconfig, struct
270271
}
271272

272273
/*
273-
* Calculate first time for each beacon from the 'delay' value.
274+
* Calculate first time for each beacon from the 'slot' or 'delay' value.
274275
*/
275276

276277
now = time(NULL);
278+
localtime_r (&now, &tm);
277279

278280
for (j=0; j<g_misc_config_p->num_beacons; j++) {
281+
struct beacon_s *bp = & (g_misc_config_p->beacon[j]);
279282
#if DEBUG
280283

281284
text_color_set(DW_COLOR_DEBUG);
282-
dw_printf ("beacon[%d] chan=%d, delay=%d, every=%d\n",
285+
dw_printf ("beacon[%d] chan=%d, delay=%d, slot=%d, every=%d\n",
283286
j,
284-
g_misc_config_p->beacon[j].sendto_chan,
285-
g_misc_config_p->beacon[j].delay,
286-
g_misc_config_p->beacon[j].every);
287+
bp->sendto_chan,
288+
bp->delay,
289+
bp->slot,
290+
bp->every);
287291
#endif
292+
293+
/*
294+
* If timeslots, there must be a full number of beacon intervals per hour.
295+
*/
296+
#define IS_GOOD(x) ((3600/(x))*(x) == 3600)
297+
298+
if (bp->slot != G_UNKNOWN) {
299+
300+
if ( ! IS_GOOD(bp->every)) {
301+
text_color_set(DW_COLOR_ERROR);
302+
dw_printf ("Config file, line %d: When using timeslots, there must be a whole number of beacon intervals per hour.\n", bp->lineno);
303+
304+
// Try to make it valid by adjusting up or down.
305+
306+
int n;
307+
for (n=1; ; n++) {
308+
int e;
309+
e = bp->every + n;
310+
if (e > 3600) {
311+
bp->every = 3600;
312+
break;
313+
}
314+
if (IS_GOOD(e)) {
315+
bp->every = e;
316+
break;
317+
}
318+
e = bp->every - n;
319+
if (e < 1) {
320+
bp->every = 1; // Impose a larger minimum?
321+
break;
322+
}
323+
if (IS_GOOD(e)) {
324+
bp->every = e;
325+
break;
326+
}
327+
}
328+
text_color_set(DW_COLOR_ERROR);
329+
dw_printf ("Config file, line %d: Time between slotted beacons has been adjusted to %d seconds.\n", bp->lineno, bp->every);
330+
}
331+
/*
332+
* Determine when next slot time will arrive.
333+
*/
334+
bp->delay = bp->slot - (tm.tm_min * 60 + tm.tm_sec);
335+
while (bp->delay > bp->every) bp->delay -= bp->every;
336+
while (bp->delay < 5) bp->delay += bp->every;
337+
}
338+
288339
g_misc_config_p->beacon[j].next = now + g_misc_config_p->beacon[j].delay;
289340
}
290341

@@ -491,10 +542,12 @@ static void * beacon_thread (void *arg)
491542
*/
492543
for (j=0; j<g_misc_config_p->num_beacons; j++) {
493544

494-
if (g_misc_config_p->beacon[j].btype == BEACON_IGNORE)
545+
struct beacon_s *bp = & (g_misc_config_p->beacon[j]);
546+
547+
if (bp->btype == BEACON_IGNORE)
495548
continue;
496549

497-
if (g_misc_config_p->beacon[j].next <= now) {
550+
if (bp->next <= now) {
498551

499552
/* Send the beacon. */
500553

@@ -503,13 +556,20 @@ static void * beacon_thread (void *arg)
503556
/* Calculate when the next one should be sent. */
504557
/* Easy for fixed interval. SmartBeaconing takes more effort. */
505558

506-
if (g_misc_config_p->beacon[j].btype == BEACON_TRACKER) {
559+
if (bp->btype == BEACON_TRACKER) {
507560

508561
if (gpsinfo.fix < DWFIX_2D) {
509562
/* Fix not available so beacon was not sent. */
510-
/* Try again in a couple seconds. */
511563

512-
g_misc_config_p->beacon[j].next = now + 2;
564+
if (g_misc_config_p->sb_configured) {
565+
/* Try again in a couple seconds. */
566+
bp->next = now + 2;
567+
}
568+
else {
569+
/* Stay with the schedule. */
570+
/* Important for slotted. Might reconsider otherwise. */
571+
bp->next += bp->every;
572+
}
513573
}
514574
else if (g_misc_config_p->sb_configured) {
515575

@@ -519,18 +579,21 @@ static void * beacon_thread (void *arg)
519579
sb_prev_time = now;
520580
sb_prev_course = gpsinfo.track;
521581

522-
g_misc_config_p->beacon[j].next = sb_calculate_next_time (now,
582+
bp->next = sb_calculate_next_time (now,
523583
DW_KNOTS_TO_MPH(gpsinfo.speed_knots), gpsinfo.track,
524584
sb_prev_time, sb_prev_course);
525585
}
526586
else {
527-
g_misc_config_p->beacon[j].next = now + g_misc_config_p->beacon[j].every;
587+
/* Tracker beacon, fixed spacing. */
588+
bp->next += bp->every;
528589
}
529590
}
530591
else {
531-
/* non-tracker beacons are at fixed spacing. */
592+
/* Non-tracker beacon, fixed spacing. */
593+
/* Increment by 'every' so slotted times come out right. */
594+
/* i.e. Don't take relative to now in case there was some delay. */
532595

533-
g_misc_config_p->beacon[j].next = now + g_misc_config_p->beacon[j].every;
596+
bp->next += bp->every;
534597
}
535598

536599
} /* if time to send it */
@@ -682,6 +745,7 @@ static time_t sb_calculate_next_time (time_t now,
682745
static void beacon_send (int j, dwgps_info_t *gpsinfo)
683746
{
684747

748+
struct beacon_s *bp = & (g_misc_config_p->beacon[j]);
685749

686750
int strict = 1; /* Strict packet checking because they will go over air. */
687751
char stemp[20];
@@ -704,13 +768,13 @@ static void beacon_send (int j, dwgps_info_t *gpsinfo)
704768
*/
705769
strlcpy (mycall, "NOCALL", sizeof(mycall));
706770

707-
assert (g_misc_config_p->beacon[j].sendto_chan >= 0);
771+
assert (bp->sendto_chan >= 0);
708772

709-
strlcpy (mycall, g_modem_config_p->achan[g_misc_config_p->beacon[j].sendto_chan].mycall, sizeof(mycall));
773+
strlcpy (mycall, g_modem_config_p->achan[bp->sendto_chan].mycall, sizeof(mycall));
710774

711775
if (strlen(mycall) == 0 || strcmp(mycall, "NOCALL") == 0) {
712776
text_color_set(DW_COLOR_ERROR);
713-
dw_printf ("MYCALL not set for beacon in config file line %d.\n", g_misc_config_p->beacon[j].lineno);
777+
dw_printf ("MYCALL not set for beacon in config file line %d.\n", bp->lineno);
714778
return;
715779
}
716780

@@ -723,17 +787,17 @@ static void beacon_send (int j, dwgps_info_t *gpsinfo)
723787
strlcpy (beacon_text, mycall, sizeof(beacon_text));
724788
strlcat (beacon_text, ">", sizeof(beacon_text));
725789

726-
if (g_misc_config_p->beacon[j].dest != NULL) {
727-
strlcat (beacon_text, g_misc_config_p->beacon[j].dest, sizeof(beacon_text));
790+
if (bp->dest != NULL) {
791+
strlcat (beacon_text, bp->dest, sizeof(beacon_text));
728792
}
729793
else {
730794
snprintf (stemp, sizeof(stemp), "%s%1d%1d", APP_TOCALL, MAJOR_VERSION, MINOR_VERSION);
731795
strlcat (beacon_text, stemp, sizeof(beacon_text));
732796
}
733797

734-
if (g_misc_config_p->beacon[j].via != NULL) {
798+
if (bp->via != NULL) {
735799
strlcat (beacon_text, ",", sizeof(beacon_text));
736-
strlcat (beacon_text, g_misc_config_p->beacon[j].via, sizeof(beacon_text));
800+
strlcat (beacon_text, bp->via, sizeof(beacon_text));
737801
}
738802
strlcat (beacon_text, ":", sizeof(beacon_text));
739803

@@ -746,53 +810,53 @@ static void beacon_send (int j, dwgps_info_t *gpsinfo)
746810
// TODO: test & document.
747811

748812
strlcpy (super_comment, "", sizeof(super_comment));
749-
if (g_misc_config_p->beacon[j].comment != NULL) {
750-
strlcpy (super_comment, g_misc_config_p->beacon[j].comment, sizeof(super_comment));
813+
if (bp->comment != NULL) {
814+
strlcpy (super_comment, bp->comment, sizeof(super_comment));
751815
}
752816

753-
if (g_misc_config_p->beacon[j].commentcmd != NULL) {
817+
if (bp->commentcmd != NULL) {
754818
char var_comment[AX25_MAX_INFO_LEN];
755819
int k;
756820

757821
/* Run given command to get variable part of comment. */
758822

759-
k = dw_run_cmd (g_misc_config_p->beacon[j].commentcmd, 2, var_comment, sizeof(var_comment));
823+
k = dw_run_cmd (bp->commentcmd, 2, var_comment, sizeof(var_comment));
760824
if (k > 0) {
761825
strlcat (super_comment, var_comment, sizeof(super_comment));
762826
}
763827
else {
764828
text_color_set(DW_COLOR_ERROR);
765-
dw_printf ("xBEACON, config file line %d, COMMENTCMD failure.\n", g_misc_config_p->beacon[j].lineno);
829+
dw_printf ("xBEACON, config file line %d, COMMENTCMD failure.\n", bp->lineno);
766830
}
767831
}
768832

769833

770834
/*
771835
* Add the info part depending on beacon type.
772836
*/
773-
switch (g_misc_config_p->beacon[j].btype) {
837+
switch (bp->btype) {
774838

775839
case BEACON_POSITION:
776840

777-
encode_position (g_misc_config_p->beacon[j].messaging, g_misc_config_p->beacon[j].compress,
778-
g_misc_config_p->beacon[j].lat, g_misc_config_p->beacon[j].lon, 0,
779-
(int)roundf(DW_METERS_TO_FEET(g_misc_config_p->beacon[j].alt_m)),
780-
g_misc_config_p->beacon[j].symtab, g_misc_config_p->beacon[j].symbol,
781-
g_misc_config_p->beacon[j].power, g_misc_config_p->beacon[j].height, g_misc_config_p->beacon[j].gain, g_misc_config_p->beacon[j].dir,
841+
encode_position (bp->messaging, bp->compress,
842+
bp->lat, bp->lon, 0,
843+
(int)roundf(DW_METERS_TO_FEET(bp->alt_m)),
844+
bp->symtab, bp->symbol,
845+
bp->power, bp->height, bp->gain, bp->dir,
782846
G_UNKNOWN, G_UNKNOWN, /* course, speed */
783-
g_misc_config_p->beacon[j].freq, g_misc_config_p->beacon[j].tone, g_misc_config_p->beacon[j].offset,
847+
bp->freq, bp->tone, bp->offset,
784848
super_comment,
785849
info, sizeof(info));
786850
strlcat (beacon_text, info, sizeof(beacon_text));
787851
break;
788852

789853
case BEACON_OBJECT:
790854

791-
encode_object (g_misc_config_p->beacon[j].objname, g_misc_config_p->beacon[j].compress, 0, g_misc_config_p->beacon[j].lat, g_misc_config_p->beacon[j].lon, 0,
792-
g_misc_config_p->beacon[j].symtab, g_misc_config_p->beacon[j].symbol,
793-
g_misc_config_p->beacon[j].power, g_misc_config_p->beacon[j].height, g_misc_config_p->beacon[j].gain, g_misc_config_p->beacon[j].dir,
855+
encode_object (bp->objname, bp->compress, 0, bp->lat, bp->lon, 0,
856+
bp->symtab, bp->symbol,
857+
bp->power, bp->height, bp->gain, bp->dir,
794858
G_UNKNOWN, G_UNKNOWN, /* course, speed */
795-
g_misc_config_p->beacon[j].freq, g_misc_config_p->beacon[j].tone, g_misc_config_p->beacon[j].offset, super_comment,
859+
bp->freq, bp->tone, bp->offset, super_comment,
796860
info, sizeof(info));
797861
strlcat (beacon_text, info, sizeof(beacon_text));
798862
break;
@@ -809,7 +873,7 @@ static void beacon_send (int j, dwgps_info_t *gpsinfo)
809873
/* transmission of altitude from GPS. */
810874

811875
my_alt_ft = G_UNKNOWN;
812-
if (gpsinfo->fix >= 3 && gpsinfo->altitude != G_UNKNOWN && g_misc_config_p->beacon[j].alt_m > 0) {
876+
if (gpsinfo->fix >= 3 && gpsinfo->altitude != G_UNKNOWN && bp->alt_m > 0) {
813877
my_alt_ft = (int)roundf(DW_METERS_TO_FEET(gpsinfo->altitude));
814878
}
815879

@@ -818,12 +882,12 @@ static void beacon_send (int j, dwgps_info_t *gpsinfo)
818882
coarse = (int)roundf(gpsinfo->track);
819883
}
820884

821-
encode_position (g_misc_config_p->beacon[j].messaging, g_misc_config_p->beacon[j].compress,
885+
encode_position (bp->messaging, bp->compress,
822886
gpsinfo->dlat, gpsinfo->dlon, 0, my_alt_ft,
823-
g_misc_config_p->beacon[j].symtab, g_misc_config_p->beacon[j].symbol,
824-
g_misc_config_p->beacon[j].power, g_misc_config_p->beacon[j].height, g_misc_config_p->beacon[j].gain, g_misc_config_p->beacon[j].dir,
887+
bp->symtab, bp->symbol,
888+
bp->power, bp->height, bp->gain, bp->dir,
825889
coarse, (int)roundf(gpsinfo->speed_knots),
826-
g_misc_config_p->beacon[j].freq, g_misc_config_p->beacon[j].tone, g_misc_config_p->beacon[j].offset,
890+
bp->freq, bp->tone, bp->offset,
827891
super_comment,
828892
info, sizeof(info));
829893
strlcat (beacon_text, info, sizeof(beacon_text));
@@ -845,8 +909,8 @@ static void beacon_send (int j, dwgps_info_t *gpsinfo)
845909
A.g_dcs = G_UNKNOWN;
846910

847911
strlcpy (A.g_src, mycall, sizeof(A.g_src));
848-
A.g_symbol_table = g_misc_config_p->beacon[j].symtab;
849-
A.g_symbol_code = g_misc_config_p->beacon[j].symbol;
912+
A.g_symbol_table = bp->symtab;
913+
A.g_symbol_code = bp->symbol;
850914
A.g_lat = gpsinfo->dlat;
851915
A.g_lon = gpsinfo->dlon;
852916
A.g_speed_mph = DW_KNOTS_TO_MPH(gpsinfo->speed_knots);
@@ -865,25 +929,25 @@ static void beacon_send (int j, dwgps_info_t *gpsinfo)
865929

866930
case BEACON_CUSTOM:
867931

868-
if (g_misc_config_p->beacon[j].custom_info != NULL) {
932+
if (bp->custom_info != NULL) {
869933

870934
/* Fixed handcrafted text. */
871935

872-
strlcat (beacon_text, g_misc_config_p->beacon[j].custom_info, sizeof(beacon_text));
936+
strlcat (beacon_text, bp->custom_info, sizeof(beacon_text));
873937
}
874-
else if (g_misc_config_p->beacon[j].custom_infocmd != NULL) {
938+
else if (bp->custom_infocmd != NULL) {
875939
char info_part[AX25_MAX_INFO_LEN];
876940
int k;
877941

878942
/* Run given command to obtain the info part for packet. */
879943

880-
k = dw_run_cmd (g_misc_config_p->beacon[j].custom_infocmd, 2, info_part, sizeof(info_part));
944+
k = dw_run_cmd (bp->custom_infocmd, 2, info_part, sizeof(info_part));
881945
if (k > 0) {
882946
strlcat (beacon_text, info_part, sizeof(beacon_text));
883947
}
884948
else {
885949
text_color_set(DW_COLOR_ERROR);
886-
dw_printf ("CBEACON, config file line %d, INFOCMD failure.\n", g_misc_config_p->beacon[j].lineno);
950+
dw_printf ("CBEACON, config file line %d, INFOCMD failure.\n", bp->lineno);
887951
strlcpy (beacon_text, "", sizeof(beacon_text)); // abort!
888952
}
889953
}
@@ -935,7 +999,7 @@ static void beacon_send (int j, dwgps_info_t *gpsinfo)
935999
alevel_t alevel;
9361000

9371001

938-
switch (g_misc_config_p->beacon[j].sendto_type) {
1002+
switch (bp->sendto_type) {
9391003

9401004
case SENDTO_IGATE:
9411005

@@ -949,21 +1013,21 @@ static void beacon_send (int j, dwgps_info_t *gpsinfo)
9491013
case SENDTO_XMIT:
9501014
default:
9511015

952-
tq_append (g_misc_config_p->beacon[j].sendto_chan, TQ_PRIO_1_LO, pp);
1016+
tq_append (bp->sendto_chan, TQ_PRIO_1_LO, pp);
9531017
break;
9541018

9551019
case SENDTO_RECV:
9561020

9571021
/* Simulated reception from radio. */
9581022

9591023
memset (&alevel, 0xff, sizeof(alevel));
960-
dlq_rec_frame (g_misc_config_p->beacon[j].sendto_chan, 0, 0, pp, alevel, 0, "");
1024+
dlq_rec_frame (bp->sendto_chan, 0, 0, pp, alevel, 0, "");
9611025
break;
9621026
}
9631027
}
9641028
else {
9651029
text_color_set(DW_COLOR_ERROR);
966-
dw_printf ("Config file: Failed to parse packet constructed from line %d.\n", g_misc_config_p->beacon[j].lineno);
1030+
dw_printf ("Config file: Failed to parse packet constructed from line %d.\n", bp->lineno);
9671031
dw_printf ("%s\n", beacon_text);
9681032
}
9691033

0 commit comments

Comments
 (0)