Loading...
Loading...
Logical Router Control
This module controls Imagine Communications (f/k/a Harris) video routers via Logical Router Control (LRC) protocol.
This module is based on version 1.1 of the LRC protocol. Not all features are available in prior versions of the protocol.
Testing has been performed against Platinum MX Series routers and Platinum IP3 Routers. Please open an issue with any incompatibilities or inconsistencies discovered across hardware platforms.
LOCK, PROTECT, XBUFFER)All commands available in the LRC protocol should be available here. Please see Protocol Documentation at the bottom of this document for a link to full documentation.
Request a take of a logical crosspoint.
One source and many destinations can be specified in each action. Optionally, channels (levels) may be specified for both source and desination. If multiple destinations are specified, the same channel (level) will be used for all destinations.
Control crosspoint buffers (execute/clear)
Disconnect logical crosspoints
Preset a crosspoint command
Request execution of a crosspoint salvo.
One salvo can be specified in each action. Optionally, one or more flags may be specified to adjust behavior of the request.
Some implementations of LRC (e.g. on a Imagine Platinum MX as reported in #9) seem to require inclusion of a user ID to properly execute XSALVO commands.
If you are attempting to use XSALVO commands and they're not working, you may need to enable the Send User ID with XSALVO Commands configuration option.
Secure a destination from further crosspoint status changes by any User ID including the lock owner. The command will be sent with the User ID defined in the instance settings.
Secure a destination from further crosspoint changes requested by anyone except the lock owner (user). The command will be sent with the User ID defined in the instance settings.
Information (name, version) about the LRC protocol on a given router may be queried using this action. Primarily used for troubleshooting. Output will be logged to "debug" in the Companion web UI.
Information (total count, ID, name) about the destinations on a given router may be queried using this action. Primarily used for troubleshooting. Output is visible in debug-level logs in the Companion web UI.
Information (total count, ID, name) about the sources on a given router may be queried using this action. Primarily used for troubleshooting. Output is visible in debug-level logs in the Companion web UI.
If none of the other actions fit your needs, you may call this action to build a LRC message manually. You will need to (1) select a message type, (2) select an operation, and (3) provide all arguments. Warning! There is only a limited amount of sanity/error checking in this action.
If you find yourself using this, please open an issue so that we can add whatever is missing or fix whatever is broken in the other actions.
If none of the other actions fit your needs, you may call this action to send an arbitrary message directly to the router via the existing TCP socket. There is no sanity/error checking in this action, so make sure you know what you're doing if using this.
If you find yourself using this, please open an issue so that we can add whatever is missing or fix whatever is broken in the other actions.
Button colors can be changed in response to the state (ON/OFF) of a given salvo. Salvo state information is synchronized upon initial connection and automatically updated by the router upon change of any crosspoints set within the salvo.
Button colors can be changed in response to the state of a given crosspoint. Crosspoint state information is automatically updated by the router upon change of any crosspoints.
Button colors can be changed in response to the state (locked/unlocked) of a given destination. Destination lock state information is automatically updated by the router upon change of lock state.
Button colors can be changed in response to the state (protected/not-protected) of a given destination. Destination protect state information is automatically updated by the router upon change of protect state.
A preset is automatically created for each salvo provided by the router.
Action is Salvo Execution for the given salvo.
Feedback is Salvo State in green if the given salvo is active.
Starting from version 2.2, this module exposes the following variable types:
From version 3.0, the Lock & Protect state variables are exposed separately from each other, per destination. The rules around how the LRC protocol describes simultaneous lock and/or protect states can be complicated, so please review the protocol documentation to ensure understanding of how all of these states interact.
Full documentation for the LRC protocol is available in the Imagine Communications Customer Portal in a document titled "Logical Router Control Operation and Reference Manual". An account is required to access the documentation. Instructions for joining can be found on the login page.