Raspi-Sump V2.0 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.
Raspi-Sump User and Install Manual
- 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
- JSON API for external endpoints like Home Assistant
Github user graysky2 has a repo called ha-raspi-sump with instructions for adding Raspi-Sump to Home Assistant. It has been added to the HACS ecosystem and is installable through the HACS tab of Home Assistant.
- Raspberry PiB, Zero2w, Pi 2, 3, 4, and 5
- Ultrasonic sensors: HC-SR04, JSN-SR04T 2.0 (waterproof). JSN-SR04T 3.0 not recommended.
| 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.
| OS | Architecture |
|---|---|
| Arch Linux and Arch Linux ARM | aarch64 and armv7h (unofficial) |
An unofficial port is maintained on the Arch User Repository, which hosts the build file and its required dependencies for running Raspi-Sump on Arch Linux via the unofficial ARM64 port or on Arch Linux ARM. This port is community-maintained and not officially supported here.
Version 2.0 is a complete rewrite:
- Installed as a
.debpackage via apt — 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
- Optional persistent admin login with 30-day session cookie
- Mastodon DM alerts as an alternative or complement to email
- FHS-compliant paths (
/etc/raspi-sump/,/var/log/raspi-sump/,/var/lib/raspi-sump/) - systemd services for both the monitor and web interface
See the changelog for full details.
V1.11.1 is the latest and last version 1 release. Only bug fixes will be applied going forward. Support for v1.11.1 will cease with the debian release cycle and drop of support for Debian 11 - Bullseye on August 31, 2026
The github source code is tagged v1.11.1 at the following url;
https://github.com/alaudet/raspi-sump/tree/legacyV1
- Discord — discuss and get support from other users. Email alaudet@linuxnorth.org for an invite link.
- Issue tracker — GitHub Issues
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
Version 2.0 is released under the Apache 2.0 License.
Please read the Contributing Guidelines before submitting a pull request.