Home Assistant Home Assistant

Tautulli

The tautulli sensor platform will monitor activity on a given Tautulli Server. 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:

  • LAN bandwidth
  • Number of direct plays
  • Number of direct streams
  • Stream count
  • Top Movie
  • Top TV Show
  • Top User
  • Total bandwidth
  • Transcode count
  • 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:

# Example configuration.yaml entry
sensor:
  - platform: tautulli
    api_key: TAUTULLI_API_KEY
    host: TAUTULLI_HOST

Configuration Variables

api_key string Required

The API key for your Tautulli server.

host string Required

The DNS name or IP Address of the server running Tautulli.

port integer (Optional, default: 8181)

The port of your Tautulli server.

path string (Optional)

The Base URL path of your Tautulli server.

ssl boolean (Optional, default: false)

Use HTTPS to connect to Tautulli server. NOTE A host cannot be an IP address when this option is enabled.

monitored_users list (Optional)

A list of Tautulli users you want to monitor, if not set this will monitor all users.

monitored_conditions list (Optional)

A list of attributes to expose for each Tautulli user you monitor, every key in the session [section here][tautulliapi] can be used.

Full example for the configuration

# 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