Plex Media Server


The plex integration 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 and report playback status via a Sensor in Home Assistant. The Media Players 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:

If your Plex server has been claimed by a Plex account via the claim interface, Home Assistant will require authentication to connect.

The Plex integration is set up via Configuration -> Integrations. You will be redirected to the Plex website to sign in with your Plex account. Once access is granted, Home Assistant will connect to the server linked to the associated account. If multiple Plex servers are available on the account, you will be prompted to complete the configuration by selecting the desired server on the Integrations page. Home Assistant will show as an authorized device on the Plex Web interface under Settings -> Authorized Devices.

Local and secure connections are preferred when setting up an Integration. After the initial configuration, all connections to your Plex servers are made directly without connecting to Plex’s services.

Integration Options

Several options are provided to adjust the behavior of media_player entities. These can be changed at Plex -> Options on the Integrations page.

Use episode art: Display TV episode art instead of TV show art.

Monitored users: A list of accounts with access to the Plex server. Only selected users will create media_player entities.

Ignore new managed/shared users: Enable to ignore new Plex accounts granted access to the server.

Ignore Plex Web clients: Do not create media_player entities for Plex Web clients.

Manual Configuration

Alternatively, you can manually configure a Plex server connection by selecting the “Configure Plex server manually” when configuring a Plex integration. This option is only available to users in “Advanced Mode”. This will allow you to specify the server connection options which will be validated before setup is completed. The available options are described below:

Host: The IP address or hostname of your Plex server. Optional if ‘Token’ is provided.

Port: The port of your Plex Server.

Use SSL: Use HTTPS to connect to Plex server.

Verify SSL certificate: Verify the SSL certificate of your Plex server. May be used if connecting with an IP or if using a self-signed certificate.

Token: A valid authorization token for your Plex server. If provided without ‘Host’, a connection URL will be retreived from Plex.

Media Player

The plex media_player platform will create Media Player entities for each connected client device. These entities will display media information, playback progress, and playback controls if supported by the device.

By default the Plex integration will create Media Player entities for all local, managed, and shared users on the Plex server. To customize which users or client types to monitor, adjust the “Monitored users”, “Ignore new managed/shared users”, and “Ignore Plex Web clients” options described under Integration Options.

Service play_media

Plays a song, album, artist, playlist, TV show/season/episode, movie, or video on a connected client.

Required fields within the media_content_id payloads are marked as such, others are optional.

Music

Service data attribute Description
entity_id entity_id of the client
media_content_id Quoted JSON containing:
  • library_name (Required)
  • artist_name (Required)
  • album_name
  • track_name
  • track_number
  • shuffle (0 or 1)
media_content_type MUSIC
Examples:
entity_id: media_player.plex_player
media_content_type: MUSIC
media_content_id: '{ "library_name": "Music", "artist_name": "Adele", "album_name": "25", "track_name": "Hello" }'
entity_id: media_player.plex_player
media_content_type: MUSIC
media_content_id: '{ "library_name": "Music", "artist_name": "Stevie Wonder", "shuffle": "1" }'

Playlist

Service data attribute Description
entity_id entity_id of the client
media_content_id Quoted JSON containing:
  • playlist_name (Required)
  • shuffle (0 or 1)
media_content_type PLAYLIST
Example:
entity_id: media_player.plex_player
media_content_type: PLAYLIST
media_content_id: '{ "playlist_name": "The Best of Disco", "shuffle": "1" }'

TV Episode

Service data attribute Description
entity_id entity_id of the client
media_content_id Quoted JSON containing:
  • library_name (Required)
  • show_name (Required)
  • season_number
  • episode_number
  • shuffle (0 or 1)
media_content_type EPISODE
Examples:
entity_id: media_player.plex_player
media_content_type: EPISODE
media_content_id: '{ "library_name": "Adult TV", "show_name": "Rick and Morty", "season_number": 2, "episode_number": 5 }'
entity_id: media_player.plex_player
media_content_type: EPISODE
media_content_id: '{ "library_name": "Kid TV", "show_name": "Sesame Street", "shuffle": "1" }'

Video

Service data attribute Description
entity_id entity_id of the client
media_content_id Quoted JSON containing:
  • library_name (Required)
  • video_name (Required)
media_content_type VIDEO
Example:
entity_id: media_player.plex_player
media_content_type: VIDEO
media_content_id: '{ "library_name": "Adult Movies", "video_name": "Blade" }'

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 None
iOS None
NVidia Shield Controlling playback when the Shield is both a client and a server will work but with error logging
Plex Web None

Notes

  • The plex integration supports multiple Plex servers. Additional connections can be configured under Configuration > Integrations.
  • 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.