Skip to content

wbyoung/watersmart

Repository files navigation

WaterSmart for Home Assistant

HACS Version Downloads Build

This integration pulls data from water utilities that use WaterSmart by VertexOne. It scrapes data from the web interface and provides a few sensors with that data.

Note: data will not be updated frequenly because the water utilities do not always update this data continuously.

Installation

HACS

Installation through HACS is the preferred installation method.

  1. Go to HACS
  2. Click on Integrations
  3. Search for "WaterSmart" and click "Download this Repository with HACS"
  4. Select the version (it will auto select the latest)
  5. Restart Home Assistant then continue to the setup section

Manual Download

  1. Go to the release page and download the watersmart.zip attached to the latest release.
  2. Unpack the file and move the folder it contains called watersmart to the following directory of your Home Assistant configuration: /config/custom_components/.
  3. Restart Home Assistant then continue to the setup section.

Setup

Open your Home Assistant instance and start setting up by following these steps:

  1. Navigate to "Settings" → "Devices & Services"
  2. Click "+ Add Integration"
  3. Search for and select → "UI Lovelace Minimalist"

Or you can use the My Home Assistant Button below.

Add Integration

Follow the instructions to configure the integration.

Configuration Settings

  • Host: The subdomain used to access your water utility information. For instance bendoregon for https://bendoregon.watersmart.com/.
  • Username: Your email address used to log in.
  • Password: Your password used to log in.

Sensors

sensor.watersmart_<host>_most_recent_full_day_usage

Gallons of water used on the most recent full day of data available.

Attributes

  • related: List of related objects with start and gallons covering the day of data.

sensor.watersmart_<host>_most_recent_hour_usage

Gallons of water used on the most recent hour of data available.

Attributes

  • start: The start of the hour of water usage
  • related: List of related objects with start and gallons starting from the most recent hour.

Services

watersmart.get_hourly_history

Fetches hourly water usage. The config_entry value be found using the Services tab in the Developer Tools, selecting the desired entity and then switching to YAML.

Service Data Attributes

  • config_entry: required Config entry to use. Example: 1b4a46c6cba0677bbfb5a8c53e8618b0.
  • cached: Accept data from the integration cache instead of re-fetching. Defaults to false.
  • start: Start time to history. Example: 2024-06-19T19:30:00-07:00.
  • end: End time to history. Example: 2024-06-19T21:30:00-07:00.

Credits

Icon designed by bsd studio.