Types used to make the payload of NMEA2000 messages more easy to read for humans. More...

Collaboration diagram for Types for payload of NMEA2000 Messages:

enum	tN2kNavigationDirection { N2kdir_forward =0 , N2kdir_reverse =1 , N2kdir_reserved1 =2 , N2kdir_reserved2 =3 , N2kdir_reserved3 =4 , N2kdir_reserved4 =5 , N2kdir_error =6 , N2kdir_unknown =7 }
	Enumeration of the navigation direction according to PGN129285. More...

enum	tN2kHeadingReference { N2khr_true =0 , N2khr_magnetic =1 , N2khr_error =2 , N2khr_Unavailable =3 }
	Enumeration of the heading type according to PGN129233, PGN129237 , PGN129250, PGN129026 and PGN129284. More...

enum	tN2kDistanceCalculationType { N2kdct_GreatCircle =0 , N2kdct_RhumbLine =1 }
	Enumeration of distance calculation types for navigation according to PGN129284. More...

enum	tN2kXTEMode { N2kxtem_Autonomous =0 , N2kxtem_Differential =1 , N2kxtem_Estimated =2 , N2kxtem_Simulator =3 , N2kxtem_Manual =4 }
	Enumeration of Cross Track Error modes according to PGN129283. More...

enum	tN2kGNSStype { N2kGNSSt_GPS =0 , N2kGNSSt_GLONASS =1 , N2kGNSSt_GPSGLONASS =2 , N2kGNSSt_GPSSBASWAAS =3 , N2kGNSSt_GPSSBASWAASGLONASS =4 , N2kGNSSt_Chayka =5 , N2kGNSSt_integrated =6 , N2kGNSSt_surveyed =7 , N2kGNSSt_Galileo =8 }
	Enumeration of the GPS system which is in use according to PGN129029, PGN129041 and PGN129794. More...

enum	tN2kGNSSmethod { N2kGNSSm_noGNSS =0 , N2kGNSSm_GNSSfix =1 , N2kGNSSm_DGNSS =2 , N2kGNSSm_PreciseGNSS =3 , N2kGNSSm_RTKFixed =4 , N2kGNSSm_RTKFloat =5 , N2kGNSSm_Error =14 , N2kGNSSm_Unavailable =15 }
	Enumeration of GNSS working methods according to PGN129029. More...

enum	tN2kGNSSDOPmode { N2kGNSSdm_1D =0 , N2kGNSSdm_2D =1 , N2kGNSSdm_3D =2 , N2kGNSSdm_Auto =3 , N2kGNSSdm_Reserved =4 , N2kGNSSdm_Reserved2 =5 , N2kGNSSdm_Error =6 , N2kGNSSdm_Unavailable =7 }
	Enumeration of GNSS DOP Mode according to PGN129539. More...

enum	tN2kTempSource { N2kts_SeaTemperature =0 , N2kts_OutsideTemperature =1 , N2kts_InsideTemperature =2 , N2kts_EngineRoomTemperature =3 , N2kts_MainCabinTemperature =4 , N2kts_LiveWellTemperature =5 , N2kts_BaitWellTemperature =6 , N2kts_RefridgerationTemperature =7 , N2kts_HeatingSystemTemperature =8 , N2kts_DewPointTemperature =9 , N2kts_ApparentWindChillTemperature =10 , N2kts_TheoreticalWindChillTemperature =11 , N2kts_HeatIndexTemperature =12 , N2kts_FreezerTemperature =13 , N2kts_ExhaustGasTemperature =14 , N2kts_ShaftSealTemperature =15 }
	Enumeration of sources for a temperature value according to PGN130311, PGN130312 and PGN130316. More...

enum	tN2kHumiditySource { N2khs_InsideHumidity =0 , N2khs_OutsideHumidity =1 , N2khs_Undef =0xff }
	Enumeration of sources for a humidity value according to PGN130311 and PGN130313. More...

enum	tN2kPressureSource { N2kps_Atmospheric = 0 , N2kps_Water = 1 , N2kps_Steam = 2 , N2kps_CompressedAir = 3 , N2kps_Hydraulic = 4 , N2kps_Filter = 5 , N2kps_AltimeterSetting = 6 , N2kps_Oil = 7 , N2kps_Fuel = 8 , N2kps_Reserved = 253 , N2kps_Error = 254 , N2kps_Unavailable = 255 }
	Enumeration of sources for a pressure value according to PGN130314 and PGN130315. More...

enum	tN2kTimeSource { N2ktimes_GPS =0 , N2ktimes_GLONASS =1 , N2ktimes_RadioStation =2 , N2ktimes_LocalCesiumClock =3 , N2ktimes_LocalRubidiumClock =4 , N2ktimes_LocalCrystalClock =5 }
	Enumeration of sources for the system time according to PGN126992. More...

enum	tN2kFluidType { N2kft_Fuel =0 , N2kft_Water =1 , N2kft_GrayWater =2 , N2kft_LiveWell =3 , N2kft_Oil =4 , N2kft_BlackWater =5 , N2kft_FuelGasoline =6 , N2kft_Error =14 , N2kft_Unavailable =15 }
	Enumeration of fluid types according to PGN127505. More...

enum	tN2kWindReference { N2kWind_True_North =0 , N2kWind_Magnetic =1 , N2kWind_Apparent =2 , N2kWind_Apprent =2 , N2kWind_True_boat =3 , N2kWind_True_water =4 , N2kWind_Error =6 , N2kWind_Unavailable =7 }
	Enumeration of wind reference types according to PGN130306. More...

enum	tN2kSpeedWaterReferenceType { N2kSWRT_Paddle_wheel =0 , N2kSWRT_Pitot_tube =1 , N2kSWRT_Doppler_log =2 , N2kSWRT_Ultra_Sound =3 , N2kSWRT_Electro_magnetic =4 , N2kSWRT_Error =254 , N2kSWRT_Unavailable =255 }
	Enumeration of speed thru water sensors types according to PGN128259. More...

enum	tN2kRudderDirectionOrder { N2kRDO_NoDirectionOrder =0 , N2kRDO_MoveToStarboard =1 , N2kRDO_MoveToPort =2 , N2kRDO_Unavailable =7 }
	Enumeration of Rudder Direction Order according to PGN127237, 127245. More...

enum	tN2kDCType { N2kDCt_Battery =0 , N2kDCt_Alternator =1 , N2kDCt_Converter =2 , N2kDCt_SolarCell =3 , N2kDCt_WindGenerator =4 }
	Enumeration of DC power sources according to PGN 127506. More...

enum	tN2kBatType { N2kDCbt_Flooded =0 , N2kDCbt_Gel =1 , N2kDCbt_AGM =2 }
	Enumeration of Battery types according to PGN 127513. More...

enum	tN2kBatEqSupport { N2kDCES_No =0 , N2kDCES_Yes =1 , N2kDCES_Error =2 , N2kDCES_Unavailable =3 }
	Enumeration of Supports Equalization according to PGN 127513. More...

enum	tN2kBatChem { N2kDCbc_LeadAcid =0 , N2kDCbc_LiIon =1 , N2kDCbc_NiCad =2 , N2kDCbc_ZnO =3 , N2kDCbc_NiMh =4 }
	Enumeration of battery chemistries according to PGN 127513. More...

enum	tN2kBatNomVolt { N2kDCbnv_6v =0 , N2kDCbnv_12v =1 , N2kDCbnv_24v =2 , N2kDCbnv_32v =3 , N2kDCbnv_62v =4 , N2kDCbnv_42v =5 , N2kDCbnv_48v =6 }
	Enumeration of nominal battery voltage according to PGN 127513. More...

enum	tN2kTransmissionGear { N2kTG_Forward =0 , N2kTG_Neutral =1 , N2kTG_Reverse =2 , N2kTG_Unknown =3 }
	Enumeration of transmission state according to PGN 127493. More...

enum	tN2kAISRepeat { N2kaisr_Initial =0 , N2kaisr_First =1 , N2kaisr_Second =2 , N2kaisr_Final =3 }
	Enumeration of AIS repeat indicator according to PGN129802, PGN129809, PGN129810, PGN129038, PGN129041,PGN129794. More...

enum	tN2kAISVersion { N2kaisv_ITU_R_M_1371_1 =0 , N2kaisv_ITU_R_M_1371_3 =1 }
	Enumeration of AIS version which is used in PGN 129794. More...

enum	tN2kAISNavStatus { N2kaisns_Under_Way_Motoring =0 , N2kaisns_At_Anchor =1 , N2kaisns_Not_Under_Command =2 , N2kaisns_Restricted_Manoeuverability =3 , N2kaisns_Constrained_By_Draught =4 , N2kaisns_Moored =5 , N2kaisns_Aground =6 , N2kaisns_Fishing =7 , N2kaisns_Under_Way_Sailing =8 , N2kaisns_Hazardous_Material_High_Speed =9 , N2kaisns_Hazardous_Material_Wing_In_Ground =10 , N2kaisns_AIS_SART =14 }
	Enumeration of navigational status of an ship sending out an AIS signal according to PGN 129038. More...

enum	tN2kAISDTE { N2kaisdte_Ready =0 , N2kaisdte_NotReady =1 }
	Enumeration of Data Terminal Equipment according to PNG 129794. More...

enum	tN2kAISUnit { N2kaisunit_ClassB_SOTDMA =0 , N2kaisunit_ClassB_CS =1 }
	Enumeration of AIS unit (transmission) type according to PGN 129039. More...

enum	tN2kAISMode { N2kaismode_Autonomous =0 , N2kaismode_Assigned =1 }
	Enumeration of AIS mode type according to PGN 129039. More...

enum	tN2kAISTransceiverInformation { N2kaischannel_A_VDL_reception =0 , N2kaischannel_B_VDL_reception =1 , N2kaischannel_A_VDL_transmission =2 , N2kaischannel_B_VDL_transmission =3 , N2kaisown_information_not_broadcast =4 }
	Enumeration of 129039, 129041, 129802. More...

enum	tN2kMagneticVariation { N2kmagvar_Manual =0 , N2kmagvar_Chart =1 , N2kmagvar_Table =2 , N2kmagvar_Calc =3 , N2kmagvar_WMM2000 =4 , N2kmagvar_WMM2005 =5 , N2kmagvar_WMM2010 =6 , N2kmagvar_WMM2015 =7 , N2kmagvar_WMM2020 =8 }
	Enumeration of magnetic variation according to PGN 127258. More...

enum	tN2kOnOff { N2kOnOff_Off =0 , N2kOnOff_On =1 , N2kOnOff_Error =2 , N2kOnOff_Unavailable =3 }
	Enumeration of On/Off status at a NMEA 2000 network. More...

enum	tN2kChargeState { N2kCS_Not_Charging =0 , N2kCS_Bulk =1 , N2kCS_Absorption =2 , N2kCS_Overcharge =3 , N2kCS_Equalise =4 , N2kCS_Float =5 , N2kCS_No_Float =6 , N2kCS_Constant_VI =7 , N2kCS_Disabled =8 , N2kCS_Fault =9 , N2kCS_Unavailable =15 }
	Enumeration of state of the battery charger operation according to PGN127507. More...

enum	tN2kChargerMode { N2kCM_Standalone =0 , N2kCM_Primary =1 , N2kCM_Secondary =2 , N2kCM_Echo =3 , N2kCM_Unavailable =15 }
	Enumeration of charger modes according to PGN 127507. More...

enum	tN2kSteeringMode { N2kSM_MainSteering =0 , N2kSM_NonFollowUpDevice =1 , N2kSM_FollowUpDevice =2 , N2kSM_HeadingControlStandalone =3 , N2kSM_HeadingControl =4 , N2kSM_TrackControl =5 , N2kSM_Unavailable =7 }
	Enumeration of the steering mode according to PGN127237. More...

enum	tN2kTurnMode { N2kTM_RudderLimitControlled =0 , N2kTM_TurnRateControlled =1 , N2kTM_RadiusControlled =2 , N2kTM_Unavailable =7 }
	Enumeration of tunr control modes according to PGN127237. More...

enum	tN2kMOBStatus { MOBEmitterActivated =0 , ManualOnBoardMOBButtonActivation =1 , TestMode =2 , MOBNotActive =3 }
	Enumeration of ManOverBoard state according to PGN127233. More...

enum	tN2kMOBPositionSource { PositionEstimatedByVessel =0 , PositionReportedByMOBEmitter =1 }
	Enumeration of ManOverBoard position source according to PGN127233. More...

enum	tN2kMOBEmitterBatteryStatus { Good =0 , Low =1 }
	Enumeration of MOB emitter battery status according to PGN127233. More...

using	tN2kEngineDiscreteStatus1 = tN2kDD206
	Alias easier for humans to read for tN2kDD206. More...

using	tN2kEngineDiscreteStatus2 = tN2kDD223
	Alias easier for humans to read for tN2kDD223. More...

using	tN2kGenericStatusPair = tN2kDD002
	Alias easier for humans to read for tN2kDD002. More...

using	tN2kDataMode = tN2kDD025
	Alias easier for humans to read for tN2kDD025. More...

using	tN2kRangeResidualMode = tN2kDD072
	Alias easier for humans to read for tN2kDD072. More...

using	tN2kPRNUsageStatus = tN2kDD124
	Alias easier for humans to read for tN2kDD124. More...

using	tN2kAISAtoNType = tN2kDD305
	Alias easier for humans to read for tN2kDD305. More...

using	tN2kDelaySource = tN2kDD374
	Alias easier for humans to read for tN2kDD374. More...

using	tN2kThrusterMotorEvents = tN2kDD471
	Alias easier for humans to read for tN2kDD471. More...

using	tN2kThrusterDirectionControl = tN2kDD473
	Alias easier for humans to read for tN2kDD473. More...

using	tN2kThrusterRetraction = tN2kDD474
	Alias easier for humans to read for tN2kDD474. More...

using	tN2kThrusterControlEvents = tN2kDD475
	Alias easier for humans to read for tN2kDD475. More...

using	tN2kWindlassMonitoringEvents = tN2kDD477
	Alias easier for humans to read for tN2kDD477. More...

using	tN2kWindlassControlEvents = tN2kDD478
	Alias easier for humans to read for tN2kDD478. More...

using	tN2kWindlassMotionStates = tN2kDD480
	Alias easier for humans to read for tN2kDD480. More...

using	tN2kRodeTypeStates = tN2kDD481
	Alias easier for humans to read for tN2kDD481. More...

using	tN2kAnchorDockingStates = tN2kDD482
	Alias easier for humans to read for tN2kDD482. More...

using	tN2kWindlassOperatingEvents = tN2kDD483
	Alias easier for humans to read for tN2kDD483. More...

using	tN2kWindlassDirectionControl = tN2kDD484
	Alias easier for humans to read for tN2kDD484. More...

using	tN2kMotorPowerType = tN2kDD487
	Alias easier for humans to read for tN2kDD487. More...

using	tN2kSpeedType = tN2kDD488
	Alias easier for humans to read for tN2kDD488. More...

enum	tN2kDD002 { N2kDD002_No =0 , N2kDD002_Yes =1 , N2kDD002_Error =2 , N2kDD002_Unavailable =3 , N2kDD002_Off =N2kDD002_No , N2kDD002_Disabled =N2kDD002_No , N2kDD002_Reset =N2kDD002_No , N2kDD002_0 =N2kDD002_No , N2kDD002_On =N2kDD002_Yes , N2kDD002_Enabled =N2kDD002_Yes , N2kDD002_Set =N2kDD002_Yes , N2kDD002_1 =N2kDD002_Yes , N2kDD002_Unknown =N2kDD002_Unavailable }
	DD002 - Generic Status Pair. More...

enum	tN2kDD025 { N2kDD025_Autonomous =0 , N2kDD025_Differential =1 , N2kDD025_Estimated =2 , N2kDD025_Simulator =3 , N2kDD025_Manual =4 , N2kDD025_Error =0xe , N2kDD025_Unavailable =0xf }
	DD025 - Mode, Data. More...

enum	tN2kDD072 { N2kDD072_RangeResidualsWereUsedToCalculateData =0 , N2kDD072_RangeResidualsWereCalculatedAfterPosition =1 , N2kDD072_Error =2 , N2kDD072_Unavailable =3 }
	DD072 - Range Residual Mode. More...

enum	tN2kDD124 { N2kDD124_NotTracked =0 , N2kDD124_TrackedButNotUsedInSolution =1 , N2kDD124_UsedInSolutionWithoutDifferentialCorrections =2 , N2kDD124_DifferentialCorrectionsAvailable =3 , N2kDD124_TrackedWithDifferentialCorrections =4 , N2kDD124_UsedWithDifferentialCorrections =5 , N2kDD124_Error =14 , N2kDD124_Unavailable =15 }
	DD124 - PRN Usage Status. More...

enum	tN2kDD305 { N2kAISAtoN_not_specified =0 , N2kAISAtoN_reference_point =1 , N2kAISAtoN_RACON =2 , N2kAISAtoN_fixed_structure =3 , N2kAISAtoN_emergency_wreck_marking_buoy =4 , N2kAISAtoN_light_without_sectors =5 , N2kAISAtoN_light_with_sectors =6 , N2kAISAtoN_leading_light_front =7 , N2kAISAtoN_leading_light_rear =8 , N2kAISAtoN_beacon_cardinal_N =9 , N2kAISAtoN_beacon_cardinal_E =10 , N2kAISAtoN_beacon_cardinal_S =11 , N2kAISAtoN_beacon_cardinal_W =12 , N2kAISAtoN_beacon_port_hand =13 , N2kAISAtoN_beacon_starboard_hand =14 , N2kAISAtoN_beacon_preferred_ch_port_hand =15 , N2kAISAtoN_beacon_preferred_ch_starboard_hand =16 , N2kAISAtoN_beacon_isolated_danger =17 , N2kAISAtoN_beacon_safe_water =18 , N2kAISAtoN_beacon_special_mark =19 , N2kAISAtoN_cardinal_mark_N =20 , N2kAISAtoN_cardinal_mark_E =21 , N2kAISAtoN_cardinal_mark_S =22 , N2kAISAtoN_cardinal_mark_W =23 , N2kAISAtoN_port_hand_mark =24 , N2kAISAtoN_starboard_hand_mark =25 , N2kAISAtoN_preferred_channel_port_hand =26 , N2kAISAtoN_preferred_channel_starboard_hand =27 , N2kAISAtoN_isolated_danger =28 , N2kAISAtoN_safe_water =29 , N2kAISAtoN_special_mark =30 , N2kAISAtoN_light_vessel_lanby_rigs =31 }
	Enumeration of Aid to Navigation (AtoN) Type according to PGN129041. More...

enum	tN2kDD374 { N2kDD374_UserDefined =0 , N2kDD374_MinimumDefined =1 , N2kDD374_FactoryDefault =2 , N2kDD374_MaximumSupported =3 , N2kDD374_OutOfRange =14 , N2kDD374_DataNotAvailable =15 }
	Measurement delay source. More...

enum	tN2kDD473 { N2kDD473_OFF =0 , N2kDD473_ThrusterReady =1 , N2kDD473_ThrusterToPORT =2 , N2kDD473_ThrusterToSTARBOARD =3 }
	DD473 - Thruster Direction Control according to PGN 128006. More...

enum	tN2kDD474 { N2kDD474_OFF =0 , N2kDD474_Extend =1 , N2kDD474_Retract =2 , N2kDD474_Reserved =3 }
	DD474 - Thruster Retraction according to PGN 128006. More...

enum	tN2kDD480 { N2kDD480_WindlassStopped =0 , N2kDD480_DeploymentOccurring =1 , N2kDD480_RetrievalOccurring =2 , N2kDD480_Unavailable =3 }
	DD480 - Windlass Motion States according to PGN 128777. More...

enum	tN2kDD481 { N2kDD481_ChainPresentlyDetected =0 , N2kDD481_RopePresentlyDetected =1 , N2kDD481_Error =2 , N2kDD481_Unavailable =3 }
	DD481 - Rode Type States according to PGN 128777. More...

enum	tN2kDD482 { N2kDD482_NotDocked =0 , N2kDD482_FullyDocked =1 , N2kDD482_Error =2 , N2kDD482_DataNotAvailable =3 }
	DD482 - Anchor Docking States according to PGN 128777. More...

enum	tN2kDD484 { N2kDD484_Off =0 , N2kDD484_Down =1 , N2kDD484_Up =2 , N2kDD484_Reserved =3 }
	DD484 - Windlass Direction Control according to PGN 128776. More...

enum	tN2kDD487 { N2kDD487_12VDC =0 , N2kDD487_24VDC =1 , N2kDD487_48VDC =2 , N2kDD487_24VAC =3 , N2kDD487_Hydraulic =4 }
	DD487 - Motor Power Type according to PGN 128007. More...

enum	tN2kDD488 { N2kDD488_SingleSpeed =0 , N2kDD488_DualSpeed =1 , N2kDD488_ProportionalSpeed =2 , N2kDD488_DataNotAvailable =3 }
	DD488 - Speed Control Type according to PGN 128776. More...

Detailed Description

Types used to make the payload of NMEA2000 messages more easy to read for humans.

As the payload of a NMEA2000 is quite limited, the data is stored with variable number of bits. To make these "bitmasks" more convenient for humans to read enums are defined.

See also: n2kMsg.h

Typedef Documentation

◆ tN2kAISAtoNType

using tN2kAISAtoNType = tN2kDD305

Alias easier for humans to read for tN2kDD305.

Definition at line 633 of file N2kTypes.h.

◆ tN2kAnchorDockingStates

using tN2kAnchorDockingStates = tN2kDD482

Alias easier for humans to read for tN2kDD482.

Definition at line 734 of file N2kTypes.h.

◆ tN2kDataMode

using tN2kDataMode = tN2kDD025

Alias easier for humans to read for tN2kDD025.

Definition at line 604 of file N2kTypes.h.

◆ tN2kDelaySource

using tN2kDelaySource = tN2kDD374

Alias easier for humans to read for tN2kDD374.

Definition at line 669 of file N2kTypes.h.

◆ tN2kEngineDiscreteStatus1

using tN2kEngineDiscreteStatus1 = tN2kDD206

Alias easier for humans to read for tN2kDD206.

Definition at line 582 of file N2kTypes.h.

◆ tN2kEngineDiscreteStatus2

using tN2kEngineDiscreteStatus2 = tN2kDD223

Alias easier for humans to read for tN2kDD223.

Definition at line 584 of file N2kTypes.h.

◆ tN2kGenericStatusPair

using tN2kGenericStatusPair = tN2kDD002

Alias easier for humans to read for tN2kDD002.

Definition at line 587 of file N2kTypes.h.

◆ tN2kMotorPowerType

using tN2kMotorPowerType = tN2kDD487

Alias easier for humans to read for tN2kDD487.

Definition at line 759 of file N2kTypes.h.

◆ tN2kPRNUsageStatus

using tN2kPRNUsageStatus = tN2kDD124

Alias easier for humans to read for tN2kDD124.

Definition at line 622 of file N2kTypes.h.

◆ tN2kRangeResidualMode

using tN2kRangeResidualMode = tN2kDD072

Alias easier for humans to read for tN2kDD072.

Definition at line 615 of file N2kTypes.h.

◆ tN2kRodeTypeStates

using tN2kRodeTypeStates = tN2kDD481

Alias easier for humans to read for tN2kDD481.

Definition at line 726 of file N2kTypes.h.

◆ tN2kSpeedType

using tN2kSpeedType = tN2kDD488

Alias easier for humans to read for tN2kDD488.

Definition at line 767 of file N2kTypes.h.

◆ tN2kThrusterControlEvents

using tN2kThrusterControlEvents = tN2kDD475

Alias easier for humans to read for tN2kDD475.

Definition at line 701 of file N2kTypes.h.

◆ tN2kThrusterDirectionControl

using tN2kThrusterDirectionControl = tN2kDD473

Alias easier for humans to read for tN2kDD473.

Definition at line 688 of file N2kTypes.h.

◆ tN2kThrusterMotorEvents

using tN2kThrusterMotorEvents = tN2kDD471

Alias easier for humans to read for tN2kDD471.

Definition at line 678 of file N2kTypes.h.

◆ tN2kThrusterRetraction

using tN2kThrusterRetraction = tN2kDD474

Alias easier for humans to read for tN2kDD474.

Definition at line 695 of file N2kTypes.h.

◆ tN2kWindlassControlEvents

using tN2kWindlassControlEvents = tN2kDD478

Alias easier for humans to read for tN2kDD478.

Definition at line 713 of file N2kTypes.h.

◆ tN2kWindlassDirectionControl

using tN2kWindlassDirectionControl = tN2kDD484

Alias easier for humans to read for tN2kDD484.

Definition at line 751 of file N2kTypes.h.

◆ tN2kWindlassMonitoringEvents

using tN2kWindlassMonitoringEvents = tN2kDD477

Alias easier for humans to read for tN2kDD477.

Definition at line 706 of file N2kTypes.h.

◆ tN2kWindlassMotionStates

using tN2kWindlassMotionStates = tN2kDD480

Alias easier for humans to read for tN2kDD480.

Definition at line 718 of file N2kTypes.h.

◆ tN2kWindlassOperatingEvents

using tN2kWindlassOperatingEvents = tN2kDD483

Alias easier for humans to read for tN2kDD483.

Definition at line 742 of file N2kTypes.h.

Enumeration Type Documentation

◆ tN2kAISDTE

enum tN2kAISDTE

Enumeration of Data Terminal Equipment according to PNG 129794.

Enumerator
N2kaisdte_Ready	equipment is ready
N2kaisdte_NotReady	equipment is not ready

Definition at line 416 of file N2kTypes.h.

◆ tN2kAISMode

enum tN2kAISMode

Enumeration of AIS mode type according to PGN 129039.

https://www.marineteacher.com/ais

There are 3 modes of operation of AIS: Autonomous and continuous mode: In this mode AIS automatically defines its own reporting rate in accordance with its navigational mode, speed and course. The unit also selects its own time slots. This is normal mode for operation in all areas but the mode may be switched from/to Assigned or Polled/Controlled mode by a competent authority via a base station on shore. Assigned/ Controlled Mode: A competent authority responsible for traffic monitoring may remotely set transmissions intervals and/or time slots for the vessel mobile stations. In Assigned mode the mobile station does not change its reporting rate when changing course and speed. Polled Mode: In this mode, mobile station will automatically respond to interrogation (polling) messages from a ship or competent authority. The response is transmitted on the channel where the interrogation message was received. Operation in Polled mode does not conflict with the operation in other two modes.

Enumerator
N2kaismode_Autonomous	AIS is in Autonomous mode.
N2kaismode_Assigned	AIS is in assigned mode.

Definition at line 451 of file N2kTypes.h.

◆ tN2kAISNavStatus

enum tN2kAISNavStatus

Enumeration of navigational status of an ship sending out an AIS signal according to PGN 129038.

Enumerator
N2kaisns_Under_Way_Motoring	Ship is under way and motoring.
N2kaisns_At_Anchor	Ship is at anchor.
N2kaisns_Not_Under_Command	Ship is not under command.
N2kaisns_Restricted_Manoeuverability	Ship has a restricted manoeuverability.
N2kaisns_Constrained_By_Draught	Ship has constrains by drought.
N2kaisns_Moored	Ship is moored.
N2kaisns_Aground	Ship is aground.
N2kaisns_Fishing	Ship is fishing.
N2kaisns_Under_Way_Sailing	Ship is under way and sailing.
N2kaisns_Hazardous_Material_High_Speed	Hazardous material in the water and moving with high speed.
N2kaisns_Hazardous_Material_Wing_In_Ground	Hazardous material in the water and wing in ground.
N2kaisns_AIS_SART	AIS Search And Rescue Transmission.

Definition at line 398 of file N2kTypes.h.

◆ tN2kAISRepeat

enum tN2kAISRepeat

Enumeration of AIS repeat indicator according to PGN129802, PGN129809, PGN129810, PGN129038, PGN129041,PGN129794.

Enumerator
N2kaisr_Initial	initial AIS repeat
N2kaisr_First	first AIS repeat
N2kaisr_Second	second AIS repeat
N2kaisr_Final	final AIS repeat

Definition at line 368 of file N2kTypes.h.

◆ tN2kAISTransceiverInformation

enum tN2kAISTransceiverInformation

Enumeration of 129039, 129041, 129802.

Enumerator
N2kaischannel_A_VDL_reception	Channel A VDL reception.
N2kaischannel_B_VDL_reception	Channel B VDL reception.
N2kaischannel_A_VDL_transmission	Channel A VDL transmission.
N2kaischannel_B_VDL_transmission	Channel B VDL transmission.
N2kaisown_information_not_broadcast	Own information not broadcast.

Definition at line 459 of file N2kTypes.h.

◆ tN2kAISUnit

enum tN2kAISUnit

Enumeration of AIS unit (transmission) type according to PGN 129039.

Enumerator
N2kaisunit_ClassB_SOTDMA	AIS Unit uses SOTDMA (Self Organizing Time Division Multiple Access)
N2kaisunit_ClassB_CS	AIS unit uses CSTDMA (Carrier Sense Time Division Multiple Access)

Definition at line 424 of file N2kTypes.h.

◆ tN2kAISVersion

enum tN2kAISVersion

Enumeration of AIS version which is used in PGN 129794.

M.1371 : Technical characteristics for an automatic identification system using time division multiple access in the VHF maritime mobile frequency band.

https://www.itu.int/rec/R-REC-M.1371

Note: The newest standard available is 1371_5 (from 2014), maybe an update is needed here

Enumerator
N2kaisv_ITU_R_M_1371_1	version ITU-R M.1371_1
N2kaisv_ITU_R_M_1371_3	version ITU-R M.1371_3

Definition at line 388 of file N2kTypes.h.

◆ tN2kBatChem

enum tN2kBatChem

Enumeration of battery chemistries according to PGN 127513.

«Battery Chemistry» parameter in PGN 127513 «Battery Configuration Status». Used for reporting, to choose default values of settings and for calculations.

Enumerator
N2kDCbc_LeadAcid	battery chemistry is lead acid
N2kDCbc_LiIon	battery chemistry is lithium ion
N2kDCbc_NiCad	battery chemistry is nickel cadmium
N2kDCbc_ZnO	battery chemistry is zink oxide
N2kDCbc_NiMh	battery chemistry is nickel metal hydride

Definition at line 332 of file N2kTypes.h.

◆ tN2kBatEqSupport

enum tN2kBatEqSupport

Enumeration of Supports Equalization according to PGN 127513.

«Supports Equalization» parameter in PGN 127513 «Battery Configuration Status» (used for reporting only,not for calculations).

Enumerator
N2kDCES_No	No, Off, Disabled.
N2kDCES_Yes	Yes, On, Enabled.
N2kDCES_Error	Error.
N2kDCES_Unavailable	Unavailable.

Definition at line 318 of file N2kTypes.h.

◆ tN2kBatNomVolt

enum tN2kBatNomVolt

Enumeration of nominal battery voltage according to PGN 127513.

Nominal voltage in PGN 127513 «Battery Configuration Status».

Enumerator
N2kDCbnv_6v	nominal voltage is 6V
N2kDCbnv_12v	nominal voltage is 12V
N2kDCbnv_24v	nominal voltage is 24V
N2kDCbnv_32v	nominal voltage is 32V
N2kDCbnv_62v	nominal voltage is 62V
N2kDCbnv_42v	nominal voltage is 42V
N2kDCbnv_48v	nominal voltage is 48V

Definition at line 345 of file N2kTypes.h.

◆ tN2kBatType

enum tN2kBatType

Enumeration of Battery types according to PGN 127513.

Battery type in PGN 127513 «Battery Configuration Status» (for reporting only).

Enumerator
N2kDCbt_Flooded	battery type is an flooded lead acid
N2kDCbt_Gel	battery type is GEL
N2kDCbt_AGM	battery type is AGM

Definition at line 306 of file N2kTypes.h.

◆ tN2kChargerMode

enum tN2kChargerMode

Enumeration of charger modes according to PGN 127507.

Enumerator
N2kCM_Standalone	Charger mode is stand alone.
N2kCM_Primary	Charger mode is primary charger.
N2kCM_Secondary	Charger mode is secondary charger.
N2kCM_Echo	Charger mode is echo.
N2kCM_Unavailable	Charger mode is unvailable.

Definition at line 518 of file N2kTypes.h.

◆ tN2kChargeState

enum tN2kChargeState

Enumeration of state of the battery charger operation according to PGN127507.

Enumerator
N2kCS_Not_Charging	Charger operation state is not charging.
N2kCS_Bulk	Charger operation state is in bulk.
N2kCS_Absorption	Charger operation state is in absorption.
N2kCS_Overcharge	Charger operation state is in overcharge.
N2kCS_Equalise	Charger operation state is in equalise.
N2kCS_Float	Charger operation state is in float.
N2kCS_No_Float	Charger operation state is in no float.
N2kCS_Constant_VI	Charger operation state is in constant power.
N2kCS_Disabled	Charger operation state is disabled.
N2kCS_Fault	Charger operation state is in fault.
N2kCS_Unavailable	Charger operation state unavailable.

Definition at line 500 of file N2kTypes.h.

◆ tN2kDCType

enum tN2kDCType

Enumeration of DC power sources according to PGN 127506.

DC Type for PGN 127506 «DC Detailed Status». Legacy NMEA 2000 devices may not support this PGN

Enumerator
N2kDCt_Battery	DC power from battery.
N2kDCt_Alternator	DC power from alternator.
N2kDCt_Converter	DC power from converter.
N2kDCt_SolarCell	DC power from solar cell.
N2kDCt_WindGenerator	DC power from wind generator.

Definition at line 292 of file N2kTypes.h.

◆ tN2kDD002

enum tN2kDD002

DD002 - Generic Status Pair.

DD002 Generic status pair DF52 2bit MSB/LSB:

00 = [No, Off, Disabled, Reset, "0"]
01 = [Yes, On, Enabled, Set, "1"]
10 = Error
11= [Unavailable, Unknown]

Enumerator
N2kDD002_No	paired status is NO
N2kDD002_Yes	paired status is YES
N2kDD002_Error	paired status is Error
N2kDD002_Unavailable	paired status is UNKNOWN
N2kDD002_Off	paired status is NO
N2kDD002_Disabled	paired status is NO
N2kDD002_Reset	paired status is NO
N2kDD002_0	paired status is NO
N2kDD002_On	paired status is YES
N2kDD002_Enabled	paired status is YES
N2kDD002_Set	paired status is YES
N2kDD002_1	paired status is YES
N2kDD002_Unknown	paired status is UNKNOWN

Definition at line 64 of file NMEA2000StdTypes.h.

◆ tN2kDD025

enum tN2kDD025

DD025 - Mode, Data.

DD025 - Mode, Data DF52 4bits

0x0 = Autonomous mode
0x1 = Differential, enhanced mode
0x2 = Estimated mode
0x3 = Simulator mode
0x4 = Manual mode
0x5 to 0xD = Reserved,
0xE = Error
0xF = Data not available

Enumerator
N2kDD025_Autonomous	autonomous mode
N2kDD025_Differential	differential mode
N2kDD025_Estimated	estimated mode
N2kDD025_Simulator	simulator mode
N2kDD025_Manual	manual mode
N2kDD025_Error	error occurred
N2kDD025_Unavailable	data not available

Definition at line 94 of file NMEA2000StdTypes.h.

◆ tN2kDD072

enum tN2kDD072

DD072 - Range Residual Mode.

DD072 Range Residual Mode DF52 2bits Range Residual used in position calculation or range residuals were calculated after the position.

0=range residuals were used to calculate data
1=range residuals were calculated after the position.
2=Error
3=Null

Enumerator
N2kDD072_RangeResidualsWereUsedToCalculateData	range residuals were used to calculate data
N2kDD072_RangeResidualsWereCalculatedAfterPosition	range residuals were calculated after the position
N2kDD072_Error	error occurred
N2kDD072_Unavailable	data not available

Definition at line 115 of file NMEA2000StdTypes.h.

◆ tN2kDD124

enum tN2kDD124

DD124 - PRN Usage Status.

DD124 PRN Usage Status DF52 4bit

0 = Not Tracked
1 = Tracked but not used in solution
2 = Used in solution without Differential corrections
3 = Differential Corrections available
4 = Tracked with Differential Corrections
5 = used with Differential Corrections
6-13 =Reserved
14 = Error
15 = No Selection

Enumerator
N2kDD124_NotTracked	Not Tracked.
N2kDD124_TrackedButNotUsedInSolution	Tracked but not used in solution.
N2kDD124_UsedInSolutionWithoutDifferentialCorrections	Used in solution without Differential corrections.
N2kDD124_DifferentialCorrectionsAvailable	Differential Corrections available.
N2kDD124_TrackedWithDifferentialCorrections	Tracked with Differential Corrections.
N2kDD124_UsedWithDifferentialCorrections	used with Differential Corrections
N2kDD124_Error	error occurred
N2kDD124_Unavailable	no selection, unavailable

Definition at line 137 of file NMEA2000StdTypes.h.

◆ tN2kDD305

enum tN2kDD305

Enumeration of Aid to Navigation (AtoN) Type according to PGN129041.

Type of AtoN.

Message 21: Aids-to-navigation report (AtoN)

https://www.itu.int/dms_pubrec/itu-r/rec/m/R-REC-M.1371-5-201402-I!!PDF-E.pdf (Table74 p.133)

ITU-R M.1371-4 This message should be used by an AtoN AIS station. This station may be mounted on an aid-to-navigation or this message may be transmitted by a fixed station when the functionality of an AtoN station is integrated into the fixed station. This message should be transmitted autonomously at a Rr of once every three (3) min or it may be assigned by an assigned mode command (Message16) via the VHF data link, or by an external command. This message should not occupy more than two slots

Enumerator
N2kAISAtoN_not_specified	Default, type of AtoN not specified.
N2kAISAtoN_reference_point	AtoN type reference point.
N2kAISAtoN_RACON	AtoN type RACON.
N2kAISAtoN_fixed_structure	AtoN type Fixed structures off-shore, such as oil platforms, wind farms.
N2kAISAtoN_emergency_wreck_marking_buoy	AtoN type Emergency Wreck Marking Buoy.
N2kAISAtoN_light_without_sectors	Fixed AtoN type Light, without sectors.
N2kAISAtoN_light_with_sectors	Fixed AtoN type Light, with sectors.
N2kAISAtoN_leading_light_front	Fixed AtoN type Leading Light Front.
N2kAISAtoN_leading_light_rear	Fixed AtoN type Leading Light Rear.
N2kAISAtoN_beacon_cardinal_N	Fixed AtoN type Beacon, Cardinal N.
N2kAISAtoN_beacon_cardinal_E	Fixed AtoN type Beacon, Cardinal E.
N2kAISAtoN_beacon_cardinal_S	Fixed AtoN type Beacon, Cardinal S.
N2kAISAtoN_beacon_cardinal_W	Fixed AtoN type Beacon, Cardinal W.
N2kAISAtoN_beacon_port_hand	Fixed AtoN type Beacon, Port hand.
N2kAISAtoN_beacon_starboard_hand	Fixed AtoN type Beacon, starboard hand.
N2kAISAtoN_beacon_preferred_ch_port_hand	Fixed AtoN type Beacon, Preferred Channel port hand.
N2kAISAtoN_beacon_preferred_ch_starboard_hand	Fixed AtoN type Beacon, Preferred Channel starboard hand.
N2kAISAtoN_beacon_isolated_danger	Fixed AtoN type Beacon, Isolated danger.
N2kAISAtoN_beacon_safe_water	Fixed AtoN type Beacon, Safe water.
N2kAISAtoN_beacon_special_mark	Fixed AtoN type Beacon, Special mark.
N2kAISAtoN_cardinal_mark_N	Floating AtoN type Cardinal Mark N.
N2kAISAtoN_cardinal_mark_E	Floating AtoN type Cardinal Mark E.
N2kAISAtoN_cardinal_mark_S	Floating AtoN type Cardinal Mark S.
N2kAISAtoN_cardinal_mark_W	Floating AtoN type Cardinal Mark W.
N2kAISAtoN_port_hand_mark	Floating AtoN type Port hand Mark.
N2kAISAtoN_starboard_hand_mark	Floating AtoN type Starboard hand Mark.
N2kAISAtoN_preferred_channel_port_hand	Floating AtoN type Preferred Channel Port hand.
N2kAISAtoN_preferred_channel_starboard_hand	Floating AtoN type Preferred Channel Starboard hand.
N2kAISAtoN_isolated_danger	Floating AtoN type Isolated danger.
N2kAISAtoN_safe_water	Floating AtoN type Safe Water.
N2kAISAtoN_special_mark	Floating AtoN type Special Mark.
N2kAISAtoN_light_vessel_lanby_rigs	Floating AtoN type Light Vessel/LANBY/Rigs.

Definition at line 264 of file NMEA2000StdTypes.h.

◆ tN2kDD374

enum tN2kDD374

Measurement delay source.

Enumerator
N2kDD374_UserDefined	Data is user defined
N2kDD374_MinimumDefined	Data is a defined minimum.
N2kDD374_FactoryDefault	Data is Factory Default.
N2kDD374_MaximumSupported	Maximum
N2kDD374_OutOfRange	Data is out of range.
N2kDD374_DataNotAvailable	Data is not available.

Definition at line 304 of file NMEA2000StdTypes.h.

◆ tN2kDD473

enum tN2kDD473

DD473 - Thruster Direction Control according to PGN 128006.

DD473 - Thruster Direction Control DF52 4bit

0 = OFF
1 = Thruster Ready
2 = Thruster to PORT
3 = Thruster to STARBOARD
4-15 = Reserved

Enumerator
N2kDD473_OFF	Thruster is Off.
N2kDD473_ThrusterReady	Truster is Ready.
N2kDD473_ThrusterToPORT	Truster to port.
N2kDD473_ThrusterToSTARBOARD	Thruster to starboard.

Definition at line 366 of file NMEA2000StdTypes.h.

◆ tN2kDD474

enum tN2kDD474

DD474 - Thruster Retraction according to PGN 128006.

DD474 - Thruster Retraction DF52 2bit

0 = OFF
1 = Extend
2 = Retract
3 = Reserved

Enumerator
N2kDD474_OFF	Thruster retraction Off.
N2kDD474_Extend	Thruster retraction Extend.
N2kDD474_Retract	Thruster retraction Retract.
N2kDD474_Reserved	Thruster retraction Reserved.

Definition at line 384 of file NMEA2000StdTypes.h.

◆ tN2kDD480

enum tN2kDD480

DD480 - Windlass Motion States according to PGN 128777.

DD480 - Windlass Motion States DF52 2bit

0 = Windlass stopped
1 = Deployment occurring
2 = Retrieval occurring
3 = Unavailable

Enumerator
N2kDD480_WindlassStopped	Windlass stopped.
N2kDD480_DeploymentOccurring	Deployment occurring.
N2kDD480_RetrievalOccurring	Retrieval occurring.
N2kDD480_Unavailable	Unavailable.

Definition at line 466 of file NMEA2000StdTypes.h.

◆ tN2kDD481

enum tN2kDD481

DD481 - Rode Type States according to PGN 128777.

DD481 - Rode Type States Df52 2bit

0 = Chain presently detected
1 = Rope presently detected
2 = Error
3 = Unavailable

Enumerator
N2kDD481_ChainPresentlyDetected	Chain presently detected.
N2kDD481_RopePresentlyDetected	Rope presently detected.
N2kDD481_Error	Error.
N2kDD481_Unavailable	Unavailable.

Definition at line 483 of file NMEA2000StdTypes.h.

◆ tN2kDD482

enum tN2kDD482

DD482 - Anchor Docking States according to PGN 128777.

DD482 - Anchor Docking States DF52 2bit

0 = Not docked
1 = Fully docked
2 = Error
3 = Data not available

Enumerator
N2kDD482_NotDocked	Not docked.
N2kDD482_FullyDocked	Fully docked.
N2kDD482_Error	Error.
N2kDD482_DataNotAvailable	Data not available.

Definition at line 500 of file NMEA2000StdTypes.h.

◆ tN2kDD484

enum tN2kDD484

DD484 - Windlass Direction Control according to PGN 128776.

DD484 - Windlass Direction Control

0 = OFF (Status Only / cannot command)
1 = DOWN
2 = UP
3 = Reserved

Enumerator
N2kDD484_Off	Status only / cannot command.
N2kDD484_Down	Windlass DOWN.
N2kDD484_Up	Windlass UP.
N2kDD484_Reserved	Reserved.

Definition at line 543 of file NMEA2000StdTypes.h.

◆ tN2kDD487

enum tN2kDD487

DD487 - Motor Power Type according to PGN 128007.

DD487 - Motor Power Type DF52 4bit

0 = 12VDC
1 = 24VDC
2 = 48VDC
3 = 24VAC
4 = Hydraulic
5-15 = Reserved for future assignment

Enumerator
N2kDD487_12VDC	Motor Power Type is 12VDC.
N2kDD487_24VDC	Motor Power Type is 24VDC.
N2kDD487_48VDC	Motor Power Type is 48VDC.
N2kDD487_24VAC	Motor Power Type is 24VAC.
N2kDD487_Hydraulic	Motor Power Type is hydraulic.

Definition at line 562 of file NMEA2000StdTypes.h.

◆ tN2kDD488

enum tN2kDD488

DD488 - Speed Control Type according to PGN 128776.

DD488 - Speed Control Type according to PGN 128776

0 = Single Speed
1 = Dual Speed
2 = Proportional Speed
3 = Data Not Available

Enumerator
N2kDD488_SingleSpeed	Single Speed.
N2kDD488_DualSpeed	Dual Speed.
N2kDD488_ProportionalSpeed	Proportional Speed.
N2kDD488_DataNotAvailable	Data Not Available.

Definition at line 580 of file NMEA2000StdTypes.h.

◆ tN2kDistanceCalculationType

enum tN2kDistanceCalculationType

Enumeration of distance calculation types for navigation according to PGN129284.

A great circle is the shortest path between two points along the surface of a sphere.
A rhumb line is a curve that crosses each meridian at the same angle. This curve is also referred to as a loxodrome (from the Greek loxos, slanted, and drome, path). Although a great circle is a shortest path, it is difficult to navigate because your bearing (or azimuth) continuously changes as you proceed. Following a rhumb line covers more distance than following a geodesic, but it is easier to navigate.

Enumerator
N2kdct_GreatCircle	great circle calculation
N2kdct_RhumbLine	rhumb line calculation

Definition at line 83 of file N2kTypes.h.

◆ tN2kFluidType

enum tN2kFluidType

Enumeration of fluid types according to PGN127505.

Enumerator
N2kft_Fuel	fluid type is fuel
N2kft_Water	fluid type is water
N2kft_GrayWater	fluid type is gray water
N2kft_LiveWell	fluid type is live well
N2kft_Oil	fluid type is oil
N2kft_BlackWater	fluid type is black water
N2kft_FuelGasoline	fluid type is gasoline fuel
N2kft_Error	error occurred
N2kft_Unavailable	unavailable

Definition at line 234 of file N2kTypes.h.

◆ tN2kGNSSDOPmode

enum tN2kGNSSDOPmode

Enumeration of GNSS DOP Mode according to PGN129539.

Dilution of precision (DOP), or geometric dilution of precision (GDOP), is a term used in satellite navigation and geomatics engineering to specify the error propagation as a mathematical effect of navigation satellite geometry on positional measurement precision.

DOP can be expressed as a number of separate measurements:

HDOP horizontal (1D) dilution of precision
VDOP vertical (2D) dilution of precision
PDOP position (3D) dilution of precision
TDOP time dilution of precision
GDOP geometric dilution of precision

https://en.wikipedia.org/wiki/Dilution_of_precision_(navigation)

Enumerator
N2kGNSSdm_1D	1D dilution of precision
N2kGNSSdm_2D	2D dilution of precision
N2kGNSSdm_3D	3D dilution of precision
N2kGNSSdm_Auto	automatic dilution of precision
N2kGNSSdm_Reserved	reserved
N2kGNSSdm_Reserved2	reserved
N2kGNSSdm_Error	error occurred
N2kGNSSdm_Unavailable	unavailable

Definition at line 156 of file N2kTypes.h.

◆ tN2kGNSSmethod

enum tN2kGNSSmethod

Enumeration of GNSS working methods according to PGN129029.

These working methods of the GNSS determine the precision of the GNSS position

Enumerator
N2kGNSSm_noGNSS	no GNSS available
N2kGNSSm_GNSSfix	GNSS is fixed and available.
N2kGNSSm_DGNSS	differential GNSS is available
N2kGNSSm_PreciseGNSS	precise GNSS is available
N2kGNSSm_RTKFixed	GNSS with RealTimeKinematic (fixed) is available.
N2kGNSSm_RTKFloat	GNSS with RealTimeKinematic (float) is available.
N2kGNSSm_Error	error occurred
N2kGNSSm_Unavailable	GNSS is unavailable.

Definition at line 126 of file N2kTypes.h.

◆ tN2kGNSStype

enum tN2kGNSStype

Enumeration of the GPS system which is in use according to PGN129029, PGN129041 and PGN129794.

Enumerator
N2kGNSSt_GPS	only GPS satellite network
N2kGNSSt_GLONASS	only the GLONASS satellite network
N2kGNSSt_GPSGLONASS	GPS + GLONASS satellite network.
N2kGNSSt_GPSSBASWAAS	GPS + WAAS correction satellite network.
N2kGNSSt_GPSSBASWAASGLONASS	GPS + GLONASS + WAAS correction satellite network.
N2kGNSSt_Chayka	Russia's Chayka system is like the erstwhile LORAN-C radio navigation architecture.
N2kGNSSt_integrated	integrated mode
N2kGNSSt_surveyed	surveyed mode
N2kGNSSt_Galileo	European Galileo satellite network.

Definition at line 108 of file N2kTypes.h.

◆ tN2kHeadingReference

enum tN2kHeadingReference

Enumeration of the heading type according to PGN129233, PGN129237 , PGN129250, PGN129026 and PGN129284.

Enumerator
N2khr_true	heading true (eg. GNSS) direction
N2khr_magnetic	heading magnetic compass direction
N2khr_error	error occurred
N2khr_Unavailable	unavailable

Definition at line 62 of file N2kTypes.h.

◆ tN2kHumiditySource

enum tN2kHumiditySource

Enumeration of sources for a humidity value according to PGN130311 and PGN130313.

Enumerator
N2khs_InsideHumidity	humidity is measured inside
N2khs_OutsideHumidity	humidity is measured outside
N2khs_Undef	source is undefined

Definition at line 194 of file N2kTypes.h.

◆ tN2kMagneticVariation

enum tN2kMagneticVariation

Enumeration of magnetic variation according to PGN 127258.

The World Magnetic Modell (WMM) can be found under https://www.ngdc.noaa.gov/geomag/WMM/WMM_old_reports.shtml

Enumerator
N2kmagvar_Manual	manual entered magnetic deviation
N2kmagvar_Chart	magnetic deviation derived from the charts
N2kmagvar_Table	magnetic deviation derived from a table
N2kmagvar_Calc	magnetic deviation calculated
N2kmagvar_WMM2000	magnetic deviation derived from the WMM 2000 report
N2kmagvar_WMM2005	magnetic deviation derived from the WMM 2005 report
N2kmagvar_WMM2010	magnetic deviation derived from the WMM 2010 report
N2kmagvar_WMM2015	magnetic deviation derived from the WMM 2015 report
N2kmagvar_WMM2020	magnetic deviation derived from the WMM 2020 report

Definition at line 473 of file N2kTypes.h.

◆ tN2kMOBEmitterBatteryStatus

enum tN2kMOBEmitterBatteryStatus

Enumeration of MOB emitter battery status according to PGN127233.

Enumerator
Good	Battery status of the MOB emitter is good.
Low	Battery status of the MOB emitter is low.

Definition at line 572 of file N2kTypes.h.

◆ tN2kMOBPositionSource

enum tN2kMOBPositionSource

Enumeration of ManOverBoard position source according to PGN127233.

Enumerator
PositionEstimatedByVessel	MOB position is estimated by the vessel.
PositionReportedByMOBEmitter	MOB position is reported by MOB emitter.

Definition at line 564 of file N2kTypes.h.

◆ tN2kMOBStatus

enum tN2kMOBStatus

Enumeration of ManOverBoard state according to PGN127233.

Enumerator
MOBEmitterActivated	MOB emitter has triggered the status.
ManualOnBoardMOBButtonActivation	MOB was triggered manually.
TestMode	MOB in test mode.
MOBNotActive	MOB not active.

Definition at line 554 of file N2kTypes.h.

◆ tN2kNavigationDirection

enum tN2kNavigationDirection

Enumeration of the navigation direction according to PGN129285.

Enumerator
N2kdir_forward	navigating forward
N2kdir_reverse	navigating reverse
N2kdir_reserved1	reserved 1
N2kdir_reserved2	reserved 2
N2kdir_reserved3	reserved 3
N2kdir_reserved4	reserved 4
N2kdir_error	error occurred
N2kdir_unknown	unknown

Definition at line 47 of file N2kTypes.h.

◆ tN2kOnOff

enum tN2kOnOff

Enumeration of On/Off status at a NMEA 2000 network.

Enumerator
N2kOnOff_Off	No, Off, Disabled.
N2kOnOff_On	Yes, On, Enabled.
N2kOnOff_Error	Error.
N2kOnOff_Unavailable	Unavailable.

Definition at line 488 of file N2kTypes.h.

◆ tN2kPressureSource

enum tN2kPressureSource

Enumeration of sources for a pressure value according to PGN130314 and PGN130315.

Enumerator
N2kps_Atmospheric	value is representing an atmospheric air pressure
N2kps_Water	value is representing a water pressure
N2kps_Steam	value is representing a steam pressure
N2kps_CompressedAir	value is representing a compressed air pressure
N2kps_Hydraulic	value is representing a hydraulic pressure
N2kps_Filter	value is representing a filter pressure
N2kps_AltimeterSetting	value is representing an altimeter setting
N2kps_Oil	value is representing an oil pressure
N2kps_Fuel	value is representing a fuel pressure
N2kps_Reserved	reserved
N2kps_Error	error occurred
N2kps_Unavailable	source is unavailable

Definition at line 204 of file N2kTypes.h.

◆ tN2kRudderDirectionOrder

enum tN2kRudderDirectionOrder

Enumeration of Rudder Direction Order according to PGN127237, 127245.

Enumerator
N2kRDO_NoDirectionOrder	no direction order
N2kRDO_MoveToStarboard	move to starboard
N2kRDO_MoveToPort	move to port
N2kRDO_Unavailable	unavailable

Definition at line 279 of file N2kTypes.h.

◆ tN2kSpeedWaterReferenceType

enum tN2kSpeedWaterReferenceType

Enumeration of speed thru water sensors types according to PGN128259.

Enumerator
N2kSWRT_Paddle_wheel	paddle wheel sensor is used
N2kSWRT_Pitot_tube	pitot tube sensor is used
N2kSWRT_Doppler_log	doppler sensor is used
N2kSWRT_Ultra_Sound	ultra sound sensor is used
N2kSWRT_Electro_magnetic	electro magnetic sensor is used
N2kSWRT_Error	error occurred
N2kSWRT_Unavailable	unavailable

Definition at line 266 of file N2kTypes.h.

◆ tN2kSteeringMode

enum tN2kSteeringMode

Enumeration of the steering mode according to PGN127237.

Enumerator
N2kSM_MainSteering	The device is the main steering.
N2kSM_NonFollowUpDevice	The device is a non followup device.
N2kSM_FollowUpDevice	The device is a follup device.
N2kSM_HeadingControlStandalone	The heading controlsystem is a standalone.
N2kSM_HeadingControl	The device is a HeadingControl.
N2kSM_TrackControl	The device is a TrackControl.
N2kSM_Unavailable	unavailable

Definition at line 530 of file N2kTypes.h.

◆ tN2kTempSource

enum tN2kTempSource

Enumeration of sources for a temperature value according to PGN130311, PGN130312 and PGN130316.

Enumerator
N2kts_SeaTemperature	value is representing a sea water temperature
N2kts_OutsideTemperature	value is representing an outside temperature
N2kts_InsideTemperature	value is representing an inside temperature
N2kts_EngineRoomTemperature	value is representing an engine room temperature
N2kts_MainCabinTemperature	value is representing a main cabin temperature
N2kts_LiveWellTemperature	value is representing a live well temperature
N2kts_BaitWellTemperature	value is representing a bait well temperature
N2kts_RefridgerationTemperature	value is representing a refrigeration temperature
N2kts_HeatingSystemTemperature	value is representing a heating system temperature
N2kts_DewPointTemperature	value is representing a dew point temperature
N2kts_ApparentWindChillTemperature	value is representing an apparent wind chill temperature
N2kts_TheoreticalWindChillTemperature	value is representing a theoretical wind chill temperature
N2kts_HeatIndexTemperature	value is representing a heat index temperature
N2kts_FreezerTemperature	value is representing a freezer temperature
N2kts_ExhaustGasTemperature	value is representing a exhaust gas temperature
N2kts_ShaftSealTemperature	value is representing a shaft seal temperature

Definition at line 171 of file N2kTypes.h.

◆ tN2kTimeSource

enum tN2kTimeSource

Enumeration of sources for the system time according to PGN126992.

Enumerator
N2ktimes_GPS	Source is Global Positioning System GPS.
N2ktimes_GLONASS	Source is Glonass.
N2ktimes_RadioStation	Source is a radio station.
N2ktimes_LocalCesiumClock	Source is a local cesium clock.
N2ktimes_LocalRubidiumClock	Source is a local rubidium clock.
N2ktimes_LocalCrystalClock	Source is a local crystal clock.

Definition at line 222 of file N2kTypes.h.

◆ tN2kTransmissionGear

enum tN2kTransmissionGear

Enumeration of transmission state according to PGN 127493.

Enumerator
N2kTG_Forward	transmission state is forward
N2kTG_Neutral	transmission state is neutral
N2kTG_Reverse	transmission state is reverse
N2kTG_Unknown	transmission state is unknown

Definition at line 358 of file N2kTypes.h.

◆ tN2kTurnMode

enum tN2kTurnMode

Enumeration of tunr control modes according to PGN127237.

Enumerator
N2kTM_RudderLimitControlled	The turning is controlled by the rudder limit.
N2kTM_TurnRateControlled	The turning is controlled by the turn rate.
N2kTM_RadiusControlled	The turning is controlled by the radius.
N2kTM_Unavailable	unavailable

Definition at line 544 of file N2kTypes.h.

◆ tN2kWindReference

enum tN2kWindReference

Enumeration of wind reference types according to PGN130306.

Details found on page 12 of https://www.rocktheboatmarinestereo.com/specs/MSNRX200I.pdf

Enumerator
N2kWind_True_North	Theoretical Wind (ground referenced, referenced to True North; calculated using COG/SOG)
N2kWind_Magnetic	Theoretical Wind (ground referenced, referenced to Magnetic North; calculated using COG/SOG)
N2kWind_Apparent	Apparent Wind (relative to the vessel centerline)
N2kWind_Apprent	Deprecated - We had the typo in older version of the library.
N2kWind_True_boat	Theoretical (Calculated to Centerline of the vessel, referenced to ground; calculated using COG/SOG)
N2kWind_True_water	Theoretical (Calculated to Centerline of the vessel, referenced to water; calculated using Heading/Speed through Water)
N2kWind_Error	error occurred
N2kWind_Unavailable	unavailable

Definition at line 252 of file N2kTypes.h.

◆ tN2kXTEMode

enum tN2kXTEMode

Enumeration of Cross Track Error modes according to PGN129283.

Cross-track error (XTE) is an essential at-a-glance indication of your distance to port or starboard of your intended straight track between two waypoints.

Enumerator
N2kxtem_Autonomous	autonomous mode
N2kxtem_Differential	differential mode
N2kxtem_Estimated	estimated mode
N2kxtem_Simulator	simulator mode
N2kxtem_Manual	manual mode

Definition at line 95 of file N2kTypes.h.