Extra Entities by Product
The SmartHomeShop integration reads the existing ESPHome entities and adds calculated sensors, status sensors and persistent Home Assistant Utility Meter helpers. It does not replace the original hardware measurements.
How to Read This Reference
- Names below are Home Assistant display names. The entity ID can differ when a device or entity has been renamed.
- A display name ending in (CC) identifies an entity created by the SmartHomeShop custom integration.
- A binary sensor is either on or off. It is intended for dashboards, notifications and automation triggers.
- A Utility Meter helper is created on Home Assistant's
utility_meterplatform and resets at the start of its configured period. - Optional source measurements remain unavailable rather than being treated as zero.
Account-wide dynamic-price, schedule and battery entities are not included in the product counts below. See Entities and services for those entities.
P1MeterKit
The P1MeterKit receives fifteen calculated sensors. They use the existing ESPHome power, tariff, returned-energy, gas and phase-current entities.
| Added entity | Unit | What it calculates and what it is useful for |
|---|---|---|
Standby power (CC) |
W | Lowest measured grid consumption between 02:00 and 05:00. Use it to find the home's persistent base load. The latest result is restored after a restart. |
Standby cost per year (CC) |
EUR | Extrapolates standby power over 24 hours and 365 days using the average T1/T2 price. Use it to estimate the annual cost of always-on equipment. |
Month peak (CC) |
kW | Highest quarter-hour average demand in the current month. It uses the DSMR average-demand value where available and otherwise a rolling 15-minute average. |
Energy cost today (CC) |
EUR | Today's imported electricity and gas cost minus the value of returned electricity, based on the configured or connected contract prices. |
Energy cost this month (CC) |
EUR | The same net cost calculation for the current month. |
Highest phase load (CC) |
% | Load on the most heavily used phase as a percentage of the configured main fuse. Phase currents are included as attributes. |
Net grid power (CC) |
W | Grid import minus grid export. A positive value means import; a negative value means export. This is useful for solar-surplus automations. |
Available grid power (CC) |
W | Conservative remaining power on the most heavily loaded phase before reaching the configured main-fuse limit. Use it as a guard before starting a large load. |
Grid import energy (CC) |
kWh | Total imported electricity, tariff 1 plus tariff 2. The Home Assistant Energy setup uses this sensor. |
Grid export energy (CC) |
kWh | Total returned electricity, tariff 1 plus tariff 2. |
Gas consumption (CC) |
m³ | One gas total for Dutch and Belgian meters. Unavailable without a gas meter. |
Energy used today (CC) |
kWh | Imported electricity since the start of the day, from the daily Utility Meters. |
Grid import power (CC) |
W | Live grid import, always in watts. |
Grid export power (CC) |
W | Live grid export, always in watts. |
Phase imbalance (CC) |
A | Difference between the highest and lowest phase current. Needs at least two phases. |
Automatically Created Utility Meters
<device-id> below is replaced by the short ID of the P1MeterKit. Returned-energy entities are only created when their source entities exist. Gas entities appear after the meter reports its first gas reading.
| Added entity | Source and period |
|---|---|
P1 <device-id> Energy Daily T1 (CC) |
Imported electricity, tariff 1, day |
P1 <device-id> Energy Daily T2 (CC) |
Imported electricity, tariff 2, day |
P1 <device-id> Energy Weekly T1 (CC) |
Imported electricity, tariff 1, week |
P1 <device-id> Energy Weekly T2 (CC) |
Imported electricity, tariff 2, week |
P1 <device-id> Energy Monthly T1 (CC) |
Imported electricity, tariff 1, month |
P1 <device-id> Energy Monthly T2 (CC) |
Imported electricity, tariff 2, month |
P1 <device-id> Energy Yearly T1 (CC) |
Imported electricity, tariff 1, year |
P1 <device-id> Energy Yearly T2 (CC) |
Imported electricity, tariff 2, year |
P1 <device-id> Energy Returned Daily T1 (CC) |
Returned electricity, tariff 1, day |
P1 <device-id> Energy Returned Daily T2 (CC) |
Returned electricity, tariff 2, day |
P1 <device-id> Energy Returned Weekly T1 (CC) |
Returned electricity, tariff 1, week |
P1 <device-id> Energy Returned Weekly T2 (CC) |
Returned electricity, tariff 2, week |
P1 <device-id> Energy Returned Monthly T1 (CC) |
Returned electricity, tariff 1, month |
P1 <device-id> Energy Returned Monthly T2 (CC) |
Returned electricity, tariff 2, month |
P1 <device-id> Energy Returned Yearly T1 (CC) |
Returned electricity, tariff 1, year |
P1 <device-id> Energy Returned Yearly T2 (CC) |
Returned electricity, tariff 2, year |
P1 <device-id> Gas Daily (CC) |
Gas, day |
P1 <device-id> Gas Weekly (CC) |
Gas, week |
P1 <device-id> Gas Monthly (CC) |
Gas, month |
P1 <device-id> Gas Yearly (CC) |
Gas, year |
This produces between 8 and 20 Utility Meter entities. They can be used in Home Assistant's Energy Dashboard and survive restarts. An entity may initially be unavailable until its source has a valid reading.
WaterMeterKit
The WaterMeterKit receives twelve calculated water sensors, eight binary status sensors and four Utility Meter helpers. Current flow can come from a dedicated flow entity or be calculated from changes in the total meter reading.
Water and Usage Sensors
| Added entity | Unit | What it calculates and what it is useful for |
|---|---|---|
Water cost today (CC) |
EUR | Today's water use multiplied by the active contract, configured or Home Assistant water price. |
Usage vs 7-day average (CC) |
% | Compares today's use with the learned average daily use after the baseline is ready. Positive means above average. |
Last water session (CC) |
L | Volume of the most recently completed water session. Duration and end time are available as attributes. |
Current water usage (CC) |
L/min | Current flow rate. Use it for live dashboards and flow-based automations. |
Usage today (CC) |
L | Water consumed since the start of the current day. |
Usage this week (CC) |
L | Water consumed since the start of the current ISO week. |
Usage this month (CC) |
L | Water consumed since the start of the current month. |
Usage this year (CC) |
L | Water consumed since the start of the current year. New installations show litres; existing installations keep m³ until you change the unit in the entity settings. |
Leak score (CC) |
% | Combined 0-100 risk score based on continuous flow, night use, microflow, pattern anomalies and deviation from learned use. Its attributes show the contributing scores and likely leak type. |
Leak detection confidence (CC) |
% | Confidence in the smart leak result. Confidence increases as the integration learns more normal-use history. |
Baseline learning days (CC) |
days | Number of days included in the learned water-use baseline, including whether the minimum learning period has been reached. |
Continuous flow duration (CC) |
min | How long water has been flowing continuously. Use it to distinguish a brief use event from a possible ongoing leak. |
Leak and Status Binary Sensors
| Added entity | Turns on when | Typical use |
|---|---|---|
Smart leak detection (CC) |
The combined leak score reaches the configured threshold with sufficient confidence. | Main smart leak notification or shut-off automation trigger. |
Continuous flow leak (CC) |
Flow continues beyond the configured duration. | Detect a running tap, pipe break or appliance that keeps taking water. |
Night usage (CC) |
More than 2 L is used during the configured night window and water keeps coming back in at least four 15-minute slots. | Warn about unexpected overnight consumption. One toilet flush does not trigger it. |
Micro leak (CC) |
A small flow continues long enough to resemble a dripping tap or small leak. | Detect low-volume leaks that may not trigger a high-flow alarm. |
Vacation leak (CC) |
Water flows while the configured vacation-mode entity is on. | Send a high-priority alert while the home should be unoccupied. |
Water flowing (CC) |
Current flow is greater than 0.1 L/min. | Simple live state for dashboards and automations. |
Leak alarm (CC) |
Any smart, continuous, night, micro or vacation leak condition is active. | One combined trigger when the individual leak type is not important. |
Baseline learned (CC) |
The configured minimum number of learning days has been completed. | Prevent baseline-dependent automations from acting too early. |
Automatically Created Utility Meters
<device-id> below is replaced by the short ID of the WaterMeterKit.
| Added entity | Period |
|---|---|
Watermeterkit <device-id> Water Daily (CC) |
Day |
Watermeterkit <device-id> Water Weekly (CC) |
Week |
Watermeterkit <device-id> Water Monthly (CC) |
Month |
Watermeterkit <device-id> Water Yearly (CC) |
Year |
These four entities are separate from the calculated usage sensors and use Home Assistant's Utility Meter integration.
WaterP1MeterKit
The WaterP1MeterKit creates the following 35 product entities. This list is complete and does not rely on the P1MeterKit or WaterMeterKit sections.
Energy and Grid Sensors
| Added entity | Unit | What it does |
|---|---|---|
Standby power (CC) |
W | Tracks the lowest grid consumption measured between 02:00 and 05:00. |
Standby cost per year (CC) |
EUR | Converts standby power into an estimated annual cost using the average T1/T2 price. |
Month peak (CC) |
kW | Tracks the highest quarter-hour average demand in the current month. |
Energy cost today (CC) |
EUR | Calculates today's electricity and gas cost minus the value of returned electricity. |
Energy cost this month (CC) |
EUR | Applies the same net-cost calculation to the current month. |
Highest phase load (CC) |
% | Shows the most heavily loaded phase as a percentage of the configured main fuse. |
Net grid power (CC) |
W | Shows grid import minus grid export; a negative value means export. |
Available grid power (CC) |
W | Estimates the remaining power on the most heavily loaded phase before the fuse limit. |
Grid import energy (CC) |
kWh | Total imported electricity, tariff 1 plus tariff 2. The Home Assistant Energy setup uses this sensor. |
Grid export energy (CC) |
kWh | Total returned electricity, tariff 1 plus tariff 2. |
Gas consumption (CC) |
m³ | One gas total for Dutch and Belgian meters. Unavailable without a gas meter. |
Energy used today (CC) |
kWh | Imported electricity since the start of the day, from the daily Utility Meters. |
Grid import power (CC) |
W | Live grid import, always in watts. |
Grid export power (CC) |
W | Live grid export, always in watts. |
Phase imbalance (CC) |
A | Difference between the highest and lowest phase current. Needs at least two phases. |
Water and Usage Sensors
| Added entity | Unit | What it does |
|---|---|---|
Water cost today (CC) |
EUR | Multiplies today's water use by the active contract or configured water price. |
Usage vs 7-day average (CC) |
% | Compares today's use with the learned average day after the baseline is ready. |
Last water session (CC) |
L | Shows the volume of the most recently completed water session. |
Current water usage (CC) |
L/min | Shows or calculates the current water flow. |
Usage today (CC) |
L | Tracks water consumed since the start of the day. |
Usage this week (CC) |
L | Tracks water consumed since the start of the ISO week. |
Usage this month (CC) |
L | Tracks water consumed since the start of the month. |
Usage this year (CC) |
L | Tracks water consumed since the start of the year. New installations show litres; existing installations keep m³ until you change the unit. |
Leak score (CC) |
% | Combines continuous flow, night use, microflow and learned pattern deviations into a 0-100 risk score. |
Leak detection confidence (CC) |
% | Shows how much learned history supports the current leak result. |
Baseline learning days (CC) |
days | Shows how many days are included in the normal-use baseline. |
Continuous flow duration (CC) |
min | Shows how long water has flowed without stopping. |
Leak and Status Binary Sensors
| Added entity | Turns on when |
|---|---|
Smart leak detection (CC) |
The combined leak score reaches the configured threshold with sufficient confidence. |
Continuous flow leak (CC) |
Water keeps flowing beyond the configured duration. |
Night usage (CC) |
More than 2 L is used during the configured night window and water keeps coming back in at least four 15-minute slots. |
Micro leak (CC) |
A small flow continues long enough to resemble a dripping tap or small leak. |
Vacation leak (CC) |
Water flows while the configured vacation-mode entity is on. |
Water flowing (CC) |
Current flow is greater than 0.1 L/min. |
Leak alarm (CC) |
Any smart, continuous, night, micro or vacation leak condition is active. |
Baseline learned (CC) |
The configured minimum learning period has been completed. |
Automatically Created Utility Meter Entities
<device-id> below is replaced by the short ID of the WaterP1MeterKit. The eight returned-energy entities are only created when a returned or produced-energy source exists. The four gas entities appear after the meter reports its first gas reading.
| Added entity | Source and period |
|---|---|
WaterP1 <device-id> Energy Daily T1 (CC) |
Imported electricity, tariff 1, day |
WaterP1 <device-id> Energy Daily T2 (CC) |
Imported electricity, tariff 2, day |
WaterP1 <device-id> Energy Weekly T1 (CC) |
Imported electricity, tariff 1, week |
WaterP1 <device-id> Energy Weekly T2 (CC) |
Imported electricity, tariff 2, week |
WaterP1 <device-id> Energy Monthly T1 (CC) |
Imported electricity, tariff 1, month |
WaterP1 <device-id> Energy Monthly T2 (CC) |
Imported electricity, tariff 2, month |
WaterP1 <device-id> Energy Yearly T1 (CC) |
Imported electricity, tariff 1, year |
WaterP1 <device-id> Energy Yearly T2 (CC) |
Imported electricity, tariff 2, year |
WaterP1 <device-id> Energy Returned Daily T1 (CC) |
Returned electricity, tariff 1, day |
WaterP1 <device-id> Energy Returned Daily T2 (CC) |
Returned electricity, tariff 2, day |
WaterP1 <device-id> Energy Returned Weekly T1 (CC) |
Returned electricity, tariff 1, week |
WaterP1 <device-id> Energy Returned Weekly T2 (CC) |
Returned electricity, tariff 2, week |
WaterP1 <device-id> Energy Returned Monthly T1 (CC) |
Returned electricity, tariff 1, month |
WaterP1 <device-id> Energy Returned Monthly T2 (CC) |
Returned electricity, tariff 2, month |
WaterP1 <device-id> Energy Returned Yearly T1 (CC) |
Returned electricity, tariff 1, year |
WaterP1 <device-id> Energy Returned Yearly T2 (CC) |
Returned electricity, tariff 2, year |
WaterP1 <device-id> Water Daily (CC) |
Water, day |
WaterP1 <device-id> Water Weekly (CC) |
Water, week |
WaterP1 <device-id> Water Monthly (CC) |
Water, month |
WaterP1 <device-id> Water Yearly (CC) |
Water, year |
WaterP1 <device-id> Gas Daily (CC) |
Gas, day |
WaterP1 <device-id> Gas Weekly (CC) |
Gas, week |
WaterP1 <device-id> Gas Monthly (CC) |
Gas, month |
WaterP1 <device-id> Gas Yearly (CC) |
Gas, year |
This results in 12 standard Utility Meter entities, 16 with gas and up to 24 when returned-energy measurements are also available. The P1 cost entities use these period totals, while the leak entities use the water total and current flow.
WaterFlowKit
The integration handles Flow 1 and Flow 2 of the WaterFlowKit independently. Flow 3 and Flow 4 of a WaterFlowKit V2 stay native ESPHome entities, without leak alarm, Utility Meter helpers or card. It does not add the shared WaterMeterKit sensor set; its detailed session and leak calculations are shown in the SmartHomeShop panel.
| Added entity | What it does |
|---|---|
Flow 1 leak alarm (CC) |
Turns on when line 1's learned leak engine considers a leak likely. Attributes expose leak type, total score and confidence. |
Flow 2 leak alarm (CC) |
The same independent alarm for line 2. |
<device-id> below is replaced by the short ID of the WaterFlowKit. A line's four entities are created when that line has been configured.
| Added entity | Source and period |
|---|---|
WaterFlowKit <device-id> Flow1 Daily |
Line 1, day |
WaterFlowKit <device-id> Flow1 Weekly |
Line 1, week |
WaterFlowKit <device-id> Flow1 Monthly |
Line 1, month |
WaterFlowKit <device-id> Flow1 Yearly |
Line 1, year |
WaterFlowKit <device-id> Flow2 Daily |
Line 2, day |
WaterFlowKit <device-id> Flow2 Weekly |
Line 2, week |
WaterFlowKit <device-id> Flow2 Monthly |
Line 2, month |
WaterFlowKit <device-id> Flow2 Yearly |
Line 2, year |
One configured line therefore adds four Utility Meter entities; two lines add eight. No combined Utility Meter is currently created. These display names intentionally do not end in (CC) in the current integration.
UltimateSensor v1
The UltimateSensor v1 creates these three calculated entities from its available CO2, PM2.5, VOC, temperature and humidity measurements:
| Added entity | What it does |
|---|---|
Room Quality (CC) |
Weighted score from 0 to 10. Missing inputs are excluded and the remaining weights are redistributed. Attributes contain source values, statuses and recommendations. |
Room Quality Label (CC) |
Converts the score to Excellent, Good, Fair, Moderate or Poor. Without a score the entity has no state. |
Room Quality Percentage (CC) |
Converts the Room Quality score to 0-100% for gauges, thresholds and automations. |
Presence, tracking, illuminance, display, media and voice entities remain native ESPHome entities.
UltimateSensor v2
The UltimateSensor v2 creates these three calculated entities from its available CO2, PM2.5, VOC, temperature and humidity measurements:
| Added entity | What it does |
|---|---|
Room Quality (CC) |
Weighted score from 0 to 10. Missing inputs are excluded and the remaining weights are redistributed. Attributes contain source values, statuses and recommendations. |
Room Quality Label (CC) |
Converts the score to Excellent, Good, Fair, Moderate or Poor. Without a score the entity has no state. |
Room Quality Percentage (CC) |
Converts the Room Quality score to 0-100% for gauges, thresholds and automations. |
PIR, mmWave, target, zone, media and voice entities remain native ESPHome entities.
UltimateSensor Mini v1
The UltimateSensor Mini v1 creates these three calculated entities. Each calculation uses only the CO2, PM2.5, VOC, temperature and humidity sources that this hardware and firmware actually expose.
| Added entity | What it does |
|---|---|
Room Quality (CC) |
Weighted score from 0 to 10 using the available air-quality and climate measurements. Missing inputs are excluded rather than treated as zero. |
Room Quality Label (CC) |
Converts the score to Excellent, Good, Fair, Moderate or Poor. Without a score the entity has no state. |
Room Quality Percentage (CC) |
Converts the Room Quality score to 0-100% for gauges, thresholds and automations. |
Native presence, media and voice entities are not duplicated.
UltimateSensor Mini v2
The UltimateSensor Mini v2 creates these three calculated entities. Each calculation uses only the CO2, PM2.5, VOC, temperature and humidity sources that this hardware and firmware actually expose.
| Added entity | What it does |
|---|---|
Room Quality (CC) |
Weighted score from 0 to 10 using the available air-quality and climate measurements. Missing inputs are excluded rather than treated as zero. |
Room Quality Label (CC) |
Converts the score to Excellent, Good, Fair, Moderate or Poor. Without a score the entity has no state. |
Room Quality Percentage (CC) |
Converts the Room Quality score to 0-100% for gauges, thresholds and automations. |
Native presence, media and voice entities are not duplicated.
CeilSense
CeilSense creates these three Room Quality entities from its available climate and air-quality measurements:
| Added entity | What it does |
|---|---|
Room Quality (CC) |
Calculates a 0-10 room score from the available air-quality and climate measurements. The source readings, statuses and recommendations are available as attributes. |
Room Quality Label (CC) |
Converts the score into a readable quality category for cards and notifications. |
Room Quality Percentage (CC) |
Converts the score to 0-100% for gauges and numeric automation thresholds. |
The original CO2, temperature, humidity, presence, target and zone entities remain supplied by ESPHome. The custom integration presents them in its CeilSense card but does not duplicate them.
When an Entity Is Missing or Unavailable
- Confirm that the correct SmartHomeShop product was added to the integration.
- Check that the required source entity exists and has a valid value under Settings > Devices & services > Entities.
- Update both the product firmware and the SmartHomeShop integration.
- Reload the SmartHomeShop config entry.
- For period helpers, wait for the source meter to publish a reading and for Home Assistant to finish creating the Utility Meter config entries.
Entity availability is deliberately conservative: an absent CO2, phase-current, returned-energy or flow reading is not silently replaced with zero. The current implementation can be checked in the SmartHomeShop Home Assistant repository.