45 lines
1.5 KiB
Markdown
45 lines
1.5 KiB
Markdown
# Blitzortung Lightning Notifier
|
|
|
|
This project connects to the Blitzortung lightning detection network and sends notifications to your devices when lightning strikes are detected near your specified location.
|
|
|
|
## Features
|
|
|
|
- Connects to Blitzortung's live WebSocket feed.
|
|
- Filters lightning strikes by your chosen location and radius.
|
|
- Sends rich notifications to your devices via [ntfy.sh](https://ntfy.sh/).
|
|
- Optionally displays details about the detectors involved in each strike.
|
|
- Supports multiple locales for notifications
|
|
- Gives you rough location of where the strike was using the nominatim api
|
|
|
|
## Usage
|
|
|
|
### Prerequisites
|
|
|
|
- Rust (edition 2021 or newer)
|
|
- [ntfy.sh](https://ntfy.sh/) account or topic (no registration required)
|
|
- Optionally, a `detectors.json` file for detector details
|
|
This file can be downloaded from my copyparty server, [here.](https://files.sad.ovh/public/detectors.json)
|
|
|
|
### Use
|
|
If you do not wish to compile `blitzortung`, feel free to download it from [here.](https://files.sad.ovh/public/releases/blitzortung/0.1.0/release/blitzortung).
|
|
|
|
### Compile
|
|
```sh
|
|
cargo build --release
|
|
```
|
|
|
|
```sh
|
|
cargo run --release -- \
|
|
--center-lat <latitude> \
|
|
--center-lon <longitude> \
|
|
--ntfy <ntfy_topic> \
|
|
[--delta <radius>] \
|
|
[--detector-fetch]
|
|
```
|
|
|
|
## Detectors
|
|
If you enable `--detector-fetch`, make sure you have a valid `detectors.json` file in the project directory. This file should contain metadata about Blitzortung detectors.
|
|
|
|
## License
|
|
|
|
MIT
|