-
Notifications
You must be signed in to change notification settings - Fork 12
/
Copy pathconfig_utils.sh
executable file
·759 lines (680 loc) · 30.8 KB
/
config_utils.sh
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
#!/bin/bash
### Config file exists, now validate it.
### Validation requires that we have a list of valid BANDs
### These are the band frequencies taken from wsprnet.org
# ----------Band----------Dial Frequency----------TX Frequency center(+range)--------------
# 2190m--------------0.136000---------------0.137500 (+- 100Hz)
# 630m--------------0.474200---------------0.475700 (+- 100Hz)
# 160m--------------1.836600---------------1.838100 (+- 100Hz)
# 80m--------------3.568600---------------3.570100 (+- 100Hz) (this is the default frequency in WSJT-X v1.8.0 to be within the Japanese allocation.)
# 80m--------------3.592600---------------3.594100 (+- 100Hz) (No TX allowed for Japan; http://www.jarl.org/English/6_Band_Plan/JapaneseAmateurBandplans20150105...)
# 60m--------------5.287200---------------5.288700 (+- 100Hz) (please check local band plan if you're allowed to operate on this frequency!)
# 60m--------------5.364700---------------5.366200 (+- 100Hz) (valid for 60m band in Germany or other EU countries, check local band plan prior TX!)
# 40m--------------7.038600---------------7.040100 (+- 100Hz)
# 30m-------------10.138700--------------10.140200 (+- 100Hz)
# 22m-------------13.553900--------------13.554500 (+- 100Hz)
# 20m-------------14.095600--------------14.097100 (+- 100Hz)
# 17m-------------18.104600--------------18.106100 (+- 100Hz)
# 15m-------------21.094600--------------21.096100 (+- 100Hz)
# 12m-------------24.924600--------------24.926100 (+- 100Hz)
# 10m-------------28.124600--------------28.126100 (+- 100Hz)
# 6m-------------50.293000--------------50.294500 (+- 100Hz)
# 4m-------------70.091000--------------70.092500 (+- 100Hz)
# 2m------------144.489000-------------144.490500 (+- 100Hz)
# 70cm------------432.300000-------------432.301500 (+- 100Hz)
# 23cm-----------1296.500000------------1296.501500 (+- 100Hz)
### These are the 'dial frequency' in kHz. The actual wspr tx frequencies are these values + 1400 to 1600 Hz
### The format of each entry is "BAND TUNING_FREQUENCY DEFAULT_DECODE_MODES" where DEFAULT_DECODE_MODES is a colon-separated list of mode W (legacy WSPR) or F (FST4W) + packet length in minutes.
### e.g. "W2" == classic WSPR decode by the wsprd of a 2 minute long wav file
declare VALID_MODE_LIST=( W0 W2 F2 F5 F15 F30 I1 J1 K1)
### This is a list of the tuning frequencies for each band
### WSPR bands tune 1500 hertz below the center of the WSPR transmit band
### Since time stations WWV and CHU are recorded only in IQ mode, they tune to the carrier freqeuency
declare WSPR_BAND_LIST=(
"2200 136.0 W2"
"630 474.2 W2"
"160 1836.6 W2"
"80 3568.6 W2"
"80eu 3592.6 W2"
"60 5287.2 W2"
"60eu 5364.7 W2"
"40 7038.6 W2"
"30 10138.7 W2"
"22 13553.9 W2"
"20 14095.6 W2"
"17 18104.6 W2"
"15 21094.6 W2"
"12 24924.6 W2"
"10 28124.6 W2"
"8 40680.0 W2"
"6 50293.0 W2"
"4 70091.0 W2"
"2 144489.0 W2"
"1 432300.0 W2"
"0 1296500.0 W2"
"WWVB 60.0 W0"
"WWV_2_5 2500.0 W0"
"WWV_5 5000.0 W0"
"WWV_10 10000.0 W0"
"WWV_15 15000.0 W0"
"WWV_20 20000.0 W0"
"WWV_25 25000.0 W0"
"CHU_3 3330.0 W0"
"CHU_7 7850.0 W0"
"CHU_14 14670.0 W0"
"SUPERDARN_9 9120.0 J1"
"SUPERDARN_11 11070.0 J1"
"SUPERDARN_14 14650.0 J1"
"SUPERDARN_16 16120.0 J1"
"K_BEACON_5 5154.3 K1"
"K_BEACON_7_3 7039.3 K1"
"K_BEACON_7_4 7039.4 K1"
)
### Get the current value of a variable stored in the wsprdaemon.conf file without perturbing any currently defined .conf file variables in the calling function
function get_config_file_variable()
{
local __return_variable=$1
local _variable_name=$2
local conf_file_value=$( shopt -u -o nounset; source ~/wsprdaemon/wsprdaemon.conf; eval echo \${${_variable_name}} )
eval ${__return_variable}=\${conf_file_value}
}
function is_valid_mode_list() {
local test_mode_entry=$1
local test_mode_entry_list=( ${test_mode_entry//:/ } )
wd_logger 2 "Starting validation of '${test_mode_entry}'"
if [[ ${#test_mode_entry_list[@]} -gt 1 && " ${test_mode_entry_list[@]} " =~ " W0 " ]] ; then
wd_logger 1 "ERROR: mode 'W0' cannot be mixed with other modes"
return 1
fi
for mode_entry in ${test_mode_entry_list[@]} ; do
if ! [[ " ${VALID_MODE_LIST[@]} " =~ " ${mode_entry} " ]]; then
wd_logger 1 "Error: ${mode_entry} is not a member of '${VALID_MODE_LIST[*]}'"
return 1
fi
done
wd_logger 2 "All modes in '${test_mode_entry}' are valid"
return 0
}
function get_default_modes_for_band() {
local return_var_name=$1
local search_for_band=$2
wd_logger 2 "Got args ${return_var_name} ${search_for_band}"
local band_entry
for band_entry in "${WSPR_BAND_LIST[@]}"; do
local band_entry_list=( ${band_entry} )
local entry_band=${band_entry_list[0]}
wd_logger 2 "Checking for band ${search_for_band} in '${band_entry_list[*]}'"
if [[ ${band_entry_list} == ${search_for_band} ]]; then
local local_default_modes=${band_entry_list[2]}
wd_logger 2 "Returning default modes for band ${search_for_band} => ${local_default_modes}"
eval ${return_var_name}=${local_default_modes}
return 0
fi
done
wd_logger 1 "Failed to find entry for band ${search_for_band}"
return 1
}
function get_wspr_band_name_from_freq_hz() {
local band_freq_hz=$1
local band_freq_khz=$(bc <<< "scale = 1; ${band_freq_hz} / 1000")
local i
for i in $( seq 0 $(( ${#WSPR_BAND_LIST[*]} - 1)) ) ; do
local band_info=(${WSPR_BAND_LIST[i]})
local this_band=${band_info[0]}
local this_freq_khz=${band_info[1]}
if [[ ${band_freq_khz} == ${this_freq_khz} ]]; then
echo ${this_band}
return
fi
done
[[ ${verbosity} -ge 1 ]] && echo "$(date): get_wspr_band_name_from_freq_hz() ERROR, can't find band for band_freq_hz = '${band_freq_hz}'" 1>&2
echo ${band_freq_hz}
}
function get_wspr_band_freq_khz(){
local target_band=$1
local i
for i in $( seq 0 $(( ${#WSPR_BAND_LIST[*]} - 1)) ) ; do
local band_info=(${WSPR_BAND_LIST[i]})
local this_band=${band_info[0]}
local this_freq_khz=${band_info[1]}
if [[ ${target_band} == ${this_band} ]]; then
echo ${this_freq_khz}
return 0
fi
done
wd_logger 1 "ERROR: unknown band ${target_band}"
exit 1
}
function get_wspr_band_freq_hz(){
local target_band=$1
local freq_khz=$(get_wspr_band_freq_khz ${target_band} )
local rc
freq_khz=$(get_wspr_band_freq_khz ${target_band} )
### Only gets here if target_band is valid
local freq_hz
freq_hz=$(bc <<< "scale = 0; (${freq_khz} * 1000)/1.0")
echo ${freq_hz}
return 0
}
### Validation requires that we have a list of valid RECEIVERs
###
function get_receiver_list_index_from_name() {
local new_receiver_name=$1
local i
for i in $(seq 0 $(( ${#RECEIVER_LIST[*]} - 1 )) ) ; do
local receiver_info=(${RECEIVER_LIST[i]})
local receiver_name=${receiver_info[0]}
local receiver_ip_address=${receiver_info[1]}
if [[ ${receiver_name} == ${new_receiver_name} ]]; then
echo ${i}
return 0
fi
done
}
function get_receiver_ip_from_name() {
local receiver_name=$1
local receiver_info=( ${RECEIVER_LIST[$(get_receiver_list_index_from_name ${receiver_name})]} )
echo ${receiver_info[1]}
}
function get_receiver_call_from_name() {
local receiver_name=$1
local receiver_info=( ${RECEIVER_LIST[$(get_receiver_list_index_from_name ${receiver_name})]} )
echo ${receiver_info[2]}
}
function get_first_receiver_reporter() {
local __return_var_name=${1}
if [[ ${#RECEIVER_LIST[@]} -eq 0 ]]; then
wd_logger 1 "ERROR: RECEIVER_LIST[] is not declared in wsprdaemon.conf"
return 1
fi
local receiver_info=( ${RECEIVER_LIST[0]} )
eval ${__return_var_name}=\${receiver_info[2]}
return 0
}
function get_receiver_grid_from_name() {
local receiver_name=$1
local receiver_info=( ${RECEIVER_LIST[$(get_receiver_list_index_from_name ${receiver_name})]} )
echo ${receiver_info[3]}
}
function get_receiver_password_from_name() {
local receiver_name=$1
local receiver_info=( ${RECEIVER_LIST[$(get_receiver_list_index_from_name ${receiver_name})]} )
echo ${receiver_info[4]}
}
function get_receiver_af_list_from_name() {
local receiver_name=$1
local receiver_info=( ${RECEIVER_LIST[$(get_receiver_list_index_from_name ${receiver_name})]} )
echo ${receiver_info[5]-}
}
function get_receiver_khz_offset_list_from_name() {
local receiver_name=$1
local receiver_info=( ${RECEIVER_LIST[$(get_receiver_list_index_from_name ${receiver_name})]} )
local khz_offset=0
local khz_info=${receiver_info[6]-}
if [[ -n "${khz_info}" ]]; then
khz_offset=${khz_info##*:}
fi
echo ${khz_offset}
}
### Validation requires we check the time specified for each job
#### Input is HH:MM or {sunrise,sunset}{+,-}HH:MM
declare SUNTIMES_FILE=${WSPRDAEMON_ROOT_DIR}/suntimes ### cache sunrise HH:MM and sunset HH:MM for Receiver's Maidenhead grid
declare MAX_SUNTIMES_FILE_AGE_SECS=86400 ### refresh that cache file once a day
### Adds or subtracts two: HH:MM +/- HH:MM
function time_math() {
local -i index_hr=$((10#${1%:*})) ### Force all HH MM to be decimal number with no leading zeros
local -i index_min=$((10#${1#*:}))
local math_operation=$2 ### I expect only '+' or '-'
local -i offset_hr=$((10#${3%:*}))
local -i offset_min=$((10#${3#*:}))
local -i result_hr=$(($index_hr $2 $offset_hr))
local -i result_min=$((index_min $2 $offset_min))
if [[ $result_min -ge 60 ]]; then
(( result_min -= 60 ))
(( result_hr++ ))
fi
if [[ $result_min -lt 0 ]]; then
(( result_min += 60 ))
(( result_hr-- ))
fi
if [[ $result_hr -ge 24 ]]; then
(( result_hr -= 24 ))
fi
if [[ $result_hr -lt 0 ]]; then
(( result_hr += 24 ))
fi
printf "%02.0f:%02.0f\n" ${result_hr} $result_min
}
######### This block of code supports scheduling changes based upon local sunrise and/or sunset ############
declare A_IN_ASCII=65 ### Decimal value of 'A'
declare ZERO_IN_ASCII=48 ### Decimal value of '0'
function alpha_to_integer() {
echo $(( $( printf "%d" "'$1" ) - $A_IN_ASCII ))
}
function digit_to_integer() {
echo $(( $( printf "%d" "'$1" ) - $ZERO_IN_ASCII ))
}
### This returns the approximate lat/long of a Maidenhead 4 or 6 character locator
### Primarily useful in getting sunrise and sunset time
function maidenhead_to_long_lat() {
printf "%s %s\n" \
$(( $(( $(alpha_to_integer ${1:0:1}) * 20 )) + $(( $(digit_to_integer ${1:2:1}) * 2)) - 180))\
$(( $(( $(alpha_to_integer ${1:1:1}) * 10 )) + $(digit_to_integer ${1:3:1}) - 90))
}
declare SUNTIMES_PYTHON_PROGRAM=${WSPRDAEMON_ROOT_DIR}/suntimes.py
function get_suntimes()
{
local _return_times_var=$1
local lat=$2
local lon=$3
python3 ${SUNTIMES_PYTHON_PROGRAM} ${lat} ${lon} > suntimes.txt 2> /dev/null
rc=$?
if [[ ${rc} -ne 0 ]]; then
wd_logger 1 "ERROR: 'python3 ${SUNTIMES_PYTHON_PROGRAM} ${lat} ${lon}' => ${rc}"
exit 1
fi
local _sunrise_sunset_times=$(< suntimes.txt)
eval ${_return_times_var}=\"\${_sunrise_sunset_times}\"
wd_logger 2 "Ran 'python3 ${SUNTIMES_PYTHON_PROGRAM} ${lat} ${lon}' and got sunrise_sunset_times='${_sunrise_sunset_times}'. Then assigned it to _return_times_var=${_return_times_var}"
return 0
}
function get_sunrise_sunset()
{
local _return_sunrise_hm=$1
local maiden
if [[ -n "${FORCE_MAIDENHEAD-}" ]]; then
maiden="${FORCE_MAIDENHEAD}"
else
maiden=$2
fi
local long_lat=( $(maidenhead_to_long_lat $maiden) )
wd_logger 2 "Get sunrise/sunset for Maidenhead ${maiden} which is at long/lat ${long_lat[*]}"
local long=${long_lat[0]}
local lat=${long_lat[1]}
local sunrise_sunset_times=""
local rc
get_suntimes sunrise_sunset_times ${lat} ${long}
rc=$?
if [[ ${rc} -ne 0 ]]; then
wd_logger 1 "ERROR: 'get_suntimes sunrise_sunset_times ${lat} ${long}' => ${rc}"
exit 1
fi
eval ${_return_sunrise_hm}=\"\${sunrise_sunset_times}\"
wd_logger 2 "'get_suntimes sunrise_sunset_times ${lat} ${long}' => 0. sunrise_sunset_times=${sunrise_sunset_times}"
return 0
}
### Once per day, cache the sunrise/sunset times for the grids of all receivers
function update_suntimes_file()
{
if [[ -f ${SUNTIMES_FILE} ]] \
&& [[ $( $GET_FILE_MOD_TIME_CMD ${SUNTIMES_FILE} ) -gt $( $GET_FILE_MOD_TIME_CMD ${WSPRDAEMON_CONFIG_FILE} ) ]] \
&& [[ $(( $(date +"%s") - $( $GET_FILE_MOD_TIME_CMD ${SUNTIMES_FILE} ))) -lt ${MAX_SUNTIMES_FILE_AGE_SECS} ]] ; then
## Only update once a day
wd_logger 2 "Skipping update"
return 0
fi
wd_logger 2 "Updating suntimes file ${SUNTIMES_FILE}"
rm -f ${SUNTIMES_FILE}
source ${WSPRDAEMON_CONFIG_FILE}
local maidenhead_list=$( ( IFS=$'\n' ; echo "${RECEIVER_LIST[*]}") | awk '{print $4}' | sort | uniq)
for grid in ${maidenhead_list} ; do
wd_logger 2 "Updating suntimes file ${SUNTIMES_FILE} for grid ${grid}"
local suntimes=""
get_sunrise_sunset suntimes ${grid}
local rc=$?
if [[ ${rc} -ne 0 ]]; then
wd_logger 1 "ERROR: 'get_sunrise_sunset suntimes ${grid}' => ${rc}"
return ${rc}
fi
echo "${grid} ${suntimes}" >> ${SUNTIMES_FILE}
wd_logger 2 "Added line '${grid} ${suntimes}' to '${SUNTIMES_FILE}'"
done
wd_logger 1 "Refreshed '${SUNTIMES_FILE}'"
return 0
}
function get_index_time()
{
local _return_hh_mm=$1
local time_field=$2
local receiver_grid=$3
local hour
local minute
local hh_mm
if [[ ${time_field} =~ ^([01][0-9]|2[0-3]):[0-5][0-9]$ ]]; then
### This is a properly formatted HH:MM time spec
hour=${time_field%:*}
minute=${time_field#*:}
hh_mm="${hour}:${minute}"
eval ${_return_hh_mm}=\"\${hh_mm}\"
wd_logger 2 "time_field=${time_field} contains valid HH:MM value ${hh_mm} and returned it to _return_hh_mm=${_return_hh_mm}"
return 0
fi
if [[ ! ${time_field} =~ sunrise|sunset ]]; then
wd_logger 1 "ERROR: time specification '${time_field}' is not valid"
return 1
fi
update_suntimes_file
## Sunrise or sunset has been specified. Uses Receiver's name to find it's Maidenhead and from there lat/long leads to sunrise and sunset
if [[ ${time_field} =~ sunrise ]] ; then
index_time=$(awk "/${receiver_grid}/{print \$2}" ${SUNTIMES_FILE} )
else ## == sunset
index_time=$(awk "/${receiver_grid}/{print \$3}" ${SUNTIMES_FILE} )
fi
local offset="00:00"
local sign="+"
if [[ ${time_field} =~ \+ ]] ; then
offset=${time_field#*+}
elif [[ ${time_field} =~ \- ]] ; then
offset=${time_field#*-}
sign="-"
fi
local offset_time=$(time_math $index_time $sign $offset)
if [[ ! ${offset_time} =~ ^([01][0-9]|2[0-3]):[0-5][0-9]$ ]]; then
wd_logger 1 "ERROR: failed to translate the sunrise/sunset+offset value ${time_field} to a valid offset_time ${offset_time}"
return 3
fi
eval ${_return_hh_mm}=\"\${offset_time}\"
wd_logger 2 "Translated a valid sunrise/sunset+offset value ${time_field} to ${offset_time} and returned it to _return_hh_mm=${_return_hh_mm}"
return 0
}
### Validate the schedule
###
declare POSTING_DIR_MAX_SPACE=1000
declare RECORDING_DIR_WAV_FILE_SPACE_PER_MINUTE=1500
function validate_configured_schedule()
{
local found_error="no"
local sched_line
if [[ -z "${WSPR_SCHEDULE[@]-}" ]]; then
wd_logger 1 "ERROR: WSPR_SCHEDULE[] is not defined in the conf file"
exit 1
fi
if [[ ${#WSPR_SCHEDULE[@]} -lt 1 ]]; then
wd_logger 1 "ERROR: WSPR_SCHEDULE[] is defined in the conf file but has no schedule entries"
exit 2
fi
wd_logger 2 "Starting"
local max_tmp_file_space=0
for sched_line in "${WSPR_SCHEDULE[@]}" ; do
wd_logger 2 "Checking line ${sched_line}"
local sched_tmp_file_space=0
local sched_line_list=( ${sched_line} )
if [[ ${#sched_line_list[@]} -lt 2 ]]; then
wd_logger 1 "ERROR: WSPR_SCHEDULE[@] line '${sched_line}' does not have the required minimum 2 fields. Remember that each schedule entry must have the form \"HH:MM RECEIVER,BAND[,MODES]... \""
exit 1
fi
local job_time=${sched_line_list[0]}
wd_logger 2 "Job for time '${job_time}' has at least one RX:BAND specifications"
### NOTE: all of the receivers must be in the same time zone.
local job
for job in ${sched_line_list[@]:1}; do
wd_logger 2 "Testing job $job"
local -a job_elements=(${job//,/ })
local job_elements_count=${#job_elements[@]}
if [[ $job_elements_count -lt 2 ]]; then
wd_logger 1 "ERROR: in WSPR_SCHEDULE line '${sched_line[@]}', job '${job}' doesn't have the form 'RECEIVER,BAND'"
exit 1
fi
local job_rx=${job_elements[0]}
local rx_index
rx_index=$(get_receiver_list_index_from_name ${job_rx})
if [[ -z "${rx_index}" ]]; then
wd_logger 1 "ERROR: in WSPR_SCHEDULE line '${sched_line[*]}', job '${job}' specifies receiver '${job_rx}' not found in RECEIVER_LIST"
found_error="yes"
fi
local job_band=${job_elements[1]}
band_freq=$(get_wspr_band_freq_khz ${job_band})
if [[ -z "${band_freq}" ]]; then
wd_logger 1 "ERROR: in WSPR_SCHEDULE line '${sched_line[*]}', job '${job}' specifies band '${job_band}' not found in WSPR_BAND_LIST"
found_error="yes"
fi
local job_modes=${job_elements[2]-W2}
is_valid_mode_list ${job_modes}
local rc=$?
if [[ ${rc} -ne 0 ]]; then
wd_logger 1 "ERROR: in WSPR_SCHEDULE line '${sched_line[*]}', job '${job}' specifies invalid mode(s)"
found_error="yes"
fi
local job_grid="$(get_receiver_grid_from_name ${job_rx})"
local job_time_resolved=""
get_index_time job_time_resolved ${job_time} ${job_grid}
local ret_code=$?
if [[ ${ret_code} -ne 0 ]]; then
wd_logger 1 "ERROR: in WSPR_SCHEDULE line '${sched_line[*]}', time specification '${job_time}' is not valid"
exit 1
fi
wd_logger 2 "Found valid job '${job}' == job_time_resolved=${job_time_resolved}"
### Calculate the maximum /tmp/wsprdaemon disk space in KBytes which could be used by this job
### For each job in this schedule there will be only one posting directory which occupies at most about 1000 KBytes
### There will be one recording dir for each simple job, but N recording jobs for MERGed receivers and each of those will occupy at most ((MAX_MODE_MINUTES * 1500 Kbytes) * 2) + 1500
local job_field_list=( ${job//,/ } )
if [[ ${#job_field_list[@]} -eq 2 ]]; then
job_field_list[2]="W2"
fi
local job_mode_list=( ${job_field_list[2]//:/ } )
local job_max_mode_minutes=$( IFS=$'\n'; echo "${job_mode_list[*]/?/}" | sort -nu | tail -n 1 )
wd_logger 2 "Found job '${job}' with a max time length mode of ${job_max_mode_minutes} minutes"
local job_rx_name=${job_field_list[0]}
local job_rx_name_list=()
if [[ ${job_rx_name} =~ ^MERG ]] ; then
local merged_receiver_address=$(get_receiver_ip_from_name ${job_rx_name}) ### In a MERGed rx, the real rxs feeding it are in a comma-separated list in the IP column
job_rx_name_list=( ${merged_receiver_address//,/ } )
else
job_rx_name_list[0]=${job_rx_name}
fi
local posting_dir_max_space=${POSTING_DIR_MAX_SPACE}
local recording_dir_one_minute_wav_file_max_space=$(( ${RECORDING_DIR_WAV_FILE_SPACE_PER_MINUTE} * ${job_max_mode_minutes} ))
local recording_dir_longest_minute_wav_copy_file_max_space=${recording_dir_one_minute_wav_file_max_space}
local recording_dir_log_files_file_max_space=1000
local recording_dir_total_max_space=$(( ${recording_dir_one_minute_wav_file_max_space} + ${recording_dir_longest_minute_wav_copy_file_max_space} + ${recording_dir_log_files_file_max_space} ))
local all_recording_dirs_total_max_space=$(( ${#job_rx_name_list[@]} * ${recording_dir_total_max_space} ))
local job_max_disk_space=$(( ${posting_dir_max_space} + ${all_recording_dirs_total_max_space} ))
sched_tmp_file_space=$(( ${sched_tmp_file_space} + ${job_max_disk_space} ))
wd_logger 2 "$(printf "'${job}' requires there be 1 posting daemon directory and ${#job_rx_name_list[@]} recording directories. Alltogether they will consume at most %'d KB, so sched_tmp_file_space=%'d KB\n" ${job_max_disk_space} ${sched_tmp_file_space})"
done
if [[ ${sched_tmp_file_space} -gt ${max_tmp_file_space} ]]; then
max_tmp_file_space=${sched_tmp_file_space}
fi
done
local tmp_filesystem_size=$(df ${WSPRDAEMON_TMP_DIR} | awk '/tmpfs/{print $2}')
if [[ ${max_tmp_file_space} -ge ${tmp_filesystem_size} ]]; then
wd_logger 1 "$( printf "ERROR: the schedule in the conf file will require a /tmp/wsprdaemon file system with %'d KBytes of space, but /tmp/wsprdaemon is configured in /etc/fstab for only %'d KBytes of space. Either increase its size in /etc/fstab or change the schedule" \
${max_tmp_file_space} ${tmp_filesystem_size} ) "
read -p "Increase the size of '/tmp/wsprdaemon' in '/etc/fstab' before trying to run this confguration. Press <ENTER> to continue with WD installation and validation => "
else
wd_logger 2 "$( printf "The schedule in the conf file will require a /tmp/wsprdaemon file system with %'d KBytes of space and /tmp/wsprdaemon is configured in /etc/fstab for %'d KBytes which is enough space" \
${max_tmp_file_space} ${tmp_filesystem_size} ) "
fi
if [[ ${found_error} == "yes" ]]; then
return 1
fi
return 0
}
###
function validate_configuration_file()
{
if [[ ! -f ${WSPRDAEMON_CONFIG_FILE} ]]; then
echo "ERROR: configuration file '${WSPRDAEMON_CONFIG_FILE}' does not exist"
exit 1
fi
source ${WSPRDAEMON_CONFIG_FILE}
if [[ -n "${SPOT_FREQ_ADJ_HZ-}" ]]; then
local absolute_value_freq_adj=${SPOT_FREQ_ADJ_HZ#-} ### Strip off a leading '-'
absolute_value_freq_adj=${absolute_value_freq_adj#+} ### Strip off a leading '+"
if [[ "${absolute_value_freq_adj:0:1}" == "." ]]; then
### The regex in the test below needs that there be a digit before a '.' in the number
absolute_value_freq_adj="0${absolute_value_freq_adj}"
wd_logger 2 "Prepend a missing '0' to the SPOT_FREQ_ADJ_HZ value ${SPOT_FREQ_ADJ_HZ} to create the test value ${absolute_value_freq_adj}"
fi
if ! [[ ${absolute_value_freq_adj} =~ ^[+-]?[0-9]+([.][0-9]+)?$ ]] ; then
wd_logger 1 "ERROR: the value '${SPOT_FREQ_ADJ_HZ}' of SPOT_FREQ_ADJ_HZ which has been defined in the conf file is not a valid integer or float"
exit 1
fi
local spot_freq_adj_max_hz=${SPOT_FREQ_ADJ_MAX_HZ-20} ### By default, limit spot frequency adjustments to +/- 20 Hz
if [[ ${absolute_value_freq_adj%.*} -gt ${spot_freq_adj_max_hz} ]]; then
wd_logger 1 "ERROR: the value '${SPOT_FREQ_ADJ_HZ}' of SPOT_FREQ_ADJ_HZ defined in the conf file is greater than the max supported value of +/-${spot_freq_adj_max_hz}"
exit 1
fi
fi
if [[ -z "${RECEIVER_LIST[@]-}" ]]; then
echo "ERROR: configuration file '${WSPRDAEMON_CONFIG_FILE}' does not contain a definition of the RECEIVER_LIST[*] array or that array is empty"
exit 1
fi
local max_index=$(( ${#RECEIVER_LIST[@]} - 1 ))
if [[ ${max_index} -lt 0 ]]; then
echo "ERROR: configuration file '${WSPRDAEMON_CONFIG_FILE}' defines RECEIVER_LIST[*] but it contains no receiver definitions"
exit 1
fi
### Create a list of receivers and validate all are specifired to be in the same grid. More validation could be added later
local rx_name=""
local rx_grid=""
local first_rx_grid=""
local rx_line
local -a rx_line_info_fields=()
local -a rx_name_list=("")
local index
for index in $(seq 0 ${max_index}); do
rx_line_info_fields=(${RECEIVER_LIST[${index}]})
if [[ ${#rx_line_info_fields[@]} -lt 5 ]]; then
echo "ERROR: configuration file '${WSPRDAEMON_CONFIG_FILE}' contains 'RECEIVER_LIST[] configuration line '${rx_line_info_fields[@]}' which has fewer than the required 5 fields"
exit 1
fi
rx_name=${rx_line_info_fields[0]}
rx_grid=${rx_line_info_fields[3]}
if [[ -z "${first_rx_grid}" ]]; then
first_rx_grid=${rx_grid}
fi
if [[ $verbosity -gt 1 ]] && [[ "${rx_grid}" != "${first_rx_grid}" ]]; then
echo "INFO: configuration file '${WSPRDAEMON_CONFIG_FILE}' contains 'RECEIVER_LIST[] configuration line '${rx_line_info_fields[@]}'"
echo " that specifies grid '${rx_grid}' which differs from the grid '${first_rx_grid}' of the first receiver"
fi
### Validate file name, i.i don't allow ',' characters in the name
if [[ ${rx_name} =~ , ]]; then
echo "ERROR: the receiver '${rx_name}' defined in wsprdaemon.conf contains the invalid character ','"
exit 1
fi
rx_name_list+=( ${rx_name} )
### More testing of validity of the fields on this line could be done
done
if [[ -z "${WSPR_SCHEDULE[@]-}" ]]; then
echo "ERROR: configuration file '${WSPRDAEMON_CONFIG_FILE}' exists, but does not contain a definition of the WSPR_SCHEDULE[*] array, or that array is empty"
exit 1
fi
local max_index=$(( ${#WSPR_SCHEDULE[@]} - 1 ))
if [[ ${max_index} -lt 0 ]]; then
echo "ERROR: configuration file '${WSPRDAEMON_CONFIG_FILE}' declares WSPR_SCHEDULE[@], but it contains no schedule definitions"
exit 1
fi
validate_configured_schedule
return 0
}
### This function returns a string which contains the names af all the the real recievers which are specified in the WSPR_SCHEDULE[] either directly or as a member of a MERG receiver
### It was implemented so that at startup WD can determine if there will be any KA9Q receivers used,, and if so then WD will setup the KA9Q-radio service
function get_list_of_active_real_receivers()
{
local __return_real_receivers_in_use_var=$1
local rx_list=()
local schedule_line
for schedule_line in "${WSPR_SCHEDULE[@]}" ; do
local schedule_line_list=(${schedule_line})
local job
for job in ${schedule_line_list[@]:1} ; do
local rx=${job%%,*}
if [[ ! "${rx}" =~ "MERG" ]]; then
if [[ ! "${rx_list[@]}" =~ ${rx} ]]; then
rx_list+=( ${rx} )
fi
else
local merge_line_list=( $(IFS=$'\n'; echo "${RECEIVER_LIST[*]}" | grep -w ${rx}) )
local merge_rx=${merge_line_list[1]}
local merge_rx_list=( ${merge_rx//,/ } )
local merged_rx
for merged_rx in ${merge_rx_list[@]} ; do
if [[ ! "${rx_list[@]}" =~ ${merged_rx} ]]; then
rx_list+=( ${merged_rx} )
fi
done
fi
done
done
local return_string=$(IFS=' '; echo "${rx_list[*]}" )
eval ${__return_real_receivers_in_use_var}=\"${return_string}\"
}
declare APT_GET_UPDATE_HAS_RUN="no"
function install_debian_package(){
local package_name=$1
local ret_code
wd_logger 2 "Check that package ${package_name} is installed"
if dpkg -L ${package_name} >& /dev/null ; then
wd_logger 2 "Package ${package_name} has already been installed"
return 0
fi
wd_logger 1 "Package ${package_name} needs to be installed"
if [[ ${APT_GET_UPDATE_HAS_RUN} == "no" ]]; then
wd_logger 1 "'apt-get update' needs to be run"
sudo apt-get update --allow-releaseinfo-change
ret_code=$?
if [[ ${ret_code} -ne 0 ]]; then
wd_logger 1 "ERROR: 'sudo apt-get update' => ${ret_code}"
return ${ret_code}
fi
APT_GET_UPDATE_HAS_RUN="yes"
fi
sudo apt-get install ${package_name} --assume-yes
ret_code=$?
if [[ ${ret_code} -ne 0 ]]; then
wd_logger 1 "ERROR: 'sudo apt-get install ${package_name}' => ${ret_code}"
return ${ret_code}
fi
wd_logger 1 "Installed ${package_name}"
return 0
}
function install_dpkg_list() {
local dpkg_list=( $@ )
local package_needed
for package_needed in ${dpkg_list[@]}; do
wd_logger 2 "Checking for package ${package_needed}"
if ! install_debian_package ${package_needed} ; then
wd_logger 1 "ERROR: 'install_debian_package ${package_needed}' => $?"
exit 1
fi
done
return 0
}
function install_python_package()
{
local pip_package=$1
wd_logger 2 "Verifying or Installing package ${pip_package}"
if python3 -c "import ${pip_package}" 2> /dev/null; then
wd_logger 2 "Found that package ${pip_package} is installed"
return 0
fi
wd_logger 1 "Package ${pip_package} is not installed. Checking that pip3 is installed"
if ! pip3 -V > /dev/null 2>&1 ; then
wd_logger 1 "Installing pip3"
if ! sudo apt install python3-pip -y ; then
wd_logger 1 "ERROR: can't install pip3: 'sudo apt install python3-pip -y' => $?"
exit 1
fi
fi
wd_logger 1 "Having pip3 install package ${pip_package} "
if [[ ${pip_package} == "psycopg2" ]]; then
wd_logger 1 "'pip3 install ${pip_package}' requires 'apt install python3-dev libpq-dev'"
sudo apt install python3-dev libpq-dev
local rc=$?
if [[ ${rc} -ne 0 ]]; then
wd_logger 1 "ERROR: 'sudo apt install python3-dev libpq-dev' => ${rc}"
exit ${rc}
fi
fi
local pip3_extra_args=""
if [[ ${OS_RELEASE} == "12" || ${OS_RELEASE} == "24.04" ]]; then
pip3_extra_args="--break-system-packages"
fi
if ! sudo pip3 install ${pip3_extra_args} ${pip_package} ; then
wd_logger 1 "ERROR: 'sudo pip3 ${pip_package}' => $?"
exit 2
fi
wd_logger 1 "Installed Python package ${pip_package}"
return 0
}