Repository navigation
FAQ
Compatibility is unverified beyond one transmitter in Gladstone, QLD, tested with an RTL-SDR Blog V4. Check your transmitter and the tested setup before buying anything. Council name and appearance do not confirm support. A reception test is needed to find out whether your transmitter provides usable pulses. Encrypted messages provide ID and signal information only; NB-IoT models cannot be received.
ha-taggle only receives. It never transmits. See Privacy and legal for the Australian context. It's not legal advice.
No. It's a radio listener. It can't send anything to the meter. Your bill still comes from the utility's own readings. Never touch the utility's equipment.
The transmitter sends about once an hour, so there is no live flow or instant alarm. 0.3.0 includes a Possible leak hint, enabled by default for configured meters. It uses continuous hourly usage or a completed local night window, needs no litre calibration and can be triggered by ordinary use or irrigation. OFF is not proof of no leak.
The transmitter sends a wrapping pulse counter, with an unknown starting offset and unknown litres per pulse. 0.3.0 uses guided dial readings to determine litres per pulse and the starting offset. Two readings separated by enough normal water use may solve both; status asks for another when needed. Until solved, use pulses. See Calibration.
meter_count adds recovered hourly pulse differences, starting with the first two recoverable intervals. It is different from both the wrapping raw radio counter and the physical dial reading. The dial shows a volume accumulated since the meter was installed.
Radio messages can be missed through interference or a busy computer. Each clear message carries enough counters for two intervals, so a later frame can recover a single missed transmission. Longer gaps may remain incomplete. Only unrecovered intervals are omitted; the card shows them as dashed bars.
Don't. Configure only your own ID. Neighbourhood comparison is on by default and publishes group figures. Default logging keeps neighbour IDs out of saved state and MQTT; scans print heard IDs, and explicitly enabling both logging options writes them to private JSONL summaries.
Encrypted messages provide ID and signal information only. The project is receive-only and does not decrypt their contents.
Only to install it. After that it runs locally: radio → your computer → your MQTT broker → Home Assistant.
Usually yes, on a Pi 4 or 5. ha-taggle processes millions of samples per second, so watch CPU load on smaller machines.
Not at the same time. One program owns the USB receiver. Buy a second one.
Put both IDs in meter_ids (if both are yours and in range), then show both on one card.
It is a rough comparison of meters your antenna can hear, not a ranking of household efficiency. Neighbour litres per pulse are unknown; displayed litres use an assumption, and partial days stay partial. See the caveats.
Follow the off-switch instructions for your installation. Disabling collection and restarting the receiver deletes stored neighbour data. Hiding the card row only changes the display.
No. ha-taggle is an unofficial, community project. It's not affiliated with Taggle Systems or any utility.
ha-taggle is experimental, receive-only and unofficial. It is not affiliated with Taggle Systems or any council or utility. Only receive your own meter, and never touch the utility's equipment. All IDs in this wiki are fictional. · Repository · Report an issue · Glossary
Start here
- Home
- Getting started
- Check your meter
- Finding your meter
- Meter types and pulse sizes
- Hardware and antennas
- Tested hardware
Setup
Using it
Reference and optional background
- Entities reference
- Configuration reference
- How it works
- Protocol
- Research and prior art
- Privacy and legal
- Glossary
- AI disclosure
Help