SmartHomeShop Docs

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

Entity Description Unit
Current Usage Current water flow rate. Shows real-time water consumption when tap is running. L/min
Total Consumption Total water consumed since device boot. Use this for Energy Dashboard: Home Assistant tracks history even across reboots. m³
Water Meter Total Your absolute meter reading. It survives reboots and OTA updates. m³
Water Meter Initial Value Enter your physical meter reading here once. Found under the device configuration. m³

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 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 Total Consumption (not Water Meter Total) for the Energy Dashboard, because Water Meter Total jumps the moment you enter your meter reading
  • 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. Slow leaks under 0.5 L/min therefore do not show as a steady flow, watch Total Consumption for those

Environment Sensors

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

📖 ESPHome Documentation: HDC1080 Sensor

Entity Description Unit
Temperature Temperature at the device location. Pre-calibrated with offset. °C
Humidity Relative 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

Entity Description
Restart Restarts the WaterMeterKit. Useful after configuration changes or if the device is unresponsive.

Buttons

Entity Description
Factory Reset Resets the device to factory defaults. Warning: This removes all configuration including WiFi credentials and the stored water meter reading. Disabled by default for safety.

Diagnostic Entities

Version Information

Entity Description
ESPHome Version The ESPHome version running on the device.
Software Version The WaterMeterKit firmware version.
Hardware Version The hardware version of your kit (V1, V2 or V3).

Network and System

Entity Description
WiFi Signal WiFi signal strength in dBm.
IP Address Current IP address. Disabled by default on V3.
MAC Address MAC address of the device. Disabled by default on V3.
Connected SSID / Connected BSSID The connected WiFi network (V1 and V2).
Uptime Time the device was last started.
CPU Temperature Internal chip temperature (V3 only).

Cloud Firmware

Entity Description
Cloud Connected On when the last sync with the SmartHomeShop app succeeded.
Cloud Status Text status such as Connected or Registering.
Cloud Device ID The ID you can use to add the device in the app.
Cloud Sync Failures Number of failed syncs in a row.
Reset Cloud Button that clears the cloud registration and registers the device again.

Firmware Update

Entity Description
Firmware Update entity (V3 only). Shows available firmware updates. Install directly from Home Assistant.
Firmware Variant Selector (V3 only): WiFi (local) or WiFi + SmartHomeShop App (cloud). Changing it installs that firmware.

LED Indicators

The WaterMeterKit has three LED indicators:

LED Behavior Meaning
Green Flashes 1 second Water pulse detected (1 liter)
Red Off or flashing Status LED: flashing indicates not connected to WiFi/Home Assistant
Blue Solid Device is powered on

Red status LED: off means all is well. Slow flashing means not connected to WiFi or Home Assistant yet. Rapid flashing means a firmware component reports an error, see Troubleshooting. On V3 cloud firmware it flashes only while the device is offline.

With cloud firmware you also see a short blue flash after each successful sync.

Entity Naming Convention

All entities follow this naming pattern:

sensor.watermeterkit_a1b2c3_watermeterkit_[sensor_name]
switch.watermeterkit_a1b2c3_watermeterkit_[switch_name]
button.watermeterkit_a1b2c3_watermeterkit_[button_name]

a1b2c3 stands for the last six characters of your device's MAC address, so every WaterMeterKit gets its own entity IDs. Always copy the exact ID from the entity in Home Assistant.

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:

Feature WaterMeterKit WaterP1MeterKit
Water monitoring ✅ ✅
Temperature & Humidity ✅ ✅
P1 energy meter ❌ ✅
Gas monitoring ❌ ✅
Ethernet/PoE ❌ ✅ (V2 and later)
Water leak sensor port ❌ ✅ (V3 and V4)

Need Help?