SmartHomeShop Docs

Sensor Definitions

This page provides detailed explanations of all sensors, controls, and entities available on the WaterP1MeterKit. 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 WaterP1MeterKit 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
Water Current Usage Current water flow rate. Shows real-time water consumption when tap is running. L/min
Water Total Consumption Total water consumed since device boot. Use this for Energy Dashboard, Home Assistant tracks history even across reboots. m³
Water Meter Initial Value Enter your current physical meter reading here. m³
Water Meter Total Your actual meter reading: the value you entered plus the water measured since. 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 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

DSMR/MBus Digital Water

Belgian digital water meters can be reported by the smart energy meter through DSMR/MBus on the P1 telegram. These entities are disabled by default because most users either use the physical pulse water sensor or do not have digital water data in their P1 telegram.

Entity Description Unit Default
DSMR Water Consumed Digital water consumption reported through DSMR/MBus. Use this as the Energy Dashboard water source if you use Belgian digital water data. m³ Disabled
DSMR Water Equipment ID Equipment ID / serial reference of the digital water meter reported by the smart meter. - Disabled
DSMR Water Device Type Device type reported for the digital water meter. - Disabled
DSMR Water Valve Position Valve position reported by the digital water meter when available. - Disabled

Do not combine water sources: if you use DSMR Water Consumed, do not also add Water Total Consumption for the same physical water meter. Use either DSMR water or pulse water.

The firmware uses water_mbus_id to select the digital water MBus device. The default is 2, which matches many Belgian digital water meter setups.

Energy Monitoring (P1/DSMR)

The WaterP1MeterKit reads data from your smart energy meter via the P1 port using the DSMR (Dutch Smart Meter Requirements) protocol.

📖 ESPHome Documentation: DSMR Component

Energy Consumption

Entity Description Unit
Energy Consumed Tariff 1 Total energy consumed during low tariff (usually night/weekend). Use for Energy Dashboard. kWh
Energy Consumed Tariff 2 Total energy consumed during high tariff (usually daytime). Use for Energy Dashboard. kWh
Power Consumed Current total power being consumed. Real-time power usage. W

Energy Production (Solar)

Entity Description Unit
Energy Produced Tariff 1 Total energy returned to grid during low tariff. Use for Energy Dashboard. kWh
Energy Produced Tariff 2 Total energy returned to grid during high tariff. Use for Energy Dashboard. kWh
Power Produced Current power being returned to grid. Real-time solar/battery export. W

Voltage Monitoring

Entity Description Unit
Voltage Phase 1 Current voltage on phase L1. Normal range: 220-240V. V
Voltage Phase 2 Current voltage on phase L2 (3-phase only). V
Voltage Phase 3 Current voltage on phase L3 (3-phase only). V

Current Monitoring

Entity Description Unit
Current Phase 1 Current amperage on phase L1. A
Current Phase 2 Current amperage on phase L2 (3-phase only). A
Current Phase 3 Current amperage on phase L3 (3-phase only). A

Per-Phase Power

Entity Description Unit
Power Consumed Phase 1/2/3 Power consumption per individual phase. Useful for load balancing. W
Power Produced Phase 1/2/3 Power production (feed-back) per individual phase. W

Electricity Quality (Advanced)

These sensors help monitor the quality of your electricity supply:

Entity Description
Electricity Failures Total number of power failures recorded by the meter.
Electricity Long Failures Total number of long (>3 min) power failures.
Voltage Sags Phase 1/2/3 Number of voltage dips (brownouts) per phase.
Voltage Swells Phase 1/2/3 Number of voltage surges per phase.

Tariff Information

Entity Description
Electricity Tariff Current active tariff as the meter sends it: 0001 = low tariff, 0002 = normal tariff. On Belgian meters the two are swapped. Useful for automations to run appliances during cheap hours.

Belgium-Specific Sensors

These sensors are disabled by default but can be enabled for Belgian meters:

Entity Description
Gas Consumed Belgium Gas consumption for Belgian meters (different protocol).
DSMR Water Consumed Belgian digital water consumption via DSMR/MBus. Disabled by default; enable only if needed.
Current Average Demand Active energy import average demand.
Maximum Demand Current Month Peak demand this month (for capacity tariff).
Maximum Demand Last 13 Months Peak demand over last 13 months.

Luxembourg-Specific Sensors

Entity Description
Energy Consumed Luxembourg Energy consumption for Luxembourg meters.
Energy Produced Luxembourg Energy production for Luxembourg meters.

Gas Monitoring

Gas consumption is read via the P1 port from the gas meter connected to your smart meter.

Entity Description Unit
Gas Consumed Total gas consumption. Updated approximately every hour by most meters. Use for Energy Dashboard. m³

Gas/MBus Diagnostics

These diagnostic entities are disabled by default. Enable them only when you need to inspect what the smart meter reports for the connected MBus gas device.

Entity Description Default
DSMR Gas Device Type Device type reported for the gas MBus device. Disabled
DSMR Gas Valve Position Valve position reported by the gas meter when available. Disabled
DSMR Gas Equipment ID Belgium Belgian equipment ID / serial reference for the gas MBus device. Disabled

Gas MBus Configuration

The gas meter communicates via MBus protocol. By default, MBus ID is set to 1. If your gas meter doesn't show data, you may need to change this to 2, 3, or 4.

⚠️ Gas not showing? See Usage Guide: Gas and Water MBus Configuration for step-by-step instructions on changing the MBus ID.

Environment Sensors

The WaterP1MeterKit 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 -4.5°C offset. °C
Humidity Relative humidity at the device location. Pre-calibrated with +12% offset. %

Use Cases

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

Water Leak Sensor (V3/V4)

The WaterP1MeterKit V3 and V4 include an expansion port for an optional water leak sensor.

Entity Description States
Water Leak Sensor Detects presence of water at the sensor location. on = water detected, off = dry

Features

  • Debounced detection: 100ms delay before triggering on, 2s delay before returning to off
  • Device class: moisture. Integrates with Home Assistant's water leak cards and automations

💡 Automation examples: See Usage Guide: Water Leak Automations for alert and shut-off valve automations.

Device Controls

Switches

Entity Description
Restart Restarts the WaterP1MeterKit. 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. Disabled by default for safety.

Selectors

Entity Description Options
Firmware Variant Selects which firmware variant the device installs and uses for OTA updates. WiFi (local), Ethernet (local), WiFi + SmartHomeShop App (cloud), Ethernet + SmartHomeShop App (cloud)

How Firmware Variant Works

The Firmware Variant selector determines which firmware the device downloads during OTA updates. On WiFi firmware the device installs a newly chosen variant by itself:

  1. WiFi (local) (default): smarthomeshop.github.io/waterp1meterkit/waterp1meterkit-vX-wifi-manifest.json
  2. Ethernet (local): smarthomeshop.github.io/waterp1meterkit/waterp1meterkit-vX-ethernet-manifest.json
  3. WiFi + SmartHomeShop App (cloud): smarthomeshop.github.io/waterp1meterkit/waterp1meterkit-vX-wifi-cloud-manifest.json
  4. Ethernet + SmartHomeShop App (cloud): smarthomeshop.github.io/waterp1meterkit/waterp1meterkit-vX-ethernet-cloud-manifest.json

⚠️ Important: Changing from WiFi to Ethernet via this selector requires an active Ethernet cable connected. WiFi stops immediately when Ethernet firmware is installed!

Diagnostic Entities

Version Information

Entity Description
ESPHome Version The ESPHome version running on the device.
Software Version The WaterP1MeterKit firmware version (e.g., "1.4").
Hardware Version The hardware version (V1, V2, V3, or V4).

P1 Meter Information

Entity Description
Identification Your smart meter's identification string.
Version The DSMR/ESMR protocol version of your meter.
Gas Equipment ID The serial number of your gas meter (if connected). Disabled by default.

Firmware Update

Entity Description
WaterP1MeterKit Firmware Shows available firmware updates. Install directly from Home Assistant.

Connection and System

Entity Description
WiFi Signal WiFi signal strength (WiFi firmware).
IP Address Current IP address of the device.
Connected SSID / Connected BSSID WiFi network and access point the device is connected to (WiFi firmware).
MAC Address MAC address of the device.
Uptime Time since the last restart. Helps to tell device restarts from API reconnects.
CPU Temperature Temperature of the chip, for diagnostics.

SmartHomeShop Cloud (cloud firmware only)

Entity Description
Cloud Status Current cloud status, for example Connected.
Cloud Connected On when the device is registered and the last sync succeeded.
Cloud Device ID The ID you use to add the device in the app when discovery does not find it.
Cloud Sync Failures Number of failed syncs.
Reset Cloud Button that clears the cloud registration on the device.

LED Indicators

The WaterP1MeterKit has three LED indicators:

LED Behavior Meaning
Green Flashes 1 second Water pulse detected (1 liter)
Red Solid/flashing Status LED: flashing indicates not connected to WiFi/Home Assistant
Red (V4), white (V2/V3), blue (V1) Solid Power LED: device is powered on

Entity Naming Convention

All entities follow this naming pattern. The kit adds its MAC suffix (here a1b2c3) to the name, so you can use several kits side by side:

sensor.waterp1meterkit_a1b2c3_[sensor_name]
binary_sensor.waterp1meterkit_a1b2c3_[sensor_name]
switch.waterp1meterkit_a1b2c3_[switch_name]
select.waterp1meterkit_a1b2c3_[select_name]
button.waterp1meterkit_a1b2c3_[button_name]

ESPHome Configuration

For advanced users who want to customize their WaterP1MeterKit firmware:

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

Need Help?