Skip to content

kdeyev/eyeonwater

Repository files navigation

Home Assistant integration for EyeOnWater

hacs_badge GitHub stars GitHub Release GitHub License Tests

Track your water usage directly in Home Assistant using the EyeOnWater service. This integration imports accurate hourly meter readings into HA's Energy Dashboard — including historical data and optional cost tracking.

Energy Dashboard — water consumption

Key Features

  • Energy Dashboard integration — hourly water consumption statistics with full history
  • Water cost tracking — multiply usage by your unit price for cost statistics
  • Historical data import — backfill days/weeks/months of data on demand
  • Diagnostic sensors — temperature, flow, battery, and signal strength
  • US & Canada support — works with eyeonwater.com and eyeonwater.ca

Quick Start

  1. Add this repository to HACS as a custom integration.
  2. Install EyeOnWater from HACS → restart Home Assistant.
  3. Go to Settings → Devices & Services → Add Integration → EyeOnWater and enter your credentials.
  4. Add the eyeonwater:water_meter_xxxxx statistic to your Energy Dashboard.

See the Installation guide and Configuration guide for detailed steps with screenshots.

📖 Documentation

Guide Description
Installation Install via HACS or manually
Configuration Set up credentials, sensors, and options
Energy Dashboard Add water consumption to HA Energy
Historical Data & Architecture Import past data — how retroactive statistics work
Water Cost Tracking Track water costs in the Energy Dashboard
Upgrading to v2.6 Breaking changes and migration steps
Troubleshooting Common issues and solutions

How It Works

This integration uses Home Assistant's external statistics API to import accurate hourly water data from EyeOnWater under a dedicated eyeonwater: namespace:

Component ID Purpose
Live sensor sensor.water_meter_xxxxx Real-time meter reading
Water statistic eyeonwater:water_meter_xxxxx Energy Dashboard — hourly usage
Cost statistic eyeonwater:water_cost_xxxxx Energy Dashboard — hourly cost

The live sensor has no state_class, so HA does not auto-compile statistics for it — all data flows through external statistics, avoiding the negative-value spikes caused by retroactive imports.

Contributing

See CONTRIBUTING.md for development setup and guidelines.