Skip to content

rsnodgrass/hass-flo-water

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

86 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Flo by Moen Water Monitor for Home Assistant

Support for Flo Smart water monitoring and control device for Home Assistant. Flo is typically installed on the main water supply line and has sensors for flow rate, pressure, and temperature as well as shut off capabilities. Water shut off can be done manually, remotely, as well as automatically by Flo's emergency monitoring service when a leak is detected.

release_badge release_date License hacs_badge

Buy Me A Coffee Donate

THIS WILL BE DEPRECATED JANUARY 1, 2021

The time has come to deprecate this integration as Home Assistant 115.0 that will be released September 17, 2020 will finally have a native Flo by Moen integration.

You can still buy your Flo by Moen device direct!

IMPORTANT NOTES

  • FLO DOESN'T PROVIDE ANY OFFICIALLY SUPPORTED API, THUS THEIR CHANGES MAY BREAK HASS INTEGRATIONS AT ANY TIME.
  • Version 3.x is a BREAKING CHANGE and requires specifying email key instead of username (if you manually configure through configuration.yaml)

Features

  • sensors:
    • water flow rate (gpm)
    • water pressure (psi)
    • water temperature (°F)
    • water consumption (g) - daily
  • services:
    • turn valve on/off
    • set monitoring mode (home, away, sleep)
    • run health test
  • multiple Flo devices at single location
  • multiple locations with Flo devices and ability to restrict locations (for users with multiple houses or locations)
  • reduced polling of Flo webservice to avoid unintentional DDoS

Support

Visit the Home Assistant community if you need help with installation and configuration of Flo.

Installation

Versions

The 'master' branch of this custom component is considered unstable, alpha quality and not guaranteed to work. Please make sure to use one of the official release branches when installing using HACS, see what has changed in each version.

Step 1: Install Custom Components

Make sure that Home Assistant Community Store (HACS) is setup, then add the "Integration" repository: rsnodgrass/hass-flo-water.

Step 2: Configuration

DO NOT MANUALLY CONFIGURE SENSORS/SWITCHES, ONLY CONFIGURE USING flo: AS BELOW. Configuration flow UI is being added in version 3.0 of this integration.

Example configuration:

flo:
  email: your@email.com
  password: your_flo_password

The following is an advanced configuration to limit sensors to a single location (if multiple houses on a single account). The location_id can be found by turning logging to DEBUG for pyflowater component, or installing pyflowater and running the example-client.py script to show all information about your Flo devices.

flo:
  email: your@email.com
  password: your_flo_password
  locations:
    - d6b2822a-f2ce-44b0-bbe2-3600a095d494

Alternative: Configure via UI

THE UI CONFIGURATION IS CURRENTLY DISABLED

Version 3.0 added the ability to configure credentials for Flo through the Home Assistant UI. Go to Configuration -> Integrations and click the + symbol to configure. Search for Flo and enter your username and password.

Flo Lovelace Examples Flo Lovelace Examples

Step 3: Add Lovelace Card

The following is a simplest Lovelace card which shows data from the Flo sensors (adjust as needed to use your own entity_id names):

type: entities
entities:
  - entity: sensor.water_flow_rate
  - entity: sensor.water_pressure
  - entity: sensor.water_temperature
  - entity: sensor.daily_water_consumption
  - entity: sensor.flo_monitoring_mode

Flo Lovelace Examples

Alternative Lovelace example with gauges that turn colors when pressure or flow rate is high:

cards:
  - type: gauge
    name: Flow
    entity: sensor.water_flow_rate
    severity:
      green: 0
      yellow: 10
      red: 12
  - type: gauge
    name: Pressure
    entity: sensor.water_pressure
    severity:
      green: 0
      yellow: 70
      red: 90
  - type: gauge
    name: Temp
    entity: sensor.water_temperature
type: horizontal-stack

More complex cards can be created, for example the following shows both the basic entities card as well as a card built with mini-graph-card (see flo/lovelace/ folder for example cards):

Flo Lovelace Examples

See Also

Known Issues

  • Flo has removed the water temperature reading as of June 2020; this is no longer available (replaced by "area temp" which is not exposed through any known API at this time)

Feature Requests

  • support metric unit system (liter, C, kPa)
  • merge turn on/off, mode, and current status into a single entity
  • auto-create a pressure sensor for status of water flow (Ok, Warning, Critical)

Other ideas (no plans to add currently):

  • support leak detection sensitivity settings (all, small, bigger, biggest)
  • support FloSense alerts (leaks detected)
  • support Flo's fixtures beta feature breaking down usage by type (e.g. toilets, appliances, faucet, irrigation, etc)
  • leak detection sensitivity setting

Automation Ideas

  • automatically turn on Away mode for water control system when house goes into Away mode (and vice-a-versa)
  • pre-warm heated towel rack when shower flow rate is detected
  • toilet flush detection as an occupancy sensor (e.g. disable Away modes)