2024.12.5
Home ▸ Integrations ▸

StreamLabs

The StreamLabs Water integration is used to interact with StreamLabs water monitoring devices in order to retrieve usage information and manage the away mode of the device. The StreamLabs Water API is used to retrieve daily, monthly, and yearly water usage along with the current away mode.

Important

Access to the StreamLabs Water API is not free, you must have a StreamPlus™ subscription level that enables API access. Visit https://streamlabswater.com/subscription for more information.

There is currently support for the following device types within Home Assistant:

  • Binary sensor
  • Sensor

In preparation for using this integration you will need to request an API key following the instructions in the StreamLabs API Getting Started Section. Be sure to request an API key and not an OAuth token.

Configuration

To add the StreamLabs integration to your Home Assistant instance, use this My button:

Manual configuration steps

If the above My button doesn’t work, you can also perform the following steps manually:

  • Browse to your Home Assistant instance.

  • Go to Settings > Devices & Services.

  • In the bottom right corner, select the Add Integration button.

  • From the list, select StreamLabs.

  • Follow the instructions on screen to complete the setup.

Action set_away_mode

You can use the streamlabswater.set_away_mode action to set the mode to home or away. The away mode will only be changed for the configured location.

Data attribute Optional Description
away_mode no String, must be away or home.
location_id yes String, location id to change away mode for. Defaults to first available location.