Devices

Prev Next

The Devices > Devices link in the navigation bar displays a list of all devices discovered by Pathfinder Core PRO.

Column

Description

Name

The device's name.

Online

Whether the device is online. The circle beside it is the connection recycle icon, which should rarely, if ever, be used. Clicking this icon makes Pathfinder drop its connection to the device and reconnect. For Livewire devices, the metering connection to the device is recycled as well.

Login State

Whether Pathfinder is logged in to the device.

Type

The kind of device, for example QEngine, WinDriver, Quasar, RestApi or PcpGpio (Pathfinder's own GPIO node).

Address

The address and port Pathfinder connects to.

Webpage

Clicking this link takes you directly to the device’s configuration web page. Rest API, SCTE-35 and Infinity devices show an edit link here instead, which opens their configuration.

If the device requires a different login, click the Change Login link to set the password:

Clicking the trash icon removes this device from the system. See notes below for details.

Important Note: When a device is removed from the system, all entries in the Audio and GPIO router for that device are also removed. If Livewire Discovery is enabled on the system page, the device may be rediscovered and added back to the list if it is still on the network.

Manually Adding Devices

Some devices cannot be discovered automatically. These include Axia OLED and LCD rackmount button panels. Additionally, you may want to add a device to the system without enabling the full network discovery engine. To add these devices to the system, click the Add + button on the Devices dialog.

A dialog box appears where you define a range of IP addresses to scan and the investigation method to use.

Field

Description

Investigation Type

If you are adding an Axia audio or GPIO device, select Lwrp as the investigation type. If you are adding an Axia rackmount OLED or LCD panel, use the Lwcp investigation type. Other types are Imagine Lrc for an Imagine router (see the Routers article), Rest Api for a Rest API device (see below), or Scte35 Reader for a SCTE-35 reader (see below).

IP Address / To

If you are adding a single device, type the same IP address in both boxes. The To box should auto-populate when you type an IP address into the IP Address box. A port can be added after a colon, for example 192.168.0.20:93.

Clicking Investigate makes the system try to contact a device on the requested IP address using the defined investigation type. If a device can be contacted and data can be discovered from the device, it will be added to the Devices list. Its routing resources will also be added to the appropriate routers.

Other Device Types

  • Telos Pulsar units are recognized as their own device type. Pathfinder controls their AUX 1–4 inputs.

  • Telos Infinity devices have an edit link that opens the Infinity configuration: Lwrp Enabled, FrontPanel Rcp Enabled and the FrontPanel Rcp Url.

Connection Timeouts

Pathfinder polls each device, and drops and rebuilds the connection when a device stops answering. A poll counts as missed only when nothing at all has arrived from the device within the poll timeout. While the system is busy, the timeout is extended so that a slow device is not mistaken for a dead one. The system counts as busy during startup, after the event system moves to another cluster node, after a service restart, and while its internal message backlog is high.

The thresholds can be tuned, with Telos support, in System > Configuration > Advanced Options under Devices, for example SET Devices#0 IgnoredDelayCount=2.

Option

Default

Description

IgnoredDelayCount

0

How many missed polls in a row to ignore before the connection is rebuilt. At 0, the first missed poll rebuilds it. Raise it if devices briefly drop and reconnect for no apparent reason. Each ignored poll adds one more poll timeout to the time it takes to detect a dead device.

UserLoadGraceMinutes

3

Extra minutes added to the poll timeout while the system is busy, on top of a built-in 2 minutes. Raise it on large systems that are slow to settle.

QueueBackPressureThreshold

100

How large the internal message backlog must get before the system counts as busy. Set it to 0 to turn this trigger off.

AdHocGraceCountdownMinutes

0

A manual grace period for planned disruptive work. Set it to a number of minutes, and the extended timeout applies for that long. The value counts down by one each minute and stops at 0. Set it to 0 to cancel early.

The same options can be set live on Devices#0 through SapV2. A live change applies from the next poll and lasts until the next restart.

Devices#0 also has four read-only properties for watching this:

Property

Description

SuspectedTimeouts

The number of missed polls since the service started.

ConfirmedRecycles

The number of connections rebuilt after a timeout since the service started. When IgnoredDelayCount is above 0, the gap between this and SuspectedTimeouts is the number of reconnects that were avoided. If the two stay close, the devices really are dropping.

AdHocGraceActive

True while an AdHocGraceCountdownMinutes countdown is running.

SapQueueDepth

The current internal message backlog, which is the figure compared with QueueBackPressureThreshold. Watch it in normal operation and at the busiest moments to choose a threshold.

These settings only delay the decision for a device that is still connected but silent. A dead device is still detected and reconnected, and a lost TCP connection is treated as a failure at once.

Virtual GPIO Node

Pathfinder Core PRO includes a virtual GPIO node, which you open from the Gpio link under Devices in the navigation bar.

This virtual node behaves very much like the GPIO portion of an Axia Livewire driver, except that the number of ports is dynamically adjustable and the node includes a few additional features, as described below.

When you first open the GPIO link, the system recognizes that the internal GPIO node has not been added to the devices table and asks whether you want to add it. The node can only be used or configured after it has been added to the device list.

Click Add to discover and add the internal GPIO node into the device list. This also discovers the GPIO points into the GPIO router.

Item

Description

Port list

Once the device has been added, you will see the list of GPIO ports. By default, there are 4 ports in the system.

Port Count / Update

You can add GPIO ports by typing a new port count at the top of the screen and then clicking Update. This allows you to add any number of GPIO ports into the local virtual GPIO node.

Advertise IP

Advertise IP makes the node take part in Livewire advertisement, so that devices which only find GPIO through advertisement (such as the Infinity Dashboard) can see it. It can only use a floating IP address (see the Clusters article). Until one exists, it is grayed out. Choose the floating IP and click Update. This also changes the address used for GPIO snake routes, and existing routes are updated over the next 10–15 seconds. Pick either a floating IP or None and keep it. It is not meant to be switched back and forth.

edit

Click the edit link to change the property values for any GPIO port. See the Pathfinder Core PRO GPIO Properties section below for details.

GPIO Refresher

It is important to understand the various ways GPIOs may be used in an Axia environment.

  • Software GPIOs with no source address assignment will simply allow closures to be directly tripped on either GPI or GPO by Pathfinder Core PRO.

  • Example: SRCA:””

  • If a source address field for a GPIO port uses a Livewire channel number in its address field, it will listen to and generate closures to and from an Axia Console over multicast.

  • Example: SRCA:9501

  • Finally, if the source address uses an IPAddress/port format, it means that the GPIO port should use TCP to connect to the device at that IP Address, monitor the GPIs from the selected port on that device, and mirror those closures on this port’s GPOs. This is the method the Pathfinder Core PRO GPIO router uses to route GPIO data across a network.

  • Example: SRCA:”172.16.1.23/8”

Pathfinder Core PRO GPIO Properties

By default, Pathfinder Core PRO’s GPIO node works in the same way as described above. Clicking Edit in the GPIO table allows advanced users to manipulate advanced properties.

Field

Description

Port Name

Type a unique name for this GPIO port.

MCast Mode

Selecting Node from the drop-down list allows the port to behave like a Livewire driver GPIO port when a Livewire channel number is typed in the source address. Specifically, the port will listen to GPIO messages from the console fader on which the Livewire channel number is loaded and change its GPO pins accordingly. Tripping the GPI pins of the port will send closures to the Axia Console. Selecting console allows the port to behave as if it were an Axia console. Therefore, GPIs that are tripped on this node will be sent to the GPOs of other GPIO ports on the network that have the same channel number assigned. Tripping a GPI on one of those other devices will cause the GPO on this port to change.

IRoute Mode

By default, this will be set to O. This property only applies to situations where an IP/Port or Livewire channel is used in the source address. When a GPI comes in from either of these sources, it is applied to a GPO on the port. This property allows you to change this behavior and apply the incoming GPI to either the GPI or to None which means it is ignored.

ORoute Mode

This property defines where inbound GPOs will be sent. By default, they are sent nowhere as this setting replicates other GPIO node functionality. When using IP/Port source addressing, the Pathfinder Core PRO GPIO node is unique in that it will also subscribe to GPO changes for the port and these may be routed to I, O, or None. See note below.

Source Address

This field may be left blank if the closures will be used by Pathfinder and do not need to follow another port or console functionality. Alternatively, you may type a Livewire channel number or IP/Port value in this field. If you type an IP/Port value, you do not need to assign it in the configuration user interface. The GPIO router will allow you to manipulate this field much more easily by just making route changes.

Important Note: By manipulating IRoute Mode and ORoute Mode, it is possible to make a multicast or unicast GPIO route where one port’s inputs and outputs mirror another port.

RestApi

Pathfinder Core PRO also lets you add Rest API devices, which send Rest API commands to a Rest API-enabled device. To add a Rest API device, click the devices link and then click the plus icon. This will display the Address to Investigate dialog.

From the Investigation Type drop-down list, select Rest Api. The dialog will change to show a name and a Base Url field.

Enter a name for the device and the HTTP address to send Rest API commands to. Alternate ports may be used by adding a colon and the port number:

After clicking Investigate, the device will be added to the system.

Rest API devices show an edit link instead of a web page link. The edit link opens the Rest Api Config dialog for customizing the authentication and the message header used by each Rest API command:

Field

Description

Auth Type

How Pathfinder authenticates with the device: None, Basic, Bearer/Jwt, ApiKey or Digest.

Message Headers

The headers sent with every command. You can use this dialog to add custom header messages if the Rest API device needs them. For Basic authentication, the <UsernamePassword> chunk is replaced by a basic authentication conversion of the user name and password. If no user name and password are defined, the Authorization may be removed.

Allow Escape Characters

Lets the message headers and the data of each command include escape sequences such as \r\n, which are turned into the characters they stand for.

Static JWT

(Bearer/Jwt) Use a fixed token that you put in the Message Headers, instead of the user name and password.

Dynamic JWT

(Bearer/Jwt) Before each command, Pathfinder asks the Auth URL for a token, reads it from the JSON response at the Json Token Path (for example data.token, which can also be written $.data.token), and sends it as a Bearer token. Auth Placement decides how the user name and password reach the Auth URL: in the header (Basic authentication) or in the body, using the Auth Body Template with {username} and {password} in it.

The Change Login link allows you to assign a username and password to be used by Rest API commands in the Authorization portion of the header:

Sending a command to the Rest API device

Once the device has been added to the system, it is available in logic flows.

The SendToRestApi property needs to be structured in a specific way. The property value to send needs to have an operator (usually GET or PUT), a path, and optionally, some data. The path portion should be only the data after the device path. For example:

PUT /my/path/url hello

When the device sends data, it prepends the device path so that the HTTP command becomes:

PUT http://172.16.1.97:4013/my/path/url hello

The data portion is optional and depends on the specification of the API you are trying to communicate with.

For example, a logic flow that sends to a Rest API device when a GPI pin closes might look like:

SAP property memory slots and string builder memory slots can also be useful for building Rest API commands according to the device’s specification and then pass the command through to the device whenever the memory slot changes.

Receiving data from the Rest API device

See the Rest API technical details section for the pitfalls of using Rest API to capture information from a device. In this case, use the example above to send a request to the device, probably using the GET operator. The information that is returned can be found in read-only properties (only seen if a start point is selected):

Response code returns the HTTP response code that results from the last message sent. For example, it might return 200 if the request succeeded, or it might return 404 if the path was not found. For more information on HTTP response codes, see: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status.

The response data property will contain the actual data returned from the command. In many cases you may need a regex to filter the data for what you want to match in the logic flow.

The Response Success property returns true or false depending on whether the last Rest API command was successful.

LastSent holds the last command sent to the device, and Online shows whether the device is reachable.

Triton Station Manager

A Rest API device can start and stop Triton Station Manager through Triton's cloud service. Add the device and set it up as a Dynamic JWT device with these values:

Field

Value

Base Url

https://smhub-service.api.tritondigital.com

Auth Type

Bearer/Jwt

Message Headers

Content-Type:application/json and Accept:application/json, each on its own line. Remove any other Authorization line.

Dynamic JWT

Checked. Leave Static JWT unchecked.

Auth URL

https://login.tritondigital.com/authenticate

Json Token Path

$.token

Auth Placement

Header

Use Change Login to enter your Triton user name and password.

Each command is a PUT to /api/<publisherId>/sm-command with the instance, the station and the command as JSON. Replace the publisher id, instance id and station name with your own:

PUT /api/206783/sm-command {"instanceId":"bb5cc55e-9ba9-4c34-97d5-a795b894b50c","stationName":"TELOS_PATHFINDER","command":"StartStation"}

PUT /api/206783/sm-command {"instanceId":"bb5cc55e-9ba9-4c34-97d5-a795b894b50c","stationName":"TELOS_PATHFINDER","command":"StopStation"}

For each command, Pathfinder asks the Auth URL for a token and then sends the command to the Base Url. Triton passes the command on to your local Station Manager instance.

Important Note: Pathfinder must be able to reach both Triton URLs over the internet, so this does not work on an air-gapped system. Pathfinder never talks to your local Station Manager instance directly. Pathfinder gets the token and sends the command in about 1 second, but Station Manager has taken 5 to 15 seconds to receive a start command and 10 to 45 seconds to receive a stop command.

SCTE-35 Readers

A SCTE-35 reader passes the SCTE-35 cue messages found in a broadcast stream to Pathfinder, where Logic Flows can act on them. To add one, click Add + on the Devices page, select Scte35 Reader as the Investigation Type, type the reader's IP address, and click Investigate.

Click the reader's edit link to configure it:

  • Time Offsets shifts the timing of timed splices, per reader id, in milliseconds, for example 1=300,2=-500,3=0.

  • Filters opens the descriptor filters, which pass on only the cues whose descriptor fields match: pick the Reader and Descriptor Filter, then add the Field and Value to match.

The cue data appears as properties of the device in Logic Flows, under Scte35.

Rest API technical details

While Rest APIs are currently very popular (which is why we added them to Pathfinder Core PRO), we regard them as generally ill-suited for many broadcast applications.

For example, we recently did some work with a product whose control protocol was exclusively Rest API. One of the first things our customer wanted to do was have Pathfinder Core PRO perform an action whenever a user pressed a button. The problem is that to detect that button push, we would have needed to poll at 2.5 times the minimum amount of time the button might be held down. For computers, this is not difficult until you start considering 25 buttons to a device and deployments of 600 to 700 devices. Now you have a situation where you are spending a massive number of compute cycles on messages which basically say "nothing has changed."

The point is that applications that need low-latency responses to state changes do not scale well with non-event-driven protocols like Rest API. The consumer of such protocols needs to be aware of the CPU load that results from what they are doing. Currently, if the user wants to poll, they would need to use an interval timer and a logic flow. We may at some point add a way to pre-program parameters that should be polled which would simplify that task, but we opted not to in this version because of the potential for abuse described above.

If all you care about is triggering a change and perhaps getting a response back that the change was made, then Rest APIs work well. But if real-time state change information is required, then care needs to be taken and other options employed if available.

This article provides a great analogy using a general and his army to illustrate the differences between REST and a socket-based architecture:

https://www.pubnub.com/blog/websockets-vs-rest-api-understanding-the-difference/

In short: Use this feature with care.