Triggers

Triggers are used to monitor a single status of a device. For example, this can be a GPI (General Purpose Input), the power supply state, the temperature of the unit or even bandwidth measurements on a switch.

Each trigger has the following base parameters:

Parameter Description
Description The description of the trigger. This is used all over the website, in log files and notifications.
Enabled Disabled triggers are not initialized during the startup of Broadcast Suite Core.
Device Each trigger is linked to a specific device.
Category Each configuration element (device, trigger, event, action) can be assigned to a category to group and filter these elements.
Trigger Type The trigger type.
Switch-on time Default value: 0

The switch-on time defines how long a measurement value needs to match or exceed the defined threshold or value before it changes its status to ON.
Switch-off time Default value: 0

The switch-off time defines how long a measurement value needs to mismatch the trigger configuration before it changes its status to OFF.
Pulse If enabled, the trigger automatically returns to the status OFF after 250ms. The default value can be changed globally in the system settings.

Cron

This trigger type uses so-called cron expressions to change the status to On periodically. This is useful for configurations where specific actions should be executed regularly, e.g., every hour or every first Monday of the month.

Parameter Description
Cron Expression Defines the intermittency in which the trigger becomes active.
Duration The duration in seconds after which the trigger switches to OFF again.

Cron expressions are made up of seven sub-expressions, that describe individual details of the schedule. These sub-expressions are separated with white-space, and represent:

  • Seconds
  • Minutes
  • Hours
  • Day-of-Month
  • Month
  • Day-of-Week
  • Year (optional field)

An example of a complete cron-expression is the following string:

0 0 11 ? * MON

which means “every Monday at 11:00:00 pm”.

These expressions can be generated quite easily with services like http://www.cronmaker.com.

DMS

DMS triggers make use of the Digital Metering System protocol from DSA Volgmann and can be used to receive so-called MF-Key values from Lawo Radio Consoles.

Parameter Description
MF-Key The MF-Key/MF-LED ID as hex string
Value The expected value of the MF-Key

The MF-Key value must have a length of eight characters and has the following format:

79D20100

This value translates to MF-LED 1 in Slot 2.

Ember+ Consumer (Generic)

This trigger type can be used with virtually any Ember+ provider to monitor a specific value within an Ember+ tree.

For more information on Ember+, please see http://www.github.com/lawo/ember-plus.

Parameter Description
Ember+ Path The path to the parameter, e.g., /Root/Input 1/Gain
Expected Value The expected value
Operand For int and long values, an operand (smaller than, larger than, ...) can be used. If the operand cannot be applied to the received value, equal will be used.
Absolute Path The absolute path as OID (e.g. 2.5.13.4). This field is optional and will be populated automatically when the parameter has been found. This value overrides the Ember+ Path.

Placeholders

This trigger passes the following custom placeholders to the action:

Placeholder Description
EmberPlusPath Absolute Ember+ Path

Ember+ GPIO

This trigger reacts on changes of Ember+ GPIO nodes of a Lawo Radio Console.

Parameter Description
GPIO Node Name Name of the Ember+ GPIO element as shown in TinyEmber on OnAir Designer
GPO Number GPO Output Number (1-16)
Absolute Path The absolute path as OID (e.g. 2.5.13.4). This field is optional and will be populated automatically when the parameter has been found. This value overrides the Ember+ Path.

Placeholders

This trigger passes the following custom placeholders to the action:

Placeholder Description
GpioNumber GPIO Number
EmberPlusPath Absolute Ember+ Path

Ember+ Matrix

This trigger reacts on changes of Ember+ matrices.

Parameter Description
Matrix Node Name Name of the Ember+ matrix node as shown in TinyEmber on OnAir Designer
Source ID Multiple values can be separated by a comma, ranges by a minus (e.g. 1,2,3-10). Leave empty if you enable "Accept any source".
Accept any source If enabled, any source routed to the configured destination(s) will invoke this trigger.
Destination ID Multiple values can be separated by a comma, ranges by a minus (e.g. 1,2,3-10).
Absolute Path The absolute path as OID (e.g. 2.5.13.4). This field is optional and will be populated automatically when the parameter has been found. This value overrides the Ember+ Path.

Placeholders

This trigger passes the following custom placeholders to the action:

Placeholder Description
Source Source ID
Destination Destination ID

Ember+ Provider

Each instance of Broadcast Suite Core is an Ember+ provider and publishes the status of all triggers, events and actions within its tree. By configuring Ember+ Provider triggers, the value of the trigger values can be changed by an external Ember+ consumer.

Parameter Description
Value The value which needs to be matched for this trigger to become active

G&D KVM Crosspoint Addon

This trigger reacts to changes on Guntermann & Drunck KVM matrices.

Parameter Description
Source Console Name
Accept any source If enabled, any source routed to the configured destination will invoke this trigger.
Destination CPU (Destination)
Accept any destination If enabled, any destination will invoke this trigger.

Placeholders

This trigger passes the following custom placeholders to the action:

Placeholder Description
Source Source Name (Console)
Destination Destination Name (CPU)

HTTP Polling

With this trigger type, external JSON APIs can be polled regularly in order to retrieve values from other devices, external systems or web services.

If multiple HTTP Polling triggers with the same request URI are assigned to the same Broadcast Suite Core, they are automatically being grouped by polling interval and only one request is being made. This reduces the number of requests to the remote service.

Parameter Description
Request URI URI which is being called by this trigger, must start with http:// or https://
Expected JSON Property The property which is being monitored. This parameter does support the JSONPath notation.
Expected Value The expected value
Operand For numeric values, an operand (smaller than, larger than, ...) can be used. If the operand cannot be applied to the received value, equal will be used.
Polling Interval HTTP polling interval in seconds

JSONPath

JSONPath can be used for the "expected JSON property" parameter and allows to refer specific objects or elements in JSON responses.

JSONPath expressions can use the dot–notation.

$.node.element[0].title

or the bracket–notation

$['node']['element'][0]['title']
Syntax Elements
Description
$ The root object/element
@ The current object/element
. or [] child operator
.. recursive descent
* Wildcard
?() Applies a filter (script) expression
() script expression, using the underlying script engine

HTTP POST

This trigger type reacts on HTTP POST requests from external systems to the Broadcast Suite Core API.

Parameter Description
Method Name Defines the API URI of the trigger. The trigger can then be invoked by calling /api/v1/custom_trigger/[METHOD_NAME].
Expected JSON Property The name of the expected JSON property
Expected Value The expected property value

Licensing

If no dongle has been found, the Broadcast Suite Core falls back to the free, limited license. With this trigger, it is possible to monitor the licensing status of the core.

Parameter Description
License Type The license level on which the trigger becomes active

Livewire GPIO

The Livewire GPIO trigger reacts on changes of Axia GPIO xNodes.

For more information on the GPIO configuration, please refer to the xNode manual.

Parameter Description
Port The xNode GPIO port number
Pin The xNode GPI (Pin)
State State of the GPI (true or false)

Placeholders

This trigger passes the following custom placeholders to the action:

Placeholder Description
GpioNumber GPIO Number

PhoneBox GPIO

This trigger listens for GPOs sent by Broadcast Bionics's PhoneBox.

Parameter Description
Listen Port The UDP Listen Port (must match the PhoneBox configuration)
GPO Number PhoneBox GPO Number
GPO Value Expected GPO Value

Ping

The Ping trigger sends in regular intervals ICMP Ping telegrams to the associated device.

Parameter Description
Interval The ping interval in seconds
Offline Threshold The amount of required ping failures before the trigger becomes active
Online Threshold The amount of required successful pings before the trigger becomes inactive
Verify Round Trip Time If enabled, the round trip time (RTT) will be measured
Max Round Trip Time Replies with an RTT higher than the configured value count as a failure, if the option "verify round trip time" is enabled.

RMON

The RMON trigger type allows the monitoring of interface bandwidth, packet counters and general counters on RMON-compatible switches.

Parameter Description
Port Nr. The interface number / ID
Parameter The RMON parameter which should be monitored
Value RMON Value
Operand The applied operand when comparing the measurement and trigger value

The following parameters and counters are currently supported:

  • Utilization
  • Drop Events
  • Octets
  • Packets
  • Broadcast Packets
  • Multicast Packets
  • CRC Align Errors
  • Undersize Packets
  • Oversize Packets
  • Fragments
  • Jabbers
  • Collisions

sFlow Generic Counter

If there is at least one sFlow trigger, the Broadcast Suite Core starts a sFlow Collector. This allows monitoring several counters (bandwidth, packet counters, errors) of sFlow compatible network devices.

Parameter Description
Interface Index The interface index as configured in the devices sFlow configuration
Counter The observed generic counter
Value The expected counter value
Operand The applied operand when comparing the measurement and trigger value

The following counters are currently supported:

  • Interface Type
  • Interface Speed
  • Interface Direction
  • Interface Status
  • Interface Promiscuous Mode
  • Input Octets
  • Input Bandwith
  • Input Utilization
  • Input Unicast Packets
  • Input Multicast Packets
  • Input Broadcast Packets
  • Input Discards
  • Input Errors
  • Input Unknown Protocols
  • Output Octets
  • Output Bandwith
  • Output Utilization
  • Output Unicast Packets
  • Output Multicast Packets
  • Output Broadcast Packets
  • Output Discards
  • Output Errors

SNMP

The SNMP trigger listens for incoming SNMPv1 and SNMPv2 traps.

Parameter Description
Trap OID The OID in dot notation (e.g. 1.41.1.2.1)
Trap Value The expected value

Syslog

Broadcast Suite can be used as a Syslog server. By configuring Syslog triggers, it is possible to react on specific incoming messages.

Parameter Description
Condition equals or contains
Message The expected message value

Telnet

This trigger allows to connect to an arbitrary device which supports Telnet connections. The configured command(s) are sent periodically to the device to poll the current status.

Parameter Description
Command Telnet Command
Expected Response The expected response for the command above. If the response contains this value, the trigger becomes active.
Polling Interval Polling interval in seconds

UDP

With UDP triggers, external systems can send any telegram to Broadcast Suite. The incoming message is treated as a UTF8 string and filtered by the expected message value.

Parameter Description
Listen Port The listen port for this trigger. Multiple triggers can use the same listen port.
Condition The condition for the message filter (equals or contains)
Message The expected message value

Placeholders

This trigger passes the following custom placeholders to the action:

Placeholder Description
ConditionFulfilled 1 if Trigger condition is fulfilled, 0 otherwise

WMI

WMI triggers allow to monitor the status of a Windows service or application.

Parameter Description
Type Process or Service
Type Name The name of the process or service
Interval The polling interval in seconds
Check Is Running If enabled, the trigger becomes active whenever the observed process is not running
Property Name The WMI property name (only available when Check Is Running is disabled). A full list of properties can be found here.
Property Value The expected value of the property