2.1 KiB
| title | description | ha_category | ha_release | ha_iot_class | ha_domain | ha_platforms | ha_integration_type | ||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| StreamLabs | Instructions on how to integrate Streamlabs Water devices with Home Assistant. |
|
0.95 | Cloud Polling | streamlabswater |
|
integration |
The Streamlabs Water integration platform 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.
Configuration
Add the following to your configuration.yaml file:
# Example configuration.yaml entry
streamlabswater:
api_key: YOUR_API_KEY
{% configuration %} api_key: description: Your api_key for the StreamLabs API. required: true type: string location_id: description: A specific monitor to use if you have multiple. By default the first found will be used. required: false type: string {% endconfiguration %}
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. |