RTI Driver Guide - Just Add Power RTI DRIVER GUIDE. Revised

Transcription

1 RTI Driver Guide - Just Add Power RTI DRIVER GUIDE Revised Just Add Power All rights reserved Unauthorized use or disclosure prohibited Last updated Jun-18

2 RTI Driver Guide ii Just Add Power Last updated Jun-18

3 Table of Contents RTI Driver Guide Information... 1 Download... 1 License Key... 1 Supported Switches... 1 JADConfig... 1 Switching Driver... 2 Add... 2 Configure... 3 Driver Commands... 4 Output Routing... 4 Output Input Selection... 5 Preset Selection... 8 POE Selection... 9 SAVE System Variables Static Route With Router Without Router TxRxComms Driver Add Configure Driver Commands Send Serial Command Send Console Command Send Console Command (advanced) Audio Delay Basic Video Wall Mode Change Basic Video Wall Tear Adjust Slideshow Send CEC Command (standard) Send CEC Command (advanced) Set OSD Format Just Add Power Last updated Jun-18 iii

4 RTI Driver Guide OSD On OSD Off System Variables Image Pull TxRxComms Driver Image URL Driver Enable Image Pull Create PNG with Macro and Event Flux Capacitor IR Dongle Troubleshooting iv Just Add Power Last updated Jun-18

5 Information Download You can find JADConfig and the complete RTI drivers at: License Key RTI Driver Guide - Just Add Power Switching drivers from Just Add Power will function in Demo mode for 30 minutes without a license key. Serial-over-IP drivers will not function without a license key. To receive a license key, send the MAC address of the RTI processor to drivers@justaddpower.com with this information: Control System (RTI) Installer name Company name Contact phone number Only one license key is needed per installation no matter how many drivers are being used; the license key is tied to the RTI processor. Supported Switches Cisco o o o o o Luxul o o o o o o o o JADConfig SG300 SG350 SG500 SG500X SG550X AMS-1208P AMS-2600 AMS-2616P AMS-2624P AMS-4424P XMS-2624P XMS-5248P XMS-7048P JADConfig is software that runs on a Windows computer and configures supported managed switches and all attached Just Add Power devices. JADConfig must be run on the switch before the driver can control the system. If Layer 3 control Video Wall, CEC control, RS232 control, IR control, On-Screen Display, Image Pull will be used in the system, please be sure to Export the text document provided at the end of JADConfig. It contains the IP addresses to all Just Add Power devices in the system, as well as the Static Route that must be added to the router in order to access the Just Add Power devices Just Add Power All rights reserved Unauthorized use or disclosure prohibited Last updated Jun-18

6 RTI Driver Guide Switching Driver Add 1. Open Integration Designer and open the installation file 2. In the XP processor Drivers menu, click Add. Navigate to the location of the appropriate switch driver and click Open. 2 Just Add Power Last updated Jun-18

7 RTI Driver Guide Configure 1. In the XP processor Drivers tab, select the Just Add Drivers switch driver. 2. Set TCP Address to the IP address assigned to the switch. 3. Set Switch Size to the size of the system that was configured. These values do NOT affect the overall system size, only the number of inputs and outputs that are active in Integration Designer. 4. Set Input Names and Output Names to the names of the sources and displays. These names will carry over to all driver functions. 5. Paste the License Key into the Licence Key box. Just Add Power Last updated Jun-18 3

8 RTI Driver Guide Driver Commands Output Routing Used to switch either a single output to a single input, or all outputs to the same input. Switch Output Switch a single output to a single input. Input numbering starts with the first Transmitter as 1. Output numbering starts with the first Receiver as 1. Switch All Outputs Switch all outputs to the same input. Input numbering starts with the first Transmitter as 1. 4 Just Add Power Last updated Jun-18

9 RTI Driver Guide Output Input Selection Used to select multiple outputs and then switch all selected outputs to the same input. ONLY works as a Button Macro (System Macro will not properly select outputs). Clear Output Selection Unselects all outputs sets the system variables for all outputs to OFF. Best-used after a switching command to prepare for next switching commands. Select All Outputs Selects all outputs sets the system variables for all outputs to ON. Just Add Power Last updated Jun-18 5

10 RTI Driver Guide Select Output Selects a single output in the system sets the system variable for that output to ON. Pair with Select Input to switch. Toggle Output Toggles the system variable for an output if set to ON change to OFF ; if set to OFF, change to ON. Pair with Select Input to switch. 6 Just Add Power Last updated Jun-18

11 RTI Driver Guide Select Input Switches all outputs with system variable ON to a single input. Pair with Toggle Output and Select Output to switch. Examples 1. A single macro has been used to select outputs 1, 4, 6, and 8 and switch them to input 4. Output selection is then cleared (sets all output variables to OFF ) in order to prepare for the next selection statement. 2. A single macro has been used to toggle outputs 2, 3, and 5 and switch them to input 2. Output selection is then cleared (sets all output variables to OFF ) in order to prepare for the next selection statement. (This macro assumes that outputs 2, 3, 5 were in the OFF state before they were toggled to ON.) Just Add Power Last updated Jun-18 7

12 RTI Driver Guide Preset Selection Presets can be set for all outputs or only certain outputs. Presets are numbered Store Preset (All Outputs) Set a preset (1-16) to remember all output/input combinations to be recalled at a later time. Store Preset (Selected Outputs) Set a preset (1-16) to remember the output/input combination for the selected outputs. Use Output-Input Selection to select outputs. Recall Preset Selection Recall a preset (1-16). 8 Just Add Power Last updated Jun-18

13 RTI Driver Guide POE Selection Turns on/off the Power over Ethernet function of individual ports. Used to remotely power-cycle PoE devices through program control. Only 2 options: ON and OFF. On Off Just Add Power Last updated Jun-18 9

14 RTI Driver Guide SAVE Saves the switch in the current configuration. This means that if the switch loses power, the system will return to the saved state upon powering back up again. 10 Just Add Power Last updated Jun-18

15 System Variables RTI Driver Guide The switching driver keeps track of some system variables that can be used to enhance programming and assist in troubleshooting issues. Operational Mode Returns the status of the driver: Demo means there is no license key entered or license key is invalid Licensed means the license key is valid and full features are enabled Connecting means the device cannot communicate with the switch. Check that the IP in the driver matches the IP of the switch. This is also the placeholder text in Integration Designer. Model Number Returns the model of switch being controlled by the driver Licence Status Returns the license status of the driver Output Current Input Returns the name of the Input currently being watched by that Output. XXX = Receiver number as connected to the Cisco SG300. First Receiver on the switch is 001. Output Selected Returns a true/false value reporting whether the output is marked as selected in the driver. This variable is toggled by Output-Input Selection. Just Add Power Last updated Jun-18 11

16 RTI Driver Guide Static Route All features after this point require a Static Route in order to work. There are two ways to enable a Static Route: With Router Without Router With Router Adding a Static Route to the local router is mandatory to get the RS232-IP Server to work. Many internet routers have the ability to redirect network traffic internally to IP addresses that are not part of the normal data network. Just Add Power devices use this function to communicate with the Local Area Network without interfering with regular data traffic. Access the web interface of the internet router connected to port 1 of the managed switch and look for a section labeled Static Routing. The exact location of this section in the menus differs depending on the router. Once in the Static Routing section, look for an option that allows the Static Route to be added to the Local Area Network. It may be called LAN & Wireless, Local Area Network, etc. If the only Static Route option is WAN, Internet, or Wide Area Network, then that internet router is most likely not capable of the Static Routing function needed. A different router is needed. Static Routing on a Luxul ABR Just Add Power Last updated Jun-18

17 Without Router RTI Driver Guide If the system will not have a router or the router does not have Static Routing, then the RTI processor will not have internet access. In that case, a Static Route cannot be applied as there is nowhere to apply it to. To setup the RTI processor so that it can communicate with the Just Add Power devices, set the IP settings of the RTI processor manually so that it uses the managed switch s IP address as the default gateway. Example: The managed switch has been configured with an IP address of and a subnet mask of (done through JADConfig.) IP address of the RTI is set as to be in the same network. RTI Network Setting Just Add Power Last updated Jun-18 13

18 RTI Driver Guide TxRxComms Driver Static Route must be set for the TxRxComms driver to work. The TxRxComms driver controls all Layer 3 features of Just Add Power devices. Layer 3 functions are: RS232 control Add CEC control IR control Video Wall Image Pull On-Screen Display Open Integration Designer and open the installation file In the XP processor Drivers menu, click Add. Navigate to the location of the appropriate switch driver and click Open. If Layer 3 functions of Just Add Power devices are being used, TxRxComms drivers must be added as well. In the XP processor Drivers menu, click Add. Navigate to the location of the TxRxComms driver and click Open. Add one TxRxComms driver for EACH Just Add Power device that is using Layer 3 functions. 14 Just Add Power Last updated Jun-18

19 RTI Driver Guide Configure 1. In the XP processor Drivers tab, select the JAD SOIP/Console/CEC driver. 2. Set TCP Address to the IP address assigned to the Just Add Power device. 3. Set Serial Port Settings: a. Serial Port Mode i. No Serial Port set if no serial control is used ii. Dumb Redirection set if a device is connected to the serial port of a Just Add Power Transmitter to have commands pass through to all connected Receivers iii. CLI Access to Single Device set if Receivers will be controlled through the RTI control platform. Default setting. iv. CLI Access to All Receivers set if one Receiver will be used to send a command to all Receivers in the installation. b. Baud Rate match to the baud rate of the communicating device. Default is c. Bits match to the bits of the communicating device. Default is 8. d. Parity match to the parity of the communicating device. Default is None. e. Stop Bits match to the stop bits of the communicating device. Default is Paste the License Key into the Licence Key box. Just Add Power Last updated Jun-18 15

20 RTI Driver Guide Driver Commands Send Serial Command Send a custom serial command out the serial port on the Just Add Power device. Hex commands should be escaped with leading \x. IR commands are also sent using the Send Serial Command option. See the Flux Capacitor IR Dongle section. Example: To send the ASCII string: ka Example: To send the hex string: d6 16 Just Add Power Last updated Jun-18

21 RTI Driver Guide Send Console Command Select a command to send directly to the Command Line Interface of the Just Add Power device Audio Delay Decrease decrease the audio delay value on a Transmitter or Receiver (2G+ only) Audio Delay Increase increase the audio delay value on a Transmitter or Receiver (2G+ only) Capture RX EDID copy the EDID from the device connected to the Receiver and pass it back to the Transmitter Link RESTART Enable Network connection on device Link STOP Disable Network connection on device Link Watchdog Disable disable active check for HDMI Link Watchdog Enable enable active check for HDMI Reboot reboot the device RX HDMI Mute/Darken RX HDMI OFF Turn off HDMI output on the Receiver RX HDMI ON Turn on HDMI output on the Receiver TX HDMI OFF Turn off HDMI services on the Transmitter TX HDMI ON Turn on HDMI services on the Transmitter TX Video Mode 0 Set Quality Mode 0 for video encoding TX Video Mode 1 Set Quality Mode 1 for video encoding TX Video Mode 2 Set Quality Mode 2 for video encoding TX Video Mode 3 Set Quality Mode 3 for video encoding TX Video Mode Dynamic DEFAULT Set Quality Mode -1 for video encoding USB/IP Enable Enable USB functionality USB/IP Take Control Tell Receiver device to take control of USB functions USB/IP Disable Disable USB functionality Video Wall Scale Adjust Scale video wall so that sizes 3x3 and larger have correct bezel gap values Watch 1080i as 1080p DEFAULT Set Transmitter to scale 1080i content to 1080p video Watch 1080i to 720p Set Transmitter to scale 1080i content to 720p video Send Console Command (advanced) Send any command to the Command-Line Interface of the Just Add Power device. Just Add Power Last updated Jun-18 17

22 RTI Driver Guide Audio Delay Adjust the Audio Delay value on the device to any integer from Basic Video Wall Mode Change Set the Receiver to show a portion of the picture for a video wall: Number Of Rows Total number of rows in the video wall. Set to (1) for single-screen. Number Of Columns Total number of columns in the video wall. Set to (1) for single-screen. Row Position This Receiver s row in the overall video wall. Set to (1) for single-screen. Column Position This Receiver s column in the overall video wall. Set to (1) for single-screen. Example 1: Set the Receiver to show row 2, column 1 of a 3x3 video wall. Example 2: Set the Receiver to show a full picture single-screen mode Basic Video Wall Tear Adjust Set the tearing value on a Receiver to remove any horizontal cuts in the picture. Maximum value: Just Add Power Last updated Jun-18

23 RTI Driver Guide Slideshow Run through a list of images stored on a Just Add Power Receiver. The Receiver must not be showing Transmitter video. Choose the number of seconds to show each slide and the number of slides to show before the slideshow ends. Just Add Power Last updated Jun-18 19

24 RTI Driver Guide Send CEC Command (standard) These commands are pre-programmed into the driver: Display ON Turn on the attached display. Display OFF Turn off the attached display. TV Speakers ON Enable the TV speakers. This is different than the TV mute function. TV Speakers OFF Disable the TV speakers. This is different than the TV mute function. Force TV to JAP HDMI Select HDMI 1 on the display device. Send CEC Command (advanced) Send customized CEC commands. is a great resource for finding CEC commands. CEC commands are a series of hex codes. Enter CEC commands separated by spaces into the driver in this format (aa, bb, cc, and dd are hex codes): aa bb cc dd Example: Send hex code ef through CEC. Set OSD Format Set the text Size, Transparency, and text Color for the On-Screen Display. Text color must be in hexadecimal format as 0xffffff where f is any hexadecimal value from 0-f. Uses RGB color formatting. Example: Set Size to 35, Transparency to 15, and Color to Green (00FF00) 20 Just Add Power Last updated Jun-18

25 OSD On RTI Driver Guide Turn on the On-Screen Display. The entered text will show up on the display. Text will continue to show until OSD Off is sent. OSD Off Turn off the On-Screen Display. Best-used in conjunction with a time delay. Example: Show text Front Doorbell for 10 seconds. Just Add Power Last updated Jun-18 21

26 RTI Driver Guide System Variables The TxRxComms driver keeps track of some system variables that are useful for troubleshooting. Licence Status Returns the license status of the driver SOIP Status Returns the SOIP status of the Just Add Power device Telnet Status Returns the status of the telnet connection to the Just Add Power device 22 Just Add Power Last updated Jun-18

27 Image Pull RTI Driver Guide Setting up Image Pull on RTI is a 5-part process. All parts must be completed for Image Pull to work correctly 1. Setup Static Route 2. Add TxRxComms driver for each device 3. Load the Image URL driver 4. Enable Image Pull on Just Add Power device 5. Convert the default bitmap to a PNG with a Macro and Event so RTI can display it. Just Add Power Last updated Jun-18 23

28 RTI Driver Guide TxRxComms Driver 1. Load the JAD_TxRxComms.rtiDriver into Integration Designer. Each instance of the driver will control one Just Add Power device (either Transmitter or Receiver). Load 1 of these drivers for each device that will be doing Image Pull. 2. Set the TCP Address to the IP address of the Just Add Power Transmitter/Receiver. 3. Enter the license key tied to the MAC Address of the RTI processor into the Licence Key box. The same license key is used for all Just Add Power drivers. Contact drivers@justaddpower.com to receive one. 24 Just Add Power Last updated Jun-18

29 Image URL Driver RTI Driver Guide 1. Load the Image URL.rtiDriver into Integration Designer. Each instance of the driver can control 12 devices, so load additional drivers if more are needed. 2. Set the Number of Image URLs Required to the number of devices that will be using Image Pull. Maximum is Set the URL Name to any name desired. 4. Set the URL Address to where xx.xx.xx.xx is the IP address of the Just Add Power device. Do this for up to 12 URLs per driver. 5. Set the URL Auto Refresh Interval to 3 the amount of seconds to wait before refreshing the image. The driver uses a large amount of the RTI processor s resources so values lower than 3 are not recommended. 6. On a Virtual Panel, ipad, remote, etc.: draw a button, go to the Library Browser s Drivers tab, and select the Image URL driver. 7. Select Assign to: Dynamic Image from the dropdown box and drag-and-drop onto the newly drawn button. Just Add Power Last updated Jun-18 25

30 RTI Driver Guide 8. Right-click on the button, Edit Properties -> Variables, and select Stretch for scaling. This will make the image take up the full button space without distortion. 9. At this point, loading the profile will show nothing on the image, as pull.png does not exist. 26 Just Add Power Last updated Jun-18

31 RTI Driver Guide Enable Image Pull 1. Telnet to the Just Add Power devices to get to the Command Line Interface (CLI). 2. Apply this line of code to enable a 320-pixel Image Pull every 3 second: astparam s pull_on_boot 320_1_3;astparam save;reboot 3. Repeat steps 1-2 for each Just Add Power device performing Image Pull. NOTE: Contact support@justaddpower.com for more information on modifying Image Pull variables. Just Add Power Last updated Jun-18 27

32 RTI Driver Guide Create PNG with Macro and Event 1. Go to System Macros on the control processor and create a new macro 2. Select Driver Command, access a JAD SOIP/Console/CEC driver, and select Send Console Command (advanced) 3. The command below tells the Just Add Power device to create the pull.png file so that it can be viewed by RTI. In the textbox for the driver command, paste this: bmp2png -o /www/tmp.png /www/pull.bmp;mv /www/tmp.png /www/pull.png 4. Drag the command into the Macro Editor window 5. Repeat steps 3-4 for each JAD COIP/Console/CEC driver performing Image Pull. A different macro can be made for each device, or have one macro handling all devices. (Figures show 5 Receivers on one macro). 6. Go to the Events tab and Add Periodic Event. Set the interval to be the same as the Auto Refresh Interval 3 seconds recommended and choose the macro(s) created in steps 1-5 above. Again, please test before using a lower interval, as the process is memory-intensive on both Just Add Power and RTI. 7. Check the box next to the event to enable it. 28 Just Add Power Last updated Jun-18

33 RTI Driver Guide Flux Capacitor IR Dongle 1. Add a TxRxComms driver for the Just Add Power device TxRxComms driver 2. In the TxRxComms driver, apply these settings: a. TCP Address IP address of the Just Add Power device that the Flux Capacitor is connected to b. Serial Port Mode CLI Access to Single Device c. Baud Rate 9600 d. Bits 8 e. Parity None f. Stop Bits 1 g. Licence Key The license key for the RTI processor (same license key as switching driver) TxRxComms Settings 3. In Library Browser, go to Select New Remote and choose the IR device to be controlled. Samsung TV IR Remote Just Add Power Last updated Jun-18 29

34 RTI Driver Guide 4. Drag the IR code onto a panel. It will create a button with the IR code assigned to it. 5. Right-click on the button and choose Copy. This will copy both the button and the command on the button. Copy IR Command 6. Paste the copied IR code into the Send RTI IR option in the Just Add Power Flux Interface driver a. Create a command or macro b. Select the JAD SOIP/Console/CEC driver SOIP Commands Send Serial Command option c. Paste the copied command into the String box d. Add a \r to the end of the code. This is the notation for the Enter key to send the command. e. Drag into the main window to add the command to the macro Note: Both Global Cache and Pronto formatted codes will work Paste IR Command into Send Serial Command option of the JAD SOIP/Console/CEC driver 7. Activate the button/macro to send the IR code. Done! 30 Just Add Power Last updated Jun-18

35 Troubleshooting RTI Driver Guide 1. Switching stops working after 30 minutes. Check that the license key is correct. See License Key section for details on how to get a license key. Check that the Operational Mode variable of the driver is marked as Licensed. This can be done by adding the variable to Button Text, or by going to the IP address of the RTI processor with the XP Diagnostics driver running. 2. The Switching driver is working, but the Serial-Over-IP driver is not working. Check that the license key has been added to the Serial-Over-IP driver. The same license key is used for all drivers in the same project. Check that the IP address if the driver is properly entered. Check that the Static Route has been properly applied in the router. Use a computer on the network to ping or tracert to the Just Add Power devices to confirm that they are able to be communicated with. See the Router or No Router sections for configuration information. 3. In the Serial-Over-IP driver, serial commands sent through Just Add Power devices are not controlling the display. Confirm that the Serial-Over-IP driver is working (see #2 above) Confirm that the Baud Rate in the driver matches the Baud Rate expected by the display. Confirm that the IP address in the driver corresponds to the Receiver that is being tested. Try adding a Null Modem to the serial connection (pins 2&3 may be swapped). If using 2G+ devices, change the configuration of the Null Modem Jumpers on the bottom of the device to swap pins 2&3. Try feeding the output of the Just Add Power serial connection into a computer running PuTTY. Send commands through RTI and see if the same commands appear in the PuTTY session. 4. Switching driver is reporting as Licensed but switching commands aren t working. Check that devices are connected to the correct ports on the switch. Transmitters start at port 2 and Receivers start immediately after the last Transmitter port. Check that the correct Input/Output number is being used. Input 1 is the first Transmitter on the switch (in port 2). Output 1 is the first Receiver on the switch (in the port immediately after the last Transmitter). Just Add Power Last updated Jun-18 31