An easy-to-use Home Assistant App that reads pulse counters from an S0PCM-2 or S0PCM-5 device and sends the data to Home Assistant via MQTT.
- Plug & Play: Automatically shows up in Home Assistant (MQTT Discovery).
- Easy Configuration: Rename meters and fix totals directly in Home Assistant - no editing files.
- Reliable: Restores your meter data on restart so you don't lose counts.
- Data Integrity: Sensors automatically report as "Unavailable" when disconnected to prevent stale readings in HA.
- Simple & Clean: No local database files to worry about.
- Secure: Supports MQTT with TLS encryption.
- Instant Issues: Reports connection errors immediately so you know if something is wrong.
- An S0PCM reader (S0PCM-2 or S0PCM-5) connected via USB.
- An MQTT Broker (e.g., the official Mosquitto broker app).
- Add this repository to your Home Assistant App Store:
https://github.com/darkrain-nl/home-assistant-addon-s0pcm-reader - Search for S0PCM Reader and click Install.
- Start the app. By default, it will auto-detect your connected S0PCM USB device. (Optional: To customize settings or manually configure the port, open the Configuration tab).
If you want to help test upcoming features, you can install the Beta version. You can install both the Beta and Stable versions at the same time without conflicts.
Warning
While both apps can be installed simultaneously, only one app can access the USB device at a time. You must stop the Stable version before starting the Beta version, and vice-versa.
- Add the Beta repository to your Home Assistant App Store:
https://github.com/darkrain-nl/home-assistant-addon-s0pcm-reader-beta - Search for S0PCM Reader (Beta) and click Install.
- Go to your Stable S0PCM Reader, Stop it, and disable Start on boot.
- Go to S0PCM Reader (Beta) and click Start (it will auto-detect your USB device by default).
For detailed configuration, advanced settings, and standalone usage (Docker), please refer to the full documentation:
In Home Assistant: Go to the Documentation tab.
On GitHub: View Full Documentation (DOCS.md)
- Configuration Reference
- Home Assistant Integration & Recipes
- Standalone / Docker Usage (available as
ghcr.io/darkrain-nl/s0pcm-reader-standalone) - Troubleshooting
If you want to contribute or modify the code, we have included a test suite and a hardware simulator (socket://).
Check out tests/README.md to see how to run it locally.
If you encounter issues or have suggestions, please open an issue on GitHub.
Inspired by the docker-s0pcm-reader project by @ualex73.