https://github.com/allskyteam/allsky-modules
User modules for allsky
https://github.com/allskyteam/allsky-modules
Last synced: about 1 year ago
JSON representation
User modules for allsky
- Host: GitHub
- URL: https://github.com/allskyteam/allsky-modules
- Owner: AllskyTeam
- License: mit
- Created: 2022-08-22T21:16:51.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2025-04-13T00:15:55.000Z (about 1 year ago)
- Last Synced: 2025-04-13T20:15:16.340Z (about 1 year ago)
- Language: Python
- Size: 25.9 MB
- Stars: 27
- Watchers: 3
- Forks: 25
- Open Issues: 45
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AllSky Modules
## Installation
### NOTE: These modules require version v2023.05.01_04 or later of Allsky.
This repository contains additional modules that can be used with Allsky. To install the modules first clone this repository:
`git clone https://github.com/AllskyTeam/allsky-modules.git`
Change to the newly cloned folder:
`cd allsky-modules`
Then run the installer:
`./install.sh`
> **NOTE:** If you are using any other branch other than master a warning will be displayed.
When you are done installing the modules you want and have verified they work correctly, you can remove the clone:
`cd; rm -fr allsky-modules`
### Moving around the menu
Use the up and down arrow keys to move the highlighted selection between the options available. Pressing the right arrow key will jump out of the options menu and take you to the `` and `` buttons. Pressing left will take you back to the options. Alternatively, use the Tab key to switch between these.
When a list is displayed the `` bar can be used to select or unselect an option.
### Module Installer Main Menu
### Install/Remove Modules
This option will display all of the available modules. If a module is already installed then it will be selected by default, this allows previously installed modules to be updated.
You can select or unselect a module. If a module is unselected but currently installed then it will be uninstalled.
> **NOTE:** If you uninstall a module then please ensure you check the overlay editor to ensure that you have removed and variables the module may generate.
### Module information
This option will display a list of modules. Selecting a module, using the `` bar and pressing `` will display information about the module.
### System Checks
This option will display information about the system.
## Available Module
| Module | Description |
|---|---|
| allsky_ai | Determines Cloud Cover using AI|
| allsky_boilerplate | Example Boilerplate module |
| allsky_border | Expands a captured image adding a border |
| allsky_dewheater | Managed a dewheater |
| allsky_discordsend | Send images to Discord channels |
| allsky_fans | Controls the Pi Fans |
| allsky_gpio | Control a GPIO Pin |
| allsky_hddtemp | Reads Hard Drive temperatures |
| allsky_ina3221 | Reads current and voltage |
| allsky_influxdb | Writes data to an Influxdb database |
| allsky_light | Estimates the sky brightness using an external sensor |
| allsky_lightgraph | Displays sun information |
| allsky_ltr390 | Measures UV levels via an external sensor |
| allsky_mlx90640 | Generates an IR image |
| allsky_openweathermap | Reads weather data from OpenWeather maps |
| allsky_pigps | REads position data from an attached GPS |
| allsky_publishdata | |
| allsky_rain | Detects rainfall via an external sensor |
| allsky_script | Allows a script to be run during day/night and night/day transitions |
| allsky_sqm | Sqky Quality Module |
| allsky_test | Module for testing the installer - DO NOT USE |
## Custom Modules
Details of how to create your own modules in Python can be found in the `Explanations -> Modules` documentation page available via the link in the WebUI.
If you feel a module would be of help to the community then please consider contributing it to this repository.