VectorNav Sensor Registers

VectorNav sensors contains a large set of configurable registers with various fields for each one. Listed below are the list of register classes that are used for reading and writing to the sensor’s registers.

AccelerationCompensationRegister

class vnpy.AccelerationCompensationRegister

Structure representing the Acceleration Compensation register.

Class attributes are:

AccelerationCompensationRegister.c

The c field.

AccelerationCompensationRegister.b

The b field.

BinaryOutputRegister

class vnpy.BinaryOutputRegister

Structure representing a Binary Output register.

The field outputGroup available on the sensor’s register is not necessary in this structure since all read/writes operations will automatically determine this from the settings for the individual groups within this structure.

Class attributes are:

BinaryOutputRegister.async_mode

The asyncMode field.

BinaryOutputRegister.rate_divisor

The rateDivisor field.

BinaryOutputRegister.common_field

Group 1 (Common)

BinaryOutputRegister.time_field

Group 2 (Time)

BinaryOutputRegister.imu_field

Group 3 (IMU)

BinaryOutputRegister.gps_field

Group 4 (GPS)

BinaryOutputRegister.attitude_field

Group 5 (Attitude)

BinaryOutputRegister.ins_field

Group 6 (INS)

CalculatedMagnetometerCalibrationRegister

class vnpy.CalculatedMagnetometerCalibrationRegister

Structure representing the Calculated Magnetometer Calibration register.

CalculatedMagnetometerCalibrationRegister.c

The c field.

CalculatedMagnetometerCalibrationRegister.b

The b field.

CommunicationProtocolControlRegister

class vnpy.CommunicationProtocolControlRegister

Structure representing the Communication Protocol Control register.

CommunicationProtocolControlRegister.serial_count

The serialCount field.

CommunicationProtocolControlRegister.serial_status

The serialStatus field.

CommunicationProtocolControlRegister.spi_count

The spiCount field.

CommunicationProtocolControlRegister.spi_status

The spiStatus field.

CommunicationProtocolControlRegister.serial_checksum

The serialChecksum field.

CommunicationProtocolControlRegister.spi_checksum

The spiChecksum field.

CommunicationProtocolControlRegister.error_mode

The errorMode field.

DeltaThetaAndDeltaVelocityConfigurationRegister

class vnpy.DeltaThetaAndDeltaVelocityConfigurationRegister

Structure representing the Delta Theta and Delta Velocity Configuration register.

DeltaThetaAndDeltaVelocityConfigurationRegister.integration_frame

The integrationFrame field.

DeltaThetaAndDeltaVelocityConfigurationRegister.gyro_compensation

The gyroCompensation field.

DeltaThetaAndDeltaVelocityConfigurationRegister.accel_compensation

The accelCompensation field.

DeltaThetaAndDeltaVelocityRegister

class vnpy.DeltaThetaAndDeltaVelocityRegister

Structure representing the Delta Theta and Delta Velocity register.

DeltaThetaAndDeltaVelocityRegister.delta_time

The deltaTime field.

DeltaThetaAndDeltaVelocityRegister.delta_theta

The deltaTheta field.

DeltaThetaAndDeltaVelocityRegister.delta_velocity

The deltaVelocity field.

FilterActiveTuningParametersRegister

class vnpy.FilterActiveTuningParametersRegister

Structure representing the Filter Active Tuning Parameters register.

FilterActiveTuningParametersRegister.magnetic_disturbance_gain

The magneticDisturbanceGain field.

FilterActiveTuningParametersRegister.acceleration_disturbance_gain

The accelerationDisturbanceGain field.

FilterActiveTuningParametersRegister.magnetic_disturbance_memory

The accelerationDisturbanceGain field.

FilterActiveTuningParametersRegister.acceleration_disturbance_memory

The accelerationDisturbanceMemory field.

FilterBasicControlRegister

class vnpy.FilterBasicControlRegister

Structure representing the Filter Basic Control register.

FilterBasicControlRegister.mag_mode

The magMode field.

FilterBasicControlRegister.extMagMode

The extMagMode field.

FilterBasicControlRegister.ext_acc_mode

The extAccMode field.

FilterBasicControlRegister.ext_gyro_mode

The extGyroMode field.

FilterBasicControlRegister.gyro_limit

The gyroLimit field.

FilterMeasurementsVarianceParametersRegister

class vnpy.FilterMeasurementsVarianceParametersRegister

Structure representing the Filter Measurements Variance Parameters register.

FilterMeasurementsVarianceParametersRegister.angular_walk_variance

The angularWalkVariance field.

FilterMeasurementsVarianceParametersRegister.angular_rate_variance

The angularRateVariance field.

FilterMeasurementsVarianceParametersRegister.magnetic_variance

The magneticVariance field.

FilterMeasurementsVarianceParametersRegister.acceleration_variance

The accelerationVariance field.

GpsCompassBaselineRegister

class vnpy.GpsCompassBaselineRegister

Structure representing the GPS Compass Baseline register.

GpsCompassBaselineRegister.position

The position field.

GpsCompassBaselineRegister.uncertainty

The uncertainty field.

GpsCompassEstimatedBaselineRegister

class vnpy.GpsCompassEstimatedBaselineRegister

Structure representing the GPS Compass Estimated Baseline register.

GpsCompassEstimatedBaselineRegister.est_baseline_used

The estBaselineUsed field.

GpsCompassEstimatedBaselineRegister.num_meas

The numMeas field.

GpsCompassEstimatedBaselineRegister.position

The position field.

GpsCompassEstimatedBaselineRegister.uncertainty

The uncertainty field.

GpsConfigurationRegister

class vnpy.GpsConfigurationRegister

Structure representing the GPS Configuration register.

GpsConfigurationRegister.mode

The mode field.

GpsConfigurationRegister.pps_source

The ppsSource field.

GpsSolutionEcefRegister

class vnpy.GpsSolutionEcefRegister

Structure representing the GPS Solution - ECEF register.

GpsSolutionEcefRegister.tow

The tow field.

GpsSolutionEcefRegister.week

The week field.

GpsSolutionEcefRegister.gps_fix

The gpsFix field.

GpsSolutionEcefRegister.num_sats

The numSats field.

GpsSolutionEcefRegister.position

The position field.

GpsSolutionEcefRegister.velocity

The velocity field.

GpsSolutionEcefRegister.pos_acc

The posAcc field.

GpsSolutionEcefRegister.speed_acc

The speedAcc field.

GpsSolutionEcefRegister.time_acc

The timeAcc field.

GpsSolutionLlaRegister

class vnpy.GpsSolutionLlaRegister

Structure representing the GPS Solution - LLA register.

GpsSolutionLlaRegister.time

The time field.

GpsSolutionLlaRegister.week

The week field.

GpsSolutionLlaRegister.gps_fix

The gpsFix field.

GpsSolutionLlaRegister.num_sats

The numSats field.

GpsSolutionLlaRegister.lla

The lla field.

GpsSolutionLlaRegister.ned_vel

The nedVel field.

GpsSolutionLlaRegister.ned_acc

The nedAcc field.

GpsSolutionLlaRegister.speed_acc

The speedAcc field.

GpsSolutionLlaRegister.time_acc

The timeAcc field.

GyroCompensationRegister

class vnpy.GyroCompensationRegister

Structure representing the Gyro Compensation register.

GyroCompensationRegister.c

The c field.

GyroCompensationRegister.b

The b field.

ImuFilteringConfigurationRegister

class vnpy.ImuFilteringConfigurationRegister

Structure representing the IMU Filtering Configuration register.

ImuFilteringConfigurationRegister.mag_window_size

The magWindowSize field.

ImuFilteringConfigurationRegister.accel_window_size

The accelWindowSize field.

ImuFilteringConfigurationRegister.gyro_window_size

The gyroWindowSize field.

ImuFilteringConfigurationRegister.temp_window_size

The tempWindowSize field.

ImuFilteringConfigurationRegister.pres_window_size

The presWindowSize field.

ImuFilteringConfigurationRegister.mag_filter_mode

The magFilterMode field.

ImuFilteringConfigurationRegister.accel_filter_mode

The accelFilterMode field.

ImuFilteringConfigurationRegister.gyro_filter_mode

The gyroFilterMode field.

ImuFilteringConfigurationRegister.temp_filter_mode

The tempFilterMode field.

ImuFilteringConfigurationRegister.pres_filter_mode

The presFilterMode field.

ImuMeasurementsRegister

class vnpy.ImuMeasurementsRegister

Structure representing the IMU Measurements register.

ImuMeasurementsRegister.mag

The mag field.

ImuMeasurementsRegister.accel

The accel field.

ImuMeasurementsRegister.gyro

The gyro field.

ImuMeasurementsRegister.temp

The temp field.

ImuMeasurementsRegister.pressure

The pressure field.

ImuRateConfigurationRegister

class vnpy.ImuRateConfigurationRegister

Structure representing the IMU Rate Configuration register.

ImuRateConfigurationRegister.imu_rate

The imuRate field.

ImuRateConfigurationRegister.nav_divisor

The navDivisor field.

ImuRateConfigurationRegister.filter_target_rate

The filterTargetRate field.

ImuRateConfigurationRegister.filter_min_rate

The filterMinRate field.

InsAdvancedConfigurationRegister

class vnpy.InsAdvancedConfigurationRegister

Structure representing the INS Advanced Configuration register.

InsAdvancedConfigurationRegister.use_mag

The useMag field.

InsAdvancedConfigurationRegister.use_pres

The usePres field.

InsAdvancedConfigurationRegister.pos_att

The posAtt field.

InsAdvancedConfigurationRegister.vel_att

The velAtt field.

InsAdvancedConfigurationRegister.vel_bias

The velBias field.

InsAdvancedConfigurationRegister.use_foam

The useFoam field.

InsAdvancedConfigurationRegister.gps_conv_type

The gpsConvType field.

InsAdvancedConfigurationRegister.vel_count

The velCount field.

InsAdvancedConfigurationRegister.vel_init

The velInit field.

InsAdvancedConfigurationRegister.move_origin

The moveOrigin field.

InsAdvancedConfigurationRegister.gps_timeout

The gpsTimeout field.

InsAdvancedConfigurationRegister.delta_limit_pos

The deltaLimitPos field.

InsAdvancedConfigurationRegister.delta_limit_vel

The deltaLimitVel field.

InsAdvancedConfigurationRegister.min_pos_uncertainty

The minPosUncertainty field.

InsAdvancedConfigurationRegister.min_vel_uncertainty

The minVelUncertainty field.

InsBasicConfigurationRegisterVn200

class vnpy.InsBasicConfigurationRegisterVn200

Structure representing the INS Basic Configuration register for a VN-200 sensor.

InsBasicConfigurationRegisterVn200.scenario

The scenario field.

InsBasicConfigurationRegisterVn200.ahrs_aiding

The ahrsAiding field.

InsBasicConfigurationRegisterVn300

class vnpy.InsBasicConfigurationRegisterVn300

Structure representing the INS Basic Configuration register for a VN-300 sensor.

InsBasicConfigurationRegisterVn300.scenario

The scenario field.

InsBasicConfigurationRegisterVn300.ahrs_aiding

The ahrsAiding field.

InsBasicConfigurationRegisterVn300.est_baseline

The estBaseline field.

InsSolutionEcefRegister

class vnpy.InsSolutionEcefRegister

Structure representing the INS Solution - ECEF register.

InsSolutionEcefRegister.time

The time field.

InsSolutionEcefRegister.week

The week field.

InsSolutionEcefRegister.status

The status field.

InsSolutionEcefRegister.yaw_pitch_roll

The yawPitchRoll field.

InsSolutionEcefRegister.velocity

The velocity field.

InsSolutionEcefRegister.att_uncertainty

The attUncertainty field.

InsSolutionEcefRegister.pos_uncertainty

The posUncertainty field.

InsSolutionEcefRegister.vel_uncertainty

The velUncertainty field.

InsSolutionLlaRegister

class vnpy.InsSolutionLlaRegister

Structure representing the INS Solution - LLA register.

InsSolutionLlaRegister.time

The time field.

InsSolutionLlaRegister.week

The week field.

InsSolutionLlaRegister.status

The status field.

InsSolutionLlaRegister.yaw_pitch_roll

The yawPitchRoll field.

InsSolutionLlaRegister.position

The position field.

InsSolutionLlaRegister.ned_vel

The nedVel field.

InsSolutionLlaRegister.att_uncertainty

The attUncertainty field.

InsSolutionLlaRegister.pos_uncertainty

The posUncertainty field.

InsSolutionLlaRegister.vel_uncertainty

The velUncertainty field.

InsStateEcefRegister

class vnpy.InsStateEcefRegister

Structure representing the INS State - ECEF register.

InsStateLlaRegister.yaw_pitch_roll

The yawPitchRoll field.

InsStateLlaRegister.position

The position field.

InsStateLlaRegister.velocity

The velocity field.

InsStateLlaRegister.accel

The accel field.

InsStateLlaRegister.angular_rate

The angularRate field.

InsStateLlaRegister

class vnpy.InsStateLlaRegister

Structure representing the INS State - LLA register.

InsStateLlaRegister.yaw_pitch_roll

The yawPitchRoll field.

InsStateLlaRegister.position

The position field.

InsStateLlaRegister.velocity

The velocity field.

InsStateLlaRegister.accel

The accel field.

InsStateLlaRegister.angular_rate

The angularRate field.

MagneticAccelerationAndAngularRatesRegister

class vnpy.MagneticAccelerationAndAngularRatesRegister

Structure representing the Magnetic and Gravity Reference Vectors register.

Class attributes are:

MagneticAccelerationAndAngularRatesRegister.mag

The mag field.

MagneticAccelerationAndAngularRatesRegister.accel

The accel field.

MagneticAccelerationAndAngularRatesRegister.gyro

The gyro field.

MagneticAndGravityReferenceVectorsRegister

class vnpy.MagneticAndGravityReferenceVectorsRegister

Structure representing the Magnetic and Gravity Reference Vectors register.

Class attributes are:

MagneticAndGravityReferenceVectorsRegister.mag_ref

The magRef field.

MagneticAndGravityReferenceVectorsRegister.acc_ref

The accRef field.

MagnetometerCalibrationControlRegister

class vnpy.MagnetometerCalibrationControlRegister

Structure representing the Magnetometer Calibration Control register.

MagnetometerCalibrationControlRegister.hsi_mode

The hsiMode field.

MagnetometerCalibrationControlRegister.hsi_output

The hsiOutput field.

MagnetometerCalibrationControlRegister.converge_rate

The convergeRate field.

MagnetometerCompensationRegister

class vnpy.MagnetometerCompensationRegister

Structure representing the Magnetometer Compensation register.

MagnetometerCompensationRegister.c

The c field.

MagnetometerCompensationRegister.b

The b field.

QuaternionMagneticAccelerationAndAngularRatesRegister

class vnpy.QuaternionMagneticAccelerationAndAngularRatesRegister

Structure representing the Quaternion, Magnetic, Acceleration and Angular Rates register.

Class attributes are:

QuaternionMagneticAccelerationAndAngularRatesRegister.quat

The quat field.

QuaternionMagneticAccelerationAndAngularRatesRegister.mag

The mag field.

QuaternionMagneticAccelerationAndAngularRatesRegister.accel

The accel field.

QuaternionMagneticAccelerationAndAngularRatesRegister.gyro

The gyro field.

ReferenceVectorConfigurationRegister

class vnpy.ReferenceVectorConfigurationRegister

Structure representing the Reference Vector Configuration register.

ReferenceVectorConfigurationRegister.use_mag_model

The useMagModel field.

ReferenceVectorConfigurationRegister.use_gravity_model

The useGravityModel field.

ReferenceVectorConfigurationRegister.recalc_threshold

The recaldThreshold field.

ReferenceVectorConfigurationRegister.year

The year field.

ReferenceVectorConfigurationRegister.position

The position field.

StartupFilterBiasEstimateRegister

class vnpy.StartupFilterBiasEstimateRegister

Structure representing the Startup Filter Bias Estimate register.

StartupFilterBiasEstimateRegister.gyro_bias

The gyroBias field.

StartupFilterBiasEstimateRegister.accel_bias

The accelBias field.

StartupFilterBiasEstimateRegister.pressure_bias

The pressureBias field.

SynchronizationControlRegister

class vnpy.SynchronizationControlRegister

Structure representing the Synchronization Control register.

SynchronizationControlRegister.sync_in_mode

The syncInMode field.

SynchronizationControlRegister.sync_in_edge

The syncInEdge field.

SynchronizationControlRegister.sync_in_skip_factor

The syncInSkipFactor field.

SynchronizationControlRegister.sync_out_mode

The syncOutMode field.

SynchronizationControlRegister.sync_out_polarity

The syncOutPolarity field.

SynchronizationControlRegister.sync_out_skip_factor

The syncOutSkipFactor field.

SynchronizationControlRegister.sync_out_pulse_width

The syncOutPulseWidth field.

SynchronizationStatusRegister

class vnpy.SynchronizationStatusRegister

Structure representing the Synchronization Status register.

SynchronizationStatusRegister.sync_in_count

The syncInCount field.

SynchronizationStatusRegister.sync_in_time

The syncInTime field.

SynchronizationStatusRegister.sync_out_count

The syncOutCount field.

VelocityCompensationControlRegister

class vnpy.VelocityCompensationControlRegister

Structure representing the Velocity Compensation Control register.

VelocityCompensationControlRegister.mode

The mode field.

VelocityCompensationControlRegister.velocity_tuning

The velocityTuning field.

VelocityCompensationControlRegister.rate_tuning

The rateTuning field.

VelocityCompensationStatusRegister

class vnpy.VelocityCompensationStatusRegister

Structure representing the Velocity Compensation Status register.

VelocityCompensationStatusRegister.x

The x field.

VelocityCompensationStatusRegister.x_dot

The xDot field.

VelocityCompensationStatusRegister.accel_offset

The accelOffset field.

VelocityCompensationStatusRegister.omega

The omega field.

VpeAccelerometerAdvancedTuningRegister

class vnpy.VpeAccelerometerAdvancedTuningRegister

Structure representing the VPE Accelerometer Advanced Tuning register.

VpeAccelerometerAdvancedTuningRegister.min_filtering

The minFiltering field.

VpeAccelerometerAdvancedTuningRegister.max_filtering

The maxFiltering field.

VpeAccelerometerAdvancedTuningRegister.max_adapt_rate

The maxAdaptRate field.

VpeAccelerometerAdvancedTuningRegister.disturbance_window

The disturbanceWindow field.

VpeAccelerometerAdvancedTuningRegister.max_tuning

The maxTuning field.

VpeAccelerometerBasicTuningRegister

class vnpy.VpeAccelerometerBasicTuningRegister

Structure representing the VPE Accelerometer Basic Tuning register.

VpeAccelerometerBasicTuningRegister.base_tuning

The baseTuning field.

VpeAccelerometerBasicTuningRegister.adaptive_tuning

The adaptiveTuning field.

VpeAccelerometerBasicTuningRegister.adaptive_filtering

The adaptiveFiltering field.

VpeBasicControlRegister

class vnpy.VpeBasicControlRegister

Structure representing the VPE Basic Control register.

VpeBasicControlRegister.enable

The enable field.

VpeBasicControlRegister.heading_mode

The headingMode field.

VpeBasicControlRegister.filtering_mode

The filteringMode field.

VpeBasicControlRegister.tuning_mode

The tuningMode field.

VpeGryoBasicTuningRegister

class vnpy.VpeGryoBasicTuningRegister

Structure representing the VPE Gryo Basic Tuning register.

VpeGryoBasicTuningRegister.angular_walk_variance

The angularWalkVariance field.

VpeGryoBasicTuningRegister.base_tuning

The baseTuning field.

VpeGryoBasicTuningRegister.adaptive_tuning

The adaptiveTuning field.

VpeMagnetometerAdvancedTuningRegister

class vnpy.VpeMagnetometerAdvancedTuningRegister

Structure representing the VPE Magnetometer Advanced Tuning register.

VpeMagnetometerAdvancedTuningRegister.min_filtering

The minFiltering field.

VpeMagnetometerAdvancedTuningRegister.max_filtering

The maxFiltering field.

VpeMagnetometerAdvancedTuningRegister.max_adapt_rate

The maxAdaptRate field.

VpeMagnetometerAdvancedTuningRegister.disturbance_window

The disturbanceWindow field.

VpeMagnetometerAdvancedTuningRegister.max_tuning

The maxTuning field.

VpeMagnetometerBasicTuningRegister

class vnpy.VpeMagnetometerBasicTuningRegister

Structure representing the VPE Magnetometer Basic Tuning register.

VpeMagnetometerBasicTuningRegister.base_tuning

The baseTuning field.

VpeMagnetometerBasicTuningRegister.adaptive_tuning

The adaptiveTuning field.

VpeMagnetometerBasicTuningRegister.adaptive_filtering

The adaptiveFiltering field.

YawPitchRollMagneticAccelerationAndAngularRatesRegister

class vnpy.YawPitchRollMagneticAccelerationAndAngularRatesRegister

Structure representing the Yaw, Pitch, Roll, Magnetic, Acceleration and Angular Rates register.

YawPitchRollMagneticAccelerationAndAngularRatesRegister.yaw_pitch_roll

The yawPitchRoll field.

YawPitchRollMagneticAccelerationAndAngularRatesRegister.mag

The mag field.

YawPitchRollMagneticAccelerationAndAngularRatesRegister.accel

The accel field.

YawPitchRollMagneticAccelerationAndAngularRatesRegister.gyro

The gyro field.

YawPitchRollTrueBodyAccelerationAndAngularRatesRegister

class vnpy.YawPitchRollTrueBodyAccelerationAndAngularRatesRegister

Structure representing the Yaw, Pitch, Roll, True Body Acceleration and Angular Rates register.

YawPitchRollTrueBodyAccelerationAndAngularRatesRegister.yaw_pitch_roll

The yawPitchRoll field.

YawPitchRollTrueBodyAccelerationAndAngularRatesRegister.body_accel

The bodyAccel field.

YawPitchRollTrueBodyAccelerationAndAngularRatesRegister.gyro

The gyro field.

YawPitchRollTrueInertialAccelerationAndAngularRatesRegister

class vnpy.YawPitchRollTrueInertialAccelerationAndAngularRatesRegister

Structure representing the Yaw, Pitch, Roll, True Inertial Acceleration and Angular Rates register.

YawPitchRollTrueInertialAccelerationAndAngularRatesRegister.yaw_pitch_roll

The yawPitchRoll field.

YawPitchRollTrueInertialAccelerationAndAngularRatesRegister.inertial_accel

The inertialAccel field.

YawPitchRollTrueInertialAccelerationAndAngularRatesRegister.gyro

The gyro field.