Skip to content

Commit

Permalink
Merge pull request #1012 from thomasjacquin/README.md
Browse files Browse the repository at this point in the history
README.md: minor updates
  • Loading branch information
EricClaeys authored Feb 11, 2022
2 parents 6cf3abd + fce5e62 commit f23c04b
Showing 1 changed file with 10 additions and 15 deletions.
25 changes: 10 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Allsky Camera ![Release 0.8.3](https://img.shields.io/badge/Release-0.8.3-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 README and our [Wiki page](https://github.com/thomasjacquin/allsky/wiki) will help get the system up and running.**
**This README and our [Wiki pages](https://github.com/thomasjacquin/allsky/wiki) will help get your Allsky camera up and running. Please review them _before_ submitting an Issue.**

This is the source code for the Allsky Camera project described [on Instructables](http://www.instructables.com/id/Wireless-All-Sky-Camera/).

Expand Down Expand Up @@ -56,7 +56,7 @@ Make sure you have a working internet connection by setting it through [the term
**NOTE:** Version 0.8 added many new settings and changed the name of several existing settings. For example, there are now separate brightness levels for daytime and nighttime, called "daybrightness" and "nightbrightness". Version 0.7 only had "brightness" that applied to both day and nighttime. It's very important that you save a copy of your current settings prior to upgrading to version 0.8 so you can restore them properly.
The WebUI from the `allsky-portal` package uses these new settings so it's also important to update AllSky **prior to** updating the WebUI.

Also note that in version 0.8, the default image file created and uploaded is called either "image.jpg" or "liveview-image.jpg", depending on how you set things up. The prior "image-resize.jpg" is no longer created. Keep that in mind if you copy the image to a remote web server - it will need to know about the new name.
Also note that in version 0.8.3 the default image file created and uploaded is called "image.jpg". The prior "image-resize.jpg" and "liveview-image.jpg" are no longer created. Keep that in mind if you copy the image to a remote web server - it will need to know about the new name.

Some users have reported ASI_ERROR_TIMEOUT errors with their ZWO cameras in verion 0.8. Click [here](https://github.com/thomasjacquin/allsky/wiki/Troubleshoot:-ASI_ERROR_TIMEOUTs) to troubleshoot.

Expand Down Expand Up @@ -138,9 +138,9 @@ 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.
<!--
**Note:** The WebUI setup uses `/etc/raspap/settings_*.json` for the camera settings. If, for some reason, you prefer to go back to the non-WebUI version, make sure to edit your `config/config.sh` file to have `CAMERA_SETTINGS_DIR="${ALLSKY_CONFIG}"` instead.
-->
## Dark frame subtraction
The dark frame subtraction feature removes hot pixels from night sky images. The concept is the following: Take an image with a cover on your camera lens and let the software subtract that image later from all images taken throughout the night.
Expand Down Expand Up @@ -181,12 +181,6 @@ See the [Keogram Wiki page](https://github.com/thomasjacquin/allsky/wiki/Keogram
**Startrails** are generated by stacking all the images from a night on top of each other.
To disable startrails, open `config/config.sh` and set
```
STARTRAILS="false"
```
See the [Startrails Wiki page](https://github.com/thomasjacquin/allsky/wiki/Startrails-Explained) for more details.
## Automatic deletion of old data
Expand Down Expand Up @@ -242,7 +236,7 @@ will be run after the usual end-of-night processing, but before the deletion of

Edit this file via the "Editor" link on the left side of the WebUI page.


<!--
### Compile your own version

If you want to modify a compiled file, edit the corresponding `src/*.cpp` file and run the following command from the `src` directory:
Expand All @@ -251,7 +245,7 @@ make all
sudo make install
```
This will compile the new code, create a new binary, and copy it to the top level `allsky` folder.

-->

## Share your sky

Expand Down Expand Up @@ -308,7 +302,7 @@ If you've built an allsky camera, please send me a message and I'll add you to t
* Many bug fixes, error checks, and warnings added.
* version **0.8.3**: Works on Bullseye operating system.
* RPiHQ version:
* Has an improved auto-exposure algorithm. To use it, set `CAPTURE_EXTRA_PARAMETERS="-mean-value 0.3 -autoexposure 1"` in config.sh (a future version will allow this to be set via the WebUI).
* Has an improved auto-exposure algorithm. To use it, set `CAPTURE_EXTRA_PARAMETERS="-daymean 0.3 -nightmean 0.3"` in config.sh (a future version will allow this to be set via the WebUI).
* Has many new settings including support for most of the text overlay features that are supported by the ZWO version. The "extra text" feature will be supported in a future version).
* New and changed config.sh variables, see the [Software Settings](https://github.com/thomasjacquin/allsky/wiki/allsky-Settings) Wiki page for more information:
* `IMG_UPLOAD_FREQUENCY`: how often the image should be uploaded to a website. Useful with slow uplinks or metered Internet connections.
Expand All @@ -317,8 +311,9 @@ If you've built an allsky camera, please send me a message and I'll add you to t
* `IMG_PREFIX`: no longer used - the name of the image used by the websites is now whatever you specify in the WebUI (default: image.jpg).
* **NOTE**: When upgrading to 0.8.3 you MUST follow the steps listed [here](https://github.com/thomasjacquin/allsky/wiki/Upgrade-from-0.8.2-or-prior-versions).
* Replaced `saveImageDay.sh` and `saveImageNight.sh` with `saveImage.sh` that has improved functionality, including passing the sensor temperature to the dark subtraction commands, thereby eliminating the need for the "temperature.txt" file.
* The image used by the websites (default: image.jpg) as well as all temporary files are now written to `allsky/tmp`. **NOTE**: if you are using the Allsky Website you will need to change the "imageName" variable in `/var/www/html/allsky/config.js` to `"/current/tmp/"`.
* You can **significanly** reduce wear on your SD card by making `allsky/tmp` a [memory-based filesystem](https://github.com/thomasjacquin/allsky/wiki/Miscellaneous-Tips) for instructions).
* The image used by the websites (default: image.jpg) as well as all temporary files are now written to `allsky/tmp`. **NOTE**: if you are using the Allsky Website you will need to change the "imageName" variable in `/var/www/html/allsky/config.js` to `"/current/tmp/image.jpg"`.
* You can **significanly** reduce wear on your SD card by making `allsky/tmp` a [memory-based filesystem](https://github.com/thomasjacquin/allsky/wiki/Miscellaneous-Tips).

## Donation

If you found this project useful, here's a link to send me a cup of coffee :)
Expand Down

0 comments on commit f23c04b

Please sign in to comment.