vrLib SDK Documentation
VideoRay.Communication Namespace
NamespacesVideoRay.Communication
Communication library. Implements the standard VideoRay protocols. Currently limited to serial communication.
Declaration Syntax
C#Visual BasicVisual C++
namespace VideoRay.Communication
Namespace VideoRay.Communication
namespace VideoRay.Communication
Types
All TypesClassesStructuresInterfacesDelegates
IconTypeDescription
AutoDetect
Class encapsulating serial port auto-detection behavior

CommPort
Abstracts Serial Port handling while providing a bit nicer interface

CommPortName
Provides friendly device driver name as well as simple COM# name

CommsManager
Manages communications on a single communication channel Currently only PRO4 protocol is implemented

CSR
Configuration Status Register abstraction This is primiarily used for the devices communicating using the PRO4 protocol

CommPort..::.DataReceivedArgs
Paramater type passed to serial reception event handler

InterfaceAdapter_KCF_SmartTether
Specialization of Protocol_PRO4_InterfaceAdapter for the KCF smart tether This implementations allows us to intercept quiers to the ROV and emulate them at the surface. This saves a bit of comms bandwidth, and allows us to inject our depth sensor etc.

Protocol_PRO4_IDevice
Interface for any device which communicates on using the PRO4 protocol

Protocol_PRO4_InterfaceAdapter
Manages devices on an PRO4 RS-485 bus which require protocol wrapping Typically this is done using the Protocol Adapter Mux on the wet end. And a vitual serial port on the top end to communicate with the driving software

Protocol_PRO4_Packet
PRO4 protocol packet

Protocol_PRO4_Packet_EventArgs
Protocol_PRO4_Packet EventArgs wrapper for packet reception event handling

Protocol_PRO4_Packet_Header
Header for a PRO4 protocol packet

Protocol_PRO4_Parser
Class to handle parsing of a PRO4 communication stream

CommPort..::.ReceivedDataHandler
Delagate used for serial port data reception handling