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-23 01:06:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add var descriptions

Browse Source
This commit is contained in:
Fabian Affolter 2016-06-15 08:37:57 +02:00
parent 8d5b0de37d
commit 26b79765ae
1 changed files with 21 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
source/_components/sensor.plex.markdown
View File

@ -9,25 +9,33 @@ sharing: true
footer: true footer: true
logo: plex.png logo: plex.png
ha_category: Sensor 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 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.
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 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.
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 ```yaml
# Example configuration.yaml entry
sensor: sensor:
platform: plex platform: plex
name: Plex Spy *optional, default Plex name: Plex Spy
host: 192.168.1.100 *optional, default localhost host: 192.168.1.100
port: 32400 *optional, default 32400 port: 32400
username: plexuser *optional, use for remote access username: plexuser
password: plexpw *optional, use for remote access password: plexpw
server: MyPlexServer *optional, use for remote access 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.