Merge pull request #4008 from AllskyTeam/v2024.12.06

V2024.12.06

.github/ISSUE_TEMPLATE/2-bug_report.yml

@@ -69,4 +69,4 @@ body:
          
         If your problem is with an **Allsky Website**, also attach:
           \*  `~/allsky/html/allsky/configuration.json` (local Website)
-          \*  `~/allsky/config/remote_configuration.json` (remote Website)
+          \*  `~/allsky/config/remote_configuration.json` (remote Website)

.github/workflows/ci_shellcheck.yml

@@ -8,6 +8,7 @@ on:
     paths:
       - '*.sh'
       - '*/*.sh'
+      - '*/*/*.sh'
 
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:

.gitignore

@@ -1,6 +1,5 @@
 images/*
 darks/*
-scripts/endOfNight_additionalSteps.sh
 
 # development artifacts
 src/*.a

README.md

@@ -1,43 +1,52 @@
-# Allsky Camera ![Release](https://img.shields.io/badge/Version-v2023.05.01_05-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-v2024.12.06-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">
+<img src="https://github.com/AllskyTeam/allsky/blob/master/assets/allsky_camera.png" width="50%" title="Example of an allsky camera">
 </p>
 
-> **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:
+In order to run the Allsky software you need:
 
- * A Raspberry Pi (Zero 2, 2, 3, 4, or 5) running Pi OS.
- * A camera (Raspberry Pi HQ, Module 3, or RPi compatible, or ZWO ASI released before October 2023)
+ * A Raspberry Pi Zero 2, Pi 2, Pi 3, Pi 4, Pi 5, or Le Potato.
+ * A camera:
+    * Any ZWO camera sold before October 2024.
+    * One of the following Raspberry Pi cameras:
+       * RPi HQ (IMX477 sensor)
+       * RPi Module 3 (IMX708 sensor)
+       * RPi Version 1 (OV5647 sensor; NOT RECOMMENDED: 0.9 second maximum exposure)
+       * IMX290 60.00 fps
+       * ArduCam 16 MP (IMX519 sensor)
+       * ArduCam 64 MP (arducam_64mp sensor)
+       * ArduCam 462 (arducam-pivariety sensor)
+       * Waveshare imx219-d160 (IMX290 sensor)
+       * ArduCam 64 MP Owlsight (OV64a40 sensor)
+       * OneInchEye IMX283 (IMX283 sensor)
 
 
 &nbsp;  
-> **NOTES:**
->	- Only the Raspberry Pi OS is supported (Buster, Bullseye, or Bookworm).  Other operating systems like Ubuntu are NOT supported.
-> 	- **NOTE**: support for Buster is going away so please upgrade to Bookworm.
->	- The ZWO ASI120-series cameras are not recommended due to somewhat poor quality and tendency to produce timeout errors. 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 most 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.
+> __NOTES:__
+>	- Only the Raspberry Pi OS is supported.  Other operating systems like Ubuntu are NOT supported.  If possible use the newest Bookworm 64-bit release. Bullseye will also work. __Buster support will be dropped in the next major release__.
+>	- The ZWO ASI120-series cameras are __not__ recommended due to their tendency to produce errors and poor-quality images.
+>	- The Pi Zero with its limited memory and _very_ limited CPU power is not recommended.  You probably won't 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.
----
 
 
 &nbsp;
 <!-- =============================================================================== --> 
 ## Software Installation
-<!-- HIDE - VIDEO IS OLD
+
+<!-- HIDE FOR NOW - THE VIDEO IS A COUPLE RELEASES OLD
 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.**
+__We recommend viewing it before installing the software__.
 -->
-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).
+
+See the [detailed installation instructions](https://htmlpreview.github.io/?https://raw.githubusercontent.com/AllskyTeam/allsky/master/html/documentation/installations/Allsky.html).
 
 ---
 
@@ -47,12 +56,12 @@ Detailed installation instructions can be found at [Installing / Upgrading --> A
 ## Web User Interface (WebUI)
 
 <p align="center">
-<img src="https://github.com/thomasjacquin/allsky/blob/master/html/documentation/settings/AllskySettingsPage.png" style="border: 1px solid black">
+<img src="https://github.com/AllskyTeam/allsky/blob/master/html/documentation/settings/AllskySettingsPage.png" width="90%">
 </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.
+The WebUI 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.
 
-A public page is also available in order to view the current image without having to log into the WebUI and without being able to do any administrative tasks. This can be useful for people who don't have a Allsky Website but still want to share a view of their sky:
+A public page is also available in order to view the current image without having to log into the WebUI and without being able to do any administrative tasks. This can be useful for people who don't use an Allsky Website but still want to share a view of their sky:
 
 ```
 http://your_raspberry_IP/public.php
@@ -61,15 +70,21 @@ http://your_raspberry_IP/public.php
 Make sure this page is publically viewable.
 If it is behind a firewall consult the documentation for your network equipment for information on allowing inbound connections.
 
+The WebUI has a link to the Allsky Documentation which describes all the settings Allsky uses as well as troubleshooting information.
+It should be used before requesting support on GitHub.
+
 ---
 
 &nbsp;
 <!-- =============================================================================== --> 
-## Allsky Website
+## Allsky Website and remote server
+
+The local Allsky Website (i.e., on the Pi) is installed with Allsky but must be enabled in the WebUI in order to use it.
+You can also install the Allsky Website on a remote server so it can be viewable via the Internet.
 
-By installling the optional Allsky Website you can display your files on a website on the Pi, on another machine, or on both.
+See [Installation / Upgrading --> Website](https://htmlpreview.github.io/?https://raw.githubusercontent.com/AllskyTeam/allsky/master/html/documentation/installations/AllskyWebsite.html) 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.
+Allsky images, keograms, startrails, and timelapse videos can optionally be uploaded to a remote server __not__ running an Allsky Website.  This is useful if you have a personal website and want to include the most recent Allsky images.
 
 ---
 
@@ -84,7 +99,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 [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.
+See [Explanations / How To -> Overlays](https://htmlpreview.github.io/?https://raw.githubusercontent.com/AllskyTeam/allsky/master/html/documentation/overlays/overlays.html) and [Explanations / How To -> Modules](https://htmlpreview.github.io/?https://raw.githubusercontent.com/AllskyTeam/allsky/master/html/documentation/modules/modules.html) for more information.
 
 ---
 
@@ -93,9 +108,9 @@ See [Explanations / How To -> Overlays](https://htmlpreview.github.io/?https://r
 <!-- =============================================================================== --> 
 ## Dark frame subtraction
 
-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.
+Dark frame subtraction removes white (i.e., "hot") pixels from images by taking images with a cover over the camera lens and subtracting those images from images.
 
-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.
+See [Explanations / How To -> Dark frames](https://htmlpreview.github.io/?https://raw.githubusercontent.com/AllskyTeam/allsky/master/html/documentation/explanations/darkFrames.html) for more information.
 
 ---
 
@@ -116,13 +131,13 @@ By default, a timelapse video is generated at the end of nighttime from all of t
 ## Keograms
 
 <p align="center">
-<img src="https://github.com/thomasjacquin/allsky/blob/master/assets/Keogram.png" width="75%">
+<img src="https://github.com/AllskyTeam/allsky/blob/master/assets/Keogram.png" width="75%">
 </p>
 
-A **Keogram** is an image giving a quick view of the day's activity.
+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 [Explanations / How To --> Keograms](https://htmlpreview.github.io/?https://raw.githubusercontent.com/thomasjacquin/allsky/master/html/documentation/explanations/keograms.html).
+See [Explanations / How To --> Keograms](https://htmlpreview.github.io/?https://raw.githubusercontent.com/AllskyTeam/allsky/master/html/documentation/explanations/keograms.html).
 
 
 ---
@@ -133,13 +148,13 @@ See [Explanations / How To --> Keograms](https://htmlpreview.github.io/?https://
 ## Startrails
 
 <p align="center">
-<img src="https://github.com/thomasjacquin/allsky/blob/master/assets/Startrails.png" width="50%">
+<img src="https://github.com/AllskyTeam/allsky/blob/master/assets/Startrails.png" width="50%">
 </p>
 
-**Startrails** are generated by stacking all the images from a night on top of each other.
+__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 [Explanations / How To --> Startrails](https://htmlpreview.github.io/?https://raw.githubusercontent.com/thomasjacquin/allsky/master/html/documentation/explanations/startrails.html).
+See [Explanations / How To --> Startrails](https://htmlpreview.github.io/?https://raw.githubusercontent.com/AllskyTeam/allsky/master/html/documentation/explanations/startrails.html).
 
 
 ---
@@ -149,10 +164,10 @@ See [Explanations / How To --> Startrails](https://htmlpreview.github.io/?https:
 <!-- =============================================================================== --> 
 ## Automatic deletion of old data
 
-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.
+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 are using the Allsky Website 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 [Settings --> Allsky](https://htmlpreview.github.io/?https://raw.githubusercontent.com/thomasjacquin/allsky/master/html/documentation/settings/allsky.html).
+See the __Days to Keep on Pi Website__ and __Web Days To Keep on Remote Website__ settings in [Settings --> Allsky](https://htmlpreview.github.io/?https://raw.githubusercontent.com/AllskyTeam/allsky/master/html/documentation/settings/allsky.html).
 
 ---
 
@@ -163,13 +178,13 @@ See the **DAYS_TO_KEEP** and **WEB_DAYS_TO_KEEP** settings in [Settings --> Alls
 ## Share your sky
 
 
-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 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/AllskyTeam/allsky/master/html/documentation/miscellaneous/AllskyMap.html).
 
 If you know anyone in Greenland or Antartica, send them a camera!!
 
 <p align="center">
 <a href="https://www.thomasjacquin.com/allsky-map/" title="Allsky map example - click to see real map">
-<img src="https://github.com/thomasjacquin/allsky/blob/master/html/documentation/miscellaneous/allsky-map-with-pins.png">
+<img src="https://github.com/AllskyTeam/allsky/blob/master/html/documentation/miscellaneous/allsky-map-with-pins.png">
 </a>
 </p>
 
@@ -181,7 +196,7 @@ If you know anyone in Greenland or Antartica, send them a camera!!
 ## Release changes
 
 See the
-[Allsky Version Change Log](https://htmlpreview.github.io/?https://raw.githubusercontent.com/thomasjacquin/allsky/master/html/documentation/changeLog.html)
+[Allsky Version Change Log](https://htmlpreview.github.io/?https://raw.githubusercontent.com/AllskyTeam/allsky/master/html/documentation/changeLog.html)
 for a list of changes in this release and all prior releases.
 
 ---