Skip to content

jacaudi/dras

Repository files navigation

On Merge Versioned Release

DRAS — Doppler Radar Notification Service

This programs monitors either a single, or multiple, WSR-88D sites and sends alerts via Pushover based on change in status.

What Is Monitored

The following attributes are monitored per each site

  • Volume Coverage Pattern (VCP) — Clear Air or Precipitation Mode
  • Operational Status
  • Power Source
  • Generator State

How To Use

Requirements

  • Pushover Account
  • A device with the pushover mobile application installed

Binary Method

  1. Assuming you have Go installed on your system, head over to the Github Releases and grab the URL to the latest release.
  2. Run go install URL (e.g. go install github.com/jacaudi/dras@v1.0.0)
  3. Be sure to set the following Environmental Variables
    • STATION_IDS — WSR-88D (Radar) Sites (e.g. KRAX - Raleigh/Durham)
    • PUSHOVER_USER_KEY — Your Pushover User Key
    • PUSHOVER_API_TOKEN — Your Pushover API Token
    • ALERT_VCP — Enable Alerts on changes to Volume Coverage Pattern (default: true)
    • ALERT_STATUS — Enable Alerts on changes to radar operational status (default: false)
    • ALERT_OPERABILITY — Enable Alerts on changes to radar operability status (default: false)
    • ALERT_POWER_SOURCE — Enable Alerts on changes to radar power source (default: false)
    • ALERT_GEN_STATE — Enable Alerts on changes to generator state (default: false)
  4. Enjoy!

Standalone Container Method

docker pull ghcr.io/jacaudi/dras:v1.0.0

docker run -d \
  -e STATION_IDS=KRAX \
  -e PUSHOVER_USER_KEY=<KEY> \
  -e PUSHOVER_API_TOKEN=<TOKEN> \
  -e ALERT_VCP=false \
  -e ALERT_STATUS=true \
  -e ALERT_OPERABILITY=true \
  ghcr.io/jacaudi/dras:v1.0.0

Kubernetes Method

See the kubernetes file in examples folder — It contains an example deployment, configmap, and secret.

Versioning

This project uses Semantic Versioning with automated releases via uplift.

Commits should follow Conventional Commits:

  • feat: - Minor version bump (new features)
  • fix: - Patch version bump (bug fixes)
  • feat!: or BREAKING CHANGE: - Major version bump

Releases are automatically created when changes are merged to main.

How To Contribute

This project welcomes any feature improvements or bugs found via PRs. Thank you!

License

MIT

About

A Go program that monitors a WSR-88D site and sends alerts based on change in site status.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors 4

  •  
  •  
  •  
  •