Modules and overlay editor

.github/ISSUE_TEMPLATE/bug_report.md

@@ -13,23 +13,21 @@ If so, please add a Discussion item by clicking on the Discussions link above;
 
 
 
-
 <!-- =========================================================== -->
-## Look in the Wiki before submitting an Issue
+&nbsp; 
+## Look in the Wiki before submitting this Issue
 The Wiki has lots of information including troubleshooting tips for the vast majority of known issues.
 
 
-
-<!-- =================================================================================================== -->
-<!-- ============= Delete this line and everything above it before submitting this Issue =============== -->
-
+<!-- ========================================================================  --> &nbsp; 
+<!-- ============= ***** Delete this line and everything above it before submitting this Issue ***** =============== -->
 
 
 
 <!-- ==================== Section 1 ==================== -->
 ### Environment
 
-* Camera:  ZWO (including model)  or  RPi
+* Camera:  ZWO  or  RPi - include the model
 * OS: Buster or Bullseye
 * Allsky version:
      * The newest software includes a file called  ~/allsky/version
@@ -38,25 +36,25 @@ The Wiki has lots of information including troubleshooting tips for the vast maj
 
 
 <!-- ==================== Section 2 ==================== -->
-<!-- Leave the next line but delete the remaining lines in this section after you've entered your information. -->
-
+<!-- ***** Leave the next line but delete the remaining lines in Section 2 after you've entered your information. ***** -->
 ### Bug Description
 
 * Include a clear and concise description of what the bug is.
 * Can it be reproduced?  If so, how?
 * Did anything change?  Any settings?  Most issues occur after a change was made.
 * Please include the exact messages or a screenshot.
 * If this is a configuration-related issue (or you are not sure), attach these files, appending ".txt" to their names first:
-  * Allsky or WebUI problems:
+  * Allsky problems:
     * ~/allsky/config/config.sh
-    * /etc/raspap/settings_ZWO.json  or  /etc/raspap/settings_RPiHQ.json, depending on the camera type you have.
-    * ~/allsky/config/ftp-settings.sh (upload-related problems)
+    * ~/allsky/config/settings.json
+    * ~/allsky/config/ftp-settings.sh (only for upload-related problems)
   * Allsky Website problems:
-    * /var/www/html/allsky/config.js (Allsky Website problems)
+    * ~/allsky/html/allsky/configuration.json (local Website)
+    * ~/allsky/config/remote_configuration.json (remote Website)
 
 
 If you have program output or multi-line messages to include,
-add it like this so it formats correctly:
+add it like this so it formats correctly (note the lines with tildas):
 
 ~~~
 output/message line 1
@@ -65,8 +63,7 @@ output/message line 2
 
 
 <!-- ==================== Section 3 ==================== -->
-<!-- Leave the next line but delete the remaining lines in this section after you've atached any files. -->
-
+<!-- ***** Leave the next line but delete the remaining lines in Section 3 after you've attached any files. ***** -->
 ### Log / configuration files
 
 Follow the instructions for Reporting Issues in the Wiki, then ATTACH a copy of the file(s) above.

.github/workflows/ci_compile.yml

@@ -3,7 +3,10 @@
 name: CI
 
 # Controls when the workflow will run
-on: [ push, pull_request, workflow_dispatch ]
+on: 
+  push:
+    paths:
+      - 'src/**'
 
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
@@ -17,198 +20,6 @@ jobs:
       # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
       - uses: actions/checkout@v2
 
-      # Runs a set of commands using the runners shell
-      - name: some useful outputs
-        run: |
-          ls -la
-          uptime
-
-      # Runs a set of commands using the runners shell
-      - name: check bash files
-        run: |
-          # check bash files (bash -n, shellcheck)
-          err=0
-          for i in $(find . -name '*.sh'); do
-            echo "$i"
-            bash -n $i
-            if [ $? -ne 0 ]; then
-              err=$((err + 1))
-            fi
-            case $i in
-              ./variables.sh)
-                #SC2034: ON_TTY appears unused. Verify use (or export if used externally).
-                shellcheck $i -e SC2034 
-                ;;
-              ./gui/install.sh)
-                #SC2155: Declare and assign separately to avoid masking return values.
-                #SC2046: Quote this to prevent word splitting.
-                #SC2086: Double quote to prevent globbing and word splitting.
-                #SC1090: Can't follow non-constant source. Use a directive to specify location.
-                #SC2164: Use 'cd ... || exit' or 'cd ... || return' in case cd fails.
-                #SC2002: Useless cat. Consider 'cmd < file | ..' or 'cmd file | ..' instead.
-                #SC2166: Prefer [ p ] || [ q ] as [ p -o q ] is not well defined.
-                #SC2181: Check exit code directly with e.g. 'if mycmd;', not indirectly with $?.
-                #SC2006: Use $(...) notation instead of legacy backticked `...`.
-                shellcheck $i -e SC2155 -e SC2046 -e SC2086 -e SC1090 -e SC2164 -e SC2002 -e SC2166 -e SC2181 -e SC2006
-                ;;
-              ./website/install.sh)
-                #SC2155: Declare and assign separately to avoid masking return values.
-                #SC2046: Quote this to prevent word splitting.
-                #SC1090: Can't follow non-constant source. Use a directive to specify location.
-                #SC2164: Use 'cd ... || exit' or 'cd ... || return' in case cd fails.
-                #SC2166: Prefer [ p ] || [ q ] as [ p -o q ] is not well defined.
-                #SC2181: Check exit code directly with e.g. 'if mycmd;', not indirectly with $?.
-                #SC2012: Use find instead of ls to better handle non-alphanumeric filenames.
-                #SC2086: Double quote to prevent globbing and word splitting.
-                shellcheck $i -e SC2155 -e SC2046 -e SC1090 -e SC2164 -e SC2166 -e SC2181 -e SC2012 -e SC2086
-                ;;
-              ./install.sh)
-                #SC2155: Declare and assign separately to avoid masking return values.
-                #SC2046: Quote this to prevent word splitting.
-                #SC1090: Can't follow non-constant source. Use a directive to specify location.
-                #SC2004: $/${} is unnecessary on arithmetic variables.
-                #SC2086: Double quote to prevent globbing and word splitting.
-                #SC2181: Check exit code directly with e.g. 'if mycmd;', not indirectly with $?.
-                shellcheck $i -e SC2155 -e SC2046 -e SC1090 -e SC2004 -e SC2086 -e SC2181
-                ;;
-              ./allsky.sh)
-                #SC2155: Declare and assign separately to avoid masking return values.
-                #SC2046: Quote this to prevent word splitting.
-                #SC2164: Use 'cd ... || exit' or 'cd ... || return' in case cd fails.
-                #SC1090: Can't follow non-constant source. Use a directive to specify location.
-                #SC2230: which is non-standard. Use builtin 'command -v' instead.
-                #SC2181: Check exit code directly with e.g. 'if mycmd;', not indirectly with $?.
-                #SC2086: Double quote to prevent globbing and word splitting.
-                #SC2206: Quote to prevent word splitting/globbing, or split robustly with mapfile or read -a.
-                #SC2207: Prefer mapfile or read -a to split command output (or quote to avoid splitting).
-                #SC2068: Double quote array expansions to avoid re-splitting elements.
-                #SC2006: Use $(...) notation instead of legacy backticked `...`.
-                #SC2166: Prefer [ p ] && [ q ] as [ p -a q ] is not well defined.
-                shellcheck $i -e SC2155 -e SC2046 -e SC2164 -e SC1090 -e SC2230 -e SC2181 -e SC2086 -e SC2206 -e SC2207 -e SC2068 -e SC2006 -e SC2166
-                ;;
-              ./uninstall.sh)
-                #SC2034: GREEN appears unused. Verify use (or export if used externally).
-                #SC2162: read without -r will mangle backslashes.
-                shellcheck $i -e SC2034 -e SC2162
-                ;;
-              ./scripts/generate_notification_images.sh)
-                #SC2155: Declare and assign separately to avoid masking return values.
-                #SC2046: Quote this to prevent word splitting.
-                #SC1090: Can't follow non-constant source. Use a directive to specify location.
-                #SC2086: Double quote to prevent globbing and word splitting.
-                #SC2230: which is non-standard. Use builtin 'command -v' instead.
-                #SC2181: Check exit code directly with e.g. 'if mycmd;', not indirectly with $?.
-                #SC2166: Prefer [ p ] || [ q ] as [ p -o q ] is not well defined.
-                #SC2016: Expressions don't expand in single quotes, use double quotes for that.
-                shellcheck $i -e SC2155 -e SC2046 -e SC1090 -e SC2086 -e SC2230 -e SC2181 -e SC2166 -e SC2016
-                ;;
-              ./scripts/postData.sh)
-                #SC1090: Can't follow non-constant source. Use a directive to specify location.
-                #SC2086: Double quote to prevent globbing and word splitting.
-                #SC2166: Prefer [ p ] || [ q ] as [ p -o q ] is not well defined.
-                #SC2154: sunriset_hhmm is referenced but not assigned (did you mean 'sunrise_hhmm'?).
-                #SC1083: This { is literal. Check expression (missing ;/\n?) or quote it.
-                #SC2219: Instead of 'let expr', prefer (( expr )) .
-                shellcheck $i -e SC1090 -e SC2086 -e SC2166 -e SC2154 -e SC1083 -e SC2219
-                ;;
-              ./scripts/endOfNight.sh)
-                #SC2155: Declare and assign separately to avoid masking return values.
-                #SC2046: Quote this to prevent word splitting.
-                #SC1090: Can't follow non-constant source. Use a directive to specify location.
-                #SC2166: Prefer [ p ] || [ q ] as [ p -o q ] is not well defined.
-                #SC2086: Double quote to prevent globbing and word splitting.
-                #SC2044: For loops over find output are fragile. Use find -exec or a while read loop.
-                #SC2004: $/${} is unnecessary on arithmetic variables.
-                shellcheck $i -e SC2155 -e SC2046 -e SC1090 -e SC2166 -e SC2086 -e SC2044 -e SC2004
-                ;;
-              ./scripts/generateForDay.sh)
-                #SC2155: Declare and assign separately to avoid masking return values.
-                #SC2046: Quote this to prevent word splitting.
-                #SC1090: Can't follow non-constant source. Use a directive to specify location.
-                #SC2086: Double quote to prevent globbing and word splitting.
-                #SC2166: Prefer [ p ] || [ q ] as [ p -o q ] is not well defined.
-                #SC2219: Instead of 'let expr', prefer (( expr )) .
-                #SC2181: Check exit code directly with e.g. 'if mycmd;', not indirectly with $?.
-                shellcheck $i -e SC2155 -e SC2046 -e SC1090 -e SC2086 -e SC2166 -e SC2219 -e SC2181
-                ;;
-              ./scripts/allsky_mfs.sh)
-                #SC2086: Double quote to prevent globbing and word splitting.
-                shellcheck $i -e SC2086
-                ;;
-              ./scripts/saveImage.sh)
-                #SC1090: Can't follow non-constant source. Use a directive to specify location.
-                #SC2086: Double quote to prevent globbing and word splitting.
-                #SC2166: Prefer [ p ] && [ q ] as [ p -a q ] is not well defined.
-                #SC2181: Check exit code directly with e.g. 'if mycmd;', not indirectly with $?.
-                #SC2166: Prefer [ p ] && [ q ] as [ p -a q ] is not well defined.
-                #SC2219: Instead of 'let expr', prefer (( expr )) .
-                shellcheck $i -e SC1090 -e SC2086 -e SC2166 -e SC2181 -e SC2166 -e SC2219
-                ;;
-              ./scripts/copy_notification_image.sh)
-                #SC1090: Can't follow non-constant source. Use a directive to specify location.
-                #SC2181: Check exit code directly with e.g. 'if mycmd;', not indirectly with $?.
-                #SC2166: Prefer [ p ] && [ q ] as [ p -a q ] is not well defined.
-                #SC2086: Double quote to prevent globbing and word splitting.
-                shellcheck $i -e SC1090 -e SC2181 -e SC2166 -e SC2086
-                ;;
-              ./scripts/uploadForDay.sh)
-                #SC2155: Declare and assign separately to avoid masking return values.
-                #SC2046: Quote this to prevent word splitting.
-                #SC1090: Can't follow non-constant source. Use a directive to specify location.
-                shellcheck $i -e SC2155 -e SC2046 -e SC1090
-                ;;
-              ./scripts/upload.sh)
-                #SC2155: Declare and assign separately to avoid masking return values.
-                #SC2046: Quote this to prevent word splitting.
-                #SC1090: Can't follow non-constant source. Use a directive to specify location.
-                #SC2166: Prefer [ p ] && [ q ] as [ p -a q ] is not well defined.
-                #SC2086: Double quote to prevent globbing and word splitting.
-                shellcheck $i -e SC2155 -e SC2046 -e SC1090 -e SC2166 -e SC2086
-                ;;
-              ./scripts/darkSubtract.sh)
-                #SC2086: Double quote to prevent globbing and word splitting.
-                #SC2219: Instead of 'let expr', prefer (( expr )) .
-                #SC2181: Check exit code directly with e.g. 'if mycmd;', not indirectly with $?.
-                shellcheck $i -e SC2086 -e SC2219 -e SC2181
-                ;;
-              ./scripts/removeBadImages.sh)
-                #SC1090: Can't follow non-constant source. Use a directive to specify location.
-                #SC2086: Double quote to prevent globbing and word splitting.
-                #SC2166: Prefer [ p ] || [ q ] as [ p -o q ] is not well defined.
-                #SC2164: Use 'cd ... || exit' or 'cd ... || return' in case cd fails.
-                #SC2188: This redirection doesn't have a command. Move to its command (or use 'true' as no-op).
-                #SC2196: egrep is non-standard and deprecated. Use grep -E instead.
-                #SC2219: Instead of 'let expr', prefer (( expr )) .
-                shellcheck $i -e SC1090 -e SC2086 -e SC2166 -e SC2164 -e SC2188 -e SC2196 -e SC2219
-                ;;
-              ./scripts/timelapse.sh)
-                #SC2155: Declare and assign separately to avoid masking return values.
-                #SC2046: Quote this to prevent word splitting.
-                #SC1090: Can't follow non-constant source. Use a directive to specify location.
-                #SC2166: Prefer [ p ] || [ q ] as [ p -o q ] is not well defined.
-                #SC2012: Use find instead of ls to better handle non-alphanumeric filenames.
-                #SC2188: This redirection doesn't have a command. Move to its command (or use 'true' as no-op).
-                #SC2086: Double quote to prevent globbing and word splitting.
-                shellcheck $i -e SC2155 -e SC2046 -e SC1090 -e SC2166 -e SC2012 -e SC2188 -e SC2086
-                ;;
-              ./scripts/darkCapture.sh)
-                #SC2086: Double quote to prevent globbing and word splitting.
-                shellcheck $i -e SC2086
-                ;;
-              *)
-                #SC2086: Double quote to prevent globbing and word splitting.
-                shellcheck $i -e SC2086
-                ;;
-            esac
-            if [ $? -ne 0 ]; then
-              err=$((err + 1))
-            fi
-          done
-          if [ $err -ne 0 ]; then
-            echo "bash or shellcheck found problems in scripts. Please fix it or add some excludes (-e SC....) here in this file."
-          fi
-          exit $err
-
       # Runs a set of commands using the runners shell
       - name: make deps
         run: |
@@ -218,4 +29,3 @@ jobs:
       - name: make all
         run: |
           sudo make all
-

.github/workflows/ci_shellcheck.yml

@@ -0,0 +1,73 @@
+# This is a basic workflow to help you get started with Actions
+
+name: CI
+
+# Controls when the workflow will run
+on: 
+  push:
+    paths:
+      - '*.sh'
+      - '*/*.sh'
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v2
+
+      # Runs a set of commands using the runners shell
+      - name: check bash files
+        run: |
+          # check bash files (bash -n, shellchecki -x)
+          err=0
+          for i in $(find . -maxdepth 2 -name '*.sh'); do
+            echo "==================== $i"
+            bash -n $i
+            if [ $? -ne 0 ]; then
+              echo "bash found problem with $i"
+              err=$((err + 1))
+            fi
+            this_err=0
+            case $i in
+
+                ###### Do not ignore these
+                #SC2034: ON_TTY appears unused. Verify use (or export if used externally).
+                #SC2206: Quote to prevent word splitting/globbing, or split robustly with mapfile or read -a.
+                #SC2207: Prefer mapfile or read -a to split command output (or quote to avoid splitting).
+                #SC2046: Quote this to prevent word splitting.
+                #SC2086: Double quote to prevent globbing and word splitting.
+                #SC2012: Use find instead of ls to better handle non-alphanumeric filenames.
+                #SC2016: Expressions don't expand in single quotes, use double quotes for that.
+                #SC2044: For loops over find output are fragile. Use find -exec or a while read loop.
+                #SC2196: egrep is non-standard and deprecated. Use grep -E instead.
+
+              *)
+                #SC1090: Can't follow non-constant source. Use a directive to specify location.
+                #SC1091: Similar to SC1090
+                #SC2004: $/${} is unnecessary on arithmetic variables.
+                #SC2155: Declare and assign separately to avoid masking return values.
+                #SC2181: Check exit code directly with e.g. 'if mycmd;', not indirectly with $?.
+                #SC2188: This redirection doesn't have a command. Move to its command (or use 'true' as no-op).
+                #SC2069: Something about the order of >&2 and > xxx
+                #SC2024: similar to SC2069
+                #SC2269: This variable is assigned to itself
+                ###shellcheck -x -e SC1090 -e SC1091 -e SC2004 -e SC2155 -e SC2181 -e SC2188 -e SC2024 -e SC2069 -e SC2269 $i || this_err=1
+                shellcheck -x -e SC2004 -e SC2155 -e SC2181 -e SC2188 -e SC2024 -e SC2069 -e SC2269 $i || this_err=1
+                ;;
+            esac
+            if [ ${this_err} -eq 1 ]; then
+              err=$((err + 1))
+            fi
+          done
+          if [ $err -ne 0 ]; then
+            echo
+            echo "bash and/or shellcheck found problems in scripts. Please fix it or add some excludes (-e SC....) here in this file."
+            echo
+          fi
+          exit $err