alaudet / raspi-sump

Raspi-Sump Version 2 Raspi-Sump Version 2 is ready for alpha testing. Alpha Install (Unstable) Alpha releases are available via the Linuxnorth APT repository. This is an unstable channel intended for testers — use on a production system at your own risk. You must remove any previous versions of Raspi-Sump or hcsr04sensor before doing this. If you are not sure what to do ask in the Issue Tracker. There are full removal and install instructions at https://github.com/alaudet/raspi-sump/blob/main/betatesting/README.md Please report issues in the issue tracker. --- About Raspi-Sump is a sump pit water level monitoring system for the Raspberry Pi. It uses an ultrasonic sensor to continuously measure water depth, logs all readings to a local SQLite database, sends email (email to SMS recommended) or Mastodon alerts if the water reaches a critical level, and provides a built-in web interface for monitoring and administration. --- Features • Continuous water level monitoring at configurable intervals • Email (email to sms recommended) and/or Mastodon alerts when water reaches a critical level • Heartbeat notifications to confirm the system is running • Secure HTTPS web interface (self-signed certificate, nginx + Flask) • Interactive charts with dark mode support • Historical readings with single-day, multi-day, and custom date range views • Admin panel: service control, configuration editor, backup/export, CSV import, support tools • Installed as a standard Debian package — no virtual environment required • systemd services with automatic startup --- Supported Hardware • Raspberry Pi 2, 3, 4, and 5 • Ultrasonic sensors: HC-SR04, JSN-SR04T 2.0 (waterproof). JSN-SR04T 3.0 not recommended. --- Supported OS | OS | Architecture | |---|---| | Raspberry Pi OS 13 (Trixie) | 32-bit and 64-bit | | Raspberry Pi OS 12 (Bookworm) | 32-bit and 64-bit | Raspi-Sump follows the Debian release schedule. Older OS versions are not supported. --- What's New in Version 2.0 Version 2.0 is a complete rewrite: • Installed as a package — no virtual environment, no manual dependency management • SQLite database replaces per-day CSV files • Full HTTPS web interface with dark mode, interactive charts (uPlot), and a mobile-friendly layout • Admin panel with service control, config editor, backup/restore, CSV import/export, and support tools • Persistent admin login with 30-day session cookie • Mastodon DM alerts as an alternative or complement to email • FHS-compliant paths ( , , ) • systemd services for both the monitor and web interface See the changelog for full details. --- Community • **Discord** — discuss and get support from other users. Email alaudet@linuxnorth.org for an invite link. • **Issue tracker** — GitHub Issues --- Disclaimer Raspi-Sump is a passive monitoring tool. It does not control your pump and cannot prevent flooding. There is no warranty. See the license for details. Best practices: • Install a backup pump that triggers at a slightly higher water level than your primary pump • Connect the backup pump to a separate dedicated electrical breaker • Have an alternate power source (generator or battery backup) for extended outages during spring thaw or severe weather • If building a new home, consider lot grading that allows gravity drainage — use a pump and Raspi-Sump as a backup layer --- License Version 2.0 is released under the Apache 2.0 License. --- Contributing Please read the Contributing Guidelines before submitting a pull request. --- Donate Your support is appreciated