Flume


The flume sensor will show you the current flume status for the given Device ID.

Flume monitors the real-time status of your home water meter. Allowing the end-user to detect small leaks, gain real-time information on household water consumption, set water goals and budgets, and receive push notifications when suspicious water activities occur.

Configuration

You can find your Client ID and Client Secret under “API Access” on the settings page.

To add Flume to your installation, go to Configuration >> Integrations in the UI, click the button with + sign and from the list of integrations select Flume.

Alternatively, add the following lines to your configuration.yaml file:

# Example configuration.yaml entry
sensor:
  # Flume
  - platform: flume
    username: YOUR_FLUME_USERNAME
    password: YOUR_FLUME_PASSWORD
    client_id: YOUR_FLUME_CLIENT_ID
    client_secret: YOUR_FLUME_CLIENT_SECRET

Configuration Variables

username stringRequired

Your flume user id.

password stringRequired

Your flume password.

client_id stringRequired

Your flume Client ID.

client_secret stringRequired

Your flume Client Secret.

name string(Optional, default: Flume Sensor)

A name to display on the sensor.

Configuration for Binary Sensor

The following YAML creates a binary sensor. This requires the default sensor to be configured successfully.

# Example configuration.yaml entry
binary_sensor:
  - platform: template
    sensors:
      flume_status:
        friendly_name: "Flume Flow Status"
        value_template: >-
          {{ states.sensor.flume_sensor.state != "0" }}