-
Notifications
You must be signed in to change notification settings - Fork 21
/
wfpiconsole.sh
executable file
·1108 lines (995 loc) · 43.8 KB
/
wfpiconsole.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
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env bash
# Automated installer and updater for the WeatherFlow PiConsole. Modified
# heavily from the PiHole and PiVPN installers.
# Copyright (C) 2018-2023 Peter Davis
# This program is free software: you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free Software
# Foundation, either version 3 of the License, or (at your option) any later
# version.
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
# details.
# You should have received a copy of the GNU General Public License along with
# this program. If not, see <http://www.gnu.org/licenses/>.
# DEFINE INSTALLER PREAMBLE
# ------------------------------------------------------------------------------
# -e option instructs bash to immediately exit if any command [1] has a non-zero
# exit status.
set -e
# Define installer colors
if [[ -f "${coltable}" ]]; then
source ${coltable}
else
COL_NC='\e[0m'
COL_LIGHT_GREEN='\e[1;32m'
COL_LIGHT_RED='\e[1;31m'
COL_LIGHT_YELLOW='\e[1;33m'
TICK="[${COL_LIGHT_GREEN}✓${COL_NC}]"
CROSS="[${COL_LIGHT_RED}✗${COL_NC}]"
EXCLAMATION="[${COL_LIGHT_YELLOW}!${COL_NC}]"
INFO="[i]"
DONE="${COL_LIGHT_GREEN} done!${COL_NC}"
OVER="\\r\\033[K"
fi
# Find the number of rows and columns in terminal. Will default to 80x24 if it
# can not be detected.
if (tput lines &> /dev/null); then
rows=$(tput lines)
else
rows=$(printf '%d' 80)
fi
if (tput cols &> /dev/null); then
columns=$(tput cols)
else
columns=$(printf '%d' 24)
fi
# Divide the number of rows and columns by two so
# the dialogs take up half of the screen.
r=$(( rows / 2 ))
c=$(( columns / 2 ))
# Unless the screen is tiny
r=$(( r < 20 ? 20 : r ))
c=$(( c < 70 ? 70 : c ))
# DEFINE INSTALLER VARIABLES
# ------------------------------------------------------------------------------
# Download and install directories
CONSOLEDIR=/home/${USER}/wfpiconsole
VENVDIR=${CONSOLEDIR}/venv/
DLDIR=${CONSOLEDIR}/temp/
# Package manager commands
PKG_MANAGER="apt-get"
PKG_UPDATE_CACHE="${PKG_MANAGER} update"
PKG_UPDATE_INSTALL="${PKG_MANAGER} dist-upgrade -y"
PKG_UPDATE_COUNT="${PKG_MANAGER} -s -o Debug::NoLocking=true upgrade | grep -c ^Inst || true"
PKG_NEW_INSTALL=(${PKG_MANAGER} --yes install)
# Python commands
PYTHON_SYS=python3
PYTHON_VENV=${VENVDIR}bin/python3
PIP_INSTALL="-m pip install --no-cache-dir"
PIP_UPDATE="-m pip install --upgrade --no-cache-dir"
# wfpiconsole and Kivy dependencies
WFPICONSOLE_DEPENDENCIES=(git curl rng-tools build-essential python3-dev python3-pip python3-setuptools
libssl-dev libffi-dev libatlas-base-dev libopenblas-dev jq)
# Python modules and versions
PYTHON_MODULES=(websockets==11.0.3
numpy==1.26.0
pytz==2023.3
tzlocal==5.1
ephem==4.1.5
packaging==23.2
cryptography==41.0.4
pyOpenSSL==23.2.0
certifi==2023.7.22)
# Kivy source and version
KIVY_VERSION="2.2.0"
KIVY_SOURCE="kivy[base]=="$KIVY_VERSION
# Github repositories
WFPICONSOLE_REPO="https://github.com/peted-davis/WeatherFlow_PiConsole.git"
WFPICONSOLE_TAGS="https://api.github.com/repos/peted-davis/WeatherFlow_PiConsole/tags"
WFPICONSOLE_RAW="https://raw.githubusercontent.com/peted-davis/WeatherFlow_PiConsole"
WFPICONSOLE_MAIN_UPDATE=$WFPICONSOLE_RAW"/main/wfpiconsole.sh"
WFPICONSOLE_BETA_UPDATE=$WFPICONSOLE_RAW"/develop/wfpiconsole.sh"
# CHECK IF INPUT IS VALID COMMAND
# ------------------------------------------------------------------------------
is_command() {
command -v "$1" >/dev/null 2>&1
}
# CLEAN UP AFTER COMPLETED OR FAILED INSTALLATION
# ------------------------------------------------------------------------------
clean_up() {
rm -f python_command error_log module_list
}
# UPDATE LOCAL PACKAGES USING apt-get update
# ------------------------------------------------------------------------------
update_packages() {
# Update local package cache. Return error if cache cannot be updated
local str="Checking for updated packages"
printf " %b %s..." "${INFO}" "${str}"
if (sudo ${PKG_UPDATE_CACHE} &> error_log); then
# Alert user if there are updates to install
updates_to_install=$(eval ${PKG_UPDATE_COUNT})
if [[ "$updates_to_install" -gt "0" ]]; then
printf "%b %b %s\\n" "${OVER}" "${TICK}" "${str}"
if [[ "$updates_to_install" -eq "1" ]]; then
local str="$updates_to_install updated package available. Use 'sudo apt upgrade' to install"
else
local str="$updates_to_install updated packages available. Use 'sudo apt upgrade' to install"
fi
printf " %b %s\\n" "${INFO}" "${str}"
else
printf "%b %b %s\\n" "${OVER}" "${TICK}" "${str}"
local str="No updated packages found"
printf " %b %s\\n" "${INFO}" "${str}"
fi
else
printf "%b %b %s\\n" "${OVER}" "${CROSS}" "${str}"
printf " %bError: Unable to update local package cache. Please check your internet connection\\n\\n %b" "${COL_LIGHT_RED}" "${COL_NC}"
printf "%s\\n\\n" "$(<error_log)"
clean_up
exit 1
fi
}
# INSTALL PACKAGES REQUIRED BY THE WeatherFlow PiConsole
# ------------------------------------------------------------------------------
install_packages() {
# Parse function input and print progress to screen
printf "\\n %b WeatherFlow PiConsole dependency checks...\\n" "${INFO}"
declare -a arg_array=("${WFPICONSOLE_DEPENDENCIES[@]}")
declare -a install_array
# Check if any of the dependent packages are already installed.
for i in "${arg_array[@]}"; do
printf " %b Checking for %s..." "${INFO}" "${i}"
if dpkg-query -W -f='${Status}' "${i}" 2>/dev/null | grep "ok installed" &> /dev/null; then
printf "%b %b Checking for %s\\n" "${OVER}" "${TICK}" "${i}"
else
echo -e "${OVER} ${INFO} Checking for $i (will be installed)"
install_array+=("${i}")
fi
done
# Only install dependent packages that are missing from the system to avoid
# unecessary downloading
if [[ "${#install_array[@]}" -gt 0 ]]; then
if ! (sudo debconf-apt-progress --logfile error_log -- "${PKG_NEW_INSTALL[@]}" "${install_array[@]}"); then
printf " %b\\nError: Unable to install dependent packages\\n\\n %b" "${COL_LIGHT_RED}" "${COL_NC}"
printf "%s\\n\\n" "$(<error_log)"
clean_up
exit 1
fi
fi
}
# INSTALL PYTHON VIRTUAL ENVIRONMENT
# ------------------------------------------------------------------------------
install_python_venv() {
local str="Installing Python virtual environment"
printf "\\n %b %s..." "${INFO}" "${str}"
if [ ! -f "$VENVDIR/bin/activate" ]; then
if (${PYTHON_SYS} -m venv $VENVDIR &> error_log); then
printf "%b %b %s\\n" "${OVER}" "${TICK}" "${str}"
else
printf "%b %b %s\\n" "${OVER}" "${CROSS}" "${str}"
printf " %bError: Unable to install Python virtual environment\\n\\n %b" "${COL_LIGHT_RED}" "${COL_NC}"
printf "%s\\n\\n" "$(<error_log)"
clean_up
exit 1
fi
else
printf " already exists\\n"
fi
}
# UPDATE PYTHON PACKAGE MANAGER: PIP
# ------------------------------------------------------------------------------
update_pip() {
local str="Updating Python package manager"
printf "\\n %b %s..." "${INFO}" "${str}"
if (${PYTHON_VENV} ${PIP_UPDATE} pip setuptools &> error_log); then
printf "%b %b %s\\n" "${OVER}" "${TICK}" "${str}"
else
printf "%b %b %s\\n" "${OVER}" "${CROSS}" "${str}"
printf " %bError: Unable to update Python package manager: pip\\n\\n %b" "${COL_LIGHT_RED}" "${COL_NC}"
printf "%s\\n\\n" "$(<error_log)"
clean_up
exit 1
fi
}
# INSTALL PYTHON MODULES FOR THE WeatherFlow PiConsole
# ------------------------------------------------------------------------------
install_python_modules() {
# Parse function input and print progress to screen.
printf "\\n %b Installing WeatherFlow PiConsole Python modules..." "${INFO}"
declare -a arg_array=("${PYTHON_MODULES[@]}")
declare -a install_array
# Update Python package manager: pip
update_pip
# Install required Python modules
for i in "${arg_array[@]}"; do
module=$(echo $i | cut -d"[" -f 1 | cut -d"=" -f 1)
local str="Installing Python module"
printf " %b %s %s..." "${INFO}" "${str}" "${module}"
if (${PYTHON_VENV} ${PIP_INSTALL} "$i" &> error_log); then
printf "%b %b %s %s\\n" "${OVER}" "${TICK}" "${str}" "${module}"
else
printf "%b %b %s\\n" "${OVER}" "${CROSS}" "${str}"
printf " %bError: Unable to install Python module: $module\\n\\n %b" "${COL_LIGHT_RED}" "${COL_NC}"
printf "%s\\n\\n" "$(<error_log)"
clean_up
exit 1
fi
done
}
# UPDATE PYTHON MODULES FOR THE WeatherFlow PiConsole
# ------------------------------------------------------------------------------
update_python_modules() {
# Parse function input and print progress to screen.
printf "\\n %b Updating WeatherFlow PiConsole Python modules..." "${INFO}"
declare -a arg_array=("${PYTHON_MODULES[@]}")
# Update Python package manager: pip
update_pip
# Get list of installed packages and versions
${PYTHON_VENV} -m pip freeze > module_list
# Update required Python modules
for i in "${arg_array[@]}"; do
module=$(echo $i | cut -d"[" -f 1 | cut -d"=" -f 1)
required_version=$(echo $i | cut -d"=" -f 3)
if grep -iF $module module_list &> /dev/null; then
current_version=$(grep -iF $module module_list | cut -d"=" -f 3)
if [[ "$current_version" != "$required_version" ]]; then
local str="Updating Python module"
printf " %b %s %s..." "${INFO}" "${str}" "${module}"
if (${PYTHON_VENV} ${PIP_INSTALL} "$i" &> error_log); then
printf "%b %b %s %s\\n" "${OVER}" "${TICK}" "${str}" "${module}"
else
printf "%b %b %s\\n" "${OVER}" "${CROSS}" "${str}"
printf " %bError: Unable to update Python module: $module\\n\\n %b" "${COL_LIGHT_RED}" "${COL_NC}"
printf "%s\\n\\n" "$(<error_log)"
clean_up
exit 1
fi
fi
else
local str="Installing new Python module"
printf " %b %s %s..." "${INFO}" "${str}" "${module}"
if (${PYTHON_VENV} ${PIP_INSTALL} "$i" &> error_log); then
printf "%b %b %s %s\\n" "${OVER}" "${TICK}" "${str}" "${module}"
else
printf "%b %b %s\\n" "${OVER}" "${CROSS}" "${str}"
printf " %bError: Unable to install Python module: $module\\n\\n %b" "${COL_LIGHT_RED}" "${COL_NC}"
printf "%s\\n\\n" "$(<error_log)"
clean_up
exit 1
fi
fi
done
}
# INSTALL KIVY PYTHON LIBRARY
# ------------------------------------------------------------------------------
install_kivy() {
# Check if required Kivy version is installed
local str="Kivy Python library installation check"
printf "\\n %b %s..." "${INFO}" "${str}"
if ${PYTHON_VENV} -c "import kivy" &> /dev/null; then
kivy_version=$(${PYTHON_VENV} -m pip show kivy | grep Version | cut -d" " -f2)
if [[ "$KIVY_VERSION" == "$kivy_version" ]]; then
printf "%b %b %s \\n" "${OVER}" "${TICK}" "${str}"
else
printf "%b %b %s (will be updated)" "${OVER}" "${INFO}" "${str}"
local update_kivy=true
fi
else
printf "%b %b %s (will be installed)" "${OVER}" "${INFO}" "${str}"
local install_kivy=true
fi
# Install Kivy Python library
if [[ "$update_kivy" = true ]] || [[ "$install_kivy" = true ]]; then
if [[ "$update_kivy" = true ]]; then
local str="Updating Kivy Python library"
else
local str="Installing Kivy Python library"
fi
printf "\\n %b %s..." "${INFO}" "${str}"
if (${PYTHON_VENV} ${PIP_INSTALL} ${KIVY_SOURCE} &> error_log); then
printf "%b %b %s\\n" "${OVER}" "${TICK}" "${str}"
else
printf "%b %b %s\\n" "${OVER}" "${CROSS}" "${str}"
printf " %bError: Unable to install Kivy Python library\\n\\n %b" "${COL_LIGHT_RED}" "${COL_NC}"
printf "%s\\n\\n" "$(<error_log)"
clean_up
exit 1
fi
# Update Kivy configuration
update_kivy_config
fi
}
# UPDATE KIVY CONFIGURATION
# ------------------------------------------------------------------------------
update_kivy_config() {
# Create Kivy config file for user that called function
local str="Updating Kivy configuration for touch screen"
printf " %b %s..." "${INFO}" "${str}"
if ${PYTHON_VENV} -c "import kivy" &> error_log; then
:
else
printf "%b %b %s\\n" "${OVER}" "${CROSS}" "${str}"
printf " %bError: Unable to update Kivy configuration for touch screen\\n\\n %b" "${COL_LIGHT_RED}" "${COL_NC}"
printf "%s\\n\\n" "$(<error_log)"
clean_up
exit 1
fi
# Ensure current user is in input and video groups
sudo usermod -a -G input,video $USER
# Echo Python commands to file required to modify the Kivy config for the
# Raspberry Pi touchscreen
config_file=$(eval echo "~$USER/.kivy/config.ini")
echo "import configparser" >> python_command
echo "Config = configparser.ConfigParser()" >> python_command
echo "Config.read('$config_file')" >> python_command
echo "Config.remove_section('input')" >> python_command
echo "Config.add_section('input')" >> python_command
echo "Config.set('input','mouse','mouse')" >> python_command
echo "Config.set('input','mtdev_%(name)s','probesysfs,provider=mtdev')" >> python_command
echo "Config.set('input','hid_%(name)s','probesysfs,provider=hidinput')" >> python_command
echo "with open('$config_file','w') as configfile:" >> python_command
echo " Config.write(configfile)" >> python_command
echo "configfile.close()" >> python_command
# Run Python command to modify Kivy config for the Raspberry Pi touchscreen
if (${PYTHON_VENV} python_command &> error_log); then
printf "%b %b %s\\n" "${OVER}" "${TICK}" "${str}"
else
printf "%b %b %s\\n" "${OVER}" "${CROSS}" "${str}"
printf " %bError: Unable to update Kivy configuration for touch screen\\n\\n %b" "${COL_LIGHT_RED}" "${COL_NC}"
printf "%s\\n\\n" "$(<error_log)"
clean_up
exit 1
fi
}
# GET THE LATEST VERSION OF THE WeatherFlow PiConsole FROM GITHUB
# ------------------------------------------------------------------------------
get_latest_version() {
# Get info on latest version from Github API
local tag_info=$(curl -s $WFPICONSOLE_TAGS -H 'Accept: application/vnd.github.v3+json')
local latest_version=$(echo $tag_info | jq -r '.[0].name')
local status=0
# If the WeatherFlow PiConsole is already installed, get the current
# installed version from wfpiconsole.ini file.
if [[ -f $CONSOLEDIR/wfpiconsole.ini ]]; then
current_version=$(${PYTHON_VENV} -c "import configparser; c=configparser.ConfigParser(); c.read('$CONSOLEDIR/wfpiconsole.ini'); print(c['System']['Version'])")
printf "\\n %b Latest version of WeatherFlow PiConsole: %s" ${INFO} ${latest_version}
printf "\\n %b Installed version of WeatherFlow PiConsole: %s" ${INFO} ${current_version}
# Compare current version with latest version. If versions match, there
# is no need to get the latest version, but make sure we are on the main
# branch
if [[ "$current_version" == "$latest_version" ]]; then
printf "\\n %b Versions match: %bNo update required%b\n" "${TICK}" "${COL_LIGHT_GREEN}" "${COL_NC}"
if (is_repo ${CONSOLEDIR}); then
local current_branch=$(git -C ${CONSOLEDIR} rev-parse --abbrev-ref HEAD)
if [[ "${current_branch}" != "main" ]]; then
git -C ${CONSOLEDIR} checkout main &> error_log || return $?
fi
git -C ${CONSOLEDIR} reset --hard "$(git -C ${CONSOLEDIR} describe --abbrev=0 --tags)" &> error_log || return $?
fi
return
# Else, get the latest version of the WeatherFlow PiConsole
else
local str="Updating WeatherFlow PiConsole to ${COL_LIGHT_GREEN}${latest_version}${COL_NC}"
printf "\\n\\n %b %b..." "${INFO}" "${str}"
if (is_repo ${CONSOLEDIR}); then
if (update_repo_latest_tag ${CONSOLEDIR} &> error_log); then status=1; fi
else
if (create_repo ${CONSOLEDIR} ${WFPICONSOLE_REPO} &> error_log); then status=1; fi
fi
if [[ $status -eq 1 ]]; then
printf "%b %b %b\\n" "${OVER}" "${TICK}" "${str}"
else
printf "%b %b %b\\n" "${OVER}" "${CROSS}" "${str}"
printf " %bError: Unable to update WeatherFlow PiConsole\\n\\n %b" "${COL_LIGHT_RED}" "${COL_NC}"
printf "%s\\n\\n" "$(<error_log)"
clean_up
exit 1
fi
fi
# Else, the WeatherFlow PiConsole is not installed so get the latest stable
# version
else
local str="Installing latest version of WeatherFlow PiConsole: ${COL_LIGHT_GREEN}${latest_version}${COL_NC}"
printf "\\n %b %b..." "${INFO}" "${str}"
if (is_repo ${CONSOLEDIR} &> error_log); then
if (update_repo_latest_tag ${CONSOLEDIR} &> error_log); then status=1; fi
else
if (create_repo ${CONSOLEDIR} ${WFPICONSOLE_REPO} &> error_log); then status=1; fi
fi
if [[ $status -eq 1 ]]; then
printf "%b %b %b\\n" "${OVER}" "${TICK}" "${str}"
else
printf "%b %b %b\\n" "${OVER}" "${CROSS}" "${str}"
printf " %bError: Unable to install WeatherFlow PiConsole\\n\\n %b" "${COL_LIGHT_RED}" "${COL_NC}"
printf "%s\\n\\n" "$(<error_log)"
clean_up
exit 1
fi
fi
# Ensure console directory is owned by the correct user
console_owner=$(stat -c "%U" $CONSOLEDIR)
if [[ "$console_owner" != "$USER" ]]; then
sudo chown -fR $USER $CONSOLEDIR
sudo chgrp -fR $USER $CONSOLEDIR
fi
# Make sure wfpiconsole.sh file is executable and create symlink to
# usr/bin/local so function can be called directly from the command line
chmod 744 $CONSOLEDIR/wfpiconsole.sh
sudo ln -sf $CONSOLEDIR/wfpiconsole.sh /usr/local/bin/wfpiconsole
}
# SWITCH TO THE WeatherFlow PiConsole STABLE BRANCH
# ------------------------------------------------------------------------------
switch_stable_branch() {
# Switch to the WeatherFlow PiConsole stable branch
local status=0
local str="Switching to stable branch"
printf " %b %b..." "${INFO}" "${str}"
if (is_repo ${CONSOLEDIR}); then
if (switch_repo_stable ${CONSOLEDIR}); then status=1; fi
fi
if [[ $status -eq 1 ]]; then
printf "%b %b %b\\n" "${OVER}" "${TICK}" "${str}"
else
printf "%b %b %b\\n" "${OVER}" "${CROSS}" "${str}"
printf " %bError: Unable to switch to WeatherFlow PiConsole stable branch\\n\\n %b" "${COL_LIGHT_RED}" "${COL_NC}"
printf "%s\\n\\n" "$(<error_log)"
clean_up
exit 1
fi
# Ensure console directory is owned by the correct user
console_owner=$(stat -c "%U" $CONSOLEDIR)
if [[ "$console_owner" != "$USER" ]]; then
sudo chown -fR $USER $CONSOLEDIR
sudo chgrp -fR $USER $CONSOLEDIR
fi
}
# SWITCH TO THE WeatherFlow PiConsole BETA BRANCH
# ------------------------------------------------------------------------------
switch_beta_branch() {
# Switch to the WeatherFlow PiConsole beta branch
local status=0
local str="Switching to WeatherFlow PiConsole beta branch"
printf " %b %b..." "${INFO}" "${str}"
if (is_repo ${CONSOLEDIR}); then
if (switch_repo_beta ${CONSOLEDIR}); then status=1; fi
fi
if [[ $status -eq 1 ]]; then
printf "%b %b %b\\n" "${OVER}" "${TICK}" "${str}"
else
printf "%b %b %b\\n" "${OVER}" "${CROSS}" "${str}"
printf " %bError: Unable to switch to WeatherFlow PiConsole beta branch\\n\\n %b" "${COL_LIGHT_RED}" "${COL_NC}"
printf "%s\\n\\n" "$(<error_log)"
clean_up
exit 1
fi
# Ensure console directory is owned by the correct user
console_owner=$(stat -c "%U" $CONSOLEDIR)
if [[ "$console_owner" != "$USER" ]]; then
sudo chown -fR $USER $CONSOLEDIR
sudo chgrp -fR $USER $CONSOLEDIR
fi
}
# INSTALL THE wfpiconsole.service FILE TO /etc/systemd/system/
# ------------------------------------------------------------------------------
install_service_file () {
# Write current user and install directory to wfpiconsole.service file
sed -i "s+ExecStart=.*$+ExecStart=$PYTHON_VENV -u main.py+" $CONSOLEDIR/wfpiconsole.service
sed -i "s+WorkingDirectory=.*$+WorkingDirectory=$CONSOLEDIR+" $CONSOLEDIR/wfpiconsole.service
sed -i "s+User=.*$+User=$USER+" $CONSOLEDIR/wfpiconsole.service
sed -i "s+StandardOutput=.*$+StandardOutput=file:${CONSOLEDIR}/wfpiconsole.log+" $CONSOLEDIR/wfpiconsole.service
sed -i "s+StandardError=.*$+StandardError=file:${CONSOLEDIR}/wfpiconsole.log+" $CONSOLEDIR/wfpiconsole.service
# Install wfpiconsole.service file to /etc/systemd/system/ and reload deamon
local str="Copying service file to autostart directory"
printf "\\n %b %s..." "${INFO}" "${str}"
sudo cp $CONSOLEDIR/wfpiconsole.service /etc/systemd/system/
if (sudo systemctl daemon-reload &> error_log); then
printf "%b %b %s\\n" "${OVER}" "${TICK}" "${str}"
else
printf "%b %b %s\\n" "${OVER}" "${CROSS}" "${str}"
printf " %bError: Unable to install wfpiconsole.service file\\n\\n %b" "${COL_LIGHT_RED}" "${COL_NC}"
printf "%s\\n\\n" "$(<error_log)"
clean_up
exit 1
fi
}
# ENABLE THE wfpiconsole.service
# ------------------------------------------------------------------------------
enable_service () {
# Enable wfpiconsole.service file
local str="Enabling WeatherFlow PiConsole service file"
printf " %b %s..." "${INFO}" "${str}"
rm -f wfpiconsole.log
if (sudo systemctl enable wfpiconsole &> error_log); then
if (sudo systemctl start wfpiconsole &> error_log); then
printf "%b %b %s\\n\\n" "${OVER}" "${TICK}" "${str}"
else
printf "%b %b %s\\n" "${OVER}" "${CROSS}" "${str}"
printf " %bError: Unable to enable WeatherFlow PiConsole service file\\n\\n %b" "${COL_LIGHT_RED}" "${COL_NC}"
printf "%s\\n\\n" "$(<error_log)"
clean_up
exit 1
fi
else
printf "%b %b %s\\n" "${OVER}" "${CROSS}" "${str}"
printf " %bError: Unable to enable WeatherFlow PiConsole service file\\n\\n %b" "${COL_LIGHT_RED}" "${COL_NC}"
printf "%s\\n\\n" "$(<error_log)"
clean_up
exit 1
fi
}
# DISABLE THE wfpiconsole.service
# ------------------------------------------------------------------------------
disable_service () {
# Disable the wfpiconsole service
local str="Disabling WeatherFlow PiConsole service file"
printf " %b %s..." "${INFO}" "${str}"
if (sudo systemctl disable wfpiconsole.service &> error_log); then
printf "%b %b %s\\n\\n" "${OVER}" "${TICK}" "${str}"
else
printf "%b %b %s\\n" "${OVER}" "${CROSS}" "${str}"
printf " %bError: Unable to disable WeatherFlow PiConsole service file\\n\\n %b" "${COL_LIGHT_RED}" "${COL_NC}"
printf "%s\\n\\n" "$(<error_log)"
clean_up
exit 1
fi
}
# CHECK IF DIRECTORY IS A GIT REPOSITORY
# ------------------------------------------------------------------------------
is_repo() {
local directory=${1}
if [[ -d ${directory} ]]; then
git -C ${directory} status --short &> error_log || local rc=$?
else
local rc=1
fi
return "${rc:-0}"
}
# CREATE NEW GIT REPOSITORY AT LATEST MAIN BRANCH RELEASE
# ------------------------------------------------------------------------------
create_repo() {
# If the directory already exists, turn it into a git directory, otherwise
# clone the git repository directly
local directory=${1}
local repository=${2}
if [[ -d ${directory} ]]; then
git clone --no-checkout ${repository} ${directory}/temp &> error_log || return $?
mv ${directory}/temp/.git ${directory}/.git
rmdir ${directory}/temp
git -C ${directory} reset --hard HEAD &> error_log || return $?
else
git clone ${repository} ${directory} &> error_log || return $?
fi
# Checkout the main branch if required and reset code to latest tag
local current_branch=$(git rev-parse --abbrev-ref HEAD)
if [[ "${current_branch}" != "main" ]]; then
git -C ${directory} checkout main &> error_log || return $?
fi
git -C ${directory} reset --hard "$(git -C ${directory} describe --abbrev=0 --tags)" &> error_log || return $?
}
# UPDATE GIT REPOSITORY TO LATEST MAIN BRANCH RELEASE
# ------------------------------------------------------------------------------
update_repo_latest_tag() {
# Clear all changes from files that are tracked in the local git repository
# and remove Python bytecode
local directory=${1}
find ${directory} -type d -name __pycache__ -exec rm -r {} +
git -C ${directory} checkout . &> error_log || return $?
# Checkout the main branch if required and pull latest commits. Reset code
# to most recent release
local current_branch=$(git -C ${directory} rev-parse --abbrev-ref HEAD)
if [[ "${current_branch}" != "main" ]]; then
git -C ${directory} checkout main &> error_log || return $?
fi
git -C ${directory} pull &> error_log || return $?
# Remove all untracked files and folders
git -C ${directory} clean --force -d &> error_log || true
}
# SWITCH GIT REPOSITORY TO LATEST MAIN BRANCH COMMIT
# ------------------------------------------------------------------------------
switch_repo_stable() {
# Clear all changes from files that are tracked in the local git repository
# and remove Python bytecode
local directory=${1}
find ${directory} -type d -name __pycache__ -exec rm -r {} +
git -C ${directory} checkout . &> error_log || return $?
# Checkout the main branch if required and pull latest commits
local current_branch=$(git -C ${directory} rev-parse --abbrev-ref HEAD)
if [[ "${current_branch}" != "main" ]]; then
git -C ${directory} checkout main &> error_log || return $?
fi
git -C ${directory} pull &> error_log || return $?
# Remove all untracked files and folders
git -C ${directory} clean --force -d &> error_log || true
}
# SWITCH GIT REPOSITORY TO LATEST DEVELOP BRANCH COMMIT
# ------------------------------------------------------------------------------
switch_repo_beta() {
# Clear all changes from files that are tracked in the local git repository
# and remove Python bytecode
local directory=${1}
find ${directory} -type d -name __pycache__ -exec rm -r {} +
git -C ${directory} checkout . &> error_log || return $?
# Checkout the develop branch if required and pull latest commits
local current_branch=$(git -C ${directory} rev-parse --abbrev-ref HEAD)
if [[ "${current_branch}" != "develop" ]]; then
git -C ${directory} checkout develop &> error_log || return $?
fi
git -C ${directory} pull &> error_log || return $?
# Remove all untracked files and folders
git -C ${directory} clean --force -d &> error_log || true
}
# DISPLAY REQUIRED PROCESS STARTING DIALOGUE
# ------------------------------------------------------------------------------
process_starting() {
# Display installation starting dialogue
case $1 in
install)
whiptail --msgbox --backtitle "Welcome" --title "WeatherFlow PiConsole automated installer" \
"\\n\\nThanks for checking out the WeatherFlow PiConsole. This script will guide you through the installation process on your Raspberry Pi." ${r} ${c}
printf "\\n"
printf " ================================ \\n"
printf " Installing WeatherFlow PiConsole \\n"
printf " ================================ \\n\\n"
;;
# Display update starting dialogue
run_update)
printf "\\n"
printf " ============================== \\n"
printf " Updating WeatherFlow PiConsole \\n"
printf " ============================== \\n\\n"
;;
# Display stable starting dialogue
stable)
printf "\\n"
printf " ============================== \\n"
printf " Switching to the stable branch \\n"
printf " ============================== \\n\\n"
;;
# Display update starting dialogue
run_beta)
printf "\\n"
printf " ============================ \\n"
printf " Switching to the beta branch \\n"
printf " ============================ \\n\\n"
;;
# Display autostart-enable starting dialogue
autostart-enable)
printf "\\n"
printf " ====================================== \\n"
printf " Enabling console autostart during boot \\n"
printf " ====================================== \\n\\n"
;;
# Display autostart-disable starting dialogue
autostart-disable)
printf "\\n"
printf " ======================================= \\n"
printf " Disabling console autostart during boot \\n"
printf " ======================================= \\n\\n"
esac
}
# DISPLAY REQUIRED PROCESS COMPLETE DIALOGUE
# ------------------------------------------------------------------------------
process_complete() {
# Display installation complete dialogue
case $1 in
install)
printf " \\n"
printf " ============================================ \\n"
printf " WeatherFlow PiConsole installation complete! \\n"
printf " Start the console with: 'wfpiconsole start' \\n"
printf " ============================================ \\n\\n"
;;
# Display update complete dialogue
run_update)
printf " \\n"
printf " ============================================= \\n"
printf " WeatherFlow PiConsole update complete! \\n"
printf " Restart the console with: 'wfpiconsole start' \\n"
printf " or 'wfpiconsole autostart-enable' \\n"
printf " ============================================= \\n\\n"
;;
# Display patch complete dialogue
stable)
printf " \\n"
printf " ============================================= \\n"
printf " Switch to stable branch complete! \\n"
printf " Restart the console with: 'wfpiconsole start' \\n"
printf " or 'wfpiconsole autostart-enable' \\n"
printf " ============================================= \\n\\n"
;;
# Display beta complete dialogue
run_beta)
printf " \\n"
printf " ============================================= \\n"
printf " Switch to beta branch complete! \\n"
printf " Restart the console with: 'wfpiconsole start' \\n"
printf " or 'wfpiconsole autostart-enable' \\n"
printf " ============================================= \\n\\n"
;;
# Display autostart-enable complete dialogue
autostart-enable)
printf " ==================================================== \\n"
printf " WeatherFlow PiConsole autostart sucesfully enabled \\n"
printf " Console will now start automatically at boot up \\n"
printf " Starting console for current session. Please wait... \\n"
printf " ==================================================== \\n\\n"
;;
# Display autostart-disable complete dialogue
autostart-disable)
printf " =================================================== \\n"
printf " WeatherFlow PiConsole autostart sucesfully disabled \\n"
printf " Use 'wfpiconsole stop' to halt current session \\n"
printf " =================================================== \\n\\n"
esac
}
# START THE WeatherFlow PiConsole
# ------------------------------------------------------------------------------
start () {
cd $CONSOLEDIR && rm -f wfpiconsole.log
${PYTHON_VENV} main.py |& tee wfpiconsole.log
}
# STOP THE WeatherFlow PiConsole
# ------------------------------------------------------------------------------
stop () {
if (sudo systemctl | grep wfpiconsole.service &> error_log); then
sudo systemctl stop wfpiconsole.service
else
pkill -HUP -f main.py
fi
clean_up
}
# INSTALL THE WeatherFlow PiConsole
# ------------------------------------------------------------------------------
install() {
# Display installation starting dialogue
process_starting ${FUNCNAME[0]}
# Check for and ask user if they wish to install any updated local packages
update_packages
# Install required packages
install_packages
# Install Python virtual environment
install_python_venv
# Install required Python modules
install_python_modules
# Install Kivy Python library
install_kivy
# Get the latest version of the WeatherFlow PiConsole and install
get_latest_version
# Edit and install wfpiconsole.service file
install_service_file
# Clean up after update
clean_up
# Display installation complete dialogue
process_complete ${FUNCNAME[0]}
}
# UPDATE THE WeatherFlow PiConsole TO THE LATEST STABLE VERSION
# ------------------------------------------------------------------------------
update() {
# Fetch the latest update code directly from the main Github branch. This
# ensures that changes in dependencies are addressed during this update
curl -sSL $WFPICONSOLE_MAIN_UPDATE | bash -s run_update
}
run_update() {
# Display installation starting dialogue
process_starting ${FUNCNAME[0]}
# Check for and ask user if they wish to install any updated local packages
update_packages
# Check if any new dependencies are required
install_packages
# Install Python virtual environment
install_python_venv
# Update Python modules as required
update_python_modules
# Install Kivy Python library
install_kivy
# Get the latest version of the WeatherFlow PiConsole and install
get_latest_version
# Edit and install wfpiconsole.service file
install_service_file
# Clean up after installation
clean_up
# Display update complete dialogue
process_complete ${FUNCNAME[0]}
}
# SWITCH THE WeatherFlow PiConsole TO THE STABLE BRANCH
# ------------------------------------------------------------------------------
stable() {
# Display installation starting dialogue
process_starting ${FUNCNAME[0]}
# Get the latest patch for the WeatherFlow PiConsole and install
switch_stable_branch
# Clean up after installation
clean_up
# Display update complete dialogue
process_complete ${FUNCNAME[0]}
}
# SWITCH THE WeatherFlow PiConsole TO THE BETA BRANCH
# ------------------------------------------------------------------------------
beta() {
# Fetch the latest beta update code directly from the develop Github branch.
# This ensures that changes in dependencies are addressed during this update
curl -sSL $WFPICONSOLE_BETA_UPDATE | bash -s run_beta
}
run_beta() {
# Display installation starting dialogue
process_starting ${FUNCNAME[0]}
# Check for and ask user if they wish to install any updated local packages
update_packages
# Check if any new dependencies are required
install_packages
# Install Python virtual environment
install_python_venv
# Update Python modules as required
update_python_modules
# Install Kivy Python library
install_kivy
# Switch to the WeatherFlow PiConsole beta branch
switch_beta_branch
# Clean up after installation
clean_up
# Display update complete dialogue
process_complete ${FUNCNAME[0]}
}
# SET THE WeatherFlow PiConsole TO START AUTOMATICALLY
# ------------------------------------------------------------------------------
autostart-enable () {
# Display autostart-enable starting dialogue
process_starting ${FUNCNAME[0]}
# Enable wfpiconsole service
enable_service
# Clean up after enabling autostart
clean_up
# Display autostart-enable complete dialogue
process_complete ${FUNCNAME[0]}
}
# DISABLE THE WeatherFlow PiConsole FROM STARTING AUTOMATICALLY
# ------------------------------------------------------------------------------
autostart-disable () {
# Display autostart-disable starting dialogue
process_starting ${FUNCNAME[0]}
# Disable wfpiconsole service
disable_service
# Clean up after disabling autostart
clean_up
# Display autostart-disable complete dialogue
process_complete ${FUNCNAME[0]}
}
# SCRIPT USAGE
# ------------------------------------------------------------------------------
help_func() {
echo "Usage: wfpiconsole [options]
Example: 'wfpiconsole update'
Options:
start : Start the WeatherFlow PiConsole
stop : Stop the WeatherFlow PiConsole
install : Install the WeatherFlow PiConsole
update : Update the WeatherFlow PiConsole
stable : Switch the WeatherFlow PiConsole to the stable branch
beta : Switch the WeatherFlow PiConsole to the beta branch
autostart-enable : Set the WeatherFlow PiConsole to autostart at boot
autostart-disable : Stop the WeatherFlow PiConsole autostarting at boot"
exit 0
}
# SCRIPT CALLED WITH NO ARGUMENTS. PRINT HELP FUNCTION
# ------------------------------------------------------------------------------
if [ $# -eq 0 ]; then
printf "Unrecognised usage\\n"
help_func
fi
# ENSURE ROOT ACCESS IS AVAILABLE
# ------------------------------------------------------------------------------
# Ensure script has not been called from an elevated prompt or with sudo
if [[ "${EUID}" -eq 0 ]]; then
printf "\\n"
printf " %bError: Unable to $1 the WeatherFlow PiConsole.\\n\\n%b" "${COL_LIGHT_RED}" "${COL_NC}"
printf " This script is not designed for elevated privileges\\n"
printf " Please run this script again with as a regular user\\n\\n"
clean_up
exit 1
fi
# Ensure sudo command is available and script can be elevated to root privileges
if [[ ! -x "$(command -v sudo)" ]]; then