Skip to content

Commit c904b57

Browse files
wb2oszwb2osz
committed
Time stamps and documentation for kissutil.
1 parent 6e34b5f commit c904b57

15 files changed

+304
-47
lines changed

‎Makefile.linux

+2-1
Original file line numberDiff line numberDiff line change
@@ -432,7 +432,7 @@ aclients : aclients.c ax25_pad.c fcs_calc.c textcolor.o misc.a
432432
# Note: kiss_frame.c has conditional compilation on KISSUTIL.
433433

434434
kissutil : kissutil.c kiss_frame.c ax25_pad.o fcs_calc.o textcolor.o serial_port.o dtime_now.o sock.o misc.a
435-
$(CC) $(CFLAGS) -g -DKISSUTIL -o $@ $^
435+
$(CC) $(CFLAGS) -g -DKISSUTIL -o $@ $^ $(LDFLAGS)
436436

437437

438438
# Touch Tone to Speech sample application.
@@ -637,6 +637,7 @@ install : $(APPS) direwolf.conf tocalls.txt symbols-new.txt symbolsX.txt dw-icon
637637
$(INSTALL) -D --mode=644 man1/decode_aprs.1 $(INSTALLDIR)/man/man1/decode_aprs.1
638638
$(INSTALL) -D --mode=644 man1/direwolf.1 $(INSTALLDIR)/man/man1/direwolf.1
639639
$(INSTALL) -D --mode=644 man1/gen_packets.1 $(INSTALLDIR)/man/man1/gen_packets.1
640+
$(INSTALL) -D --mode=644 man1/kissutil.1 $(INSTALLDIR)/man/man1/kissutil.1
640641
$(INSTALL) -D --mode=644 man1/ll2utm.1 $(INSTALLDIR)/man/man1/ll2utm.1
641642
$(INSTALL) -D --mode=644 man1/log2gpx.1 $(INSTALLDIR)/man/man1/log2gpx.1
642643
$(INSTALL) -D --mode=644 man1/text2tt.1 $(INSTALLDIR)/man/man1/text2tt.1

‎Makefile.macosx

+2-2
Original file line numberDiff line numberDiff line change
@@ -430,9 +430,9 @@ install-conf : direwolf.conf
430430

431431
# Separate application to decode raw data.
432432

433-
# First two use .c rather than .o because they depend on DECAMAIN definition.
433+
# First three use .c rather than .o because they depend on DECAMAIN definition.
434434

435-
decode_aprs : decode_aprs.c kiss_frame.c dwgpsnmea.o dwgps.o dwgpsd.o serial_port.o symbols.o ax25_pad.o textcolor.o fcs_calc.o latlong.o log.o telemetry.o tt_text.o
435+
decode_aprs : decode_aprs.c kiss_frame.c ax25_pad.c dwgpsnmea.o dwgps.o dwgpsd.o serial_port.o symbols.o textcolor.o fcs_calc.o latlong.o log.o telemetry.o tt_text.o
436436
$(CC) $(CFLAGS) -DDECAMAIN -o $@ $^ -lm
437437

438438
# Convert between text and touch tone representation.

‎doc/User-Guide.pdf

-67.9 KB
Binary file not shown.

‎dtime_now.c

+167-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11

22
#include "direwolf.h"
3+
4+
#include <stdio.h>
5+
36
#include "textcolor.h"
47
#include "dtime_now.h"
58

@@ -18,7 +21,25 @@
1821
#endif
1922

2023

21-
24+
/*------------------------------------------------------------------
25+
*
26+
* Name: dtime_now
27+
*
28+
* Purpose: Return current time as double precision.
29+
*
30+
* Input: none
31+
*
32+
* Returns: Unix time, as double precision, so we can get resolution
33+
* finer than one second.
34+
*
35+
* Description: Normal unix time is in seconds since 1/1/1970 00:00:00 UTC.
36+
* Sometimes we want resolution finer than a second.
37+
* Rather than having a separate variable for the fractional
38+
* part of a second, and having extra calculations everywhere,
39+
* simply use double precision floating point to make usage
40+
* easier.
41+
*
42+
*---------------------------------------------------------------*/
2243

2344

2445
double dtime_now (void)
@@ -59,3 +80,148 @@ double dtime_now (void)
5980

6081
return (result);
6182
}
83+
84+
85+
#if __WIN32__
86+
87+
/*
88+
* Windows doesn't have localtime_r.
89+
* It should have the equivalent localtime_s, with opposite parameter
90+
* order, but I get undefined reference when trying to use it.
91+
*/
92+
93+
static struct tm *localtime_r(time_t *clock, struct tm *res)
94+
{
95+
struct tm *tm;
96+
97+
tm = localtime (clock);
98+
memcpy (res, tm, sizeof(struct tm));
99+
return (res);
100+
}
101+
102+
#endif
103+
104+
105+
/*------------------------------------------------------------------
106+
*
107+
* Name: timestamp_now
108+
*
109+
* Purpose: Convert local time to one of these formats for debug output.
110+
*
111+
* HH:MM:SS
112+
* HH:MM:SS.mmm
113+
*
114+
* Input: result_size - Size of result location.
115+
* Should be at least 9 or 13.
116+
*
117+
* show_ms - True to display milliseconds.
118+
*
119+
* Output: result - Result is placed here.
120+
*
121+
*---------------------------------------------------------------*/
122+
123+
void timestamp_now (char *result, int result_size, int show_ms)
124+
{
125+
double now = dtime_now();
126+
time_t t = (int)now;
127+
struct tm tm;
128+
129+
localtime_r (&t, &tm);
130+
strftime (result, result_size, "%H:%M:%S", &tm);
131+
132+
if (show_ms) {
133+
int ms = (now - (int)t) * 1000;
134+
char strms[16];
135+
136+
if (ms == 1000) ms = 999;
137+
sprintf (strms, ".%03d", ms);
138+
strlcat (result, strms, result_size);
139+
}
140+
141+
} /* end timestamp_now */
142+
143+
144+
145+
/*------------------------------------------------------------------
146+
*
147+
* Name: timestamp_user_format
148+
*
149+
* Purpose: Convert local time user-specified format. e.g.
150+
*
151+
* HH:MM:SS
152+
* mm/dd/YYYY HH:MM:SS
153+
* dd/mm/YYYY HH:MM:SS
154+
*
155+
* Input: result_size - Size of result location.
156+
*
157+
* user_format - See strftime documentation.
158+
*
159+
* https://linux.die.net/man/3/strftime
160+
* https://msdn.microsoft.com/en-us/library/aa272978(v=vs.60).aspx
161+
*
162+
* Note that Windows does not support all of the Linux formats.
163+
* For example, Linux has %T which is equivalent to %H:%M:%S
164+
*
165+
* Output: result - Result is placed here.
166+
*
167+
*---------------------------------------------------------------*/
168+
169+
void timestamp_user_format (char *result, int result_size, char *user_format)
170+
{
171+
double now = dtime_now();
172+
time_t t = (int)now;
173+
struct tm tm;
174+
175+
localtime_r (&t, &tm);
176+
strftime (result, result_size, user_format, &tm);
177+
178+
} /* end timestamp_user_format */
179+
180+
181+
/*------------------------------------------------------------------
182+
*
183+
* Name: timestamp_filename
184+
*
185+
* Purpose: Generate unique file name based on the current time.
186+
* The format will be:
187+
*
188+
* YYYYMMDD-HHMMSS-mmm
189+
*
190+
* Input: result_size - Size of result location.
191+
* Should be at least 20.
192+
*
193+
* Output: result - Result is placed here.
194+
*
195+
* Description: This is for the kissutil "-r" option which places
196+
* each received frame in a new file. It is possible to
197+
* have two packets arrive in less than a second so we
198+
* need more than one second resolution.
199+
*
200+
* What if someone wants UTC, rather than local time?
201+
* You can simply set an environment variable like this:
202+
*
203+
* TZ=UTC direwolf
204+
*
205+
* so it's probably not worth the effort to add another
206+
* option.
207+
*
208+
*---------------------------------------------------------------*/
209+
210+
void timestamp_filename (char *result, int result_size)
211+
{
212+
double now = dtime_now();
213+
time_t t = (int)now;
214+
struct tm tm;
215+
216+
localtime_r (&t, &tm);
217+
strftime (result, result_size, "%Y%m%d-%H%M%S", &tm);
218+
219+
int ms = (now - (int)t) * 1000;
220+
char strms[16];
221+
222+
if (ms == 1000) ms = 999;
223+
sprintf (strms, "-%03d", ms);
224+
strlcat (result, strms, result_size);
225+
226+
} /* end timestamp_filename */
227+

‎dtime_now.h

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
11

22

3-
extern double dtime_now (void);
3+
extern double dtime_now (void);
4+
5+
void timestamp_now (char *result, int result_size, int show_ms);
6+
7+
void timestamp_user_format (char *result, int result_size, char *user_format);
8+
9+
void timestamp_filename (char *result, int result_size);

0 commit comments

Comments
 (0)