Skip to content

Sensor Definitions

This page provides detailed explanations of all sensors, controls, and entities available on the WaterMeterKit. Use this as a reference to understand what each value means and how to use it.

Source Code: View the complete ESPHome configuration on GitHub

Quick Navigation


Water Monitoring

The WaterMeterKit uses a pulse meter to detect water flow via a magnetic sensor that detects the rotating metal plate in your water meter.

📖 ESPHome Documentation: Pulse Meter Sensor

Water Sensors

EntityDescriptionUnit
Water Current UsageCurrent water flow rate. Shows real-time water consumption when tap is running.L/min
Water Total ConsumptionTotal water consumed since device boot. Use this for Energy Dashboard — Home Assistant tracks history even across reboots.

How It Works

  1. Detection: The sensor detects the rotating metal plate in your water meter
  2. Pulse counting: Each rotation = 1 liter of water
  3. Flow calculation: The sensor calculates flow rate based on pulse frequency
  4. LED feedback: Green LED flashes once per liter detected

Important Notes

  • The Water Total Consumption entity resets to 0 after a device reboot, but this is fine for the Energy Dashboard — Home Assistant tracks the total over time
  • Use Water Total Consumption (not Water Meter Total) for the Energy Dashboard
  • The sensor has a 200ms internal filter to debounce false pulses
  • Timeout is set to 2 minutes — flow rate returns to 0 if no pulse detected within this time

Environment Sensors

The WaterMeterKit includes an HDC1080 temperature and humidity sensor for monitoring the environment at the device location.

📖 ESPHome Documentation: HDC1080 Sensor

EntityDescriptionUnit
TemperatureTemperature at the device location. Pre-calibrated with offset.°C
HumidityRelative humidity at the device location. Pre-calibrated with offset.%

Use Cases

  • Monitor temperature in your meter cupboard or cellar
  • Detect humidity issues (potential moisture problems)
  • Set up alerts for extreme temperatures (frost protection)

🔧 Calibration: See Usage Guide — ESPHome Configuration for instructions on adjusting sensor calibration.


Device Controls

Switches

EntityDescription
RestartRestarts the WaterMeterKit. Useful after configuration changes or if the device is unresponsive.

Buttons

EntityDescription
Factory ResetResets the device to factory defaults. Warning: This removes all configuration including WiFi credentials. Disabled by default for safety.

Diagnostic Entities

Version Information

EntityDescription
ESPHome VersionThe ESPHome version running on the device.
Software VersionThe WaterMeterKit firmware version.

Firmware Update

EntityDescription
Firmware UpdateShows available firmware updates. Install directly from Home Assistant.

LED Indicators

The WaterMeterKit has three LED indicators:

LEDBehaviorMeaning
GreenFlashes 1 secondWater pulse detected (1 liter)
RedSolid/flashingStatus LED — flashing indicates not connected to WiFi/Home Assistant
BlueSolidDevice is powered on

Entity Naming Convention

All entities follow this naming pattern:

sensor.watermeterkit_[sensor_name]
binary_sensor.watermeterkit_[sensor_name]
switch.watermeterkit_[switch_name]
button.watermeterkit_[button_name]

If you have multiple WaterMeterKits, the MAC address suffix ensures unique entity IDs.


ESPHome Configuration

For advanced users who want to customize the WaterMeterKit firmware:

🔧 Advanced Configuration: See Usage Guide — ESPHome Configuration for substitutions, sensor calibration, and customization options.


WaterMeterKit vs WaterP1MeterKit

Looking for more features? The WaterP1MeterKit adds:

FeatureWaterMeterKitWaterP1MeterKit
Water monitoring
Temperature & Humidity
P1 energy meter
Gas monitoring
Ethernet/PoE✅ (V2/V3)
Water leak sensor port✅ (V3)

Need Help?