Plex


The plex platform allows you to connect to a Plex Media Server. Once connected, Plex Clients playing media from the connected Plex Media Server will show up as Media Players in Home Assistant. It will allow you to control media playback and see the current playing item.

There is currently support for the following device types within Home Assistant:

Setup - Media Player

The preferred way to setup the Plex platform is by enabling the discovery component which requires GDM enabled on your Plex server. This can be found on your Plex Web App under Settings > (server Name) > settings > Network and choose “Enable local network discovery (GDM)”.

If your Plex server has local authentication enabled or multiple users defined, Home Assistant requires an authentication token to be entered in the frontend. Press “CONFIGURE” to do it.

To authorize your device, you’ll first need to click here to claim a token.

If your server enforces SSL connections, write “on” or “true” in the “Use SSL” field. If it does not have a valid SSL certificate available but you still want to use it, write “on” or “true” in the “Do not verify SSL” field as well.

You can also enable the plex platform directly by adding the following lines to your configuration.yaml:

# Example configuration.yaml entry
media_player:
  - platform: plex

In the event that discovery does not work (GDM disabled or non-local Plex server), you can manually create a plex.conf file manually and place it in your configuration directory or /config/ if you are running Hass.io. The following is an example of plex.conf:

{"IP_ADDRESS:PORT": {"token": "TOKEN", "ssl": false, "verify": true}}

Configuration Variables

IP_ADDRESS

(string)(Required)IP address of the Plex Media Server.

PORT

(integer)(Required)Port where Plex is listening.

Default value: 32400

TOKEN

(string)(Optional)Only if authentication is required. Set to null (without quotes) otherwise.

ssl

(boolean)(Optional)Whether to use SSL/TLS or not.

Default value: false

verify

(boolean)(Optional)Perform a verification of the certificate. To allow invalid or self-signed SSL certificates set it to false.

Default value: true

Customization

You can customize the Plex component by adding any of the variables below to your configuration:

# Example configuration.yaml entry
media_player:
  - platform: plex
    show_all_controls: false
    use_episode_art: true
    remove_unavailable_clients: true
    client_remove_interval: 600

Configuration Variables

show_all_controls

(boolean)(Optional)Forces all controls to display. Ignores dynamic controls (ex. show volume controls for client A but not for client B) based on detected client capabilities. This option allows you to override this detection if you suspect it to be incorrect.

Default value: false

use_episode_art

(boolean)(Optional)Display TV episode art instead of TV show art.

Default value: false

remove_unavailable_clients

(boolean)(Optional)Remove stale plex clients from UI after interval.

Default value: true

client_remove_interval

(integer)(Optional)How long a client is to be unavailable for before it is cleaned up in seconds.

Default value: 600

Service play_media

Plays a song, playlist, TV episode, or video on a connected client.

Music

Service data attribute Optional Description Example
entity_id no entity_id of the client media_player.theater_plex
media_content_id no Quote escaped JSON with library_name, artist_name, album_name, track_name, shuffle (0 or 1). { \“library_name\” : \“My Music\”, \“artist_name\” : \“Adele\”, \“album_name\” : \“25\”, \“track_name\” : \“hello\”, \“shuffle\”: \“0\” }
media_content_type no Type of media to play, in this case MUSIC MUSIC

Playlist

Service data attribute Optional Description Example
entity_id no entity_id of the client media_player.theater_plex
media_content_id no Quote escaped JSON with playlist_name, shuffle (0 or 1). { \“playlist_name\” : \“The Best of Disco\” \“shuffle\”: \“0\” }
media_content_type no Type of media to play, in this case PLAYLIST PLAYLIST

TV Episode

Service data attribute Optional Description Example
entity_id no entity_id of the client media_player.theater_plex
media_content_id no Quote escaped JSON with library_name, show_name, season_number, episode_number, shuffle (0 or 1). { \“library_name\” : \“Adult TV\”, \“show_name\” : \“Rick and Morty\”, \“season_number\” : 2, \“episode_number\” : 5, \“shuffle\”: \“0\” }
media_content_type no Type of media to play, in this case EPISODE EPISODE

Video

Service data attribute Optional Description Example
entity_id no entity_id of the client media_player.theater_plex
media_content_id no Quote escaped JSON with library_name, video_name, shuffle (0 or 1). { \“library_name\” : \“Adult Movies\”, \“video_name\” : \“Blade\”, \“shuffle\”: \“0\” }
media_content_type no Type of media to play, in this case VIDEO VIDEO

Compatibility

Client Limitations
Any (when all controls disabled) A stop button will appear but is not functional.
Any (when casting) Controlling playback will work but with error logging.
Any (remote client) Controls disabled.
Apple TV (PlexConnect) Controls disabled. Music does not work.
iOS None
NVidia Shield Mute disabled. Volume set below 2 will cause error logging. Controlling playback when the Shield is both a client and a server will work but with error logging
Plex Web None
Tivo Plex App Only play, pause, stop/off controls enabled

Notes

  • At this moment, the Plex platform only supports one Plex Media Server.
  • It is possible to get errors that look like the following.

    ERROR:plexapi:http://192.168.1.10:32400: ('Connection aborted.', BadStatusLine("''",))
    INFO:homeassistant.components.media_player.plex:No server found at: http://192.168.1.10:32400
    

    If this occurs, check the setting Server>Network>Secure connections on your Plex Media Server: if it is set to Preferred or Required, you may need to manually set the ssl and verify booleans in the plex.conf file to, respectively, true and false. See the “Setup” section above for details.

  • Movies must be located under ‘Movies’ section in the Plex library to properly get ‘playing’ state.

Sensor

The plex 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.

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 use the username and password, all servers in that account are monitored.

If you don’t know your token, see Finding your account token / X-Plex-Token.

If you want to enable the plex sensor, add the following lines to your configuration.yaml:

# Example configuration.yaml entry
sensor:
  - platform: plex

Configuration Variables

host

(string)(Optional)The IP address of your Plex server.

Default value: localhost

port

(integer)(Optional)The port of your Plex Server.

Default value: 32400

name

(string)(Optional)Name of the Plex server.

Default value: Plex

username

(string)(Optional)The username for the remote Plex server.

password

(string)(Optional)The password for your given account on the remote Plex server.

server

(string)(Optional)The name of your remote Plex server.

token

(string)(Optional)X-Plex-Token of your remote Plex server.

ssl

(boolean)(Optional)Use HTTPS to connect to Plex server, NOTE: host must not be an IP when this option is enabled.

Default value: false

verify_ssl

(boolean)(Optional)Verify the SSL certificate of your Plex server. You may need to disable this check if your local server enforces secure connections with the default certificate.

Default value: true