Add config flow to tautulli docs (#19705)

* Add config flow to tautulli docs

* tweak

* Update source/_integrations/tautulli.markdown

Co-authored-by: Joakim Sørensen <hi@ludeeus.dev>

Co-authored-by: Joakim Sørensen <hi@ludeeus.dev>
This commit is contained in:
Robert Hillis 2022-04-26 19:37:34 -04:00 committed by GitHub
parent 149eb34231
commit ab4b8e92d3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -3,17 +3,27 @@ title: Tautulli
description: Instructions on how to set up Tautulli sensors in Home Assistant. description: Instructions on how to set up Tautulli sensors in Home Assistant.
ha_category: ha_category:
- Sensor - Sensor
ha_config_flow: true
ha_release: 0.82 ha_release: 0.82
ha_iot_class: Local Polling ha_iot_class: Local Polling
ha_codeowners: ha_codeowners:
- '@ludeeus' - '@ludeeus'
- '@tkdrob'
ha_domain: tautulli ha_domain: tautulli
ha_platforms: ha_platforms:
- sensor - sensor
ha_integration_type: integration ha_integration_type: integration
--- ---
The `tautulli` sensor platform will monitor activity on a given [Tautulli Server][tautulli]. It will create a sensor that shows the number of currently active streams as the state. If you click the sensor for more details it will show you more statistics, the following stats are available by default: The Tautulli integration will monitor activity on a given [Tautulli Server][tautulli]. It will create a sensor that shows the number of currently active streams as the state. If you click the sensor for more details, it will show you more statistics.
## Setup
To find your `api_key`, open the Tautulli web interface and navigate to `Settings` and then to `Web interface`. The `api_key` will be at the bottom of that page.
{% include integrations/config_flow.md %}
The following stats are available by default:
- LAN bandwidth - LAN bandwidth
- Number of direct plays - Number of direct plays
@ -26,71 +36,4 @@ The `tautulli` sensor platform will monitor activity on a given [Tautulli Server
- Transcode count - Transcode count
- WAN bandwidth - WAN bandwidth
More user statistics can be added with the `monitored_conditions` configuration option, this will add one attribute per user in addition to the users current `activity`.
## Setup
To find your `api_key` open the Tautulli web interface and navigate to `Settings` and then to `Web interface`, the `api_key` will be at the bottom of that page.
## Configuration
If you want to enable this sensor, add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
sensor:
- platform: tautulli
api_key: TAUTULLI_API_KEY
host: TAUTULLI_HOST
```
{% configuration %}
api_key:
description: The API key for your Tautulli server.
required: true
type: string
host:
description: The DNS name or IP Address of the server running Tautulli.
required: true
type: string
port:
description: The port of your Tautulli server.
required: false
default: 8181
type: integer
path:
description: The Base URL path of your Tautulli server.
required: false
type: string
ssl:
description: Use HTTPS to connect to Tautulli server. *NOTE* A host *cannot* be an IP address when this option is enabled.
required: false
default: false
type: boolean
monitored_users:
description: A list of Tautulli users you want to monitor, if not set this will monitor **all** users.
required: false
type: list
monitored_conditions:
description: A list of attributes to expose for each Tautulli user you monitor, every key in the `session` [section here](https://github.com/Tautulli/Tautulli/wiki/Tautulli-API-Reference#get_activity) can be used.
required: false
type: list
{% endconfiguration %}
## Full example for the configuration
```yaml
# Example configuration.yaml entry
sensor:
- platform: tautulli
api_key: TAUTULLI_API_KEY
host: TAUTULLI_HOST
monitored_users:
- USER_1
- USER_2
monitored_conditions:
- ATTRIBUTE_1
- ATTRIBUTE_2
```
[tautulli]: https://tautulli.com [tautulli]: https://tautulli.com