home-assistant.io/source/_integrations/streamlabswater.markdown
Joost Lekkerkerker e5d5c107a8
Add StreamLabs config flow (#30299)
* Add StreamLabs config flow

* Update streamlabswater.markdown
2023-12-27 06:56:50 +01:00

2.0 KiB

title, description, ha_category, ha_release, ha_iot_class, ha_domain, ha_config_flow, ha_platforms, ha_integration_type
title description ha_category ha_release ha_iot_class ha_domain ha_config_flow ha_platforms ha_integration_type
StreamLabs Instructions on how to integrate Streamlabs Water devices with Home Assistant.
Binary sensor
Sensor
0.95 Cloud Polling streamlabswater true
binary_sensor
sensor
integration

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.

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.

{% include integrations/config_flow.md %}

Service set_away_mode

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

Service 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.