jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-18 23:06:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add StreamLabs config flow (#30299)

Browse Source 
* Add StreamLabs config flow

* Update streamlabswater.markdown
This commit is contained in:
Joost Lekkerkerker 2023-12-27 06:56:50 +01:00 committed by GitHub
parent 56d731fc08
commit e5d5c107a8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
source/_integrations/streamlabswater.markdown
View File

@ -7,13 +7,14 @@ ha_category:
ha_release: '0.95'
ha_iot_class: Cloud Polling
ha_domain: streamlabswater
ha_config_flow: true
ha_platforms:
- binary_sensor
- sensor
ha_integration_type: integration
---
The `Streamlabs Water` integration platform is used to interact with [StreamLabs water monitoring devices](https://www.streamlabswater.com/) in order to retrieve usage information and manage the away mode of the device. The [StreamLabs Water API](https://developer.streamlabswater.com) is used to retrieve daily, monthly, and yearly water usage along with the current away mode.
The StreamLabs Water integration is used to interact with [StreamLabs water monitoring devices](https://www.streamlabswater.com/) in order to retrieve usage information and manage the away mode of the device. The [StreamLabs Water API](https://developer.streamlabswater.com) is used to retrieve daily, monthly, and yearly water usage along with the current away mode.
<div class='note'>
@ -28,31 +29,13 @@ There is currently support for the following device types within Home Assistant:
In preparation for using this integration you will need to request an API key following the instructions in the [StreamLabs API Getting Started Section](https://developer.streamlabswater.com/docs/getting-started.html). Be sure to request an API key and not an OAuth token.
## Configuration
Add the following to your `configuration.yaml` file:
```yaml
# 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 %}
{% 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`.
|------------------------|----------|------------------------------------------------------------------------------------|
| `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. |