Loadable Module: Sensor

The SensorModule provides components responsible for providing software-hardware-device communications for getting measurements from navigation-related sensor devices – i.e., devices that measure the state of the vehicle and its trajectory, such as the AHRS, depth sensor, modems, and internal pressure, temperature, and humidity. More...

Namespaces
	ISUSIF
	Specifies the interface details for the ISUS component in the SensorModule.
	PAR_LicorIF
	Specifies the interface details for the Depth_MSI_US300 component in the SensorModule.
	Turner_Cyclops_rhodamineIF
	Specifies the interface details for the Depth_MSI_US300 component in the SensorModule.
	WetLabsBB2FLIF
	Specifies the interface details for the WetLabsBB2FL component in the SensorModule.
	AcousticModem_Benthos_ATM900IF
	Specifies the interface details for the AcousticModem_Benthos_ATM900 component in the SensorModule.
	AHRS_3DMGX3IF
	Specifies the interface details for the AHRS_3DMGX3 component in the SensorModule.
	AHRS_sp3003DIF
	Specifies the interface details for the AHRS_sp3003D component in the SensorModule.
	Batt_Ocean_ServerIF
	Specifies the interface details for the Batt_Ocean_Server component in the SensorModule.
	BPC1IF
	Specifies the interface details for the BPC1 component in the SensorModule.
	DataOverHttpsIF
	Specifies the interface details for the DataOverHttps component in the SensorModule.
	DATIF
	Specifies the interface details for the DAT component in the SensorModule.
	Depth_KellerIF
	Specifies the interface details for the Depth_MSI_US300 component in the SensorModule.
	DropWeightIF
	Specifies the interface details for the DropWeight component in the SensorModule.
	DVL_microIF
	Specifies the interface details for the DVL_micro component in the SensorModule.
	NAL9602IF
	Specifies the interface details for the NAL9602 component in the SensorModule.
	OnboardIF
	Specifies the interface details for the Onboard component in the SensorModule.
	PNI_TCMIF
	Specifies the interface details for the PNI_TCM component in the SensorModule.
	Radio_SurfaceIF
	Specifies the interface details for the Radio_Surface component in the SensorModule.
	Rowe_600IF
	Specifies the interface details for the Rowe_600 component in the SensorModule.
	Rowe_600LCMIF
	Specifies the interface details for the Rowe_600 component in the SensorModule.
	SCPIIF
	Specifies the interface details for the SCPI component in the SensorModule.

Classes
class	LogSplitterComponent
	Splits logs whenever data is requested from a Universal::communications reader. More...
class	PAR_Licor
	Provides software interface to the Keller depth sensor Can also use SimSlate to provide simulated depth values when they are available. More...
class	Turner_Cyclops_rhodamine
	Provides software interface to the Keller depth sensor Can also use SimSlate to provide simulated depth values when they are available. More...
class	AcousticModem_Benthos_ATM900
	Provides software interface to the Benthos ATM-900 Acoustic Modem. More...
class	AHRS_3DMGX3
	Provides software interface to the Microstrain 3DMGX1 AHRS. More...
class	AHRS_sp3003D
	Provides software interface to the Sparton SP3003D AHRS. More...
class	Batt_Ocean_Server
	Provides software interface to the Ocean Server Battery Boards. More...
struct	Batt_Ocean_Server::BattPack
	Data structure looks as follows: More...
class	BPC1
	Provides software interface to the Battery Pack Controller. More...
struct	BPC1::BattStick
class	DAT
	Provides software interface to the Benthos DAT. More...
class	DataOverHttps
	Provides software interface for sending sbds over the https when an https connection is available. More...
class	Depth_Keller
	Provides software interface to the Keller depth sensor Can also use SimSlate to provide simulated depth values when they are available. More...
class	DropWeight
	Provides software interface to the DVL Micro. More...
class	NAL9602
	Provides software interface to the NAL Research NAL9602 Iridium modem and compass. More...
struct	NAL9602::SendPacket
struct	NAL9602::Fix
	Data structure contains items specified by the NMEA GPS data standard. More...
struct	NAL9602::NmeaUTCDate
struct	NAL9602::NmeaUTCTime
struct	NAL9602::SNRWriters
class	NAL9602_Test
	Unit tests for NAL9602 class. More...
class	Onboard
	Provides software interface to internal system sensors on the Tethys motherboard. More...
class	PNI_TCM
	Provides software interface to the PNI TCM compass. More...
class	Rowe_600
	Provides software interface to the Rowe Rowe_600 DVL. More...
class	Rowe_600LCM
	Provides software interface to the Rowe Rowe_600 DVL. More...
class	SensorModule
	The SensorModule provides components responsible for providing software-hardware-device communications for getting measurements from navigation-related sensor devices – i.e., devices that measure the state of the vehicle and its trajectory, such as the AHRS, depth sensor, modems, and internal pressure, temperature, and humidity. More...

Macros
#define	UART_BUFSIZE   10240L
	Provides software interface to the DVL Micro. More...

Enumerations
enum	AHRS_sp3003D::CalibrateSpartonMode {   AHRS_sp3003D::CAL_OFF, AHRS_sp3003D::CAL_RESET, AHRS_sp3003D::CAL_AUTOVAR, AHRS_sp3003D::CAL_MANUAL,   AHRS_sp3003D::CAL_AUTO }
enum	Batt_Ocean_Server::SMBStatus {   Batt_Ocean_Server::OVER_CHARGED_ALARM = 0x8000, Batt_Ocean_Server::TERMINATE_CHARGE_ALARM = 0x4000, Batt_Ocean_Server::OVER_TEMP_ALARM = 0x1000, Batt_Ocean_Server::TERMINATE_DISCHARGE_ALARM = 0x0800,   Batt_Ocean_Server::REMAINING_CAPACITY_ALARM = 0x0200, Batt_Ocean_Server::REMAINING_TIME_ALARM = 0x0100, Batt_Ocean_Server::INITIALIZED = 0x0080, Batt_Ocean_Server::DISCHARGING = 0x0040,   Batt_Ocean_Server::FULLY_CHARGED = 0x0020, Batt_Ocean_Server::FULLY_DISCHARGED = 0x0010 }
enum	BPC1::SMBStatus {   BPC1::OVER_CHARGED_ALARM = 0x8000, BPC1::TERMINATE_CHARGE_ALARM = 0x4000, BPC1::OVER_TEMP_ALARM = 0x1000, BPC1::TERMINATE_DISCHARGE_ALARM = 0x0800,   BPC1::REMAINING_CAPACITY_ALARM = 0x0200, BPC1::REMAINING_TIME_ALARM = 0x0100, BPC1::INITIALIZED = 0x0080, BPC1::DISCHARGING = 0x0040,   BPC1::FULLY_CHARGED = 0x0020, BPC1::FULLY_DISCHARGED = 0x0010 }
enum	DataOverHttps::DataState {   DataOverHttps::TCP_CONNECT, DataOverHttps::TCP_CONNECTING, DataOverHttps::SSL_CONNECT, DataOverHttps::SSL_CONNECTING,   DataOverHttps::DATA_WRITE, DataOverHttps::DATA_WRITING, DataOverHttps::DATA_READ, DataOverHttps::DISCONNECT,   DataOverHttps::DISCONNECTED }
enum	DataOverHttps::KeyType {   DataOverHttps::KEY_UNKNOWN = -1, DataOverHttps::KEY_BUSY, DataOverHttps::KEY_FILE, DataOverHttps::KEY_FILENAME,   DataOverHttps::KEY_FILESIZE, DataOverHttps::KEY_MOMSN, DataOverHttps::KEY_MTMSN, DataOverHttps::KEY_VEHICLE,   DataOverHttps::KEY_COUNT }
enum	NAL9602::CommsState {   NAL9602::SLEEPING, NAL9602::WAKING, NAL9602::CMDMODE, NAL9602::AWAKE,   NAL9602::NEED_FIX, NAL9602::NEED_GSV, NAL9602::GET_SIG_QUALITY, NAL9602::SENDING_FILL_BUFFER,   NAL9602::SENDING_TRANSMIT, NAL9602::SENDING_VERIFY, NAL9602::RECEIVING_1, NAL9602::RECEIVING_2,   NAL9602::MTQUEUE_QUALITY, NAL9602::MTQUEUE_SESSION, NAL9602::GO_TO_SLEEP }
enum	NAL9602::DataQuality { NAL9602::INVALID, NAL9602::VALID_ONE, NAL9602::VALID_TWO, NAL9602::DEAD_RECKON }
enum	NAL9602::Hemisphere {   NAL9602::NORTHERN_HEMI, NAL9602::SOUTHERN_HEMI, NAL9602::EASTERN_HEMI, NAL9602::WESTERN_HEMI,   NAL9602::INVALID_HEMISPHERE }
enum	NAL9602::SentenceType { NAL9602::GPGGA, NAL9602::GPGSA, NAL9602::GPRMC, NAL9602::UNKNOWN_NMEA_TYPE }
enum	NAL9602IF::DownlinkOutStatus { NAL9602IF::DOWNLINK_OUT_OK = 0, NAL9602IF::DOWNLINK_OUT_SENT = 1, NAL9602IF::DOWNLINK_OUT_ERROR = 2 }
	Defines downlink (out) status states. More...
enum	NAL9602IF::UplinkInStatus { NAL9602IF::UPLINK_IN_NO_MESSAGE = 0, NAL9602IF::UPLINK_IN_GOT_MESSAGE = 1, NAL9602IF::UPLINK_IN_ERROR = 2 }
	Defines uplink (in) status states. More...
enum	PNI_TCM::StartupSequence {   PNI_TCM::SETDATA, PNI_TCM::MOUNTING, PNI_TCM::ENDIAN, PNI_TCM::PARAMS,   PNI_TCM::PARAMRESPONSE, PNI_TCM::DONE }

Detailed Description

The SensorModule provides components responsible for providing software-hardware-device communications for getting measurements from navigation-related sensor devices – i.e., devices that measure the state of the vehicle and its trajectory, such as the AHRS, depth sensor, modems, and internal pressure, temperature, and humidity.

Macro Definition Documentation

#define UART_BUFSIZE   10240L

Provides software interface to the DVL Micro.

Enumeration Type Documentation

enum AHRS_sp3003D::CalibrateSpartonMode

Enumerator
CAL_OFF
CAL_RESET
CAL_AUTOVAR
CAL_MANUAL
CAL_AUTO

enum NAL9602::CommsState

private

Enumerator
SLEEPING
WAKING
CMDMODE
AWAKE
NEED_FIX
NEED_GSV
GET_SIG_QUALITY
SENDING_FILL_BUFFER
SENDING_TRANSMIT
SENDING_VERIFY
RECEIVING_1
RECEIVING_2
MTQUEUE_QUALITY
MTQUEUE_SESSION
GO_TO_SLEEP

enum NAL9602::DataQuality

private

Enumerator
INVALID
VALID_ONE
VALID_TWO
DEAD_RECKON

enum DataOverHttps::DataState

private

Enumerator
TCP_CONNECT
TCP_CONNECTING
SSL_CONNECT
SSL_CONNECTING
DATA_WRITE
DATA_WRITING
DATA_READ
DISCONNECT
DISCONNECTED

enum NAL9602IF::DownlinkOutStatus

Defines downlink (out) status states.

Enumerator
DOWNLINK_OUT_OK
DOWNLINK_OUT_SENT
DOWNLINK_OUT_ERROR

enum NAL9602::Hemisphere

private

Enumerator
NORTHERN_HEMI
SOUTHERN_HEMI
EASTERN_HEMI
WESTERN_HEMI
INVALID_HEMISPHERE

enum DataOverHttps::KeyType

private

Enumerator
KEY_UNKNOWN
KEY_BUSY
KEY_FILE
KEY_FILENAME
KEY_FILESIZE
KEY_MOMSN
KEY_MTMSN
KEY_VEHICLE
KEY_COUNT

enum NAL9602::SentenceType

private

Enumerator
GPGGA
GPGSA
GPRMC
UNKNOWN_NMEA_TYPE

enum Batt_Ocean_Server::SMBStatus

private

Enumerator
OVER_CHARGED_ALARM
TERMINATE_CHARGE_ALARM
OVER_TEMP_ALARM
TERMINATE_DISCHARGE_ALARM
REMAINING_CAPACITY_ALARM
REMAINING_TIME_ALARM
INITIALIZED
DISCHARGING
FULLY_CHARGED
FULLY_DISCHARGED

enum BPC1::SMBStatus

private

Enumerator
OVER_CHARGED_ALARM
TERMINATE_CHARGE_ALARM
OVER_TEMP_ALARM
TERMINATE_DISCHARGE_ALARM
REMAINING_CAPACITY_ALARM
REMAINING_TIME_ALARM
INITIALIZED
DISCHARGING
FULLY_CHARGED
FULLY_DISCHARGED

enum PNI_TCM::StartupSequence

private

Enumerator
SETDATA
MOUNTING
ENDIAN
PARAMS
PARAMRESPONSE
DONE

enum NAL9602IF::UplinkInStatus

Defines uplink (in) status states.

Enumerator
UPLINK_IN_NO_MESSAGE
UPLINK_IN_GOT_MESSAGE
UPLINK_IN_ERROR