Plex component to feed the Upcoming Media Card for Home Assistant.
Branch: master
Clone or download
Latest commit 13e8e8d Jan 16, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE Update issue templates Jan 16, 2019
custom_components/sensor Bump Jan 9, 2019
LICENSE Initial commit Oct 31, 2018
README.md Artist & photo would result it error, remove from example Jan 9, 2019

README.md

Plex Recently Added Component

Home Assistant component to feed Upcoming Media Card with Plex's recently added media.
This component does not require, nor conflict with, the default Plex components.

Buy me a coffeeIf you feel I deserve it, you can buy me a coffee

If you're having issues, check out the troubleshooting guide before posting an issue or asking for help on the forums.

Installation:

  1. Install this component by copying to your /custom_components/sensor/ folder.
  2. Install the card: Upcoming Media Card
  3. Add the code to your configuration.yaml using the config options below.
  4. Add the code for the card to your ui-lovelace.yaml.
  5. You will need to restart after installation for the component to start working.

Options

key default required description
token yes Your Plex token (Find your Plex token)
host localhost Required if server_name not used The host Plex is running on (Not required if Plex is accessable outside your network and server_name is used).
port 32400 Required if server_name not used The port Plex is running on (Not required if Plex is accessable outside your network and server_name is used).
server_name Required if host & port aren't used The name of your Plex server. Can be found in Plex's server settings in "General".
ssl false no Set to true if you use SSL to access Plex.
max 5 no Max number of items to show in sensor.
download_images true no Setting this to false will turn off downloading of images, but will require certain Plex settings to work. See below.
img_dir '/custom-lovelace/upcoming-media-card/images/plex/' no This option allows you to choose a custom directory to store images in if you enable download_images.
ssl_cert false no If you provide your own SSL certificate in Plex's network settings set this to true.
section_types movie, show no Allows you to specify which section types to consider [movie, show].

By default this addon automatically downloads images from Plex to your /www/custom-lovelace/upcoming-media-card/ directory. The directory is automatically created & only images reported in the upcoming list are downloaded. Images are small in size and are removed automatically when no longer needed. Currently & unfortunately, this may not work on all systems.

If you prefer to not download the images you may set download_images to false, but you either have to set "Secure connections" to "preferred" or "disabled" (no SSL) or have a custom certificate set (these options are found in your Plex server's network settings). This is needed because the default SSL certificate supplied by Plex is for their own domain and not for your Plex server. Your server also needs to be "fully accessible outside your network" if you wish to be able to see images remotely. If your Plex server provides it's own certificate you only need to set ssl_cert to true and download_images to false.



Do not just copy examples, please use config options above to build your own!

Sample for configuration.yaml:

sensor:
- platform: plex_recently_added
  token: YOUR_PLEX_TOKEN
  server_name: PLEX_SERVER_NAME
  ssl: true
  ssl_cert: false
  download_images: false
  max: 5
  section_types:
  - movie
  - show

Sample for ui-lovelace.yaml:

- type: custom:upcoming-media-card
  entity: sensor.plex_recently_added
  title: Recently Downloaded

*Currently genres, rating, and studio only work for Movies

Card Content Defaults

key default example
title $title "The Walking Dead"
line1 $episode "What Comes After"
line2 $day, $date $time "Monday, 10/31 10:00 PM" Displays time of download.
line3 $number - $rating - $runtime "S01E12 - ★ 9.8 - 01:30"
line4 $genres "Action, Adventure, Comedy"
icon mdi:eye-off https://materialdesignicons.com/icon/eye-off