PJLink

This is the PJLink plugin documentation.

PJLink Class

PJLink has 2 classes, ‘1’ and ‘2’. In PJLink Class 2, device discovery was added, as well as the spontaneous state notifications. Class 1 only provides the basic control of the projector/display.

In PJLink Class 2, the following is defined:

Device search (not implemented)
Procedure of connecting with a projector/display via network
Security
Control command form
Spontaneous status notification

Supported parameters

The following parameters are available:

Mapping parameter name Parameter	Mapping IO type IO type	Read / Write access mode R/W
Info
name	string	r
model	string	r
manufacturer	string	r
info	string	r
Optional info, can be empty
class	int8	r
Projector Class, `1` or `2`
input_list	string	r
Comma separated list of all available inputs
Operation
power	bool	rw
input	int8	rw
Integer number between `11` and `59` Where the first digit is the channel, the second the input number (from `1` to `9`) Possible channel values are: `1` - RGB `2` - Video `3` - Digital `4` - Storage `5` - Network
input_str	string	rw
String composed of the channel and the input number, separated by a `-` Channel names are case insensitive. Possible values are: RGB Video Digital Storage Network The input number is a number from `1` to `9` e.g.: `RGB-1`
av_mute	bool	rw
Both Audio & Video mute
audio_mute	bool	rw
video_mute	bool	rw
Status
lamp_power	bool	r
Only the first or only lamp
lamp_power	bool	r
Lamp Power State for lamp `n` Where `n` starts at 1 for the first lamp
lamp_hours	float	r
Only the first or only lamp
lamp_hours	float	r
Lamp Hours for lamp `n` Where `n` starts at 1 for the first lamp
error_fan	int8	r
Integer number, one of: `0` - No Error `1` - Warning `2` - Error
error_lamp	int8	r
Integer number, one of: `0` - No Error `1` - Warning `2` - Error
error_temp	int8	r
Integer number, one of: `0` - No Error `1` - Warning `2` - Error
error_cover	int8	r
Integer number, one of: `0` - No Error `1` - Warning `2` - Error
error_filter	int8	r
Integer number, one of: `0` - No Error `1` - Warning `2` - Error
error_other	int8	r
Integer number, one of: `0` - No Error `1` - Warning `2` - Error

Configuration options

The minimal device config when using the default options would be:

devices:
  - type: PJLink
    name: projector1
    options:
      ip: 10.0.0.1

This assumes that the scan rate at which the device will be polled is the default of 5000ms.

A complete config would look like this:

devices:
  - type: PJLink
    name: projector1
    options:
      scan_rate: 2000
      ip: 10.0.0.1
      port: 4352
      password: PJLinkPassword

where

type: is always “PJLink” as this is the name of this plugin.
name: unique arbitrary name.
options/ip: projector/screen ip address
options/port: the tcp port that the projector/screen is listening on. Default: 4352
options/scan_rate: this is the polling scan rate in ms and should be an integer. Default: 5000, minimum: 500
options/password: the PJLink password, of one is required. Defaults to no password

Metrics

The following metrics are exported by the PJLink plugin. They are prefixed / namespaced with pjlink_, and all of them have the label {instance:"plugin_name"} where plugin_name is the name specified in the settings.yml file with the name attribute.

Metric Name	Metric Type	Notes
General
connection_state	Gauge	The connection state of the PJLink device.
Values: `-1` initial / undefined `0` connected `1` disconnected `2` connection error `3` error received `4` error sending
Info
info	Gauge	Info labels of the PJLink device.
Labels: `{class="1"}` `{name="projector_name"}` `{manufacturer="manufacturer_name"}` `{model="projector_model"}` `{info="projector_info"}` Values: `1` valid `0` invalidated
Operation
power		Projector Power
Values: `0` Off `1` On
input		Active Input
Values: `1x` RGB input x `2x` Video input x `3x` Digital input x `4x` Storage input x `5x` Network input x
av_mute		AV Mute
Values: `0` Not muted `1` Muted (Audio & Video)
audio_mute		Audio Mute
Values: `0` Not muted `1` Muted
video_mute		Video Mute
Values: `0` Not muted `1` Muted
Status
lamp_power		Lamp Power State
Labels: `{lamp="1"}` Values: `0` Off `1` On
error_fan		Fan Error
Values: `0` No Error `1` Warning `2` Error
error_lamp		Lamp Error
Values: `0` No Error `1` Warning `2` Error
error_temp		Temperature Error
Values: `0` No Error `1` Warning `2` Error
error_cover		Cover Open Error
Values: `0` No Error `1` Warning `2` Error
error_filter		Filter Error
Values: `0` No Error `1` Warning `2` Error
error_other		Other Error
Values: `0` No Error `1` Warning `2` Error
lamp_hours		Lamp Hours
Labels: `{lamp="1"}`