开源软件名称：

开源软件地址：

开源编程语言：

开源软件介绍：

Plex Webhooks Server plugin for Homebridge

This Homebridge plugin can expose occupancy sensor(s) in Home app what will trigger occupancy when media starts playing through a Plex client. Thanks to the unlimited filtering criterias, occupancy events can be controlled based on several different attributes (e.g.: Plex servers, Plex clients, Plex users, media types, media metadata).

This plugin uses Plex's Webhooks feature which is the best available option at the moment to create quick and smooth automation experience.

Please note, Webhooks are a premium feature and requires an active Plex Pass Subscription for the Plex Media Server account. Based on past years experience, once or twice a year Plex Inc discounts its life time licence.
However, if you don't own or plan to buy Plex Pass, you can try this plugin instead, but please note I'm not planning to maintain this plugin anymore: homebridge-plex-v2

Installation

If you don't have a Homebridge installation yet, head over to the project documentation for more information.

The best and easiest way to install and configure this plugin is through Homebridge UI.

However, if you would like to you can do it through terminal:

npm install homebridge-plex-webhooks

Or, you can install it for root but please be aware of the security risks:

sudo npm install -g --unsafe-perm homebridge-plex-webhooks

Configuration

The easiest way to configure this plugin is through Homebridge UI.

Available options:

Simple config with one filter:

"platforms": [
  {
    "name": "Plex Webhooks Platform",
    "platform": "PlexWebhooks",
    "sensors": [
      {
        "name": "Plex Movie",
        "filters": [
          [
            {
              "path": "Metadata.type",
              "value": "movie"
            }
          ]
        ]
      }
    ]
  }
]

Advanced config with multiple sensors and filters with custom server options and verbose logging:

{
  "name": "Plex Webhooks Platform",
  "platform": "PlexWebhooks",
  "sensors": [
    {
      "name": "Plex Movie",
      "filters": [
        [
          {
            "path": "Account.title",
            "value": "User"
          }
        ],
        [
          {
            "path": "Metadata.type",
            "value": "movie"
          },
          {
            "path": "Player.title",
            "value": "Apple TV"
          }
        ]
      ]
    },
    {
      "name": "Plex Pre-roll",
      "filters": [
        [
          {
            "path": "Metadata.type",
            "value": "clip"
          },
          {
            "path": "Player.title",
            "value": "Apple TV"
          }
        ]
      ]
    },
    {
      "name": "Plex Show",
      "filters": [
        [
          {
            "path": "Metadata.type",
            "value": "episode"
          },
          {
            "path": "Player.title",
            "value": "Safari"
          }
        ]
      ]
    }
  ],
  "server": {
    "address": "192.168.88.100",
    "port": 32401
  },
  "verbose": true
}

Set up Plex Media Server

After you launch homebridge, look for the listening URL:

Add this URL as a webhook URL on your Plex Media Server Webhooks settings page:

In case your Homebridge server and PMS server is not on the same network, must probably you need to use NAT.

Questions, issues, feature requests

Before you raise a ticket, try to run Homebridge with the --debug option or set verbose logging for the plugin and look for the payload in console. Make sure your config is valid and your filtering rules are correct. For easier debugging, please provide your config.