From 26b79765ae5fc4c672b50b5fd78319588e983491 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Wed, 15 Jun 2016 08:37:57 +0200 Subject: [PATCH] Add var descriptions --- source/_components/sensor.plex.markdown | 34 +++++++++++++++---------- 1 file changed, 21 insertions(+), 13 deletions(-) diff --git a/source/_components/sensor.plex.markdown b/source/_components/sensor.plex.markdown index e4d5be77a7f..daf62cad8b7 100644 --- a/source/_components/sensor.plex.markdown +++ b/source/_components/sensor.plex.markdown @@ -9,25 +9,33 @@ sharing: true footer: true logo: plex.png ha_category: Sensor -ha_release: 0.21 +ha_release: 0.22 --- -This sensor platform will monitor activity on a given Plex Media Server. It will create a sensor that shows the number of -currently watching users as the state. If you click the sensor for more details it will show you who is watching what. +The `plex` sensor platform will monitor activity on a given [Plex Media Server](https://plex.tv/). It will create a sensor that shows the number of currently watching users as the state. If you click the sensor for more details it will show you who is watching what. -If your plex server is on the same local network as Home Assistant, all you need to provide in the configuration.yaml -is the host or ip address. If you want to access a remote plex server, you must provide the plex username, password, -and optionally the server name of the remote plex server. If no server name is given it will use the first server listed. +If your Plex server is on the same local network as Home Assistant, all you need to provide in the `configuration.yaml` is the host or IP address. If you want to access a remote Plex server, you must provide the Plex username, password, and optionally the server name of the remote Plex server. If no server name is given it will use the first server listed. + +If you want to enable the plex sensor, add the following lines to your `configuration.yaml`: -Example Configuration: ```yaml +# Example configuration.yaml entry sensor: platform: plex - name: Plex Spy *optional, default Plex - host: 192.168.1.100 *optional, default localhost - port: 32400 *optional, default 32400 - username: plexuser *optional, use for remote access - password: plexpw *optional, use for remote access - server: MyPlexServer *optional, use for remote access + name: Plex Spy + host: 192.168.1.100 + port: 32400 + username: plexuser + password: plexpw + server: MyPlexServer ``` +Configuration variables: + +- **host** (*Optional*): The IP address of your Plex server. Defaults to `localhost`. +- **port** (*Optional*): The port of your Plex Server. Defaults to 32400. +- **name** (*Optional*): Name of the Plex server. Defaults to Plex. +- **username** (*Optional*): The username for the remote Plex server. +- **password** (*Optional*): The password for your given account on the remote Plex server. +- **server** (*Optional*): The name of your remote Plex server. +