Skip to content

eliottrobson/homebridge-plex

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Homebridge Plex

Homebridge plugin to track Plex webhook events (play / pause / stop)

Installation

Install the plugin

sudo npm install @eliottrobson/homebridge-plex-webhooks -g --registry "https://npm.pkg.github.com"
ln -s /usr/local/lib/node_modules/@eliottrobson/homebridge-plex-webhooks /usr/local/lib/node_modules/homebridge-plex-webhooks-@eliottrobson

Configure in homebridge config

{
    "platform": "homebridge-plex-webhooks.Plex",
    "sensors": [
        {
            "name": "Plex Playing"
        },
        {
            "name": "Plex - TV Show Playing",
            "users": ["eliottrobson"],
            "players": ["Bedroom TV"],
            "types": ["episode"]
        },
        {
            "name": "Plex - Movie Playing",
            "users": ["eliottrobson"],
            "players": ["Bedroom TV"],
            "types": ["movie", "clip"]
        },
        {
            "name": "Plex - Music Playing",
            "users": ["eliottrobson"],
            "players": ["Bedroom TV"],
            "types": ["track"],
            "delay": 1000
        }
    ]
}

Setting up plex

You will need plex pass in order to add the webhook to your Plex account, first visit the following url:

https://app.plex.tv/desktop#!/settings/webhooks

Click "ADD WEBHOOK" and enter the url of the homebridge server with port 32512 (this can be changed in settings). (Example: http://192.168.86.100:32512).

Setup Homekit

The device will show as a plug. This is because plugs have 2 states and can very easily be added into homekit automations.

Outlet State In Use State Plex State
ON ON PLAYING
ON OFF PAUSED
OFF OFF STOPPED

Config

Variable Description
sensors This is the array of sensor objects (see sensor-config below).
port (Optional) The custom port to use (default: 32512)

Sensor Config

Variable Description
name This will be the name of this sensor, is is required and must be unique.
users (Optional) This is a filter for the different plex users required to trigger the sensor
players (Optional) This is a filter for the different plex players required to trigger the sensor
types (Optional) This is a filter for the types of media required to trigger the sensor (episode, movie, track)
delay (Optional) Applies an optional delay to the off status to avoid quick off->on when moving between songs etc...

Debugging

DEBUG=* /usr/local/bin/homebridge -D -U ~/Documents/Homebridge/homebridge-dev -P ~/Documents/Source/homebridge-plex

About

Homebridge plugin to track Plex webhook events

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages