{"id":24910633,"url":"https://github.com/archinamon/ha-esp-flowmeter","last_synced_at":"2026-04-14T06:03:03.148Z","repository":{"id":271708693,"uuid":"914325868","full_name":"Archinamon/ha-esp-flowmeter","owner":"Archinamon","description":"Intelligent flowmeter for Home Assistant based on ESP8266","archived":false,"fork":false,"pushed_at":"2025-01-09T15:04:13.000Z","size":2956,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-08-26T00:34:59.004Z","etag":null,"topics":["arduino","esp8266","esp8266-arduino","esp8266-firmware","esp8266mqtt","esp8266wifi","flow-meter","flowmeter","home-assistant","homeassistant","homeassistant-sensor"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Archinamon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-01-09T11:30:04.000Z","updated_at":"2025-01-14T16:07:19.000Z","dependencies_parsed_at":"2025-01-09T12:40:30.380Z","dependency_job_id":"cb0a169d-cf32-49a7-8d32-6ebfc1914bf8","html_url":"https://github.com/Archinamon/ha-esp-flowmeter","commit_stats":null,"previous_names":["archinamon/ha-esp-flowmeter"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Archinamon/ha-esp-flowmeter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Archinamon%2Fha-esp-flowmeter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Archinamon%2Fha-esp-flowmeter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Archinamon%2Fha-esp-flowmeter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Archinamon%2Fha-esp-flowmeter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Archinamon","download_url":"https://codeload.github.com/Archinamon/ha-esp-flowmeter/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Archinamon%2Fha-esp-flowmeter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31784255,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-14T02:24:21.117Z","status":"ssl_error","status_checked_at":"2026-04-14T02:24:20.627Z","response_time":153,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["arduino","esp8266","esp8266-arduino","esp8266-firmware","esp8266mqtt","esp8266wifi","flow-meter","flowmeter","home-assistant","homeassistant","homeassistant-sensor"],"created_at":"2025-02-02T03:37:41.623Z","updated_at":"2026-04-14T06:03:03.118Z","avatar_url":"https://github.com/Archinamon.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# IoT Water Flow Sensor Project\n\n## Overview\n\nThis project is an IoT-based water flow monitoring and control system powered by an ESP8266 NodeMCU. The system provides real-time monitoring of water consumption, pump current readings, and pump control capabilities, fully integrated with Home Assistant (HA).\n\n## Features\n\n- **Real-time Water Flow Measurement**: Tracks water flow using the FL-408 impeller pulse sensor and sends data to Home Assistant.\n- **Pump Current Monitoring**: Measures pump current using an ACS712-30 shunt sensor to ensure accurate status readings.\n- **Pump Control**: Controls the water pump via an SRD-05VDC-SL-C relay with full control accessible through Home Assistant.\n- **Dry-Run Protection**: Detects dry running of the pump and automatically shuts it down to prevent damage.\n- **Home Assistant Auto-Integration**: Automatically registers the device via MQTT Discovery messages, including sensors and control buttons, with Home Assistant.\n- **Over-the-Air (OTA) Firmware Updates**: Supports seamless firmware updates over Wi-Fi.\n\n## Components\n\n- **FL-408 Impeller Pulse Sensor**: Measures water flow rate in real time.\n- **SRD-05VDC-SL-C Relay**: Controls the water pump.\n- **KY-012 Buzzer**: Provides audible alerts for pump issues such as dry runs.\n- **ACS712-30 Shunt Sensor**: Monitors the pump's electrical current.\n- **PW821 Power Module**: Supplies stable power to the ESP8266 and other components.\n- **ESP8266 NodeMCU v1**: The core microcontroller handling sensor data, pump control, and communication with Home Assistant.\n\n## Installation and Setup\n\n![principal diagram](flowmeter_circuit_scheme.png)\n\n1. **Hardware Assembly**:\n\n   - Connect the FL-408 sensor to the ESP8266 for water flow readings.\n   - Wire the ACS712-30 sensor to measure the pump’s current.\n   - Connect the SRD-05VDC-SL-C relay for pump control.\n   - Attach the KY-012 buzzer for alerts.\n   - Use the PW821 power module to power the ESP8266 and connected components.\n\n2. **Firmware Installation**:\n\n   - Install additional library to work with the shunt sensor — https://github.com/RobTillaart/ACS712/\n   - Install additional library for timer tickers — https://github.com/natnqweb/Simpletimer\n   - Flash the ESP8266 with the provided firmware using the Arduino IDE or similar tools.\n   - Configure the firmware for Wi-Fi and Home Assistant integration (MQTT Broker IP-address and username/password).\n\n3. **Home Assistant Integration**:\n\n   - Upon powering up, the device will auto-register with Home Assistant.\n   - Add the sensors and controls to your Home Assistant dashboard.\n\n4. **OTA Updates**:\n\n   - Use the built-in OTA feature to update firmware without physical access.\n   - Access \u003cip-address_of_devices\u003e:88/firmware to upload the firmware updates.\n   - Access \u003cip-address_of_devices\u003e:88/restart to reboot the device remotely.\n\n## Usage\n\n- Monitor water flow and pump status in real time via the Home Assistant dashboard.\n- Control the pump directly from Home Assistant or through physical buttons connected to the device.\n- Receive alerts and automatic pump shutdowns in case of dry runs.\n\n## Safety and Maintenance\n\n- Ensure all electrical connections are insulated and secure.\n- Periodically check the sensors and relay for proper functioning.\n- Use OTA updates to keep the firmware up to date with the latest features and fixes.\n\n## Contributions\n\nFeel free to contribute to this project by submitting issues, feature requests, or pull requests on the GitHub repository.\n\n## License\n\nThis project is licensed under the MIT License. See the LICENSE file for details.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farchinamon%2Fha-esp-flowmeter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farchinamon%2Fha-esp-flowmeter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farchinamon%2Fha-esp-flowmeter/lists"}