Version 2023.05.01_01

README.md

@@ -1,30 +1,31 @@
-# Allsky Camera ![Release](https://img.shields.io/badge/Version-v2023.05.01-green.svg) [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=MEBU2KN75G2NG&source=url)
+# Allsky Camera ![Release](https://img.shields.io/badge/Version-v2023.05.01_01-green.svg) [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=MEBU2KN75G2NG&source=url)
 
 This is the source code for the Allsky Camera project described [on Instructables](http://www.instructables.com/id/Wireless-All-Sky-Camera/).
    
 <p align="center">
 <img src="https://github.com/thomasjacquin/allsky/blob/master/assets/allsky_camera.png" width="50%" title="Example of an allsky camera">
 </p>
 
-> **This README and the [Allsky documentation](https://github.com/thomasjacquin/allsky/wiki) will help get your allsky camera up and running.**
+> **This README and the [Allsky documentation](https://htmlpreview.github.io/?https://raw.githubusercontent.com/thomasjacquin/allsky/master/html/documentation/index.html) will help get your allsky camera up and running.**
 
 &nbsp;  
 
 <!-- =============================================================================== --> 
 ## Requirements
 
-You will need the following hardware:
+You will need the following:
 
- * A camera (Raspberry Pi HQ, Module 3 or compatible, or ZWO ASI)
- * A Raspberry Pi (2, 3, 4 or Zero 2 W).
+ * A Raspberry Pi (Zero 2, 2, 3, 4) running Pi OS.
+ * A camera (Raspberry Pi HQ, Module 3, or RPi compatible, or ZWO ASI)
 
 
 &nbsp;  
 > **NOTES:**
->	- The ZWO ASI120-series cameras are not recommended due to somewhat poor quality. See the [Troubleshooting --> ZWO Cameras](https://github.com/thomasjacquin/allsky/wiki) documentation for notes on the ASI120-series and related T7 / T7C cameras.
->	- The Pi Zero and Pi Zero W, with their limited memory and _very_ limited CPU power (single CPU core), are not recommended.  You will likely not be able to create keograms, startrails, or timelapse videos.
->	- The Pi Zero 2 and Pi Zero 2 W, with their limited memory and somewhat limited CPU power, are not recommended unless cost is a major concern.  Creating keograms, startrails, and timelapse videos may or may not be possible.
->	- We have not found any "Pi-compatible" boards that are actually compatible, so buyer beware.
+>	- Only the Raspberry Pi OS is supported.  Other operating systems like Ubuntu are NOT supported.
+>	- The ZWO ASI120-series cameras are not recommended due to somewhat poor quality. See [Troubleshooting --> ZWO Cameras](https://htmlpreview.github.io/?https://raw.githubusercontent.com/thomasjacquin/allsky/master/html/documentation/troubleshooting/ZWOCameras.html) for notes on the ASI120-series and related T7 / T7C cameras.
+>	- The Pi Zero with its limited memory and _very_ limited CPU power (single CPU core), is not recommended.  You will likely not be able to create keograms, startrails, or timelapse videos.
+>	- The Pi Zero 2 with its limited memory and somewhat limited CPU power, is not recommended unless cost is the only concern.  Creating keograms, startrails, and timelapse videos may or may not be possible.
+>	- The Le Potato is the only "Pi-compatible" board that we've found to actually be compatible, so buyer beware.
 ---
 
 
@@ -35,7 +36,7 @@ You will need the following hardware:
 PatriotAstro created a great [video](https://www.youtube.com/watch?v=7TGpGz5SeVI) describing the installation steps below.
 **We highly suggest viewing it before installing the software.**
 
-Detailed installation instructions can be found in the [Installing / Upgrading --> Allsky](https://github.com/thomasjacquin/allsky/wiki) documentation.
+Detailed installation instructions can be found at [Installing / Upgrading --> Allsky](https://htmlpreview.github.io/?https://raw.githubusercontent.com/thomasjacquin/allsky/master/html/documentation/installations/Allsky.html).
 
 ---
 
@@ -45,7 +46,7 @@ Detailed installation instructions can be found in the [Installing / Upgrading -
 ## Web User Interface (WebUI)
 
 <p align="center">
-<img src="https://github.com/thomasjacquin/allsky/blob/master/assets/WebUI.png" style="border: 1px solid black">
+<img src="https://github.com/thomasjacquin/allsky/blob/master/html/documentation/settings/AllskySettingsPage.png" style="border: 1px solid black">
 </p>
 
 The WebUI is now installed as part of Allsky and is used to administer Allsky, and to a lesser extent, your Pi. It can also be used to view the current image as well as all saved images, keograms, startrails, and timelapse videos.
@@ -67,7 +68,7 @@ If it is behind a firewall consult the documentation for your network equipment
 
 By installling the optional Allsky Website you can display your files on a website on the Pi, on another machine, or on both.
 
-See the [Installation / Upgrading --> Website](https://github.com/thomasjacquin/allsky/wiki) documentation for information on how to install and configure an Allsky Website.
+See [Installation / Upgrading --> Website](https://htmlpreview.github.io/?https://raw.githubusercontent.com/thomasjacquin/allsky/master/html/documentation/installations/AllskyWebsite.html) for information on how to install and configure an Allsky Website.
 
 ---
 
@@ -82,7 +83,7 @@ Allsky supports running "modules" after each picture is taken to change the imag
 
 The Overlay Editor lets you easily specify what text and images you want in your overlay, and place them using drag-and-drop.  Each field can be formatted however you want (font, color, size, position, rotation, etc.).  The only limit is your imagination!!
 
-See the [Explanations / How To -> Overlays](https://github.com/thomasjacquin/allsky/wiki) and [Explanations / How To -> Modules](https://github.com/thomasjacquin/allsky/wiki)  documentation for more information.
+See [Explanations / How To -> Overlays](https://htmlpreview.github.io/?https://raw.githubusercontent.com/thomasjacquin/allsky/master/html/documentation/overlays/overlays.html) and [Explanations / How To -> Modules](https://htmlpreview.github.io/?https://raw.githubusercontent.com/thomasjacquin/allsky/master/html/documentation/modules/modules.html) for more information.
 
 ---
 
@@ -93,7 +94,7 @@ See the [Explanations / How To -> Overlays](https://github.com/thomasjacquin/all
 
 Dark frame subtraction removes hot pixels from images by taking images at different temperatures with a cover on your camera lens and subtracting those images from nighttime images.
 
-See the [Explanations / How To -> Dark frames](https://github.com/thomasjacquin/allsky/wiki) documentation for more information.
+See [Explanations / How To -> Dark frames](https://htmlpreview.github.io/?https://raw.githubusercontent.com/thomasjacquin/allsky/master/html/documentation/explanations/darkFrames.html) for more information.
 
 ---
 
@@ -120,7 +121,7 @@ By default, a timelapse video is generated at the end of nighttime from all of t
 A **Keogram** is an image giving a quick view of the day's activity.
 For each image a central vertical column 1 pixel wide is extracted. All these columns are then stitched together from left to right. This results in a timeline that reads from dawn to the end of nighttime (the image above only shows nighttime data since daytime images were turned off).
 
-See the [Explanations / How To --> Keograms](https://github.com/thomasjacquin/allsky/wiki) documentation.
+See [Explanations / How To --> Keograms](https://htmlpreview.github.io/?https://raw.githubusercontent.com/thomasjacquin/allsky/master/html/documentation/explanations/keograms.html).
 
 
 ---
@@ -137,7 +138,7 @@ See the [Explanations / How To --> Keograms](https://github.com/thomasjacquin/al
 **Startrails** are generated by stacking all the images from a night on top of each other.
 In the image above, Polaris is centered about one-fourth the way from the top.
 
-See the [Explanations / How To --> Startrails](https://github.com/thomasjacquin/allsky/wiki) documentation.
+See [Explanations / How To --> Startrails](https://htmlpreview.github.io/?https://raw.githubusercontent.com/thomasjacquin/allsky/master/html/documentation/explanations/startrails.html).
 
 
 ---
@@ -150,7 +151,7 @@ See the [Explanations / How To --> Startrails](https://github.com/thomasjacquin/
 You can specify how many days worth of images to keep in order to keep the Raspberry Pi SD card from filling up.  If you have the Allsky Website installed on your Pi, you can specify how many days worth of its imags to keep.
 
 
-See the **DAYS_TO_KEEP** and **WEB_DAYS_TO_KEEP** settings in the [Settings --> Allsky Website](https://github.com/thomasjacquin/allsky/wiki) documentation.
+See the **DAYS_TO_KEEP** and **WEB_DAYS_TO_KEEP** settings in [Settings --> Allsky](https://htmlpreview.github.io/?https://raw.githubusercontent.com/thomasjacquin/allsky/master/html/documentation/settings/allsky.html).
 
 ---
 
@@ -161,7 +162,7 @@ See the **DAYS_TO_KEEP** and **WEB_DAYS_TO_KEEP** settings in the [Settings -->
 ## Share your sky
 
 
-If you want your allsky camera added to the [Allsky map](http://www.thomasjacquin.com/allsky-map), see the [Put your camera on Allsky Map](https://github.com/thomasjacquin/allsky/wiki) documentation.
+If you want your allsky camera added to the [Allsky map](http://www.thomasjacquin.com/allsky-map), see [Put your camera on Allsky Map](https://htmlpreview.github.io/?https://raw.githubusercontent.com/thomasjacquin/allsky/master/html/documentation/miscellaneous/AllskyMap.html).
 
 If you know anyone in Greenland or Antartica, send them a camera!!
 
@@ -179,7 +180,7 @@ If you know anyone in Greenland or Antartica, send them a camera!!
 ## Release changes
 
 See the
-[Allsky Version Change Log](https://github.com/thomasjacquin/allsky/blob/master/html/documentation/changeLog.html)
+[Allsky Version Change Log](https://htmlpreview.github.io/?https://raw.githubusercontent.com/thomasjacquin/allsky/master/html/documentation/changeLog.html)
 for a list of changes in this release and all prior releases.
 
 ---

allsky.sh

@@ -32,6 +32,27 @@ source "${ALLSKY_CONFIG}/config.sh"						|| exit ${ALLSKY_ERROR_STOP}
 #shellcheck disable=SC2086 source-path=scripts
 source "${ALLSKY_SCRIPTS}/installUpgradeFunctions.sh"	|| exit ${ALLSKY_ERROR_STOP}
 
+# Make sure they rebooted if they were supposed to.
+NEEDS_REBOOT="false"
+reboot_needed && NEEDS_REBOOT="true"
+
+# Make sure the settings have been configured after an installation or upgrade.
+LAST_CHANGED="$( settings ".lastChanged" )"
+if [[ ${LAST_CHANGED} == "" || ${LAST_CHANGED} == "null" ]]; then
+	echo "*** ===== Allsky needs to be configured before it can be used.  See the WebUI."
+	if [[ ${NEEDS_REBOOT} == "true" ]]; then
+		echo "*** ===== The Pi also needs to be rebooted."
+		doExit "${EXIT_ERROR_STOP}" "Error" \
+			"Allsky needs\nconfiguration\nand the Pi needs\na reboot" \
+			"Allsky needs to be configured then the Pi rebooted."
+	else
+		doExit "${EXIT_ERROR_STOP}" "ConfigurationNeeded" "" ""
+		"${ALLSKY_SCRIPTS}/addMessage.sh" "Error" "Allsky needs to be configured."
+	fi
+elif [[ ${NEEDS_REBOOT} == "true" ]]; then
+	doExit "${EXIT_ERROR_STOP}" "RebootNeeded" "" ""
+	"${ALLSKY_SCRIPTS}/addMessage.sh" "Error" "The Pi needs to be rebooted."
+fi
 
 SEE_LOG_MSG="See ${ALLSKY_LOG}"
 ARGS_FILE="${ALLSKY_TMP}/capture_args.txt"
@@ -171,6 +192,12 @@ else
 		"${NOT_STARTED_MSG}<br>${MSG}"
 fi
 
+# Make sure the settings file is linked to the camera-specific file.
+if ! MSG="$( check_settings_link "${SETTINGS_FILE}" )" ; then
+	"${ALLSKY_SCRIPTS}/addMessage.sh" "error" "${MSG}"
+	echo "ERROR: Settings file (${SETTINGS_FILE}) not linked correctly." >&2
+fi
+
 # Make directories that need to exist.
 if [[ -d ${ALLSKY_TMP} ]]; then
 	# remove any lingering old image files.
@@ -186,11 +213,13 @@ else
 	"${ALLSKY_SCRIPTS}/addMessage.sh" warning "${ME}: ${MSG}"
 fi
 
+rm -f "${ALLSKY_BAD_IMAGE_COUNT}"	# Start with no bad images
+
 # Clear out these files and allow the web server to write to it.
-: > "${ALLSKY_ABORTEDUPLOADS}"
-: > "${ALLSKY_ABORTEDTIMELAPSE}"
-sudo chgrp "${WEBSERVER_GROUP}" "${ALLSKY_ABORTEDUPLOADS}" "${ALLSKY_ABORTEDTIMELAPSE}"
-sudo chmod 664 "${ALLSKY_ABORTEDUPLOADS}" "${ALLSKY_ABORTEDTIMELAPSE}"
+rm -fr "${ALLSKY_ABORTS_DIR}"
+mkdir "${ALLSKY_ABORTS_DIR}"
+sudo chgrp "${WEBSERVER_GROUP}" "${ALLSKY_ABORTS_DIR}"
+sudo chmod 775 "${ALLSKY_ABORTS_DIR}"
 
 # Optionally display a notification image.
 if [[ $USE_NOTIFICATION_IMAGES -eq 1 ]]; then
@@ -219,17 +248,12 @@ if [[ -z ${LOCALE} || ${LOCALE} == "null" ]]; then
 	fi
 fi
 
-# shellcheck disable=SC2207
-KEYS=( $(settings 'keys[]') )
-for KEY in "${KEYS[@]}"
-do
-	K="$(settings ".${KEY}")"
-	# We must pass "-config ${ARGS_FILE}" on the command line,
-	# and debuglevel we did above, so don't do them again.
-	[[ ${KEY} == "config" && ${KEY} == "debuglevel" ]] && continue
-
-	echo "-${KEY}=${K}" >> "${ARGS_FILE}"
-done
+# We must pass "-config ${ARGS_FILE}" on the command line,
+# and debuglevel we did above, so don't do them again.
+TAB="$( echo -e "\t" )"
+convert_json_to_tabs "${SETTINGS_FILE}" |
+	grep -E -i -v "^config${TAB}|^debuglevel${TAB}" |
+	sed -e 's/^/-/' -e "s/${TAB}/=/" >> "${ARGS_FILE}"
 
 # When using a desktop environment a preview of the capture can be displayed in a separate window.
 # The preview mode does not work if we are started as a service or if the debian distribution has no desktop environment.
@@ -252,6 +276,9 @@ CAPTURE="capture_${CAMERA_TYPE}"
 
 rm -f "${ALLSKY_NOTIFICATION_LOG}"	# clear out any notificatons from prior runs.
 
+# Clear up any flow timings
+"${ALLSKY_SCRIPTS}/flow-runner.py" --cleartimings
+
 # Run the main program - this is the main attraction...
 # Pass debuglevel on command line so the capture program knows if it should display debug output.
 "${ALLSKY_BIN}/${CAPTURE}" -debuglevel "${ALLSKY_DEBUG_LEVEL}" -config "${ARGS_FILE}"

config_repo/config.sh.repo

@@ -156,7 +156,8 @@ UHUBCTL_PORT=2
 # ================ DO NOT CHANGE ANYTHING BELOW THIS LINE ================
 ME2="$(basename "${BASH_SOURCE[0]}")"
 
-CAMERA_TYPE=""						# Updated during installation
+# CAMERA_TYPE is updated during installation
+CAMERA_TYPE=""
 if [ "${CAMERA_TYPE}" = "" ]; then
 	echo -e "${RED}${ME2}: ERROR: Please set 'Camera Type' in the WebUI.${NC}"
 	sudo systemctl stop allsky > /dev/null 2>&1
@@ -192,6 +193,7 @@ CAMERA_MODEL="$(settings '.cameraModel')"
 
 # So scripts can conditionally output messages.
 ALLSKY_DEBUG_LEVEL="$(settings '.debuglevel')"
-ALLSKY_VERSION="XX_ALLSKY_VERSION_XX"	# Updated during installation
+# ALLSKY_VERSION is updated during installation
+ALLSKY_VERSION="XX_ALLSKY_VERSION_XX"
 
 CONFIG_SH_VERSION=1

config_repo/ftp-settings.sh.repo

@@ -41,7 +41,7 @@ REMOTE_HOST=""
 REMOTE_PORT=""
 
 
-############### ftp, ftps, and sftp PROTOCOLS only:
+############### ftp, ftps, and sftp PROTOCOLS only.  REMOTE_USER is also used by the scp PROTOCOL:
 	# The username of the login on the remote server.
 REMOTE_USER=""
 

config_repo/lighttpd.conf.repo

@@ -20,6 +20,7 @@ setenv.add-environment = (
 
 alias.url		    = ("/current/" => "XX_ALLSKY_HOME_XX/")
 alias.url		    += ("/images/" => "XX_ALLSKY_IMAGES_XX/")
+alias.url		    += ("/config/" => "XX_ALLSKY_CONFIG_XX/")
 alias.url		    += ("/website/" => "XX_ALLSKY_WEBSITE_XX/")
 alias.url		    += ("/documentation" => "XX_ALLSKY_DOCUMENTATION_XX/")
 alias.url		    += ("/overlay" => "XX_ALLSKY_OVERLAY_XX/")