Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mattblack85/astro_monitor
A small program to help you during your astrophotography sessions
https://github.com/mattblack85/astro_monitor
astrophotography backup ekos indi-backup kstars kstars-backup monitoring phd2-backup rust telegram
Last synced: 2 months ago
JSON representation
A small program to help you during your astrophotography sessions
- Host: GitHub
- URL: https://github.com/mattblack85/astro_monitor
- Owner: MattBlack85
- Created: 2021-12-21T09:22:39.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-15T08:48:27.000Z (10 months ago)
- Last Synced: 2024-10-11T12:25:02.759Z (3 months ago)
- Topics: astrophotography, backup, ekos, indi-backup, kstars, kstars-backup, monitoring, phd2-backup, rust, telegram
- Language: Rust
- Homepage:
- Size: 65.4 KB
- Stars: 9
- Watchers: 3
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Astro monitor
A small program that can help you with your astro session.
The main functionality is the watchdog; if astromonitor notices Kstars is dead il will send a request to notify you via telegram.
The other cool feature is the backup, astromonitor can backup:
- your INDI configuration for your devices
- the profile containing your equipment and setup
- PHD2 profile
- generic Kstars option (theme, colors, etc.)
you can restore the backup on an other PC or when installing the suite again.
# Have a look at how it works
https://github.com/MattBlack85/astro_monitor/assets/4163222/587784c4-6a9b-4485-9444-9d0d61d9897e
# Install
you trust me? run the following command
```shell
wget -O - https://raw.githubusercontent.com/MattBlack85/astro_monitor/main/install.sh | sh
```
sudo will be needed as last step to move `astromonitor` to `/usr/local/bin`
# How to use astromonitor
Using astromonitor is easy, just follow these instruction
## First step - obtain a token using telegram
On telegram, look for @AstroMonitorBot (the icon is the bubble nebula from hubble) and send a `/register` command, it will answer with a token, store it in a safe place, that's your key for the backups.
## Make a backup
Open a terminal and run `astromonitor --do-backup XXXXXXXXXXXXXXXXXX` paste your key obtained in the previous step instead of XXXXXXXXXX
## Retrieve a previously made backup
Open a terminal and run `astromonitor --retrieve-backup XXXXXXXXXXXXXXXXXX` paste your key obtained in the previous step instead of XXXXXXXXXX
## Monitor Kstars during a session
Open a terminal and run `astromonitor --kstars XXXXXXXXXXXXXXXXXX` paste your key obtained in the previous step instead of XXXXXXXXXX
This will start monitoring Kstars and if it crashes, it will send you a notification via telegram
# List of all functionalities:
you can obtain the same list by running `astromonitor --help`, here what we actually support:
- `--kstars` monitor Kstars and send a telegram notification if it crashes during a session
- `--do-backup` make a backup of the Kstars database and INDI devices configuration and store it remotely
- `--retrieve-backup` restore the previously saved backup
- `--fd-monitor` monitor file descriptors used to check if there is any leak
- `--system-monitor` monitor system resources (CPU and RAM) usage and log it
The main folder where you'll find the logs is `~/.local/share/astromonitor/logs`
# Compile it and run
If you want to compile it by yourself, the project is pure `Rust`, you just need the rust toolchain (see https://rustup.rs/), then clone this repo with `git clone https://github.com/MattBlack85/astro_monitor` or `git clone [email protected]:MattBlack85/astro_monitor` cd into the folder `cd astro_monitor` and then `cargo build --release`.
You will find the compiled program then under `target/release/astromonitor` you can move the program around (for example /usr/local/bin)