NMEA2000 Library  0.1
Library to handle NMEA 2000 Communication written in C++
NMEA2000StdTypes.h File Reference

NMEA2000 standard type definitions. More...

#include <stdint.h>
Include dependency graph for NMEA2000StdTypes.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

union  tN2kDD206
 DD206 - Engine Discrete Warning Status. More...
 
union  tN2kDD223
 DD223 - Engine Discrete Warning Status. More...
 
union  tN2kDD471
 DD471 - Thruster Motor Events according to PGN 128008. More...
 
union  tN2kDD475
 DD475 - Thruster Control Events according to PGN 128006. More...
 
union  tN2kDD477
 DD477 - Windlass Monitoring Events according to PGN 128778. More...
 
union  tN2kDD478
 DD478 - Windlass Control Events according to PGN 128776. More...
 
union  tN2kDD483
 DD483 - Windlass Operating Events according to PGN 128777. More...
 

Enumerations

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

NMEA2000 standard type definitions.

This file contains (and must only contain) type definitions of data types defined in the NMEA2000 standard. These all have names of the form "DDnnn". The language of the definitions should follow exactly that of the standard document from which the information is drawn. No abbreviated names. No mangled capitalisation.

The entries here are mostly enums describing bit field types. Where an enum member has multiple meanings, each meaning is aliased (see tN2kDD0002 for an example).

This file is included by N2kTypes.h where the standard code names are aliased into corresponding long names (once again, exactly as described by NMEA).

Resources NMEA 2000 ® Appendix B.2 – Data Dictionary

Definition in file NMEA2000StdTypes.h.