vrLib SDK Documentation
VideoRay Namespace
NamespacesVideoRay
Default namespace. Contains mostly abstractions for hardware.
Declaration Syntax
C#Visual BasicVisual C++
namespace VideoRay
Namespace VideoRay
namespace VideoRay
Types
All TypesClassesInterfacesEnumerations
IconTypeDescription
Standards..::.AutoControlSubsystems
AutoMode
An automode provides for autonomous control of a specific parameter A typical VideoRay ROV has 2 or more automodes, heading, depth, etc. Currently only exposes the PRO4 CSR fields

Camera
Represents a Camera

Camera..::.CameraButtonCommands
Buttons available on the manual camera interface These are used for controlling the on-board menu

ROV..::.ControlGains
Encapsulates the gains which are applied to the mapped controller input prior to setting the thruster parameters

ROV..::.DeviceSpecificResponsePacketType
Standards..::.Directions
ExternalThruster
An object which represents a PAM based external thruster POD

Health
Exposes various internal health status indicators for a device

IThruster
Interface for a thruster object. All thrusters should implement this regardless of their low level implemenation

Lights
Represents an Illumination device

Standards..::.Limits
Manipulator
Represents a manipulator or simple cutting device

Standards..::.MotionDirection
Standard DOF as per Fossen and SNAME are: 1 x (surge) 2 y (sway) 3 z (heave) 4 rot x (roll) 5 rot y (pitch) 6 rot z (yaw)

Navigation
The Navigation class contains all orientation, velocity, acceleration, and position data available

PAM_AccessoryModule
Represents the unspecialized Protocol Adapter Multiplexer

PID
Parameters for PID controllers

PowerManager
Represents the power manager subsystem on the ROV

Camera..::.QuickCommand
EXPERIMENTAL Macros to drive camera menu commands These emulate manual button presses on the camera

Standards..::.Rotations
ROV
Encapsulates an ROV. Specifically a PRO4 ROV.

ROV..::.SelectedCamera
Standards
Various arbitrary standards Used for things like indexing into arrays etc.

Manipulator..::.State
Current videoray tooling supports opening or closing.

Thruster
A thruster provides propulsion A typical VideoRay ROV has 3 thrusters: Port, Starboard, and Vertical Currently only exposes the PRO4 CSR fields