node-red-contrib-plex-ws 0.2.4
Nodes for connecting to Plex with real time notifications.
Nodes for connecting to Plex with real time notifications.
NOTE: The Plex WebSocket API is not documented and probably not intended for third-party use. Breaking changes may occurr during Plex upgrades.
Getting Started
This assumes you have node-red already installed and working.
cd ~/.node-red
npm install node-red-contrib-plex-ws
sudo service nodered restart
Configuration
You will need to get your X-Plex-Token in order to configure the nodes. See "Finding an authentication token / X-Plex-Token".
Included Nodes
You can view detailed documentation for the nodes via the node-red info pane. Just select a node and start readin'.
playing
Receive notification when the playing state of a session changes. Add filters for specific conditions (e.g. media type, player, user, etc).
notification
Receive all Plex notifications.
Development
An environment with node-red can be easily spun up using Docker and Docker Compose.
- Clone this repository:
git clone https://github.com/scraton/node-red-contrib-plex-ws - Install node dependencies:
cd node-red-contrib-plex-ws && yarn install - Start the docker environment:
yarn run dev
Credits
Gotta give credit where credit is due.
- node-red
- node-red-contrib-plex - Uses official APIs via polling, more stable option
