NMEA2000 Library  0.1
Library to handle NMEA 2000 Communication written in C++
Parsing tN2kMsg objects

List of functions which parse the data content of tN2kMsg objects. More...

Collaboration diagram for Parsing tN2kMsg objects:

Functions

bool ParseN2kAISAtoNReport (const tN2kMsg &N2kMsg, tN2kAISAtoNReportData &N2kData)
 Parsing the content of a "AIS Aids to Navigation (AtoN) Report" message - PGN 129041. More...
 
bool ParseN2kAISClassAPosition (const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat &Repeat, uint32_t &UserID, double &Latitude, double &Longitude, bool &Accuracy, bool &RAIM, uint8_t &Seconds, double &COG, double &SOG, double &Heading, double &ROT, tN2kAISNavStatus &NavStatus)
 Parsing the content of a "AIS position reports for Class A" message - PGN 129038. More...
 
bool ParseN2kAISClassAStatic (const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat &Repeat, uint32_t &UserID, uint32_t &IMOnumber, char *Callsign, size_t CallsignBufSize, char *Name, size_t NameBufSize, uint8_t &VesselType, double &Length, double &Beam, double &PosRefStbd, double &PosRefBow, uint16_t &ETAdate, double &ETAtime, double &Draught, char *Destination, size_t DestinationBufSize, tN2kAISVersion &AISversion, tN2kGNSStype &GNSStype, tN2kAISDTE &DTE, tN2kAISTransceiverInformation &AISinfo)
 Parsing the content of a "AIS static data class A" message - PGN 129794. More...
 
bool ParseN2kAISClassBPosition (const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat &Repeat, uint32_t &UserID, double &Latitude, double &Longitude, bool &Accuracy, bool &RAIM, uint8_t &Seconds, double &COG, double &SOG, double &Heading, tN2kAISUnit &Unit, bool &Display, bool &DSC, bool &Band, bool &Msg22, tN2kAISMode &Mode, bool &State)
 Parsing the content of a "AIS position reports for Class B" message - PGN 129039. More...
 
bool ParseN2kAISClassBPosition (const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat &Repeat, uint32_t &UserID, double &Latitude, double &Longitude, bool &Accuracy, bool &RAIM, uint8_t &Seconds, double &COG, double &SOG, tN2kAISTransceiverInformation &AISTransceiverInformation, double &Heading, tN2kAISUnit &Unit, bool &Display, bool &DSC, bool &Band, bool &Msg22, tN2kAISMode &Mode, bool &State)
 Parsing the content of a "AIS position reports for Class B" message - PGN 129039. More...
 
bool ParseN2kAISClassBStaticPartA (const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat &Repeat, uint32_t &UserID, char *Name, size_t NameBufSize)
 Parsing the content of a "AIS static data class B part A" message - PGN 129809. More...
 
bool ParseN2kAISClassBStaticPartB (const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat &Repeat, uint32_t &UserID, uint8_t &VesselType, char *Vendor, size_t VendorBufSize, char *Callsign, size_t CallsignBufSize, double &Length, double &Beam, double &PosRefStbd, double &PosRefBow, uint32_t &MothershipID)
 Parsing the content of a "AIS static data class B part B" message - PGN 129810. More...
 
bool ParseN2kAISSafetyRelatedBroadcastMsg (const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat &Repeat, uint32_t &SourceID, tN2kAISTransceiverInformation &AISTransceiverInformation, char *SafetyRelatedText, size_t &SafetyRelatedTextMaxSize)
 Parsing the content of a "AIS Safety Related Broadcast Message" message - PGN 129802. More...
 
bool ParseN2kAttitude (const tN2kMsg &N2kMsg, unsigned char &SID, double &Yaw, double &Pitch, double &Roll)
 Parsing the content of a "Attitude" message - PGN 127257. More...
 
bool ParseN2kBatConf (const tN2kMsg &N2kMsg, unsigned char &BatInstance, tN2kBatType &BatType, tN2kBatEqSupport &SupportsEqual, tN2kBatNomVolt &BatNominalVoltage, tN2kBatChem &BatChemistry, double &BatCapacity, int8_t &BatTemperatureCoefficient, double &PeukertExponent, int8_t &ChargeEfficiencyFactor)
 Parsing the content of a "Battery Configuration Status" message - PGN 127513. More...
 
bool ParseN2kBinaryStatus (const tN2kMsg &N2kMsg, unsigned char &DeviceBankInstance, tN2kBinaryStatus &BankStatus)
 Parsing the content of a "Universal Binary Status Report" message - PGN 127501. More...
 
bool ParseN2kBinaryStatus (const tN2kMsg &N2kMsg, unsigned char &DeviceBankInstance, tN2kOnOff &Status1, tN2kOnOff &Status2, tN2kOnOff &Status3, tN2kOnOff &Status4)
 Parsing the content of a "Universal Binary Status Report" message - PGN 127501. More...
 
bool ParseN2kBoatSpeed (const tN2kMsg &N2kMsg, unsigned char &SID, double &WaterReferenced, double &GroundReferenced, tN2kSpeedWaterReferenceType &SWRT)
 Parsing the content of a "Boat Speed, Water Referenced" message - PGN 128259. More...
 
bool ParseN2kChargerStatus (const tN2kMsg &N2kMsg, unsigned char &Instance, unsigned char &BatteryInstance, tN2kChargeState &ChargeState, tN2kChargerMode &ChargerMode, tN2kOnOff &Enabled, tN2kOnOff &EqualizationPending, double &EqualizationTimeRemaining)
 Parsing the content of a "DC Charger Status" message - PGN 127507. More...
 
bool ParseN2kDCBatStatus (const tN2kMsg &N2kMsg, unsigned char &BatteryInstance, double &BatteryVoltage, double &BatteryCurrent, double &BatteryTemperature, unsigned char &SID)
 Parsing the content of a "Battery Status" message - PGN 127508. More...
 
bool ParseN2kDCStatus (const tN2kMsg &N2kMsg, unsigned char &SID, unsigned char &DCInstance, tN2kDCType &DCType, unsigned char &StateOfCharge, unsigned char &StateOfHealth, double &TimeRemaining, double &RippleVoltage, double &Capacity)
 Parsing the content of a "DC Detailed Status" message - PGN 127506. More...
 
bool ParseN2kDirectionData (const tN2kMsg &N2kMsg, tN2kDataMode &DataMode, tN2kHeadingReference &CogReference, unsigned char &SID, double &COG, double &SOG, double &Heading, double &SpeedThroughWater, double &Set, double &Drift)
 Parsing the content of a "Direction Data" message - PGN 130577. More...
 
bool ParseN2kDistanceLog (const tN2kMsg &N2kMsg, uint16_t &DaysSince1970, double &SecondsSinceMidnight, uint32_t &Log, uint32_t &TripLog)
 Parsing the content of a "Distance log" message - PGN 128275. More...
 
bool ParseN2kEngineDynamicParam (const tN2kMsg &N2kMsg, unsigned char &EngineInstance, double &EngineOilPress, double &EngineOilTemp, double &EngineCoolantTemp, double &AltenatorVoltage, double &FuelRate, double &EngineHours)
 Parsing the content of a "Engine parameters dynamic" message - PGN 127489. More...
 
bool ParseN2kEngineDynamicParam (const tN2kMsg &N2kMsg, unsigned char &EngineInstance, double &EngineOilPress, double &EngineOilTemp, double &EngineCoolantTemp, double &AltenatorVoltage, double &FuelRate, double &EngineHours, double &EngineCoolantPress, double &EngineFuelPress, int8_t &EngineLoad, int8_t &EngineTorque)
 Parsing the content of a "Engine parameters dynamic" message - PGN 127489. More...
 
bool ParseN2kEngineDynamicParam (const tN2kMsg &N2kMsg, unsigned char &EngineInstance, double &EngineOilPress, double &EngineOilTemp, double &EngineCoolantTemp, double &AltenatorVoltage, double &FuelRate, double &EngineHours, double &EngineCoolantPress, double &EngineFuelPress, int8_t &EngineLoad, int8_t &EngineTorque, tN2kEngineDiscreteStatus1 &Status1, tN2kEngineDiscreteStatus2 &Status2)
 Parsing the content of a "Engine parameters dynamic" message - PGN 127489. More...
 
bool ParseN2kEngineParamRapid (const tN2kMsg &N2kMsg, unsigned char &EngineInstance, double &EngineSpeed, double &EngineBoostPressure, int8_t &EngineTiltTrim)
 Parsing the content of a "Engine parameters rapid" message - PGN 127488. More...
 
bool ParseN2kEngineTripParameters (const tN2kMsg &N2kMsg, unsigned char &EngineInstance, double &TripFuelUsed, double &FuelRateAverage, double &FuelRateEconomy, double &InstantaneousFuelEconomy)
 Parsing the content of a "Trip Parameters, Engine" message - PGN 127497. More...
 
bool ParseN2kEnvironmentalParameters (const tN2kMsg &N2kMsg, unsigned char &SID, tN2kTempSource &TempSource, double &Temperature, tN2kHumiditySource &HumiditySource, double &Humidity, double &AtmosphericPressure)
 Parsing the content of a "Environmental Parameters - DEPRECATED" message - PGN 130311. More...
 
bool ParseN2kFluidLevel (const tN2kMsg &N2kMsg, unsigned char &Instance, tN2kFluidType &FluidType, double &Level, double &Capacity)
 Parsing the content of a "Fluid level" message - PGN 127505. More...
 
bool ParseN2kGNSS (const tN2kMsg &N2kMsg, unsigned char &SID, uint16_t &DaysSince1970, double &SecondsSinceMidnight, double &Latitude, double &Longitude, double &Altitude, tN2kGNSStype &GNSStype, tN2kGNSSmethod &GNSSmethod, unsigned char &nSatellites, double &HDOP, double &PDOP, double &GeoidalSeparation, unsigned char &nReferenceStations, tN2kGNSStype &ReferenceStationType, uint16_t &ReferenceSationID, double &AgeOfCorrection)
 Parsing the content of a "GNSS Position Data" message - PGN 129029. More...
 
bool ParseN2kGNSSDOPData (const tN2kMsg &N2kMsg, unsigned char &SID, tN2kGNSSDOPmode &DesiredMode, tN2kGNSSDOPmode &ActualMode, double &HDOP, double &VDOP, double &TDOP)
 Parsing the content of a "GNSS DOP data" message - PGN 129539. More...
 
bool ParseN2kHeading (const tN2kMsg &N2kMsg, unsigned char &SID, double &Heading, double &Deviation, double &Variation, tN2kHeadingReference &ref)
 Parsing the content of a "Vessel Heading" message - PGN 127250. More...
 
bool ParseN2kHeadingTrackControl (const tN2kMsg &N2kMsg, tN2kOnOff &RudderLimitExceeded, tN2kOnOff &OffHeadingLimitExceeded, tN2kOnOff &OffTrackLimitExceeded, tN2kOnOff &Override, tN2kSteeringMode &SteeringMode, tN2kTurnMode &TurnMode, tN2kHeadingReference &HeadingReference, tN2kRudderDirectionOrder &CommandedRudderDirection, double &CommandedRudderAngle, double &HeadingToSteerCourse, double &Track, double &RudderLimit, double &OffHeadingLimit, double &RadiusOfTurnOrder, double &RateOfTurnOrder, double &OffTrackLimit, double &VesselHeading)
 Parsing the content of a "Heading/Track control" message - PGN 127237. More...
 
bool ParseN2kHeave (const tN2kMsg &N2kMsg, unsigned char &SID, double &Heave)
 Parsing the content of a "Heave" message - PGN 127252. More...
 
bool ParseN2kHeave (const tN2kMsg &N2kMsg, unsigned char &SID, double &Heave, double &Delay, tN2kDelaySource &DelaySource)
 Parsing the content of a "Heave" message - PGN 127252. More...
 
bool ParseN2kHumidity (const tN2kMsg &N2kMsg, unsigned char &SID, unsigned char &HumidityInstance, tN2kHumiditySource &HumiditySource, double &ActualHumidity)
 Parsing the content of a "Humidity" message - PGN 130313. More...
 
bool ParseN2kHumidity (const tN2kMsg &N2kMsg, unsigned char &SID, unsigned char &HumidityInstance, tN2kHumiditySource &HumiditySource, double &ActualHumidity, double &SetHumidity)
 Parsing the content of a "Humidity" message - PGN 130313. More...
 
bool ParseN2kLeeway (const tN2kMsg &N2kMsg, unsigned char &SID, double &Leeway)
 Parsing the content of a "Nautical Leeway Angle" message - PGN 128000. More...
 
bool ParseN2kLocalOffset (const tN2kMsg &N2kMsg, uint16_t &DaysSince1970, double &SecondsSinceMidnight, int16_t &LocalOffset)
 Parsing the content of a "Date,Time & Local offset" message - PGN 129033. More...
 
bool ParseN2kMagneticVariation (const tN2kMsg &N2kMsg, unsigned char &SID, tN2kMagneticVariation &Source, uint16_t &DaysSince1970, double &Variation)
 Parsing the content of a "Magnetic Variation" message - PGN 127258. More...
 
bool ParseN2kMeteorlogicalStationData (const tN2kMsg &N2kMsg, tN2kMeteorlogicalStationData &N2kData)
 Parsing the content of a "Meterological Station Data" message - PGN 130323. More...
 
bool ParseN2kMOBNotification (const tN2kMsg &N2kMsg, unsigned char &SID, uint32_t &MobEmitterId, tN2kMOBStatus &MOBStatus, double &ActivationTime, tN2kMOBPositionSource &PositionSource, uint16_t &PositionDate, double &PositionTime, double &Latitude, double &Longitude, tN2kHeadingReference &COGReference, double &COG, double &SOG, uint32_t &MMSI, tN2kMOBEmitterBatteryStatus &MOBEmitterBatteryStatus)
 Parsing the content of a "Man Overboard Notification" message - PGN 127233. More...
 
bool ParseN2kNavigationInfo (const tN2kMsg &N2kMsg, unsigned char &SID, double &DistanceToWaypoint, tN2kHeadingReference &BearingReference, bool &PerpendicularCrossed, bool &ArrivalCircleEntered, tN2kDistanceCalculationType &CalculationType, double &ETATime, int16_t &ETADate, double &BearingOriginToDestinationWaypoint, double &BearingPositionToDestinationWaypoint, uint32_t &OriginWaypointNumber, uint32_t &DestinationWaypointNumber, double &DestinationLatitude, double &DestinationLongitude, double &WaypointClosingVelocity)
 Parsing the content of a "Navigation Data" message - PGN 129284. More...
 
bool ParseN2kOutsideEnvironmentalParameters (const tN2kMsg &N2kMsg, unsigned char &SID, double &WaterTemperature, double &OutsideAmbientAirTemperature, double &AtmosphericPressure)
 Parsing the content of a "Environmental Parameters - DEPRECATED" message - PGN 130310. More...
 
bool ParseN2kPGN126992 (const tN2kMsg &N2kMsg, unsigned char &SID, uint16_t &SystemDate, double &SystemTime, tN2kTimeSource &TimeSource)
 Parsing the Content of a PGN126992 Message - "System date/time". More...
 
bool ParseN2kPGN127233 (const tN2kMsg &N2kMsg, unsigned char &SID, uint32_t &MobEmitterId, tN2kMOBStatus &MOBStatus, double &ActivationTime, tN2kMOBPositionSource &PositionSource, uint16_t &PositionDate, double &PositionTime, double &Latitude, double &Longitude, tN2kHeadingReference &COGReference, double &COG, double &SOG, uint32_t &MMSI, tN2kMOBEmitterBatteryStatus &MOBEmitterBatteryStatus)
 Parsing the Content of Message PGN127233 "Man Overboard Notification". More...
 
bool ParseN2kPGN127237 (const tN2kMsg &N2kMsg, tN2kOnOff &RudderLimitExceeded, tN2kOnOff &OffHeadingLimitExceeded, tN2kOnOff &OffTrackLimitExceeded, tN2kOnOff &Override, tN2kSteeringMode &SteeringMode, tN2kTurnMode &TurnMode, tN2kHeadingReference &HeadingReference, tN2kRudderDirectionOrder &CommandedRudderDirection, double &CommandedRudderAngle, double &HeadingToSteerCourse, double &Track, double &RudderLimit, double &OffHeadingLimit, double &RadiusOfTurnOrder, double &RateOfTurnOrder, double &OffTrackLimit, double &VesselHeading)
 Parsing the Content of Message PGN127237 "Heading/Track control". More...
 
bool ParseN2kPGN127245 (const tN2kMsg &N2kMsg, double &RudderPosition, unsigned char &Instance, tN2kRudderDirectionOrder &RudderDirectionOrder, double &AngleOrder)
 Parsing the content of Message PGN127245 "Rudder". More...
 
bool ParseN2kPGN127250 (const tN2kMsg &N2kMsg, unsigned char &SID, double &Heading, double &Deviation, double &Variation, tN2kHeadingReference &ref)
 Parsing Content of Message PGN 127250 "Vessel Heading". More...
 
bool ParseN2kPGN127251 (const tN2kMsg &N2kMsg, unsigned char &SID, double &RateOfTurn)
 Parsing the content of Message PGN127251 "Rate of Turn". More...
 
bool ParseN2kPGN127252 (const tN2kMsg &N2kMsg, unsigned char &SID, double &Heave, double &Delay, tN2kDelaySource &DelaySource)
 Parsing the content of Message PGN127252 "Heave". More...
 
bool ParseN2kPGN127257 (const tN2kMsg &N2kMsg, unsigned char &SID, double &Yaw, double &Pitch, double &Roll)
 Parsing the content of Message PGN 127257 "Attitude". More...
 
bool ParseN2kPGN127258 (const tN2kMsg &N2kMsg, unsigned char &SID, tN2kMagneticVariation &Source, uint16_t &DaysSince1970, double &Variation)
 Parsing the content of Message PGN 127258 "Magnetic Variation". More...
 
bool ParseN2kPGN127488 (const tN2kMsg &N2kMsg, unsigned char &EngineInstance, double &EngineSpeed, double &EngineBoostPressure, int8_t &EngineTiltTrim)
 Parsing the content of Message PGN 127488 "Engine parameters rapid". More...
 
bool ParseN2kPGN127489 (const tN2kMsg &N2kMsg, unsigned char &EngineInstance, double &EngineOilPress, double &EngineOilTemp, double &EngineCoolantTemp, double &AltenatorVoltage, double &FuelRate, double &EngineHours, double &EngineCoolantPress, double &EngineFuelPress, int8_t &EngineLoad, int8_t &EngineTorque)
 Parsing the content of a "Engine parameters dynamic" message - PGN 127489. More...
 
bool ParseN2kPGN127489 (const tN2kMsg &N2kMsg, unsigned char &EngineInstance, double &EngineOilPress, double &EngineOilTemp, double &EngineCoolantTemp, double &AltenatorVoltage, double &FuelRate, double &EngineHours, double &EngineCoolantPress, double &EngineFuelPress, int8_t &EngineLoad, int8_t &EngineTorque, tN2kEngineDiscreteStatus1 &Status1, tN2kEngineDiscreteStatus2 &Status2)
 Parsing the content of Message PGN 127489 "Engine parameters dynamic". More...
 
bool ParseN2kPGN127493 (const tN2kMsg &N2kMsg, unsigned char &EngineInstance, tN2kTransmissionGear &TransmissionGear, double &OilPressure, double &OilTemperature, unsigned char &DiscreteStatus1)
 Parsing the content of Message PGN 127493 "Transmission parameters, dynamic". More...
 
bool ParseN2kPGN127497 (const tN2kMsg &N2kMsg, unsigned char &EngineInstance, double &TripFuelUsed, double &FuelRateAverage, double &FuelRateEconomy, double &InstantaneousFuelEconomy)
 Parsing the content of Message PGN 127497 "Trip Parameters, Engine". More...
 
bool ParseN2kPGN127501 (const tN2kMsg &N2kMsg, unsigned char &DeviceBankInstance, tN2kBinaryStatus &BankStatus)
 Parsing the content of Message PGN 127501 Message "Universal Binary Status Report". More...
 
bool ParseN2kPGN127501 (const tN2kMsg &N2kMsg, unsigned char &DeviceBankInstance, tN2kOnOff &Status1, tN2kOnOff &Status2, tN2kOnOff &Status3, tN2kOnOff &Status4)
 Parsing the content of Message PGN 127501 Message "Universal Binary Status Report". More...
 
bool ParseN2kPGN127502 (const tN2kMsg &N2kMsg, unsigned char &TargetBankInstance, tN2kBinaryStatus &BankStatus)
 Parse the content of a PGN 127502 (Switch Bank Control) message. More...
 
bool ParseN2kPGN127505 (const tN2kMsg &N2kMsg, unsigned char &Instance, tN2kFluidType &FluidType, double &Level, double &Capacity)
 Parsing the content of message PGN 127505 "Fluid level". More...
 
bool ParseN2kPGN127506 (const tN2kMsg &N2kMsg, unsigned char &SID, unsigned char &DCInstance, tN2kDCType &DCType, unsigned char &StateOfCharge, unsigned char &StateOfHealth, double &TimeRemaining, double &RippleVoltage, double &Capacity)
 Parsing the content of message PGN 127506 "DC Detailed Status". More...
 
bool ParseN2kPGN127507 (const tN2kMsg &N2kMsg, unsigned char &Instance, unsigned char &BatteryInstance, tN2kChargeState &ChargeState, tN2kChargerMode &ChargerMode, tN2kOnOff &Enabled, tN2kOnOff &EqualizationPending, double &EqualizationTimeRemaining)
 Parsing the content of message PGN 127507 "DC Charger Status". More...
 
bool ParseN2kPGN127508 (const tN2kMsg &N2kMsg, unsigned char &BatteryInstance, double &BatteryVoltage, double &BatteryCurrent, double &BatteryTemperature, unsigned char &SID)
 Parsing the content of message PGN 127508 "Battery Status". More...
 
bool ParseN2kPGN127513 (const tN2kMsg &N2kMsg, unsigned char &BatInstance, tN2kBatType &BatType, tN2kBatEqSupport &SupportsEqual, tN2kBatNomVolt &BatNominalVoltage, tN2kBatChem &BatChemistry, double &BatCapacity, int8_t &BatTemperatureCoefficient, double &PeukertExponent, int8_t &ChargeEfficiencyFactor)
 Parsing the content of message PGN 127513 "Battery Configuration Status". More...
 
bool ParseN2kPGN128000 (const tN2kMsg &N2kMsg, unsigned char &SID, double &Leeway)
 Parsing the content of Message PGN 128000 "Nautical Leeway Angle". More...
 
bool ParseN2kPGN128259 (const tN2kMsg &N2kMsg, unsigned char &SID, double &WaterReferenced, double &GroundReferenced, tN2kSpeedWaterReferenceType &SWRT)
 Parsing the content of message PGN 128259 "Boat Speed, Water Referenced". More...
 
bool ParseN2kPGN128267 (const tN2kMsg &N2kMsg, unsigned char &SID, double &DepthBelowTransducer, double &Offset, double &Range)
 Parsing the content of message PGN 128267 "Water depth". More...
 
bool ParseN2kPGN128275 (const tN2kMsg &N2kMsg, uint16_t &DaysSince1970, double &SecondsSinceMidnight, uint32_t &Log, uint32_t &TripLog)
 Parsing the content of message PGN 128275 "Distance log". More...
 
bool ParseN2kPGN128776 (const tN2kMsg &N2kMsg, unsigned char &SID, unsigned char &WindlassIdentifier, tN2kWindlassDirectionControl &WindlassDirectionControl, unsigned char &SpeedControl, tN2kSpeedType &SpeedControlType, tN2kGenericStatusPair &AnchorDockingControl, tN2kGenericStatusPair &PowerEnable, tN2kGenericStatusPair &MechanicalLock, tN2kGenericStatusPair &DeckAndAnchorWash, tN2kGenericStatusPair &AnchorLight, double &CommandTimeout, tN2kWindlassControlEvents &WindlassControlEvents)
 Parsing the content of message PGN 128776 "Anchor Windlass Control Status". More...
 
bool ParseN2kPGN128777 (const tN2kMsg &N2kMsg, unsigned char &SID, unsigned char &WindlassIdentifier, double &RodeCounterValue, double &WindlassLineSpeed, tN2kWindlassMotionStates &WindlassMotionStatus, tN2kRodeTypeStates &RodeTypeStatus, tN2kAnchorDockingStates &AnchorDockingStatus, tN2kWindlassOperatingEvents &WindlassOperatingEvents)
 Parsing the content of message PGN 128777 "Anchor Windlass Operating Status". More...
 
bool ParseN2kPGN128778 (const tN2kMsg &N2kMsg, unsigned char &SID, unsigned char &WindlassIdentifier, double &TotalMotorTime, double &ControllerVoltage, double &MotorCurrent, tN2kWindlassMonitoringEvents &WindlassMonitoringEvents)
 Parsing the content of message PGN128778 "Anchor Windlass Monitoring Status". More...
 
bool ParseN2kPGN129025 (const tN2kMsg &N2kMsg, double &Latitude, double &Longitude)
 Parsing the content of PGN 129025 "Position, Rapid Update". More...
 
bool ParseN2kPGN129026 (const tN2kMsg &N2kMsg, unsigned char &SID, tN2kHeadingReference &ref, double &COG, double &SOG)
 Parsing the content of PGN 129026 "COG SOG rapid update". More...
 
bool ParseN2kPGN129029 (const tN2kMsg &N2kMsg, unsigned char &SID, uint16_t &DaysSince1970, double &SecondsSinceMidnight, double &Latitude, double &Longitude, double &Altitude, tN2kGNSStype &GNSStype, tN2kGNSSmethod &GNSSmethod, unsigned char &nSatellites, double &HDOP, double &PDOP, double &GeoidalSeparation, unsigned char &nReferenceStations, tN2kGNSStype &ReferenceStationType, uint16_t &ReferenceSationID, double &AgeOfCorrection)
 Parsing the content of message PGN 129029 "GNSS Position Data". More...
 
bool ParseN2kPGN129033 (const tN2kMsg &N2kMsg, uint16_t &DaysSince1970, double &SecondsSinceMidnight, int16_t &LocalOffset)
 Parsing the content of message PGN 129033 "Date,Time & Local offset". More...
 
bool ParseN2kPGN129038 (const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat &Repeat, uint32_t &UserID, double &Latitude, double &Longitude, bool &Accuracy, bool &RAIM, uint8_t &Seconds, double &COG, double &SOG, double &Heading, double &ROT, tN2kAISNavStatus &NavStatus)
 Parsing the content of message PGN 129038 "AIS position reports for Class A". More...
 
bool ParseN2kPGN129039 (const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat &Repeat, uint32_t &UserID, double &Latitude, double &Longitude, bool &Accuracy, bool &RAIM, uint8_t &Seconds, double &COG, double &SOG, tN2kAISTransceiverInformation &AISTransceiverInformation, double &Heading, tN2kAISUnit &Unit, bool &Display, bool &DSC, bool &Band, bool &Msg22, tN2kAISMode &Mode, bool &State)
 Parsing the content of message PGN 129039 "AIS position reports for Class B". More...
 
bool ParseN2kPGN129041 (const tN2kMsg &N2kMsg, tN2kAISAtoNReportData &N2kData)
 Parsing the content of message PGN 129041 "AIS Aids to Navigation (AtoN) Report". More...
 
bool ParseN2kPGN129283 (const tN2kMsg &N2kMsg, unsigned char &SID, tN2kXTEMode &XTEMode, bool &NavigationTerminated, double &XTE)
 Parsing the content of Message PGN 129283 Message "Cross Track Error". More...
 
bool ParseN2kPGN129284 (const tN2kMsg &N2kMsg, unsigned char &SID, double &DistanceToWaypoint, tN2kHeadingReference &BearingReference, bool &PerpendicularCrossed, bool &ArrivalCircleEntered, tN2kDistanceCalculationType &CalculationType, double &ETATime, int16_t &ETADate, double &BearingOriginToDestinationWaypoint, double &BearingPositionToDestinationWaypoint, uint32_t &OriginWaypointNumber, uint32_t &DestinationWaypointNumber, double &DestinationLatitude, double &DestinationLongitude, double &WaypointClosingVelocity)
 Parsing the content of message PGN 129284 "Navigation Data". More...
 
bool ParseN2kPgn129539 (const tN2kMsg &N2kMsg, unsigned char &SID, tN2kGNSSDOPmode &DesiredMode, tN2kGNSSDOPmode &ActualMode, double &HDOP, double &VDOP, double &TDOP)
 Parsing the content of message PGN 129539 "GNSS DOP data". More...
 
bool ParseN2kPGN129540 (const tN2kMsg &N2kMsg, uint8_t SVIndex, tSatelliteInfo &SatelliteInfo)
 Parsing the content of message PGN 129540 "GNSS Satellites in View". More...
 
bool ParseN2kPGN129540 (const tN2kMsg &N2kMsg, unsigned char &SID, tN2kRangeResidualMode &Mode, uint8_t &NumberOfSVs)
 Parsing the content of message PGN 129540 "GNSS Satellites in View". More...
 
bool ParseN2kPGN129794 (const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat &Repeat, uint32_t &UserID, uint32_t &IMOnumber, char *Callsign, size_t CallsignBufSize, char *Name, size_t NameBufSize, uint8_t &VesselType, double &Length, double &Beam, double &PosRefStbd, double &PosRefBow, uint16_t &ETAdate, double &ETAtime, double &Draught, char *Destination, size_t DestinationBufSize, tN2kAISVersion &AISversion, tN2kGNSStype &GNSStype, tN2kAISDTE &DTE, tN2kAISTransceiverInformation &AISinfo)
 Parsing the content of message PGN 129794 "AIS static data class A". More...
 
bool ParseN2kPGN129802 (const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat &Repeat, uint32_t &SourceID, tN2kAISTransceiverInformation &AISTransceiverInformation, char *SafetyRelatedText, size_t &SafetyRelatedTextMaxSize)
 Parsing the Content of a PGN129802 Message - "AIS Safety Related Broadcast Message". More...
 
bool ParseN2kPGN129809 (const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat &Repeat, uint32_t &UserID, char *Name, size_t NameBufSize)
 Parsing the content of message PGN 129809 "AIS static data class B part A". More...
 
bool ParseN2kPGN129810 (const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat &Repeat, uint32_t &UserID, uint8_t &VesselType, const char *Vendor, size_t VendorBufSize, const char *Callsign, size_t CallsignBufSize, double &Length, double &Beam, double &PosRefStbd, double &PosRefBow, uint32_t &MothershipID)
 Parsing the content of message PGN 129810 "AIS static data class B part B". More...
 
bool ParseN2kPGN130306 (const tN2kMsg &N2kMsg, unsigned char &SID, double &WindSpeed, double &WindAngle, tN2kWindReference &WindReference)
 Parsing the content of message PGN 130306 "Wind Data". More...
 
bool ParseN2kPGN130310 (const tN2kMsg &N2kMsg, unsigned char &SID, double &WaterTemperature, double &OutsideAmbientAirTemperature, double &AtmosphericPressure)
 Parsing the content of message PGN 130310 "Environmental Parameters - DEPRECATED". More...
 
bool ParseN2kPGN130311 (const tN2kMsg &N2kMsg, unsigned char &SID, tN2kTempSource &TempSource, double &Temperature, tN2kHumiditySource &HumiditySource, double &Humidity, double &AtmosphericPressure)
 Parsing the content of message PGN 130311 "Environmental Parameters - DEPRECATED". More...
 
bool ParseN2kPGN130312 (const tN2kMsg &N2kMsg, unsigned char &SID, unsigned char &TempInstance, tN2kTempSource &TempSource, double &ActualTemperature, double &SetTemperature)
 Parsing the content of message PGN 130312 "Temperature - DEPRECATED". More...
 
bool ParseN2kPGN130313 (const tN2kMsg &N2kMsg, unsigned char &SID, unsigned char &HumidityInstance, tN2kHumiditySource &HumiditySource, double &ActualHumidity)
 Parsing the content of a "Humidity" message - PGN 130313. More...
 
bool ParseN2kPGN130313 (const tN2kMsg &N2kMsg, unsigned char &SID, unsigned char &HumidityInstance, tN2kHumiditySource &HumiditySource, double &ActualHumidity, double &SetHumidity)
 Parsing the content of message PGN 130313 "Humidity". More...
 
bool ParseN2kPGN130314 (const tN2kMsg &N2kMsg, unsigned char &SID, unsigned char &PressureInstance, tN2kPressureSource &PressureSource, double &Pressure)
 Parsing the content of message PGN 130314 "Actual Pressure". More...
 
bool ParseN2kPGN130316 (const tN2kMsg &N2kMsg, unsigned char &SID, unsigned char &TempInstance, tN2kTempSource &TempSource, double &ActualTemperature, double &SetTemperature)
 Parsing the content of message PGN 130316 "Temperature, Extended Range". More...
 
bool ParseN2kPGN130323 (const tN2kMsg &N2kMsg, tN2kMeteorlogicalStationData &N2kData)
 Parsing the content of message PGN 130323 "Meterological Station Data". More...
 
bool ParseN2kPGN130576 (const tN2kMsg &N2kMsg, int8_t &PortTrimTab, int8_t &StbdTrimTab)
 Parsing the content of message PGN 130576 "Trim Tab Status". More...
 
bool ParseN2kPGN130577 (const tN2kMsg &N2kMsg, tN2kDataMode &DataMode, tN2kHeadingReference &CogReference, unsigned char &SID, double &COG, double &SOG, double &Heading, double &SpeedThroughWater, double &Set, double &Drift)
 Parsing the content of message PGN 130577 "Direction Data". More...
 
bool ParseN2kPGNSatellitesInView (const tN2kMsg &N2kMsg, uint8_t SVIndex, tSatelliteInfo &SatelliteInfo)
 Parsing the content of a "GNSS Satellites in View" message - PGN 129540. More...
 
bool ParseN2kPGNSatellitesInView (const tN2kMsg &N2kMsg, unsigned char &SID, tN2kRangeResidualMode &Mode, uint8_t &NumberOfSVs)
 Parsing the content of a "GNSS Satellites in View" message - PGN 129540. More...
 
bool ParseN2kPositionRapid (const tN2kMsg &N2kMsg, double &Latitude, double &Longitude)
 Parsing the content of a "Position, Rapid Update" message - PGN 129025. More...
 
bool ParseN2kPressure (const tN2kMsg &N2kMsg, unsigned char &SID, unsigned char &PressureInstance, tN2kPressureSource &PressureSource, double &Pressure)
 Parsing the content of a "Actual Pressure" message - PGN 130314. More...
 
bool ParseN2kRateOfTurn (const tN2kMsg &N2kMsg, unsigned char &SID, double &RateOfTurn)
 Parsing the content of a "Rate of Turn" message - PGN 127251. More...
 
bool ParseN2kRudder (const tN2kMsg &N2kMsg, double &RudderPosition)
 Parsing the content of a "Rudder" message - PGN 127245. More...
 
bool ParseN2kRudder (const tN2kMsg &N2kMsg, double &RudderPosition, unsigned char &Instance, tN2kRudderDirectionOrder &RudderDirectionOrder, double &AngleOrder)
 Parsing the content of a "Rudder" message - PGN 127245. More...
 
bool ParseN2kSystemTime (const tN2kMsg &N2kMsg, unsigned char &SID, uint16_t &SystemDate, double &SystemTime, tN2kTimeSource &TimeSource)
 Parsing the content of a "System date/time" message - PGN 126992. More...
 
bool ParseN2kTemperature (const tN2kMsg &N2kMsg, unsigned char &SID, unsigned char &TempInstance, tN2kTempSource &TempSource, double &ActualTemperature, double &SetTemperature)
 Parsing the content of a "Temperature - DEPRECATED" message - PGN 130312. More...
 
bool ParseN2kTemperatureExt (const tN2kMsg &N2kMsg, unsigned char &SID, unsigned char &TempInstance, tN2kTempSource &TempSource, double &ActualTemperature, double &SetTemperature)
 Parsing the content of a "Temperature, Extended Range" message - PGN 130316. More...
 
bool ParseN2kTransmissionParameters (const tN2kMsg &N2kMsg, unsigned char &EngineInstance, tN2kTransmissionGear &TransmissionGear, double &OilPressure, double &OilTemperature, bool &flagCheck, bool &flagOverTemp, bool &flagLowOilPressure, bool &flagLowOilLevel, bool &flagSailDrive)
 Parsing the content of a "Transmission parameters, dynamic" message - PGN 127493. More...
 
bool ParseN2kTransmissionParameters (const tN2kMsg &N2kMsg, unsigned char &EngineInstance, tN2kTransmissionGear &TransmissionGear, double &OilPressure, double &OilTemperature, unsigned char &DiscreteStatus1)
 Parsing the content of a "Transmission parameters, dynamic" message - PGN 127493. More...
 
bool ParseN2kTrimTab (const tN2kMsg &N2kMsg, int8_t &PortTrimTab, int8_t &StbdTrimTab)
 Parsing the content of a "Trim Tab Status" message - PGN 130576. More...
 
bool ParseN2kWaterDepth (const tN2kMsg &N2kMsg, unsigned char &SID, double &DepthBelowTransducer, double &Offset)
 Parsing the content of a "Water depth" message - PGN 128267. More...
 
bool ParseN2kWaterDepth (const tN2kMsg &N2kMsg, unsigned char &SID, double &DepthBelowTransducer, double &Offset, double &Range)
 Parsing the content of a "Water depth" message - PGN 128267. More...
 
bool ParseN2kWindSpeed (const tN2kMsg &N2kMsg, unsigned char &SID, double &WindSpeed, double &WindAngle, tN2kWindReference &WindReference)
 Parsing the content of a "Wind Data" message - PGN 130306. More...
 
bool ParseN2kXTE (const tN2kMsg &N2kMsg, unsigned char &SID, tN2kXTEMode &XTEMode, bool &NavigationTerminated, double &XTE)
 Parsing the content of a "Cross Track Error" message - PGN 129283. More...
 

Detailed Description

List of functions which parse the data content of tN2kMsg objects.

This is a collection of functions for handling NMEA2000 bus messages.

Each SetN2kPNGxxx function has a corresponding ParsN2kPGNxxx function which can extract the data out of an incoming N2k Message. These functions have as well an inline alias easy for humans to read like ParseN2kPositionRapid.

See also
n2kMessages.h

Function Documentation

◆ ParseN2kAISAtoNReport()

bool ParseN2kAISAtoNReport ( const tN2kMsg N2kMsg,
tN2kAISAtoNReportData N2kData 
)
inline

Parsing the content of a "AIS Aids to Navigation (AtoN) Report" message - PGN 129041.

Alias of PGN 129041. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN129041

Definition at line 3775 of file N2kMessages.h.

◆ ParseN2kAISClassAPosition()

bool ParseN2kAISClassAPosition ( const tN2kMsg N2kMsg,
uint8_t &  MessageID,
tN2kAISRepeat Repeat,
uint32_t &  UserID,
double &  Latitude,
double &  Longitude,
bool &  Accuracy,
bool &  RAIM,
uint8_t &  Seconds,
double &  COG,
double &  SOG,
double &  Heading,
double &  ROT,
tN2kAISNavStatus NavStatus 
)
inline

Parsing the content of a "AIS position reports for Class A" message - PGN 129038.

Alias of PGN 129038. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN129038

Definition at line 3333 of file N2kMessages.h.

◆ ParseN2kAISClassAStatic()

bool ParseN2kAISClassAStatic ( const tN2kMsg N2kMsg,
uint8_t &  MessageID,
tN2kAISRepeat Repeat,
uint32_t &  UserID,
uint32_t &  IMOnumber,
char *  Callsign,
size_t  CallsignBufSize,
char *  Name,
size_t  NameBufSize,
uint8_t &  VesselType,
double &  Length,
double &  Beam,
double &  PosRefStbd,
double &  PosRefBow,
uint16_t &  ETAdate,
double &  ETAtime,
double &  Draught,
char *  Destination,
size_t  DestinationBufSize,
tN2kAISVersion AISversion,
tN2kGNSStype GNSStype,
tN2kAISDTE DTE,
tN2kAISTransceiverInformation AISinfo 
)
inline

Parsing the content of a "AIS static data class A" message - PGN 129794.

Alias of PGN 129794. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN129794

Definition at line 4414 of file N2kMessages.h.

◆ ParseN2kAISClassBPosition() [1/2]

bool ParseN2kAISClassBPosition ( const tN2kMsg N2kMsg,
uint8_t &  MessageID,
tN2kAISRepeat Repeat,
uint32_t &  UserID,
double &  Latitude,
double &  Longitude,
bool &  Accuracy,
bool &  RAIM,
uint8_t &  Seconds,
double &  COG,
double &  SOG,
double &  Heading,
tN2kAISUnit Unit,
bool &  Display,
bool &  DSC,
bool &  Band,
bool &  Msg22,
tN2kAISMode Mode,
bool &  State 
)
inline

Parsing the content of a "AIS position reports for Class B" message - PGN 129039.

Note
Previous inline version for backwards compatibility, using temporary value to parse unused parameter

Alias of PGN 129039. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN129039

Definition at line 3558 of file N2kMessages.h.

◆ ParseN2kAISClassBPosition() [2/2]

bool ParseN2kAISClassBPosition ( const tN2kMsg N2kMsg,
uint8_t &  MessageID,
tN2kAISRepeat Repeat,
uint32_t &  UserID,
double &  Latitude,
double &  Longitude,
bool &  Accuracy,
bool &  RAIM,
uint8_t &  Seconds,
double &  COG,
double &  SOG,
tN2kAISTransceiverInformation AISTransceiverInformation,
double &  Heading,
tN2kAISUnit Unit,
bool &  Display,
bool &  DSC,
bool &  Band,
bool &  Msg22,
tN2kAISMode Mode,
bool &  State 
)
inline

Parsing the content of a "AIS position reports for Class B" message - PGN 129039.

(Latest inline version)

Alias of PGN 129039. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN129039

Definition at line 3539 of file N2kMessages.h.

◆ ParseN2kAISClassBStaticPartA()

bool ParseN2kAISClassBStaticPartA ( const tN2kMsg N2kMsg,
uint8_t &  MessageID,
tN2kAISRepeat Repeat,
uint32_t &  UserID,
char *  Name,
size_t  NameBufSize 
)
inline

Parsing the content of a "AIS static data class B part A" message - PGN 129809.

Alias of PGN 129809. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN129809

Definition at line 4501 of file N2kMessages.h.

◆ ParseN2kAISClassBStaticPartB()

bool ParseN2kAISClassBStaticPartB ( const tN2kMsg N2kMsg,
uint8_t &  MessageID,
tN2kAISRepeat Repeat,
uint32_t &  UserID,
uint8_t &  VesselType,
char *  Vendor,
size_t  VendorBufSize,
char *  Callsign,
size_t  CallsignBufSize,
double &  Length,
double &  Beam,
double &  PosRefStbd,
double &  PosRefBow,
uint32_t &  MothershipID 
)
inline

Parsing the content of a "AIS static data class B part B" message - PGN 129810.

Alias of PGN 129810. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN129810

Definition at line 4610 of file N2kMessages.h.

◆ ParseN2kAISSafetyRelatedBroadcastMsg()

bool ParseN2kAISSafetyRelatedBroadcastMsg ( const tN2kMsg N2kMsg,
uint8_t &  MessageID,
tN2kAISRepeat Repeat,
uint32_t &  SourceID,
tN2kAISTransceiverInformation AISTransceiverInformation,
char *  SafetyRelatedText,
size_t &  SafetyRelatedTextMaxSize 
)
inline

Parsing the content of a "AIS Safety Related Broadcast Message" message - PGN 129802.

Alias of PGN 129802. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN129802

Definition at line 318 of file N2kMessages.h.

◆ ParseN2kAttitude()

bool ParseN2kAttitude ( const tN2kMsg N2kMsg,
unsigned char &  SID,
double &  Yaw,
double &  Pitch,
double &  Roll 
)
inline

Parsing the content of a "Attitude" message - PGN 127257.

Alias of PGN 127257. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN127257

Definition at line 990 of file N2kMessages.h.

◆ ParseN2kBatConf()

bool ParseN2kBatConf ( const tN2kMsg N2kMsg,
unsigned char &  BatInstance,
tN2kBatType BatType,
tN2kBatEqSupport SupportsEqual,
tN2kBatNomVolt BatNominalVoltage,
tN2kBatChem BatChemistry,
double &  BatCapacity,
int8_t &  BatTemperatureCoefficient,
double &  PeukertExponent,
int8_t &  ChargeEfficiencyFactor 
)
inline

Parsing the content of a "Battery Configuration Status" message - PGN 127513.

Alias of PGN 127513. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN127513

Definition at line 2232 of file N2kMessages.h.

◆ ParseN2kBinaryStatus() [1/2]

bool ParseN2kBinaryStatus ( const tN2kMsg N2kMsg,
unsigned char &  DeviceBankInstance,
tN2kBinaryStatus BankStatus 
)
inline

Parsing the content of a "Universal Binary Status Report" message - PGN 127501.

Alias of PGN 127501. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN127501

Definition at line 1782 of file N2kMessages.h.

◆ ParseN2kBinaryStatus() [2/2]

bool ParseN2kBinaryStatus ( const tN2kMsg N2kMsg,
unsigned char &  DeviceBankInstance,
tN2kOnOff Status1,
tN2kOnOff Status2,
tN2kOnOff Status3,
tN2kOnOff Status4 
)
inline

Parsing the content of a "Universal Binary Status Report" message - PGN 127501.

Alias of PGN 127501. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN127501

Definition at line 1741 of file N2kMessages.h.

◆ ParseN2kBoatSpeed()

bool ParseN2kBoatSpeed ( const tN2kMsg N2kMsg,
unsigned char &  SID,
double &  WaterReferenced,
double &  GroundReferenced,
tN2kSpeedWaterReferenceType SWRT 
)
inline

Parsing the content of a "Boat Speed, Water Referenced" message - PGN 128259.

Alias of PGN 128259. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN128259

Definition at line 2399 of file N2kMessages.h.

◆ ParseN2kChargerStatus()

bool ParseN2kChargerStatus ( const tN2kMsg N2kMsg,
unsigned char &  Instance,
unsigned char &  BatteryInstance,
tN2kChargeState ChargeState,
tN2kChargerMode ChargerMode,
tN2kOnOff Enabled,
tN2kOnOff EqualizationPending,
double &  EqualizationTimeRemaining 
)
inline

Parsing the content of a "DC Charger Status" message - PGN 127507.

Alias of PGN 127507. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN127507

Definition at line 2079 of file N2kMessages.h.

◆ ParseN2kDCBatStatus()

bool ParseN2kDCBatStatus ( const tN2kMsg N2kMsg,
unsigned char &  BatteryInstance,
double &  BatteryVoltage,
double &  BatteryCurrent,
double &  BatteryTemperature,
unsigned char &  SID 
)
inline

Parsing the content of a "Battery Status" message - PGN 127508.

Alias of PGN 127508. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN127508

Definition at line 2154 of file N2kMessages.h.

◆ ParseN2kDCStatus()

bool ParseN2kDCStatus ( const tN2kMsg N2kMsg,
unsigned char &  SID,
unsigned char &  DCInstance,
tN2kDCType DCType,
unsigned char &  StateOfCharge,
unsigned char &  StateOfHealth,
double &  TimeRemaining,
double &  RippleVoltage,
double &  Capacity 
)
inline

Parsing the content of a "DC Detailed Status" message - PGN 127506.

Alias of PGN 127506. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN127506

Definition at line 2006 of file N2kMessages.h.

◆ ParseN2kDirectionData()

bool ParseN2kDirectionData ( const tN2kMsg N2kMsg,
tN2kDataMode DataMode,
tN2kHeadingReference CogReference,
unsigned char &  SID,
double &  COG,
double &  SOG,
double &  Heading,
double &  SpeedThroughWater,
double &  Set,
double &  Drift 
)
inline

Parsing the content of a "Direction Data" message - PGN 130577.

Alias of PGN 130577. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN130577

Definition at line 5553 of file N2kMessages.h.

◆ ParseN2kDistanceLog()

bool ParseN2kDistanceLog ( const tN2kMsg N2kMsg,
uint16_t &  DaysSince1970,
double &  SecondsSinceMidnight,
uint32_t &  Log,
uint32_t &  TripLog 
)
inline

Parsing the content of a "Distance log" message - PGN 128275.

Alias of PGN 128275. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN128275

Definition at line 2548 of file N2kMessages.h.

◆ ParseN2kEngineDynamicParam() [1/3]

bool ParseN2kEngineDynamicParam ( const tN2kMsg N2kMsg,
unsigned char &  EngineInstance,
double &  EngineOilPress,
double &  EngineOilTemp,
double &  EngineCoolantTemp,
double &  AltenatorVoltage,
double &  FuelRate,
double &  EngineHours 
)
inline

Parsing the content of a "Engine parameters dynamic" message - PGN 127489.

Alias of PGN 127489. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN127489

Definition at line 1389 of file N2kMessages.h.

◆ ParseN2kEngineDynamicParam() [2/3]

bool ParseN2kEngineDynamicParam ( const tN2kMsg N2kMsg,
unsigned char &  EngineInstance,
double &  EngineOilPress,
double &  EngineOilTemp,
double &  EngineCoolantTemp,
double &  AltenatorVoltage,
double &  FuelRate,
double &  EngineHours,
double &  EngineCoolantPress,
double &  EngineFuelPress,
int8_t &  EngineLoad,
int8_t &  EngineTorque 
)
inline

Parsing the content of a "Engine parameters dynamic" message - PGN 127489.

Alias of PGN 127489. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN127489

Definition at line 1351 of file N2kMessages.h.

◆ ParseN2kEngineDynamicParam() [3/3]

bool ParseN2kEngineDynamicParam ( const tN2kMsg N2kMsg,
unsigned char &  EngineInstance,
double &  EngineOilPress,
double &  EngineOilTemp,
double &  EngineCoolantTemp,
double &  AltenatorVoltage,
double &  FuelRate,
double &  EngineHours,
double &  EngineCoolantPress,
double &  EngineFuelPress,
int8_t &  EngineLoad,
int8_t &  EngineTorque,
tN2kEngineDiscreteStatus1 Status1,
tN2kEngineDiscreteStatus2 Status2 
)
inline

Parsing the content of a "Engine parameters dynamic" message - PGN 127489.

Alias of PGN 127489. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN127489

Definition at line 1369 of file N2kMessages.h.

◆ ParseN2kEngineParamRapid()

bool ParseN2kEngineParamRapid ( const tN2kMsg N2kMsg,
unsigned char &  EngineInstance,
double &  EngineSpeed,
double &  EngineBoostPressure,
int8_t &  EngineTiltTrim 
)
inline

Parsing the content of a "Engine parameters rapid" message - PGN 127488.

Alias of PGN 127488. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN127488

Definition at line 1120 of file N2kMessages.h.

◆ ParseN2kEngineTripParameters()

bool ParseN2kEngineTripParameters ( const tN2kMsg N2kMsg,
unsigned char &  EngineInstance,
double &  TripFuelUsed,
double &  FuelRateAverage,
double &  FuelRateEconomy,
double &  InstantaneousFuelEconomy 
)
inline

Parsing the content of a "Trip Parameters, Engine" message - PGN 127497.

Alias of PGN 127497. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN127497

Definition at line 1577 of file N2kMessages.h.

◆ ParseN2kEnvironmentalParameters()

bool ParseN2kEnvironmentalParameters ( const tN2kMsg N2kMsg,
unsigned char &  SID,
tN2kTempSource TempSource,
double &  Temperature,
tN2kHumiditySource HumiditySource,
double &  Humidity,
double &  AtmosphericPressure 
)
inline

Parsing the content of a "Environmental Parameters - DEPRECATED" message - PGN 130311.

Alias of PGN 130311. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN130311

Definition at line 4920 of file N2kMessages.h.

◆ ParseN2kFluidLevel()

bool ParseN2kFluidLevel ( const tN2kMsg N2kMsg,
unsigned char &  Instance,
tN2kFluidType FluidType,
double &  Level,
double &  Capacity 
)
inline

Parsing the content of a "Fluid level" message - PGN 127505.

Alias of PGN 127505. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN127505

Definition at line 1929 of file N2kMessages.h.

◆ ParseN2kGNSS()

bool ParseN2kGNSS ( const tN2kMsg N2kMsg,
unsigned char &  SID,
uint16_t &  DaysSince1970,
double &  SecondsSinceMidnight,
double &  Latitude,
double &  Longitude,
double &  Altitude,
tN2kGNSStype GNSStype,
tN2kGNSSmethod GNSSmethod,
unsigned char &  nSatellites,
double &  HDOP,
double &  PDOP,
double &  GeoidalSeparation,
unsigned char &  nReferenceStations,
tN2kGNSStype ReferenceStationType,
uint16_t &  ReferenceSationID,
double &  AgeOfCorrection 
)
inline

Parsing the content of a "GNSS Position Data" message - PGN 129029.

Alias of PGN 129029. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN129029

Definition at line 3130 of file N2kMessages.h.

◆ ParseN2kGNSSDOPData()

bool ParseN2kGNSSDOPData ( const tN2kMsg N2kMsg,
unsigned char &  SID,
tN2kGNSSDOPmode DesiredMode,
tN2kGNSSDOPmode ActualMode,
double &  HDOP,
double &  VDOP,
double &  TDOP 
)
inline

Parsing the content of a "GNSS DOP data" message - PGN 129539.

Alias of PGN 129539. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPgn129539

Definition at line 4115 of file N2kMessages.h.

◆ ParseN2kHeading()

bool ParseN2kHeading ( const tN2kMsg N2kMsg,
unsigned char &  SID,
double &  Heading,
double &  Deviation,
double &  Variation,
tN2kHeadingReference ref 
)
inline

Parsing the content of a "Vessel Heading" message - PGN 127250.

Alias of PGN 127250. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN127250

Definition at line 791 of file N2kMessages.h.

◆ ParseN2kHeadingTrackControl()

bool ParseN2kHeadingTrackControl ( const tN2kMsg N2kMsg,
tN2kOnOff RudderLimitExceeded,
tN2kOnOff OffHeadingLimitExceeded,
tN2kOnOff OffTrackLimitExceeded,
tN2kOnOff Override,
tN2kSteeringMode SteeringMode,
tN2kTurnMode TurnMode,
tN2kHeadingReference HeadingReference,
tN2kRudderDirectionOrder CommandedRudderDirection,
double &  CommandedRudderAngle,
double &  HeadingToSteerCourse,
double &  Track,
double &  RudderLimit,
double &  OffHeadingLimit,
double &  RadiusOfTurnOrder,
double &  RateOfTurnOrder,
double &  OffTrackLimit,
double &  VesselHeading 
)
inline

Parsing the content of a "Heading/Track control" message - PGN 127237.

Alias of PGN 127237. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN127237

Definition at line 607 of file N2kMessages.h.

◆ ParseN2kHeave() [1/2]

bool ParseN2kHeave ( const tN2kMsg N2kMsg,
unsigned char &  SID,
double &  Heave 
)
inline

Parsing the content of a "Heave" message - PGN 127252.

Alias of PGN 127252. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN127252

Definition at line 911 of file N2kMessages.h.

◆ ParseN2kHeave() [2/2]

bool ParseN2kHeave ( const tN2kMsg N2kMsg,
unsigned char &  SID,
double &  Heave,
double &  Delay,
tN2kDelaySource DelaySource 
)
inline

Parsing the content of a "Heave" message - PGN 127252.

Alias of PGN 127252. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN127252

Definition at line 924 of file N2kMessages.h.

◆ ParseN2kHumidity() [1/2]

bool ParseN2kHumidity ( const tN2kMsg N2kMsg,
unsigned char &  SID,
unsigned char &  HumidityInstance,
tN2kHumiditySource HumiditySource,
double &  ActualHumidity 
)
inline

Parsing the content of a "Humidity" message - PGN 130313.

Alias of PGN 130313. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN130313

Definition at line 5101 of file N2kMessages.h.

◆ ParseN2kHumidity() [2/2]

bool ParseN2kHumidity ( const tN2kMsg N2kMsg,
unsigned char &  SID,
unsigned char &  HumidityInstance,
tN2kHumiditySource HumiditySource,
double &  ActualHumidity,
double &  SetHumidity 
)
inline

Parsing the content of a "Humidity" message - PGN 130313.

Alias of PGN 130313. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN130313

Definition at line 5074 of file N2kMessages.h.

◆ ParseN2kLeeway()

bool ParseN2kLeeway ( const tN2kMsg N2kMsg,
unsigned char &  SID,
double &  Leeway 
)
inline

Parsing the content of a "Nautical Leeway Angle" message - PGN 128000.

Alias of PGN 128000. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN128000

Definition at line 2333 of file N2kMessages.h.

◆ ParseN2kLocalOffset()

bool ParseN2kLocalOffset ( const tN2kMsg N2kMsg,
uint16_t &  DaysSince1970,
double &  SecondsSinceMidnight,
int16_t &  LocalOffset 
)
inline

Parsing the content of a "Date,Time & Local offset" message - PGN 129033.

Alias of PGN 129033. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN129033

Definition at line 3208 of file N2kMessages.h.

◆ ParseN2kMagneticVariation()

bool ParseN2kMagneticVariation ( const tN2kMsg N2kMsg,
unsigned char &  SID,
tN2kMagneticVariation Source,
uint16_t &  DaysSince1970,
double &  Variation 
)
inline

Parsing the content of a "Magnetic Variation" message - PGN 127258.

Alias of PGN 127258. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN127258

Definition at line 1058 of file N2kMessages.h.

◆ ParseN2kMeteorlogicalStationData()

bool ParseN2kMeteorlogicalStationData ( const tN2kMsg N2kMsg,
tN2kMeteorlogicalStationData N2kData 
)
inline

Parsing the content of a "Meterological Station Data" message - PGN 130323.

Alias of PGN 130323. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN130323

Definition at line 5418 of file N2kMessages.h.

◆ ParseN2kMOBNotification()

bool ParseN2kMOBNotification ( const tN2kMsg N2kMsg,
unsigned char &  SID,
uint32_t &  MobEmitterId,
tN2kMOBStatus MOBStatus,
double &  ActivationTime,
tN2kMOBPositionSource PositionSource,
uint16_t &  PositionDate,
double &  PositionTime,
double &  Latitude,
double &  Longitude,
tN2kHeadingReference COGReference,
double &  COG,
double &  SOG,
uint32_t &  MMSI,
tN2kMOBEmitterBatteryStatus MOBEmitterBatteryStatus 
)
inline

Parsing the content of a "Man Overboard Notification" message - PGN 127233.

Alias of PGN 127233. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN127233

Definition at line 452 of file N2kMessages.h.

◆ ParseN2kNavigationInfo()

bool ParseN2kNavigationInfo ( const tN2kMsg N2kMsg,
unsigned char &  SID,
double &  DistanceToWaypoint,
tN2kHeadingReference BearingReference,
bool &  PerpendicularCrossed,
bool &  ArrivalCircleEntered,
tN2kDistanceCalculationType CalculationType,
double &  ETATime,
int16_t &  ETADate,
double &  BearingOriginToDestinationWaypoint,
double &  BearingPositionToDestinationWaypoint,
uint32_t &  OriginWaypointNumber,
uint32_t &  DestinationWaypointNumber,
double &  DestinationLatitude,
double &  DestinationLongitude,
double &  WaypointClosingVelocity 
)
inline

Parsing the content of a "Navigation Data" message - PGN 129284.

Alias of PGN 129284. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN129284

Definition at line 3952 of file N2kMessages.h.

◆ ParseN2kOutsideEnvironmentalParameters()

bool ParseN2kOutsideEnvironmentalParameters ( const tN2kMsg N2kMsg,
unsigned char &  SID,
double &  WaterTemperature,
double &  OutsideAmbientAirTemperature,
double &  AtmosphericPressure 
)
inline

Parsing the content of a "Environmental Parameters - DEPRECATED" message - PGN 130310.

Alias of PGN 130310. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN130310

Definition at line 4833 of file N2kMessages.h.

◆ ParseN2kPGN126992()

bool ParseN2kPGN126992 ( const tN2kMsg N2kMsg,
unsigned char &  SID,
uint16_t &  SystemDate,
double &  SystemTime,
tN2kTimeSource TimeSource 
)

Parsing the Content of a PGN126992 Message - "System date/time".

The PGN126992 purpose is twofold: To provide a regular transmission of UTC time and date. To provide synchronism for measurement data.

Parameters
N2kMsgN2kMsg Object, Output: NMEA2000 message ready to be send.
SIDSequence ID. Normally you can just forget its value. See SID.
SystemDateSystemdate in days since 1970-01-01 (UTC)
SystemTimeSystem time seconds since midnight (UTC)
TimeSourceSource of the Systemtime
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 39 of file N2kMessages.cpp.

◆ ParseN2kPGN127233()

bool ParseN2kPGN127233 ( const tN2kMsg N2kMsg,
unsigned char &  SID,
uint32_t &  MobEmitterId,
tN2kMOBStatus MOBStatus,
double &  ActivationTime,
tN2kMOBPositionSource PositionSource,
uint16_t &  PositionDate,
double &  PositionTime,
double &  Latitude,
double &  Longitude,
tN2kHeadingReference COGReference,
double &  COG,
double &  SOG,
uint32_t &  MMSI,
tN2kMOBEmitterBatteryStatus MOBEmitterBatteryStatus 
)

Parsing the Content of Message PGN127233 "Man Overboard Notification".

The MOB PGN is intended to provide notification from a MOB monitoring system. The included position information may be that of the vessel or the MOB device itself as identified in field “X”, position source. Additional information may include the current state of the MOB device, time of activation, and MOB device battery status.

Parameters
N2kMsgReference to a N2kMsg Object,
SIDSequence ID. Normally you can just forget its value. See SID.
MobEmitterIdIdentifier for each MOB emitter, unique to the vessel
MOBStatusMOB Status
ActivationTimeTime of day (UTC) when MOB was activated
PositionSourcePosition Source
PositionDateDate of MOB position
PositionTimeTime of day of MOB position (UTC)
LatitudeLatitude in degrees
LongitudeLongitude in degrees
COGReferenceTrue or Magnetic
COGCourse Over Ground in radians
SOGSpeed Over Ground in m/s
MMSIMMSI
MOBEmitterBatteryStatusBattery status
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 121 of file N2kMessages.cpp.

◆ ParseN2kPGN127237()

bool ParseN2kPGN127237 ( const tN2kMsg N2kMsg,
tN2kOnOff RudderLimitExceeded,
tN2kOnOff OffHeadingLimitExceeded,
tN2kOnOff OffTrackLimitExceeded,
tN2kOnOff Override,
tN2kSteeringMode SteeringMode,
tN2kTurnMode TurnMode,
tN2kHeadingReference HeadingReference,
tN2kRudderDirectionOrder CommandedRudderDirection,
double &  CommandedRudderAngle,
double &  HeadingToSteerCourse,
double &  Track,
double &  RudderLimit,
double &  OffHeadingLimit,
double &  RadiusOfTurnOrder,
double &  RateOfTurnOrder,
double &  OffTrackLimit,
double &  VesselHeading 
)

Parsing the Content of Message PGN127237 "Heading/Track control".

Sends commands to, and receives data from, heading control systems. Allows for navigational (remote) control of a heading control system and direct rudder control.

Parameters
N2kMsgReference to a N2kMsg Object,
RudderLimitExceededYes/No
OffHeadingLimitExceededYes/No
OffTrackLimitExceededYes/No
OverrideYes/No
SteeringModeSteering mode
TurnModeTurn mode
HeadingReferenceTrue or Magnetic
CommandedRudderDirectionPort or Starboard
CommandedRudderAngleIn radians
HeadingToSteerCourseIn radians
TrackIn radians
RudderLimitIn radians
OffHeadingLimitIn radians
RadiusOfTurnOrderIn meter
RateOfTurnOrderIn radians/s
OffTrackLimitIn meters
VesselHeadingin radians
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 207 of file N2kMessages.cpp.

◆ ParseN2kPGN127245()

bool ParseN2kPGN127245 ( const tN2kMsg N2kMsg,
double &  RudderPosition,
unsigned char &  Instance,
tN2kRudderDirectionOrder RudderDirectionOrder,
double &  AngleOrder 
)

Parsing the content of Message PGN127245 "Rudder".

Rudder order command in direction or angle with current rudder angle reading.

Parameters
N2kMsgReference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
RudderPositionCurrent rudder postion in radians.
InstanceRudder instance.
RudderDirectionOrderDirection, where rudder should be turned.
AngleOrderIn radians angle where rudder should be turned.
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted
See also
tN2kRudderDirectionOrder

Definition at line 266 of file N2kMessages.cpp.

◆ ParseN2kPGN127250()

bool ParseN2kPGN127250 ( const tN2kMsg N2kMsg,
unsigned char &  SID,
double &  Heading,
double &  Deviation,
double &  Variation,
tN2kHeadingReference ref 
)

Parsing Content of Message PGN 127250 "Vessel Heading".

Heading sensor value with a flag for True or Magnetic. If the sensor value is Magnetic, the deviation field can be used to produce a Magnetic heading, and the variation field can be used to correct the Magnetic heading to produce a True heading.

Parameters
N2kMsgReference to a N2kMsg Object,
SIDSequence ID. Normally you can just forget its value. See SID.
HeadingHeading in radians
DeviationMagnetic deviation in radians. Use N2kDoubleNA for undefined value.
VariationHeading reference. See definition of tN2kHeadingReference.
refHeading reference. See definition of tN2kHeadingReference.
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 291 of file N2kMessages.cpp.

◆ ParseN2kPGN127251()

bool ParseN2kPGN127251 ( const tN2kMsg N2kMsg,
unsigned char &  SID,
double &  RateOfTurn 
)

Parsing the content of Message PGN127251 "Rate of Turn".

Rate of Turn is the rate of change of the Heading.

Parameters
N2kMsgReference to a N2kMsg Object,
SIDSequence ID. Normally you can just forget its value. See SID.
RateOfTurnChange in heading in radians per second
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 317 of file N2kMessages.cpp.

◆ ParseN2kPGN127252()

bool ParseN2kPGN127252 ( const tN2kMsg N2kMsg,
unsigned char &  SID,
double &  Heave,
double &  Delay,
tN2kDelaySource DelaySource 
)

Parsing the content of Message PGN127252 "Heave".

Vertical displacement perpendicular to (smooth, wave-free water on) the earth’s surface.

Parameters
N2kMsgReference to a N2kMsg Object,
SIDSequence ID. Normally you can just forget its value. See SID.
HeaveVertical displacement perpendicular to the earth’s surface in meters
DelayDelay added by calculations in seconds
DelaySourceDelay Source, see tN2kDelaySource
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 349 of file N2kMessages.cpp.

◆ ParseN2kPGN127257()

bool ParseN2kPGN127257 ( const tN2kMsg N2kMsg,
unsigned char &  SID,
double &  Yaw,
double &  Pitch,
double &  Roll 
)

Parsing the content of Message PGN 127257 "Attitude".

This parameter group provides a single transmission that describes the position of a vessel relative to both horizontal and vertical planes. This would typically be used for vessel stabilization, vessel control and onboard platform stabilization.

Parameters
N2kMsgReference to a N2kMsg Object,
SIDSequence ID. Normally you can just forget its value. See SID.
YawHeading in radians.
PitchPitch in radians. Positive, when your bow rises.
RollRoll in radians. Positive, when tilted right.
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 380 of file N2kMessages.cpp.

◆ ParseN2kPGN127258()

bool ParseN2kPGN127258 ( const tN2kMsg N2kMsg,
unsigned char &  SID,
tN2kMagneticVariation Source,
uint16_t &  DaysSince1970,
double &  Variation 
)

Parsing the content of Message PGN 127258 "Magnetic Variation".

Message for transmitting variation. The message contains a sequence number to allow synchronization of other messages such as Heading or Course over Ground. The quality of service and age of service are provided to enable recipients to determine an appropriate level of service if multiple transmissions exist.

Parameters
N2kMsgReference to a N2kMsg Object,
SIDSequence ID. Normally you can just forget its value. See SID.
SourceHow was the variation value generated
DaysSince1970Days since January 1, 1970
VariationMagnetic variation/declination in radians
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 404 of file N2kMessages.cpp.

◆ ParseN2kPGN127488()

bool ParseN2kPGN127488 ( const tN2kMsg N2kMsg,
unsigned char &  EngineInstance,
double &  EngineSpeed,
double &  EngineBoostPressure,
int8_t &  EngineTiltTrim 
)

Parsing the content of Message PGN 127488 "Engine parameters rapid".

Provides data with a high update rate for a specific engine in a single frame message. The first field provides information as to which engine.

Parameters
N2kMsgReference to a N2kMsg Object,
EngineInstanceEngine instance.
EngineSpeedRPM (Revolutions Per Minute)
EngineBoostPressurein Pascal
EngineTiltTrimin %
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 430 of file N2kMessages.cpp.

◆ ParseN2kPGN127489() [1/2]

bool ParseN2kPGN127489 ( const tN2kMsg N2kMsg,
unsigned char &  EngineInstance,
double &  EngineOilPress,
double &  EngineOilTemp,
double &  EngineCoolantTemp,
double &  AltenatorVoltage,
double &  FuelRate,
double &  EngineHours,
double &  EngineCoolantPress,
double &  EngineFuelPress,
int8_t &  EngineLoad,
int8_t &  EngineTorque 
)
inline

Parsing the content of a "Engine parameters dynamic" message - PGN 127489.

Alias of PGN 127489. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN127489

Definition at line 1331 of file N2kMessages.h.

◆ ParseN2kPGN127489() [2/2]

bool ParseN2kPGN127489 ( const tN2kMsg N2kMsg,
unsigned char &  EngineInstance,
double &  EngineOilPress,
double &  EngineOilTemp,
double &  EngineCoolantTemp,
double &  AltenatorVoltage,
double &  FuelRate,
double &  EngineHours,
double &  EngineCoolantPress,
double &  EngineFuelPress,
int8_t &  EngineLoad,
int8_t &  EngineTorque,
tN2kEngineDiscreteStatus1 Status1,
tN2kEngineDiscreteStatus2 Status2 
)

Parsing the content of Message PGN 127489 "Engine parameters dynamic".

Used to provide real-time operational data and status relevant to a specific engine, indicated by the engine instance field. This message would normally be broadcasted periodically to provide information for instrumentation or control functions.

Parameters
N2kMsgReference to a N2kMsg Object,
EngineInstanceEngine instance
EngineOilPressin Pascal
EngineOilTempin Kelvin
EngineCoolantTempin Kelvin
AltenatorVoltagein Voltage
FuelRatein litres/hour
EngineHoursin seconds
EngineCoolantPressin Pascal
EngineFuelPressin Pascal
EngineLoadin %
EngineTorquein %
Status1Engine Discrete Status 1 tN2kEngineDiscreteStatus1
Status2Engine Discrete Status 2 tN2kEngineDiscreteStatus2
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 469 of file N2kMessages.cpp.

◆ ParseN2kPGN127493()

bool ParseN2kPGN127493 ( const tN2kMsg N2kMsg,
unsigned char &  EngineInstance,
tN2kTransmissionGear TransmissionGear,
double &  OilPressure,
double &  OilTemperature,
unsigned char &  DiscreteStatus1 
)

Parsing the content of Message PGN 127493 "Transmission parameters, dynamic".

Used to provide the operational state and internal operating parameters of a specific transmission, indicated by the transmission instance field. This message would normally be broadcasted periodically to provide information for instrumentation or control functions.

Parameters
N2kMsgReference to a N2kMsg Object,
EngineInstanceEngine instance.
TransmissionGearSelected transmission. tN2kTransmissionGear
OilPressurein Pascal
OilTemperaturein Kelvin
DiscreteStatus1in %
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 511 of file N2kMessages.cpp.

◆ ParseN2kPGN127497()

bool ParseN2kPGN127497 ( const tN2kMsg N2kMsg,
unsigned char &  EngineInstance,
double &  TripFuelUsed,
double &  FuelRateAverage,
double &  FuelRateEconomy,
double &  InstantaneousFuelEconomy 
)

Parsing the content of Message PGN 127497 "Trip Parameters, Engine".

Engine related trip / fuel information.

Parameters
N2kMsgReference to a N2kMsg Object,
EngineInstanceEngine instance
TripFuelUsedin litres
FuelRateAveragein litres/hour
FuelRateEconomyin litres/hour
InstantaneousFuelEconomyin litres/hour
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 540 of file N2kMessages.cpp.

◆ ParseN2kPGN127501() [1/2]

bool ParseN2kPGN127501 ( const tN2kMsg N2kMsg,
unsigned char &  DeviceBankInstance,
tN2kBinaryStatus BankStatus 
)

Parsing the content of Message PGN 127501 Message "Universal Binary Status Report".

Universal status report for binary state devices in banks of up to 28 devices each. That means that a Device can report up to 32 states. The meaning of these states depends on the implementation by the manufacture.

Note
Use N2kGetStatusOnBinaryStatus to read specific status
Parameters
N2kMsgReference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
DeviceBankInstanceDevice or Bank Instance
BankStatusFull bank status. Read single status by using N2kGetStatusOnBinaryStatus
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 624 of file N2kMessages.cpp.

◆ ParseN2kPGN127501() [2/2]

bool ParseN2kPGN127501 ( const tN2kMsg N2kMsg,
unsigned char &  DeviceBankInstance,
tN2kOnOff Status1,
tN2kOnOff Status2,
tN2kOnOff Status3,
tN2kOnOff Status4 
)

Parsing the content of Message PGN 127501 Message "Universal Binary Status Report".

Note
This function parses the first four states of the bank status.

Universal status report for binary state devices in banks of up to 28 devices each. That means that a Device can report up to 32 states. The meaning of these states depends on the implementation by the manufacture.

Parameters
N2kMsgReference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
DeviceBankInstanceDevice or Bank Instance
Status1On/Off for Status1
Status2On/Off for Status2
Status3On/Off for Status3
Status4On/Off for Status4
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 604 of file N2kMessages.cpp.

◆ ParseN2kPGN127502()

bool ParseN2kPGN127502 ( const tN2kMsg N2kMsg,
unsigned char &  TargetBankInstance,
tN2kBinaryStatus BankStatus 
)

Parse the content of a PGN 127502 (Switch Bank Control) message.

Review N2kGetStatusOnBinaryStatus and the documentation of tN2kOnOff for information on how to process the bank status data returned by this function.

Note
This PGN is deprecated by NMEA and modern switch bank devices may well not support it, favouring PGN 126208 Command Group Function.
Parameters
N2kMsgReference to the N2kMsg object to be parsed. If this contains a valid PGN 127502 message then the following return values will be set.
TargetBankInstanceInstance number of the switchbank that was targetted by this switchbank control message.
BankStatusThe binary status component of the switchbank control containing the commanded state of channels on the target switchbank.
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 638 of file N2kMessages.cpp.

◆ ParseN2kPGN127505()

bool ParseN2kPGN127505 ( const tN2kMsg N2kMsg,
unsigned char &  Instance,
tN2kFluidType FluidType,
double &  Level,
double &  Capacity 
)

Parsing the content of message PGN 127505 "Fluid level".

Fluid Level contains an instance number, type of fluid, level of fluid, and tank capacity. For example the fluid instance may be the level of fuel in a tank or the level of water in the bilge. Used primarily by display or instrumentation devices.

Parameters
N2kMsgReference to a N2kMsg Object,
InstanceTank instance. Different devices handles this a bit differently. So it is best to have instance unique over
FluidTypeDefines type of fluid. See definition of tN2kFluidType
LevelTank level in % of full tank.
CapacityTank Capacity in litres
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 670 of file N2kMessages.cpp.

◆ ParseN2kPGN127506()

bool ParseN2kPGN127506 ( const tN2kMsg N2kMsg,
unsigned char &  SID,
unsigned char &  DCInstance,
tN2kDCType DCType,
unsigned char &  StateOfCharge,
unsigned char &  StateOfHealth,
double &  TimeRemaining,
double &  RippleVoltage,
double &  Capacity 
)

Parsing the content of message PGN 127506 "DC Detailed Status".

Provides parametric data for a specific battery, indicated by the battery instance field. Used primarily by display or instrumentation devices, but may also be used by battery management controls.

Parameters
N2kMsgReference to a N2kMsg Object,
SIDSequence ID. Normally you can just forget its value. See SID.
DCInstanceDC instance
DCTypeDefines type of DC source. See definition of tN2kDCType
StateOfCharge% of charge
StateOfHealth% of health
TimeRemainingTime remaining in seconds
RippleVoltageDC output voltage ripple in V
CapacityBattery capacity in coulombs
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

◆ ParseN2kPGN127507()

bool ParseN2kPGN127507 ( const tN2kMsg N2kMsg,
unsigned char &  Instance,
unsigned char &  BatteryInstance,
tN2kChargeState ChargeState,
tN2kChargerMode ChargerMode,
tN2kOnOff Enabled,
tN2kOnOff EqualizationPending,
double &  EqualizationTimeRemaining 
)

Parsing the content of message PGN 127507 "DC Charger Status".

Any device capable of charging a battery may transmit this message.

Note
This PGN is DEPRECATED
Parameters
N2kMsgReference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
InstanceChargerInstance
BatteryInstanceBatteryInstance
ChargeStatesee tN2kChargeState
ChargerModesee tN2kChargerMode
Enabledset tN2kOnOff
EqualizationPendingset tN2kOnOff
EqualizationTimeRemainingdouble seconds
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 741 of file N2kMessages.cpp.

◆ ParseN2kPGN127508()

bool ParseN2kPGN127508 ( const tN2kMsg N2kMsg,
unsigned char &  BatteryInstance,
double &  BatteryVoltage,
double &  BatteryCurrent,
double &  BatteryTemperature,
unsigned char &  SID 
)

Parsing the content of message PGN 127508 "Battery Status".

Provides parametric data for a specific DC Source, indicated by the instance field. The type of DC Source can be identified from the DC Detailed Status PGN. Used primarily by display or instrumentation devices, but may also be used by power management.

Parameters
N2kMsgReference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
BatteryInstanceBatteryInstance.
BatteryVoltageBattery voltage in V
BatteryCurrentCurrent in A
BatteryTemperatureBattery temperature in K. Use function CToKelvin, if you want to use °C.
SIDSequence ID. Normally you can just forget its value. See SID.
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 775 of file N2kMessages.cpp.

◆ ParseN2kPGN127513()

bool ParseN2kPGN127513 ( const tN2kMsg N2kMsg,
unsigned char &  BatInstance,
tN2kBatType BatType,
tN2kBatEqSupport SupportsEqual,
tN2kBatNomVolt BatNominalVoltage,
tN2kBatChem BatChemistry,
double &  BatCapacity,
int8_t &  BatTemperatureCoefficient,
double &  PeukertExponent,
int8_t &  ChargeEfficiencyFactor 
)

Parsing the content of message PGN 127513 "Battery Configuration Status".

Any device connected to a battery may transmit this message.

Parameters
N2kMsgReference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
BatInstanceBatteryInstance
BatTypeType of battery. See tN2kBatType
SupportsEqualSupports equalization. See tN2kBatEqSupport
BatNominalVoltageBattery nominal voltage. See tN2kBatNomVolt
BatChemistryBattery Chemistry See tN2kBatChem
BatCapacityBattery capacity in Coulombs. Use AhToCoulombs, if you have your value in Ah.
BatTemperatureCoefficientBattery temperature coefficient in %
PeukertExponentPeukert Exponent
ChargeEfficiencyFactorCharge efficiency factor
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 806 of file N2kMessages.cpp.

◆ ParseN2kPGN128000()

bool ParseN2kPGN128000 ( const tN2kMsg N2kMsg,
unsigned char &  SID,
double &  Leeway 
)

Parsing the content of Message PGN 128000 "Nautical Leeway Angle".

This PGN provides the Nautical Leeway Angle, which is defined as the angle between the vessel’s heading (direction to which the vessel’s bow points) and its course (direction of its motion (track) through the water). The Nautical Leeway Angle is water referenced and does not account for slip due to current. This is commonly provided by dual-axis speed sensors. Dual axis speed sensors are able to measure accurately the ship's speed in a longitudinal direction and a transverse direction. By measuring both speed components (i.e. the velocity vector), the Nautical Leeway Angle can be determined, and this angle can be used to optimize the vessel's course.

Note
This Nautical Leeway Angle is used primarily in the sailing segment of the maritime industry and may differ from oceanographic or scientific definitions of Leeway.

The Sequence ID field (SID) is used to link this PGN to other related PGN’s from the same source address. When no linkage exists, the value of the SID shall be set to 255

NMEA2000 document

Parameters
N2kMsgReference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SIDSequence ID. Normally you can just forget its value. See SID.
LeewayPositive angles indicate slippage to starboard, that is, the vessel is tracking to the right of its heading, and negative angles indicate slippage to port
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 837 of file N2kMessages.cpp.

◆ ParseN2kPGN128259()

bool ParseN2kPGN128259 ( const tN2kMsg N2kMsg,
unsigned char &  SID,
double &  WaterReferenced,
double &  GroundReferenced,
tN2kSpeedWaterReferenceType SWRT 
)

Parsing the content of message PGN 128259 "Boat Speed, Water Referenced".

This parameter group provides a single transmission that describes the motion of a vessel.

Parameters
N2kMsgReference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SIDSequence ID. Normally you can just forget its value. See SID.
WaterReferencedSpeed over water in m/s
GroundReferencedSpeed over Ground in m/s
SWRTType of transducer. See tN2kSpeedWaterReferenceType
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 861 of file N2kMessages.cpp.

◆ ParseN2kPGN128267()

bool ParseN2kPGN128267 ( const tN2kMsg N2kMsg,
unsigned char &  SID,
double &  DepthBelowTransducer,
double &  Offset,
double &  Range 
)

Parsing the content of message PGN 128267 "Water depth".

Water depth relative to the transducer and offset of the measuring transducer. Positive offset numbers provide the distance from the transducer to the waterline.

Parameters
N2kMsgReference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SIDSequence ID. Normally you can just forget its value. See SID.
DepthBelowTransducerWater depth below transducer in meters
OffsetDistance in meters between transducer and water surface (positive) or transducer and keel (negative)
Rangemaximum depth range tha can be measured
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 885 of file N2kMessages.cpp.

◆ ParseN2kPGN128275()

bool ParseN2kPGN128275 ( const tN2kMsg N2kMsg,
uint16_t &  DaysSince1970,
double &  SecondsSinceMidnight,
uint32_t &  Log,
uint32_t &  TripLog 
)

Parsing the content of message PGN 128275 "Distance log".

This PGN provides the cumulative voyage distance traveled since the last reset. The distance is tagged with the time and date of the distance measurement.

Parameters
N2kMsgReference to a N2kMsg Object,
DaysSince1970Timestamp
SecondsSinceMidnightTimestamp
LogThis field indicates the total distance traveled through the water since the device was installed in units of 1 m.
TripLogThis field indicates the total distance traveled through the water since last reset in units of 1 m.
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 908 of file N2kMessages.cpp.

◆ ParseN2kPGN128776()

bool ParseN2kPGN128776 ( const tN2kMsg N2kMsg,
unsigned char &  SID,
unsigned char &  WindlassIdentifier,
tN2kWindlassDirectionControl WindlassDirectionControl,
unsigned char &  SpeedControl,
tN2kSpeedType SpeedControlType,
tN2kGenericStatusPair AnchorDockingControl,
tN2kGenericStatusPair PowerEnable,
tN2kGenericStatusPair MechanicalLock,
tN2kGenericStatusPair DeckAndAnchorWash,
tN2kGenericStatusPair AnchorLight,
double &  CommandTimeout,
tN2kWindlassControlEvents WindlassControlEvents 
)

Parsing the content of message PGN 128776 "Anchor Windlass Control Status".

This PGN is used to report status of anchor windlass controls and can be used with Command Group Function (PGN 126208) to command the windlass and anchoring equipment. The Windlass Identifier Field (Field 2) specifies which windlass the PGN message is intended for, and all following data fields refer only to that windlass. This PGN has several transmission rates dependent upon windlass operation: Static is 5s, Dynamic is 500ms, Control is 250ms. The message will be broadcasted periodically, but can also be requested as required. The default static update rate is 5 seconds to reduce bandwidth use when the windlass is not operating, this update rate is used when all control commands are OFF.

See also
https://www.nmea.org/Assets/20190613%20windlass%20amendment,%20128776,%20128777,%20128778.pdf
Parameters
N2kMsgReference to a N2kMsg Object,
SIDSequence ID. Normally you can just forget its value. See SID.
WindlassIdentifierUnique Identifier of a function within a Virtual Device: 0 - 255
WindlassDirectionControlsee tN2kWindlassDirectionControl
SpeedControlSingle speed 0=off, 1-100=on; Dual speed: 0=off, 1-49=slow, 50-100=fast; Proporional speed: 0=off, 1-100=speed
SpeedControlTypesee tN2kSpeedType
AnchorDockingControlsee tN2kGenericStatusPair
PowerEnablesee tN2kGenericStatusPair
MechanicalLocksee tN2kGenericStatusPair
DeckAndAnchorWashsee tN2kGenericStatusPair
AnchorLightsee tN2kGenericStatusPair
CommandTimeoutrange 0.25 ... 1.26sec -> If timeout elapses the thruster stops operating and reverts to static mode.
WindlassControlEventssee tN2kWindlassControlEvents -> Events are cleared when the condition is no longer true, or by manually resetting using the Command Group Function (PGN 126208).
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 952 of file N2kMessages.cpp.

◆ ParseN2kPGN128777()

bool ParseN2kPGN128777 ( const tN2kMsg N2kMsg,
unsigned char &  SID,
unsigned char &  WindlassIdentifier,
double &  RodeCounterValue,
double &  WindlassLineSpeed,
tN2kWindlassMotionStates WindlassMotionStatus,
tN2kRodeTypeStates RodeTypeStatus,
tN2kAnchorDockingStates AnchorDockingStatus,
tN2kWindlassOperatingEvents WindlassOperatingEvents 
)

Parsing the content of message PGN 128777 "Anchor Windlass Operating Status".

This PGN is used to provide the operating status and data relevant to a specific Anchor Windlass and can be used with Command Group Function (PGN 126208) to command windlass and anchoring equipment.
The Windlass Identifier (Field 2) specifies which windlass the PGN message relates to and all following data fields refer only to that windlass.
This PGN has several transmission rates dependent upon windlass operation: Static is 5s, Dynamic is 500ms. The message will be broadcasted periodically, but can also be requested as required. The default static update rate is 5 seconds to reduce bandwidth use when the windlass is not operating.
The default dynamic update rate is 500ms to provide the status of activity while the windlass is operating. This PGN can be used with PGN 128776 to provide the windlass control status, and PGN 128778 to provide the monitoring status. The Sequence ID can be used to link the three windlass PGNs.

Parameters
N2kMsgReference to a N2kMsg Object,
SIDSequence ID. Normally you can just forget its value. See SID.
WindlassIdentifierUnique Identifier of a function within a Virtual Device: 0 - 255
RodeCounterValueamount of rode deployed in meters
WindlassLineSpeedAmount of rode deployed or retrieved per minute.
WindlassMotionStatusIndicates current physical state of windlass movement. see tN2kWindlassMotionStates
RodeTypeStatusIndicates whether chain or rope is currently being deployed or retrieved. see tN2kRodeTypeStates
AnchorDockingStatusIndicates current physical state of anchor docking. Used in automatic docking situations to report when the anchor has been fully docked.
WindlassOperatingEventssee tN2kWindlassOperatingEvents
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 1012 of file N2kMessages.cpp.

◆ ParseN2kPGN128778()

bool ParseN2kPGN128778 ( const tN2kMsg N2kMsg,
unsigned char &  SID,
unsigned char &  WindlassIdentifier,
double &  TotalMotorTime,
double &  ControllerVoltage,
double &  MotorCurrent,
tN2kWindlassMonitoringEvents WindlassMonitoringEvents 
)

Parsing the content of message PGN128778 "Anchor Windlass Monitoring Status".

This PGN is used to provide the monitoring status and data relevant to a specific Anchor Windlass and can be used with Command Group Function (PGN 126208) to command windlass and anchoring equipment.
The Windlass Identifier Field (Field 2) specifies which windlass the PGN message relates to and all following data fields refer only to that windlass.
This PGN has several transmission rates dependent upon windlass operation: Static is 5s, Dynamic is 500ms. The message will be broadcasted periodically, but can also be requested as required. The default static update rate is 5 seconds to reduce bandwidth use when the windlass is not operating. The default dynamic update rate is 500ms to provide the status of activity while the windlass is operating. This PGN can be used with PGN 128776 to provide the windlass control status, and PGN 128777 to provide the operating status. The Sequence ID can be used to link the three windlass PGNs.

Parameters
N2kMsgReference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SIDSequence ID. Normally you can just forget its value. See SID.
WindlassIdentifierUnique Identifier of a function within a Virtual Device: 0 - 255
TotalMotorTimeTotal time windlass has operated since last reset in seconds
ControllerVoltageSupply voltage of electronic windlass controller in Volt
MotorCurrentLoad current of electric windlass motor in Ampere
WindlassMonitoringEventsEvents are cleared when the condition is no longer true, or by manually resetting using the Command Group Function (PGN 126208). see tN2kWindlassMonitoringEvents
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 1063 of file N2kMessages.cpp.

◆ ParseN2kPGN129025()

bool ParseN2kPGN129025 ( const tN2kMsg N2kMsg,
double &  Latitude,
double &  Longitude 
)

Parsing the content of PGN 129025 "Position, Rapid Update".

This PGN provides latitude and longitude referenced to WGS84. Being defined as single frame message, as opposed to other PGNs that include latitude and longitude and are defined as fast or multi-packet, this PGN lends itself to being transmitted more frequently without using up excessive bandwidth on the bus for the benefit of receiving equipment that may require rapid position updates.

Parameters
N2kMsgReference to a N2kMsg Object,
LatitudeLatitude in degrees
LongitudeLongitude in degrees
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 1092 of file N2kMessages.cpp.

◆ ParseN2kPGN129026()

bool ParseN2kPGN129026 ( const tN2kMsg N2kMsg,
unsigned char &  SID,
tN2kHeadingReference ref,
double &  COG,
double &  SOG 
)

Parsing the content of PGN 129026 "COG SOG rapid update".

This parameter group is a single frame parameter group that provides Course Over Ground (COG) and Speed Over Ground (SOG).

Parameters
N2kMsgReference to a N2kMsg Object,
SIDSequence ID. Normally you can just forget its value. See SID.
refCOG reference, see tN2kHeadingReference
COGCourse Over Ground in radians
SOGSpeed Over Ground in m/s
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 1115 of file N2kMessages.cpp.

◆ ParseN2kPGN129029()

bool ParseN2kPGN129029 ( const tN2kMsg N2kMsg,
unsigned char &  SID,
uint16_t &  DaysSince1970,
double &  SecondsSinceMidnight,
double &  Latitude,
double &  Longitude,
double &  Altitude,
tN2kGNSStype GNSStype,
tN2kGNSSmethod GNSSmethod,
unsigned char &  nSatellites,
double &  HDOP,
double &  PDOP,
double &  GeoidalSeparation,
unsigned char &  nReferenceStations,
tN2kGNSStype ReferenceStationType,
uint16_t &  ReferenceSationID,
double &  AgeOfCorrection 
)

Parsing the content of message PGN 129029 "GNSS Position Data".

This parameter group conveys a comprehensive set of Global Navigation Satellite System (GNSS) parameters, including position information.

The parameters passed to ReferenceStationType, ReferenceStationID and AgeOfCorrection are set to N2kGNSSt_GPS, N2kInt16NA and N2kDoubleNA respectively, when there are no reference stations present in the message.

Parameters
N2kMsgReference to a N2kMsg Object,
SIDSequence ID. Normally you can just forget its value. See SID.
DaysSince1970UTC Date in resolution of 1 day (The number of days since January 1, 1970).
SecondsSinceMidnightUTC time second since midnight
LatitudeLatitude in degrees ("-" = south, “+” = north)
LongitudeLongitude in degrees ("-" = west, “+” = east)
AltitudeAltitude referenced to WGS-84 in meters
GNSStypeGNSS type. See tN2kGNSStype
GNSSmethodGNSS method type. See tN2kGNSSmethod
nSatellitesIndicate the number of satellites used for data
HDOPHorizontal Dilution Of Precision in meters.
PDOPProbable dilution of precision in meters.
GeoidalSeparationGeoidal separation in meters
nReferenceStationsNumber of Reference Stations
ReferenceStationTypeReference Station Type, see N2kGNSSt_GPS
ReferenceSationIDReference Station ID
AgeOfCorrectionAge of DGNSS Corrections
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

◆ ParseN2kPGN129033()

bool ParseN2kPGN129033 ( const tN2kMsg N2kMsg,
uint16_t &  DaysSince1970,
double &  SecondsSinceMidnight,
int16_t &  LocalOffset 
)

Parsing the content of message PGN 129033 "Date,Time & Local offset".

This parameter group has a single transmission that provides: UTC time, UTC date and Local Offset Datum Local geodetic datum and datum offsets from a reference datum.

See also
SetN2kPGN126992 , ParseN2kPGN126992
Parameters
N2kMsgReference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
DaysSince1970UTC Date in resolution of 1 day (The number of days since January 1, 1970).
SecondsSinceMidnightSeconds since midnight
LocalOffsetLocal offset in minutes
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 1208 of file N2kMessages.cpp.

◆ ParseN2kPGN129038()

bool ParseN2kPGN129038 ( const tN2kMsg N2kMsg,
uint8_t &  MessageID,
tN2kAISRepeat Repeat,
uint32_t &  UserID,
double &  Latitude,
double &  Longitude,
bool &  Accuracy,
bool &  RAIM,
uint8_t &  Seconds,
double &  COG,
double &  SOG,
double &  Heading,
double &  ROT,
tN2kAISNavStatus NavStatus 
)

Parsing the content of message PGN 129038 "AIS position reports for Class A".

This parameter group provides data associated with the ITU-R M.1371 Messages 1, 2, and 3 Position Reports, autonomous, assigned, and response to interrogation, respectively. An AIS device may generate this parameter group either upon receiving a VHF data link message 1,2 or 3, or upon receipt of an ISO or NMEA request PGN (see ITU-R M.1371-1 for additional information).

See also
ITU-R M.1371
Parameters
N2kMsgReference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
MessageIDMessage Type ID according to e ITU-R M.1371
RepeatRepeat indicator, Used by the repeater to indicate how many times a message has been repeated. Refer to § 4.6.1, Annex 2; 0-3; 0 = default; 3 = do not repeat any more
UserIDMMSI number
Latitudelatitude of position degree
Longitudelongitude of position degree
Accuracy{bool} position accuracy
  • 0 = default
  • 1 = high (≤10 m)
  • 0 = low (>10 m)
RAIM{bool}Receiver autonomous integrity monitoring (RAIM) flag of electronic position fixing device
  • 0 = RAIM not in use = default
  • 1 = RAIM in use
SecondsUTC second when the report was generated by the EPFS (0-59 or 60) if time stamp is not available, which should also be the default value or 61 if positioning system is in manual input mode or 62 if electronic position fixing system operates in estimated (dead reckoning) mode, or 63 if the positioning system is inoperative)
COGCourse over ground
SOGSpeed over ground
Headingheading
ROTRate of turn
NavStatusNavigational status, see tN2kAISNavStatus
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 1353 of file N2kMessages.cpp.

◆ ParseN2kPGN129039()

bool ParseN2kPGN129039 ( const tN2kMsg N2kMsg,
uint8_t &  MessageID,
tN2kAISRepeat Repeat,
uint32_t &  UserID,
double &  Latitude,
double &  Longitude,
bool &  Accuracy,
bool &  RAIM,
uint8_t &  Seconds,
double &  COG,
double &  SOG,
tN2kAISTransceiverInformation AISTransceiverInformation,
double &  Heading,
tN2kAISUnit Unit,
bool &  Display,
bool &  DSC,
bool &  Band,
bool &  Msg22,
tN2kAISMode Mode,
bool &  State 
)

Parsing the content of message PGN 129039 "AIS position reports for Class B".

This parameter group provides data associated with the ITU-R M.1371 Message18 Standard Class B Equipment Position Report. An AIS device may generate this parameter group either upon receiving a VHF data link message 18, or upon receipt of an ISO or NMEA request PGN (see ITU-R M.1371-1 for additional information).

See also
ITU-R M.1371
Parameters
N2kMsgReference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
MessageIDMessage Type ID according to e ITU-R M.1371
RepeatRepeat indicator, Used by the repeater to indicate how many times a message has been repeated. Refer to § 4.6.1, Annex 2; 0-3; 0 = default; 3 = do not repeat any more
UserIDMMSI number
Latitudelatitude of position degree
Longitudelongitude of position degree
Accuracy{bool} position accuracy
  • 0 = default
  • 1 = high (≤10 m)
  • 0 = low (>10 m)
RAIM{bool}Receiver autonomous integrity monitoring (RAIM) flag of electronic position fixing device
  • 0 = RAIM not in use = default
  • 1 = RAIM in use
SecondsTimeStamp UTC second when the report was generated by the EPFS (0-59 or 60) if time stamp is not available, which should also be the default value or 61 if positioning system is in manual input mode or 62 if electronic position fixing system operates in estimated (dead reckoning) mode, or 63 if the positioning system is inoperative)
COGCourse over ground
SOGSpeed over ground
AISTransceiverInformationAIS Transceiver Information, see tN2kAISTransceiverInformation
HeadingHeading
UnitClass B unit flag, see tN2kAISUnit
DisplayClass B display flag,
  • 0 = No display available; not capable of displaying AIS Message 12 and 14
  • 1 = Equipped with integrated display displaying AIS Message 12 and 14
DSCClass B DSC flag
  • 0 = Not equipped with DSC function
  • 1 = Equipped with DSC function (dedicated or time-shared)
BandClass B band flag
  • 0 = Capable of operating over the upper 525 kHz band of the marine band
  • 1 = Capable of operating over the whole marine band (irrelevant if “Class B Message 22 flag” is 0)
Msg22Class B Message22 flag
  • 0 = No frequency management via Message 22 , operating on AIS1, AIS2 only
  • 1 = Frequency management via Message 22
ModeStation Operating Mode flag, see tN2kAISMode
StateCommunication State Selector Flag
  • 0 = SOTDMA communication state follows
  • 1 = ITDMA communication state follows (always “1” for Class-B “CS”)
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 1409 of file N2kMessages.cpp.

◆ ParseN2kPGN129041()

bool ParseN2kPGN129041 ( const tN2kMsg N2kMsg,
tN2kAISAtoNReportData N2kData 
)

Parsing the content of message PGN 129041 "AIS Aids to Navigation (AtoN) Report".

This PGN provides information received from an AtoN AIS station conforming to ITU-R M.1371-4 Message 21.

Parameters
N2kMsgReference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
N2kDatastructure that consists all relevant data, see tN2kAISAtoNReportData
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 1466 of file N2kMessages.cpp.

◆ ParseN2kPGN129283()

bool ParseN2kPGN129283 ( const tN2kMsg N2kMsg,
unsigned char &  SID,
tN2kXTEMode XTEMode,
bool &  NavigationTerminated,
double &  XTE 
)

Parsing the content of Message PGN 129283 Message "Cross Track Error".

This parameter group provides the magnitude of position error perpendicular to the desired course.

Parameters
N2kMsgReference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SIDSequence ID. Normally you can just forget its value. See SID.
XTEModeCrossTrackError Mode, see tN2kXTEMode
NavigationTerminated{bool] Navigation has been terminated
XTECrossTrackError in meter
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 1506 of file N2kMessages.cpp.

◆ ParseN2kPGN129284()

bool ParseN2kPGN129284 ( const tN2kMsg N2kMsg,
unsigned char &  SID,
double &  DistanceToWaypoint,
tN2kHeadingReference BearingReference,
bool &  PerpendicularCrossed,
bool &  ArrivalCircleEntered,
tN2kDistanceCalculationType CalculationType,
double &  ETATime,
int16_t &  ETADate,
double &  BearingOriginToDestinationWaypoint,
double &  BearingPositionToDestinationWaypoint,
uint32_t &  OriginWaypointNumber,
uint32_t &  DestinationWaypointNumber,
double &  DestinationLatitude,
double &  DestinationLongitude,
double &  WaypointClosingVelocity 
)

Parsing the content of message PGN 129284 "Navigation Data".

This parameter group provides essential navigation data for following a route. Transmissions will originate from products that can create and manage routes using waypoints. This information is intended for navigational repeaters.

Parameters
N2kMsgReference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SIDSequence ID. Normally you can just forget its value. See SID.
DistanceToWaypointDistance to Destination Waypoint
BearingReferenceCourse / Bearing Reference, see tN2kHeadingReference
PerpendicularCrossed{bool}Perpendicular Crossed
ArrivalCircleEntered{bool}Arrival Circle Entered
CalculationTypeCalculation Type, see tN2kDistanceCalculationType
ETATimeEstimated Time at Arrival - Time
ETADateEstimated Time at Arrival - Date
BearingOriginToDestinationWaypointBearing, Origin To Destination Waypoint
BearingPositionToDestinationWaypointBearing, Position To Destination Waypoint
OriginWaypointNumberOrigin Waypoint Number
DestinationWaypointNumberDestination Waypoint Number
DestinationLatitudeDestination Wpt Latitude
DestinationLongitudeDestination Wpt Longitude
WaypointClosingVelocityWaypoint Closing Velocity
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 1543 of file N2kMessages.cpp.

◆ ParseN2kPgn129539()

bool ParseN2kPgn129539 ( const tN2kMsg N2kMsg,
unsigned char &  SID,
tN2kGNSSDOPmode DesiredMode,
tN2kGNSSDOPmode ActualMode,
double &  HDOP,
double &  VDOP,
double &  TDOP 
)

Parsing the content of message PGN 129539 "GNSS DOP data".

This PGN provides a single transmission containing GNSS status and dilution of precision components (DOP) that indicate the contribution of satellite geometry to the overall positioning error. There are three DOP parameters reported, horizontal (HDOP), Vertical (VDOP) and time (TDOP).

Parameters
N2kMsgReference to a N2kMsg Object,
SIDSequence ID. Normally you can just forget its value. See SID.
DesiredModeDesired Dilution Of Precision mode, see tN2kGNSSDOPmode
ActualModeActual Dilution Of Precision mode. see tN2kGNSSDOPmode
HDOPHorizontal Dilution Of Precision in meters.
VDOPProbable dilution of precision in meters.
TDOPTime dilution of precision
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 1233 of file N2kMessages.cpp.

◆ ParseN2kPGN129540() [1/2]

bool ParseN2kPGN129540 ( const tN2kMsg N2kMsg,
uint8_t  SVIndex,
tSatelliteInfo SatelliteInfo 
)

Parsing the content of message PGN 129540 "GNSS Satellites in View".

GNSS information on current satellites in view tagged by sequence ID. Information includes PRN, elevation, azimuth, SNR, defines the number of satellites; defines the satellite number and the information.

Use second (THIS) function to get information for specific satellite. It is possible to use just this function, but it returns also false for wrong message.

Parameters
N2kMsgReference to a N2kMsg Object,
SVIndexIndex of saellite info requested.
SatelliteInfoRequested satellite info
Returns
true function succeeded
false called with wrong message or SVIndex is out of range.

Definition at line 1299 of file N2kMessages.cpp.

◆ ParseN2kPGN129540() [2/2]

bool ParseN2kPGN129540 ( const tN2kMsg N2kMsg,
unsigned char &  SID,
tN2kRangeResidualMode Mode,
uint8_t &  NumberOfSVs 
)

Parsing the content of message PGN 129540 "GNSS Satellites in View".

GNSS information on current satellites in view tagged by sequence ID. Information includes PRN, elevation, azimuth, SNR, defines the number of satellites; defines the satellite number and the information.

Use first (THIS) function to get basic information and specially NumberOfSVs.

Parameters
N2kMsgReference to a N2kMsg Object,
SIDSequence ID. Normally you can just forget its value. See SID.
ModeRange residual mode, see tN2kRangeResidualMode
NumberOfSVsNumber of satellite infos in message.
Returns
true function succeeded
false called with wrong message

Definition at line 1287 of file N2kMessages.cpp.

◆ ParseN2kPGN129794()

bool ParseN2kPGN129794 ( const tN2kMsg N2kMsg,
uint8_t &  MessageID,
tN2kAISRepeat Repeat,
uint32_t &  UserID,
uint32_t &  IMOnumber,
char *  Callsign,
size_t  CallsignBufSize,
char *  Name,
size_t  NameBufSize,
uint8_t &  VesselType,
double &  Length,
double &  Beam,
double &  PosRefStbd,
double &  PosRefBow,
uint16_t &  ETAdate,
double &  ETAtime,
double &  Draught,
char *  Destination,
size_t  DestinationBufSize,
tN2kAISVersion AISversion,
tN2kGNSStype GNSStype,
tN2kAISDTE DTE,
tN2kAISTransceiverInformation AISinfo 
)

Parsing the content of message PGN 129794 "AIS static data class A".

This parameter group provides data associated with the ITU-R M.1371 Message 5 Ship Static and Voyage Related Data Message. An AIS device may generate this parameter group either upon receiving a VHF data link message 5, or upon receipt of an ISO or NMEA request PGN.

See also
ITU-R M.1371
Parameters
N2kMsgReference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
MessageIDMessage Type ID according to e ITU-R M.1371
RepeatRepeat indicator, Used by the repeater to indicate how many times a message has been repeated.
see tN2kAISRepeat
UserIDMMSI Number
IMOnumberShip identification number by IMO [1 .. 999999999]; 0 = not available = default
Not applicable to SAR aircraft
CallsignCall Sign
CallsignBufSizesize of Callsign buffer
NameName of the vessel; Maximum 20 characters 6 bit ASCII; For SAR aircraft, it should be set to “SAR AIRCRAFT NNNNNNN” where NNNNNNN equals the aircraft registration number
NameBufSizesize of Name buffer
VesselTypeVessel Type 0 = not available or no ship = default 1-99 = as defined in § 3.3.2 100-199 = reserved, for regional use 200-255 = reserved, for future use Not applicable to SAR aircraft
LengthLength/Diameter in meters
BeamBeam/Diameter in meters
PosRefStbdPosition Reference Point from Starboard
PosRefBowPosition Reference Point from the Bow
ETAdateEstimatedTimeOfArrival - Days since 1970-01-01 (UTC)
ETAtimeEstimatedTimeOfArrival -seconds since midnight (UTC)
DraughtMaximum present static draught
DestinationDestination - Maximum 20 characters using 6-bit ASCII
DestinationBufSizesize of Destination buffer
AISversionAIS version, see tN2kAISVersion
GNSStypeType of GNSS, see tN2kGNSStype
DTEData terminal equipment (DTE) ready
  • 0 = available
  • 1 = not available = default
AISinfoAIS Transceiver Information, see tN2kAISTransceiverInformation
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 1640 of file N2kMessages.cpp.

◆ ParseN2kPGN129802()

bool ParseN2kPGN129802 ( const tN2kMsg N2kMsg,
uint8_t &  MessageID,
tN2kAISRepeat Repeat,
uint32_t &  SourceID,
tN2kAISTransceiverInformation AISTransceiverInformation,
char *  SafetyRelatedText,
size_t &  SafetyRelatedTextMaxSize 
)

Parsing the Content of a PGN129802 Message - "AIS Safety Related Broadcast Message".

This parameter group provides data associated with the ITU-R M.1371 Message 14 Safety Related Broadcast Message supporting broadcast communication of safety related data. An AIS device may generate this parameter group either upon receiving a VHF data link message 14, or upon receipt of an ISO or NMEA request PGN.

Parameters
N2kMsgReference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
MessageIDMessage type
RepeatRepeat indicator
SourceIDMMSI
AISTransceiverInformationTransceiver Information
SafetyRelatedTextSafety related Text of the Broadcast communication
SafetyRelatedTextMaxSizesize of SafetyRelatedText
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted
See also
tN2kAISTransceiverInformation

Definition at line 66 of file N2kMessages.cpp.

◆ ParseN2kPGN129809()

bool ParseN2kPGN129809 ( const tN2kMsg N2kMsg,
uint8_t &  MessageID,
tN2kAISRepeat Repeat,
uint32_t &  UserID,
char *  Name,
size_t  NameBufSize 
)

Parsing the content of message PGN 129809 "AIS static data class B part A".

This parameter group is used by Class B "CS" shipborne mobile equipment each time Part A of ITU-R M.1372 Message 24 is received.

See also
ITU-R M.1371
SetN2kPGN129810 and ParseN2kPGN129810
Parameters
N2kMsgReference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
MessageIDMessage Type ID according to e ITU-R M.1371
RepeatRepeat indicator, Used by the repeater to indicate how many times a message has been repeated.
see tN2kAISRepeat
UserIDMMSI Number
NameName of the vessel; Maximum 20 characters; For SAR aircraft, it should be set to “SAR AIRCRAFT NNNNNNN” where NNNNNNN equals the aircraft registration number Input string will be converted to contain only SixBit ASCII character set (see. ITU-R M.1371-1)
NameBufSizesize of Name buffer
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 1682 of file N2kMessages.cpp.

◆ ParseN2kPGN129810()

bool ParseN2kPGN129810 ( const tN2kMsg N2kMsg,
uint8_t &  MessageID,
tN2kAISRepeat Repeat,
uint32_t &  UserID,
uint8_t &  VesselType,
const char *  Vendor,
size_t  VendorBufSize,
const char *  Callsign,
size_t  CallsignBufSize,
double &  Length,
double &  Beam,
double &  PosRefStbd,
double &  PosRefBow,
uint32_t &  MothershipID 
)

Parsing the content of message PGN 129810 "AIS static data class B part B".

This parameter group is used by Class B "CS" shipborne mobile equipment each time Part B of ITU-R M.1372 Message 24 is received.

See also
ITU-R M.1371
SetN2kPGN129809 and ParseN2kPGN129809
Parameters
N2kMsgReference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
MessageIDMessage Type ID according to e ITU-R M.1371
RepeatRepeat indicator, Used by the repeater to indicate how many times a message has been repeated.
see tN2kAISRepeat
UserIDMMSI Number
VesselTypeVessel Type 0 = not available or no ship = default 1-99 = as defined in § 3.3.2 100-199 = reserved, for regional use 200-255 = reserved, for future use Not applicable to SAR aircraft
VendorUnique identification of the Unit by a number as defined by the manufacturer
VendorBufSizesize of Vendor buffer
CallsignCall Sign
CallsignBufSizesize of Callsign buffer
LengthLength/Diameter in meters
BeamBeam/Diameter in meters
PosRefStbdPosition Reference Point from Starboard
PosRefBowPosition Reference Point from the Bow
MothershipIDMMSI of the mothership
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

◆ ParseN2kPGN130306()

bool ParseN2kPGN130306 ( const tN2kMsg N2kMsg,
unsigned char &  SID,
double &  WindSpeed,
double &  WindAngle,
tN2kWindReference WindReference 
)

Parsing the content of message PGN 130306 "Wind Data".

Direction and speed of Wind. True wind can be referenced to the vessel or to the ground. The Apparent Wind is what is felt standing on the (moving) ship, I.e., the wind measured by the typical mast head instruments. The boat referenced true wind is given by the vector sum of Apparent wind and vessel's heading and speed though the water. The ground referenced true wind is given by the vector sum of Apparent wind and vessel's heading and speed over ground.

Parameters
N2kMsgReference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SIDSequence ID. Normally you can just forget its value. See SID.
WindSpeedMeasured wind speed in m/s
WindAngleMeasured wind angle in radians. If you have value in degrees, use function DegToRad() in call.
WindReferenceWind reference, see definition of tN2kWindReference
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 1799 of file N2kMessages.cpp.

◆ ParseN2kPGN130310()

bool ParseN2kPGN130310 ( const tN2kMsg N2kMsg,
unsigned char &  SID,
double &  WaterTemperature,
double &  OutsideAmbientAirTemperature,
double &  AtmosphericPressure 
)

Parsing the content of message PGN 130310 "Environmental Parameters - DEPRECATED".

Local atmospheric environmental conditions.

Note
This PGN has been deprecated. Specific PGNs 130316 Temperature, 130313 Relative Humidity, 130314 Actual Pressure, 130315 Set Pressure shall be used.
Parameters
N2kMsgReference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SIDSequence ID. Normally you can just forget its value. See SID.
WaterTemperatureWater temperature in K. Use CToKelvin, if you want to use °C.
OutsideAmbientAirTemperatureOutside ambient temperature in K.Use CToKelvin, if you want to use °C.
AtmosphericPressureAtmospheric pressure in Pascals. Use mBarToPascal, if you like to use mBar
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 1823 of file N2kMessages.cpp.

◆ ParseN2kPGN130311()

bool ParseN2kPGN130311 ( const tN2kMsg N2kMsg,
unsigned char &  SID,
tN2kTempSource TempSource,
double &  Temperature,
tN2kHumiditySource HumiditySource,
double &  Humidity,
double &  AtmosphericPressure 
)

Parsing the content of message PGN 130311 "Environmental Parameters - DEPRECATED".

Note
This PGN has been deprecated. Specific PGNs 130316 Temperature, 130313 Relative Humidity, 130314 Actual Pressure, 130315 Set Pressure shall be used.
In PGN 130311 TempInstance is named as TempSource (other then in PGN 130312 where TempSource really means source of temperature)
Parameters
N2kMsgReference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SIDSequence ID. Normally you can just forget its value. See SID.
TempSourcesee tN2kTempSource
TemperatureTemperature in K. Use CToKelvin, if you want to use °C.
HumiditySourcesee tN2kHumiditySource.
HumidityHumidity in %
AtmosphericPressureAtmospheric pressure in Pascals. Use mBarToPascal, if you like to use mBar
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 1849 of file N2kMessages.cpp.

◆ ParseN2kPGN130312()

bool ParseN2kPGN130312 ( const tN2kMsg N2kMsg,
unsigned char &  SID,
unsigned char &  TempInstance,
tN2kTempSource TempSource,
double &  ActualTemperature,
double &  SetTemperature 
)

Parsing the content of message PGN 130312 "Temperature - DEPRECATED".

Note
Temperature as measured by a specific temperature source. This PGN has been deprecated. Please use PGN 130316 (Temperature-Extended Range) for all new designs.
Parameters
N2kMsgReference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SIDSequence ID. Normally you can just forget its value. See SID.
TempInstanceThis should be unique at least on one device. May be best to have it unique over all devices sending this PGN.
TempSourcesee tN2kTempSource
ActualTemperatureTemperature in K. Use CToKelvin, if you want to use °C.
SetTemperatureTemperature set point in K. Use CToKelvin, if you want to use °C. This is meaningful for temperatures, which can be controlled like cabin, freezer, refridgeration temperature. God can use value for this for outside and sea temperature values.
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 1878 of file N2kMessages.cpp.

◆ ParseN2kPGN130313() [1/2]

bool ParseN2kPGN130313 ( const tN2kMsg N2kMsg,
unsigned char &  SID,
unsigned char &  HumidityInstance,
tN2kHumiditySource HumiditySource,
double &  ActualHumidity 
)
inline

Parsing the content of a "Humidity" message - PGN 130313.

Alias of PGN 130313. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN130313

Definition at line 5087 of file N2kMessages.h.

◆ ParseN2kPGN130313() [2/2]

bool ParseN2kPGN130313 ( const tN2kMsg N2kMsg,
unsigned char &  SID,
unsigned char &  HumidityInstance,
tN2kHumiditySource HumiditySource,
double &  ActualHumidity,
double &  SetHumidity 
)

Parsing the content of message PGN 130313 "Humidity".

Humidity as measured by a specific humidity source.

Parameters
N2kMsgReference to a N2kMsg Object,
SIDSequence ID. Normally you can just forget its value. See SID.
HumidityInstanceThis should be unique at least on one device. May be best to have it unique over all devices sending this PGN.
HumiditySourcesource of measurement, see tN2kHumiditySource
ActualHumidityHumidity in percent
SetHumiditySet value of Humidity in percent
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 1906 of file N2kMessages.cpp.

◆ ParseN2kPGN130314()

bool ParseN2kPGN130314 ( const tN2kMsg N2kMsg,
unsigned char &  SID,
unsigned char &  PressureInstance,
tN2kPressureSource PressureSource,
double &  Pressure 
)

Parsing the content of message PGN 130314 "Actual Pressure".

Pressure as measured by a specific pressure source

Parameters
N2kMsgReference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SIDSequence ID. Normally you can just forget its value. See SID.
PressureInstanceThis should be unique at least on one device. May be best to have it unique over all devices sending this PGN.
PressureSourcesource of measurement, see tN2kPressureSource
Pressureactual in Pascals. Use function mBarToPascal, if you like to use mBar
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 1932 of file N2kMessages.cpp.

◆ ParseN2kPGN130316()

bool ParseN2kPGN130316 ( const tN2kMsg N2kMsg,
unsigned char &  SID,
unsigned char &  TempInstance,
tN2kTempSource TempSource,
double &  ActualTemperature,
double &  SetTemperature 
)

Parsing the content of message PGN 130316 "Temperature, Extended Range".

This parameter group is used to report a wide variety of temperature measurements.

Parameters
N2kMsgReference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SIDSequence ID. Normally you can just forget its value. See SID.
TempInstanceThis should be unique at least on one device. May be best to have it unique over all devices sending this PGN.
TempSourcesource of measurement, see tN2kTempSource
ActualTemperatureActual Temperature in K. Use CToKelvin, if you want to use °C.
SetTemperatureSet Temperature in K. Use CToKelvin, if you want to use °C.
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 1971 of file N2kMessages.cpp.

◆ ParseN2kPGN130323()

bool ParseN2kPGN130323 ( const tN2kMsg N2kMsg,
tN2kMeteorlogicalStationData N2kData 
)

Parsing the content of message PGN 130323 "Meterological Station Data".

Meteorological station measurement data including station location, numeric identifier, and name.

Parameters
N2kMsgReference to a N2kMsg Object,
N2kDataMeterological Station Data, see tN2kMeteorlogicalStationData

Definition at line 2005 of file N2kMessages.cpp.

◆ ParseN2kPGN130576()

bool ParseN2kPGN130576 ( const tN2kMsg N2kMsg,
int8_t &  PortTrimTab,
int8_t &  StbdTrimTab 
)

Parsing the content of message PGN 130576 "Trim Tab Status".

Provides data on various small craft control surfaces and speed through the water. Used primarily by display or instrumentation. Trim tab position is a percentage 0 to 100% where 0 is fully retracted and 100 is fully extended.

Parameters
N2kMsgReference to a N2kMsg Object,
PortTrimTabPort trim tab position
StbdTrimTabStarboard trim tab position
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 2043 of file N2kMessages.cpp.

◆ ParseN2kPGN130577()

bool ParseN2kPGN130577 ( const tN2kMsg N2kMsg,
tN2kDataMode DataMode,
tN2kHeadingReference CogReference,
unsigned char &  SID,
double &  COG,
double &  SOG,
double &  Heading,
double &  SpeedThroughWater,
double &  Set,
double &  Drift 
)

Parsing the content of message PGN 130577 "Direction Data".

The purpose of this PGN is to group three fundamental vectors related to vessel motion, speed and heading referenced to the water, speed and course referenced to ground and current speed and flow direction.

Parameters
N2kMsgReference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
DataModeData mode, see tN2kDataMode
CogReferenceTrue or Magnetic
SIDSequence ID. Normally you can just forget its value. See SID.
COGCourse Over Ground in radians
SOGSpeed Over Ground in m/s
HeadingHeading in radians
SpeedThroughWaterSpeed through water in m/s
SetSet in radians
Driftdrift in m/s
Returns
true Parsing of PGN Message successful
false Parsing of PGN Message aborted

Definition at line 2083 of file N2kMessages.cpp.

◆ ParseN2kPGNSatellitesInView() [1/2]

bool ParseN2kPGNSatellitesInView ( const tN2kMsg N2kMsg,
uint8_t  SVIndex,
tSatelliteInfo SatelliteInfo 
)
inline

Parsing the content of a "GNSS Satellites in View" message - PGN 129540.

Alias of PGN 129540. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN129540

Definition at line 4264 of file N2kMessages.h.

◆ ParseN2kPGNSatellitesInView() [2/2]

bool ParseN2kPGNSatellitesInView ( const tN2kMsg N2kMsg,
unsigned char &  SID,
tN2kRangeResidualMode Mode,
uint8_t &  NumberOfSVs 
)
inline

Parsing the content of a "GNSS Satellites in View" message - PGN 129540.

Alias of PGN 129540. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN129540

Definition at line 4252 of file N2kMessages.h.

◆ ParseN2kPositionRapid()

bool ParseN2kPositionRapid ( const tN2kMsg N2kMsg,
double &  Latitude,
double &  Longitude 
)
inline

Parsing the content of a "Position, Rapid Update" message - PGN 129025.

Alias of PGN 129025. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN129025

Definition at line 2954 of file N2kMessages.h.

◆ ParseN2kPressure()

bool ParseN2kPressure ( const tN2kMsg N2kMsg,
unsigned char &  SID,
unsigned char &  PressureInstance,
tN2kPressureSource PressureSource,
double &  Pressure 
)
inline

Parsing the content of a "Actual Pressure" message - PGN 130314.

Alias of PGN 130314. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN130314

Definition at line 5171 of file N2kMessages.h.

◆ ParseN2kRateOfTurn()

bool ParseN2kRateOfTurn ( const tN2kMsg N2kMsg,
unsigned char &  SID,
double &  RateOfTurn 
)
inline

Parsing the content of a "Rate of Turn" message - PGN 127251.

Alias of PGN 127251. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN127251

Definition at line 847 of file N2kMessages.h.

◆ ParseN2kRudder() [1/2]

bool ParseN2kRudder ( const tN2kMsg N2kMsg,
double &  RudderPosition 
)
inline

Parsing the content of a "Rudder" message - PGN 127245.

Alias of PGN 127245. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN127245

Definition at line 704 of file N2kMessages.h.

◆ ParseN2kRudder() [2/2]

bool ParseN2kRudder ( const tN2kMsg N2kMsg,
double &  RudderPosition,
unsigned char &  Instance,
tN2kRudderDirectionOrder RudderDirectionOrder,
double &  AngleOrder 
)
inline

Parsing the content of a "Rudder" message - PGN 127245.

Alias of PGN 127245. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN127245

Definition at line 691 of file N2kMessages.h.

◆ ParseN2kSystemTime()

bool ParseN2kSystemTime ( const tN2kMsg N2kMsg,
unsigned char &  SID,
uint16_t &  SystemDate,
double &  SystemTime,
tN2kTimeSource TimeSource 
)
inline

Parsing the content of a "System date/time" message - PGN 126992.

Alias of PGN 126992. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN126992

Definition at line 238 of file N2kMessages.h.

◆ ParseN2kTemperature()

bool ParseN2kTemperature ( const tN2kMsg N2kMsg,
unsigned char &  SID,
unsigned char &  TempInstance,
tN2kTempSource TempSource,
double &  ActualTemperature,
double &  SetTemperature 
)
inline

Parsing the content of a "Temperature - DEPRECATED" message - PGN 130312.

Alias of PGN 130312. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN130312

Definition at line 5006 of file N2kMessages.h.

◆ ParseN2kTemperatureExt()

bool ParseN2kTemperatureExt ( const tN2kMsg N2kMsg,
unsigned char &  SID,
unsigned char &  TempInstance,
tN2kTempSource TempSource,
double &  ActualTemperature,
double &  SetTemperature 
)
inline

Parsing the content of a "Temperature, Extended Range" message - PGN 130316.

Alias of PGN 130316. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN130316

Definition at line 5286 of file N2kMessages.h.

◆ ParseN2kTransmissionParameters() [1/2]

bool ParseN2kTransmissionParameters ( const tN2kMsg N2kMsg,
unsigned char &  EngineInstance,
tN2kTransmissionGear TransmissionGear,
double &  OilPressure,
double &  OilTemperature,
bool &  flagCheck,
bool &  flagOverTemp,
bool &  flagLowOilPressure,
bool &  flagLowOilLevel,
bool &  flagSailDrive 
)
inline

Parsing the content of a "Transmission parameters, dynamic" message - PGN 127493.

Alias of PGN 127493. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN127493

Definition at line 1500 of file N2kMessages.h.

◆ ParseN2kTransmissionParameters() [2/2]

bool ParseN2kTransmissionParameters ( const tN2kMsg N2kMsg,
unsigned char &  EngineInstance,
tN2kTransmissionGear TransmissionGear,
double &  OilPressure,
double &  OilTemperature,
unsigned char &  DiscreteStatus1 
)
inline

Parsing the content of a "Transmission parameters, dynamic" message - PGN 127493.

Alias of PGN 127493. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN127493

Definition at line 1487 of file N2kMessages.h.

◆ ParseN2kTrimTab()

bool ParseN2kTrimTab ( const tN2kMsg N2kMsg,
int8_t &  PortTrimTab,
int8_t &  StbdTrimTab 
)
inline

Parsing the content of a "Trim Tab Status" message - PGN 130576.

Alias of PGN 130576. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN130576

Definition at line 5476 of file N2kMessages.h.

◆ ParseN2kWaterDepth() [1/2]

bool ParseN2kWaterDepth ( const tN2kMsg N2kMsg,
unsigned char &  SID,
double &  DepthBelowTransducer,
double &  Offset 
)
inline

Parsing the content of a "Water depth" message - PGN 128267.

Alias of PGN 128267. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN128267

Definition at line 2466 of file N2kMessages.h.

◆ ParseN2kWaterDepth() [2/2]

bool ParseN2kWaterDepth ( const tN2kMsg N2kMsg,
unsigned char &  SID,
double &  DepthBelowTransducer,
double &  Offset,
double &  Range 
)
inline

Parsing the content of a "Water depth" message - PGN 128267.

Alias of PGN 128267. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN128267

Definition at line 2479 of file N2kMessages.h.

◆ ParseN2kWindSpeed()

bool ParseN2kWindSpeed ( const tN2kMsg N2kMsg,
unsigned char &  SID,
double &  WindSpeed,
double &  WindAngle,
tN2kWindReference WindReference 
)
inline

Parsing the content of a "Wind Data" message - PGN 130306.

Alias of PGN 130306. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN130306

Definition at line 4755 of file N2kMessages.h.

◆ ParseN2kXTE()

bool ParseN2kXTE ( const tN2kMsg N2kMsg,
unsigned char &  SID,
tN2kXTEMode XTEMode,
bool &  NavigationTerminated,
double &  XTE 
)
inline

Parsing the content of a "Cross Track Error" message - PGN 129283.

Alias of PGN 129283. This alias was introduced to improve the readability of the source code. See parameter details on ParseN2kPGN129283

Definition at line 3838 of file N2kMessages.h.