VideoRay Cockpit Application Integration

VideoRay Cockpit supports unprecedented application integration through new software and hardware interfaces.

Virtual COM Ports

For data communications with other applications, VideoRay Cockpit software includes a virtual COM port driver. As an example of how this technology works, VideoRay Cockpit is integrated with the KCF Smart Tether. Both programs need to access their respective hardware, but the KCF Smart Tether nodes and the ROV share a common communications bus. This presents a problem because only one software application at a time can access the physical port to which the bus is attached. In order to solve this problem, VideoRay Cockpit handles the communications with both hardware systems and passes information it receives from the tether nodes to a virtual COM port. The KCF Smart Tether opens a companion virtual COM Port where it receives this data. As you may have noticed, virtual COM ports are defined in pairs. Typically one application writes to a port, and the other application reads from the companion port. The virtual COM port driver supports multiple port pairs.

A second example is the Desert Star AquaMap Shiphull. Traditionally, this system used the APIC (Auxiliary Pair of Independent Conductors) in the tether, and the software "talked" directly to the mobile station mounted on the ROV. This meant that other devices that require the APIC could not be used simultaneously with ShipHull. In the Pro 4, the mobile station can be connected to the ROV communications bus rather than the APIC (see below for hardware configuration details), and VideoRay cockpit can pass the data from the mobile station to the Shiphull software using a pair of virtual COM ports. Using this arrangement, ShipHull can now be used simultaneously with accessories such as sonar or other devices that require a dedicated communications channel.

Other possible uses of virtual COM ports include having VideoRay Cockpit make the heading, depth, temperature and/or other parameters available for another software application to read in real time.

Default Virtual COM Port Assignments

COM Port Pair	Purpose
15 - 16	Ports assigned for VideoRay Cockpit to communicate with KCF Smart Tether
17 - 18	Unassigned
19 - 20	Unassigned
31 - 32	Reserved for VideoRay Cockpit to communicate with a generic external application for real-time serial data transfer

Additional port pairs or assignments may be defined in the future.

In each case in the table above, VideoRay Cockpit is configured to communicate with the lower (odd) numbered port and the other software application configured to communicate with the higher (even) numbered port.

PAM - a New Hardware Interface

Up until now, the only accessory that could be controlled by VideoRay was the manipulator. Other accessories needed to use the APIC and have a topside software application to control the accessory or read data from it. In order to expand the possibilities, VideoRay created a PAM (Protocol Adapter and Multiplexer) module. The PAM module is a hardware interface that supports power, servo motor controllers and serial communications. The PAM will allow devices like the radiation sensor, which required the APIC and its own software application, to be connected to a PAM, and communicate directly with VideoRay Cockpit. Besides freeing up the APIC for another device, this arrangement allows VideoRay Cockpit to offer a radiation sensor instrument. The instrument can be configurable with control over and the display and alarms, and even turning the sensor on or off. In addition, and perhaps more importantly, with VideoRay Cockpit managing the data from the radiation sensor, it can be displayed in the video text overlay and/or recorded as part of a comprehensive collection of synchronized video and sensor data.

SDK (Software Developer's Kit)

Accessory developers, programmers and "Do-it-your-selfers" will be able to exploit the capabilities of the virtual COM ports and PAM easily through the VideoRay Cockpit SDK. See the SDK section of the Customization Guide for more information. Additional information about the SDK can also be found online at: https://download.videoray.com/developer/