NMEA2000 Library
0.1
Library to handle NMEA 2000 Communication written in C++
|
List of functions which parse the data content of tN2kMsg objects. More...
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... | |
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.
|
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.
|
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.
|
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.
|
inline |
Parsing the content of a "AIS position reports for Class B" message - PGN 129039.
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
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.
N2kMsg | N2kMsg Object, Output: NMEA2000 message ready to be send. |
SID | Sequence ID. Normally you can just forget its value. See SID. |
SystemDate | Systemdate in days since 1970-01-01 (UTC) |
SystemTime | System time seconds since midnight (UTC) |
TimeSource | Source of the Systemtime |
Definition at line 39 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, |
SID | Sequence ID. Normally you can just forget its value. See SID. |
MobEmitterId | Identifier for each MOB emitter, unique to the vessel |
MOBStatus | MOB Status |
ActivationTime | Time of day (UTC) when MOB was activated |
PositionSource | Position Source |
PositionDate | Date of MOB position |
PositionTime | Time of day of MOB position (UTC) |
Latitude | Latitude in degrees |
Longitude | Longitude in degrees |
COGReference | True or Magnetic |
COG | Course Over Ground in radians |
SOG | Speed Over Ground in m/s |
MMSI | MMSI |
MOBEmitterBatteryStatus | Battery status |
Definition at line 121 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, |
RudderLimitExceeded | Yes/No |
OffHeadingLimitExceeded | Yes/No |
OffTrackLimitExceeded | Yes/No |
Override | Yes/No |
SteeringMode | Steering mode |
TurnMode | Turn mode |
HeadingReference | True or Magnetic |
CommandedRudderDirection | Port or Starboard |
CommandedRudderAngle | In radians |
HeadingToSteerCourse | In radians |
Track | In radians |
RudderLimit | In radians |
OffHeadingLimit | In radians |
RadiusOfTurnOrder | In meter |
RateOfTurnOrder | In radians/s |
OffTrackLimit | In meters |
VesselHeading | in radians |
Definition at line 207 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send. |
RudderPosition | Current rudder postion in radians. |
Instance | Rudder instance. |
RudderDirectionOrder | Direction, where rudder should be turned. |
AngleOrder | In radians angle where rudder should be turned. |
Definition at line 266 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, |
SID | Sequence ID. Normally you can just forget its value. See SID. |
Heading | Heading in radians |
Deviation | Magnetic deviation in radians. Use N2kDoubleNA for undefined value. |
Variation | Heading reference. See definition of tN2kHeadingReference. |
ref | Heading reference. See definition of tN2kHeadingReference. |
Definition at line 291 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, |
SID | Sequence ID. Normally you can just forget its value. See SID. |
RateOfTurn | Change in heading in radians per second |
Definition at line 317 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, |
SID | Sequence ID. Normally you can just forget its value. See SID. |
Heave | Vertical displacement perpendicular to the earth’s surface in meters |
Delay | Delay added by calculations in seconds |
DelaySource | Delay Source, see tN2kDelaySource |
Definition at line 349 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, |
SID | Sequence ID. Normally you can just forget its value. See SID. |
Yaw | Heading in radians. |
Pitch | Pitch in radians. Positive, when your bow rises. |
Roll | Roll in radians. Positive, when tilted right. |
Definition at line 380 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, |
SID | Sequence ID. Normally you can just forget its value. See SID. |
Source | How was the variation value generated |
DaysSince1970 | Days since January 1, 1970 |
Variation | Magnetic variation/declination in radians |
Definition at line 404 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, |
EngineInstance | Engine instance. |
EngineSpeed | RPM (Revolutions Per Minute) |
EngineBoostPressure | in Pascal |
EngineTiltTrim | in % |
Definition at line 430 of file N2kMessages.cpp.
|
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.
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.
N2kMsg | Reference to a N2kMsg Object, |
EngineInstance | Engine instance |
EngineOilPress | in Pascal |
EngineOilTemp | in Kelvin |
EngineCoolantTemp | in Kelvin |
AltenatorVoltage | in Voltage |
FuelRate | in litres/hour |
EngineHours | in seconds |
EngineCoolantPress | in Pascal |
EngineFuelPress | in Pascal |
EngineLoad | in % |
EngineTorque | in % |
Status1 | Engine Discrete Status 1 tN2kEngineDiscreteStatus1 |
Status2 | Engine Discrete Status 2 tN2kEngineDiscreteStatus2 |
Definition at line 469 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, |
EngineInstance | Engine instance. |
TransmissionGear | Selected transmission. tN2kTransmissionGear |
OilPressure | in Pascal |
OilTemperature | in Kelvin |
DiscreteStatus1 | in % |
Definition at line 511 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, |
EngineInstance | Engine instance |
TripFuelUsed | in litres |
FuelRateAverage | in litres/hour |
FuelRateEconomy | in litres/hour |
InstantaneousFuelEconomy | in litres/hour |
Definition at line 540 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send. |
DeviceBankInstance | Device or Bank Instance |
BankStatus | Full bank status. Read single status by using N2kGetStatusOnBinaryStatus |
Definition at line 624 of file N2kMessages.cpp.
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".
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.
N2kMsg | Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send. |
DeviceBankInstance | Device or Bank Instance |
Status1 | On/Off for Status1 |
Status2 | On/Off for Status2 |
Status3 | On/Off for Status3 |
Status4 | On/Off for Status4 |
Definition at line 604 of file N2kMessages.cpp.
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.
N2kMsg | Reference to the N2kMsg object to be parsed. If this contains a valid PGN 127502 message then the following return values will be set. |
TargetBankInstance | Instance number of the switchbank that was targetted by this switchbank control message. |
BankStatus | The binary status component of the switchbank control containing the commanded state of channels on the target switchbank. |
Definition at line 638 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, |
Instance | Tank instance. Different devices handles this a bit differently. So it is best to have instance unique over |
FluidType | Defines type of fluid. See definition of tN2kFluidType |
Level | Tank level in % of full tank. |
Capacity | Tank Capacity in litres |
Definition at line 670 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, |
SID | Sequence ID. Normally you can just forget its value. See SID. |
DCInstance | DC instance |
DCType | Defines type of DC source. See definition of tN2kDCType |
StateOfCharge | % of charge |
StateOfHealth | % of health |
TimeRemaining | Time remaining in seconds |
RippleVoltage | DC output voltage ripple in V |
Capacity | Battery capacity in coulombs |
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.
N2kMsg | Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send. |
Instance | ChargerInstance |
BatteryInstance | BatteryInstance |
ChargeState | see tN2kChargeState |
ChargerMode | see tN2kChargerMode |
Enabled | set tN2kOnOff |
EqualizationPending | set tN2kOnOff |
EqualizationTimeRemaining | double seconds |
Definition at line 741 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send. |
BatteryInstance | BatteryInstance. |
BatteryVoltage | Battery voltage in V |
BatteryCurrent | Current in A |
BatteryTemperature | Battery temperature in K. Use function CToKelvin, if you want to use °C. |
SID | Sequence ID. Normally you can just forget its value. See SID. |
Definition at line 775 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send. |
BatInstance | BatteryInstance |
BatType | Type of battery. See tN2kBatType |
SupportsEqual | Supports equalization. See tN2kBatEqSupport |
BatNominalVoltage | Battery nominal voltage. See tN2kBatNomVolt |
BatChemistry | Battery Chemistry See tN2kBatChem |
BatCapacity | Battery capacity in Coulombs. Use AhToCoulombs, if you have your value in Ah. |
BatTemperatureCoefficient | Battery temperature coefficient in % |
PeukertExponent | Peukert Exponent |
ChargeEfficiencyFactor | Charge efficiency factor |
Definition at line 806 of file N2kMessages.cpp.
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.
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
N2kMsg | Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send. |
SID | Sequence ID. Normally you can just forget its value. See SID. |
Leeway | Positive angles indicate slippage to starboard, that is, the vessel is tracking to the right of its heading, and negative angles indicate slippage to port |
Definition at line 837 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send. |
SID | Sequence ID. Normally you can just forget its value. See SID. |
WaterReferenced | Speed over water in m/s |
GroundReferenced | Speed over Ground in m/s |
SWRT | Type of transducer. See tN2kSpeedWaterReferenceType |
Definition at line 861 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send. |
SID | Sequence ID. Normally you can just forget its value. See SID. |
DepthBelowTransducer | Water depth below transducer in meters |
Offset | Distance in meters between transducer and water surface (positive) or transducer and keel (negative) |
Range | maximum depth range tha can be measured |
Definition at line 885 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, |
DaysSince1970 | Timestamp |
SecondsSinceMidnight | Timestamp |
Log | This field indicates the total distance traveled through the water since the device was installed in units of 1 m. |
TripLog | This field indicates the total distance traveled through the water since last reset in units of 1 m. |
Definition at line 908 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, |
SID | Sequence ID. Normally you can just forget its value. See SID. |
WindlassIdentifier | Unique Identifier of a function within a Virtual Device: 0 - 255 |
WindlassDirectionControl | see tN2kWindlassDirectionControl |
SpeedControl | Single speed 0=off, 1-100=on; Dual speed: 0=off, 1-49=slow, 50-100=fast; Proporional speed: 0=off, 1-100=speed |
SpeedControlType | see tN2kSpeedType |
AnchorDockingControl | see tN2kGenericStatusPair |
PowerEnable | see tN2kGenericStatusPair |
MechanicalLock | see tN2kGenericStatusPair |
DeckAndAnchorWash | see tN2kGenericStatusPair |
AnchorLight | see tN2kGenericStatusPair |
CommandTimeout | range 0.25 ... 1.26sec -> If timeout elapses the thruster stops operating and reverts to static mode. |
WindlassControlEvents | see tN2kWindlassControlEvents -> Events are cleared when the condition is no longer true, or by manually resetting using the Command Group Function (PGN 126208). |
Definition at line 952 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, |
SID | Sequence ID. Normally you can just forget its value. See SID. |
WindlassIdentifier | Unique Identifier of a function within a Virtual Device: 0 - 255 |
RodeCounterValue | amount of rode deployed in meters |
WindlassLineSpeed | Amount of rode deployed or retrieved per minute. |
WindlassMotionStatus | Indicates current physical state of windlass movement. see tN2kWindlassMotionStates |
RodeTypeStatus | Indicates whether chain or rope is currently being deployed or retrieved. see tN2kRodeTypeStates |
AnchorDockingStatus | Indicates current physical state of anchor docking. Used in automatic docking situations to report when the anchor has been fully docked. |
WindlassOperatingEvents | see tN2kWindlassOperatingEvents |
Definition at line 1012 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send. |
SID | Sequence ID. Normally you can just forget its value. See SID. |
WindlassIdentifier | Unique Identifier of a function within a Virtual Device: 0 - 255 |
TotalMotorTime | Total time windlass has operated since last reset in seconds |
ControllerVoltage | Supply voltage of electronic windlass controller in Volt |
MotorCurrent | Load current of electric windlass motor in Ampere |
WindlassMonitoringEvents | Events are cleared when the condition is no longer true, or by manually resetting using the Command Group Function (PGN 126208). see tN2kWindlassMonitoringEvents |
Definition at line 1063 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, |
Latitude | Latitude in degrees |
Longitude | Longitude in degrees |
Definition at line 1092 of file N2kMessages.cpp.
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).
N2kMsg | Reference to a N2kMsg Object, |
SID | Sequence ID. Normally you can just forget its value. See SID. |
ref | COG reference, see tN2kHeadingReference |
COG | Course Over Ground in radians |
SOG | Speed Over Ground in m/s |
Definition at line 1115 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, |
SID | Sequence ID. Normally you can just forget its value. See SID. |
DaysSince1970 | UTC Date in resolution of 1 day (The number of days since January 1, 1970). |
SecondsSinceMidnight | UTC time second since midnight |
Latitude | Latitude in degrees ("-" = south, “+” = north) |
Longitude | Longitude in degrees ("-" = west, “+” = east) |
Altitude | Altitude referenced to WGS-84 in meters |
GNSStype | GNSS type. See tN2kGNSStype |
GNSSmethod | GNSS method type. See tN2kGNSSmethod |
nSatellites | Indicate the number of satellites used for data |
HDOP | Horizontal Dilution Of Precision in meters. |
PDOP | Probable dilution of precision in meters. |
GeoidalSeparation | Geoidal separation in meters |
nReferenceStations | Number of Reference Stations |
ReferenceStationType | Reference Station Type, see N2kGNSSt_GPS |
ReferenceSationID | Reference Station ID |
AgeOfCorrection | Age of DGNSS Corrections |
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.
N2kMsg | Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send. |
DaysSince1970 | UTC Date in resolution of 1 day (The number of days since January 1, 1970). |
SecondsSinceMidnight | Seconds since midnight |
LocalOffset | Local offset in minutes |
Definition at line 1208 of file N2kMessages.cpp.
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).
N2kMsg | Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send. |
MessageID | Message Type ID according to e ITU-R M.1371 |
Repeat | Repeat 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 |
UserID | MMSI number |
Latitude | latitude of position degree |
Longitude | longitude of position degree |
Accuracy | {bool} position accuracy
|
RAIM | {bool}Receiver autonomous integrity monitoring (RAIM) flag of electronic position fixing device
|
Seconds | 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) |
COG | Course over ground |
SOG | Speed over ground |
Heading | heading |
ROT | Rate of turn |
NavStatus | Navigational status, see tN2kAISNavStatus |
Definition at line 1353 of file N2kMessages.cpp.
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).
N2kMsg | Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send. |
MessageID | Message Type ID according to e ITU-R M.1371 |
Repeat | Repeat 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 |
UserID | MMSI number |
Latitude | latitude of position degree |
Longitude | longitude of position degree |
Accuracy | {bool} position accuracy
|
RAIM | {bool}Receiver autonomous integrity monitoring (RAIM) flag of electronic position fixing device
|
Seconds | TimeStamp 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) |
COG | Course over ground |
SOG | Speed over ground |
AISTransceiverInformation | AIS Transceiver Information, see tN2kAISTransceiverInformation |
Heading | Heading |
Unit | Class B unit flag, see tN2kAISUnit |
Display | Class B display flag,
|
DSC | Class B DSC flag
|
Band | Class B band flag
|
Msg22 | Class B Message22 flag
|
Mode | Station Operating Mode flag, see tN2kAISMode |
State | Communication State Selector Flag
|
Definition at line 1409 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send. |
N2kData | structure that consists all relevant data, see tN2kAISAtoNReportData |
Definition at line 1466 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send. |
SID | Sequence ID. Normally you can just forget its value. See SID. |
XTEMode | CrossTrackError Mode, see tN2kXTEMode |
NavigationTerminated | {bool] Navigation has been terminated |
XTE | CrossTrackError in meter |
Definition at line 1506 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send. |
SID | Sequence ID. Normally you can just forget its value. See SID. |
DistanceToWaypoint | Distance to Destination Waypoint |
BearingReference | Course / Bearing Reference, see tN2kHeadingReference |
PerpendicularCrossed | {bool}Perpendicular Crossed |
ArrivalCircleEntered | {bool}Arrival Circle Entered |
CalculationType | Calculation Type, see tN2kDistanceCalculationType |
ETATime | Estimated Time at Arrival - Time |
ETADate | Estimated Time at Arrival - Date |
BearingOriginToDestinationWaypoint | Bearing, Origin To Destination Waypoint |
BearingPositionToDestinationWaypoint | Bearing, Position To Destination Waypoint |
OriginWaypointNumber | Origin Waypoint Number |
DestinationWaypointNumber | Destination Waypoint Number |
DestinationLatitude | Destination Wpt Latitude |
DestinationLongitude | Destination Wpt Longitude |
WaypointClosingVelocity | Waypoint Closing Velocity |
Definition at line 1543 of file N2kMessages.cpp.
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).
N2kMsg | Reference to a N2kMsg Object, |
SID | Sequence ID. Normally you can just forget its value. See SID. |
DesiredMode | Desired Dilution Of Precision mode, see tN2kGNSSDOPmode |
ActualMode | Actual Dilution Of Precision mode. see tN2kGNSSDOPmode |
HDOP | Horizontal Dilution Of Precision in meters. |
VDOP | Probable dilution of precision in meters. |
TDOP | Time dilution of precision |
Definition at line 1233 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, |
SVIndex | Index of saellite info requested. |
SatelliteInfo | Requested satellite info |
Definition at line 1299 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, |
SID | Sequence ID. Normally you can just forget its value. See SID. |
Mode | Range residual mode, see tN2kRangeResidualMode |
NumberOfSVs | Number of satellite infos in message. |
Definition at line 1287 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send. |
MessageID | Message Type ID according to e ITU-R M.1371 |
Repeat | Repeat indicator, Used by the repeater to indicate how many times a message has been repeated. see tN2kAISRepeat |
UserID | MMSI Number |
IMOnumber | Ship identification number by IMO [1 .. 999999999]; 0 = not available = default Not applicable to SAR aircraft |
Callsign | Call Sign |
CallsignBufSize | size of Callsign buffer |
Name | Name 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 |
NameBufSize | size of Name buffer |
VesselType | Vessel 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 |
Length | Length/Diameter in meters |
Beam | Beam/Diameter in meters |
PosRefStbd | Position Reference Point from Starboard |
PosRefBow | Position Reference Point from the Bow |
ETAdate | EstimatedTimeOfArrival - Days since 1970-01-01 (UTC) |
ETAtime | EstimatedTimeOfArrival -seconds since midnight (UTC) |
Draught | Maximum present static draught |
Destination | Destination - Maximum 20 characters using 6-bit ASCII |
DestinationBufSize | size of Destination buffer |
AISversion | AIS version, see tN2kAISVersion |
GNSStype | Type of GNSS, see tN2kGNSStype |
DTE | Data terminal equipment (DTE) ready
|
AISinfo | AIS Transceiver Information, see tN2kAISTransceiverInformation |
Definition at line 1640 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send. |
MessageID | Message type |
Repeat | Repeat indicator |
SourceID | MMSI |
AISTransceiverInformation | Transceiver Information |
SafetyRelatedText | Safety related Text of the Broadcast communication |
SafetyRelatedTextMaxSize | size of SafetyRelatedText |
Definition at line 66 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send. |
MessageID | Message Type ID according to e ITU-R M.1371 |
Repeat | Repeat indicator, Used by the repeater to indicate how many times a message has been repeated. see tN2kAISRepeat |
UserID | MMSI Number |
Name | Name 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) |
NameBufSize | size of Name buffer |
Definition at line 1682 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send. |
MessageID | Message Type ID according to e ITU-R M.1371 |
Repeat | Repeat indicator, Used by the repeater to indicate how many times a message has been repeated. see tN2kAISRepeat |
UserID | MMSI Number |
VesselType | Vessel 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 |
Vendor | Unique identification of the Unit by a number as defined by the manufacturer |
VendorBufSize | size of Vendor buffer |
Callsign | Call Sign |
CallsignBufSize | size of Callsign buffer |
Length | Length/Diameter in meters |
Beam | Beam/Diameter in meters |
PosRefStbd | Position Reference Point from Starboard |
PosRefBow | Position Reference Point from the Bow |
MothershipID | MMSI of the mothership |
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.
N2kMsg | Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send. |
SID | Sequence ID. Normally you can just forget its value. See SID. |
WindSpeed | Measured wind speed in m/s |
WindAngle | Measured wind angle in radians. If you have value in degrees, use function DegToRad() in call. |
WindReference | Wind reference, see definition of tN2kWindReference |
Definition at line 1799 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send. |
SID | Sequence ID. Normally you can just forget its value. See SID. |
WaterTemperature | Water temperature in K. Use CToKelvin, if you want to use °C. |
OutsideAmbientAirTemperature | Outside ambient temperature in K.Use CToKelvin, if you want to use °C. |
AtmosphericPressure | Atmospheric pressure in Pascals. Use mBarToPascal, if you like to use mBar |
Definition at line 1823 of file N2kMessages.cpp.
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".
N2kMsg | Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send. |
SID | Sequence ID. Normally you can just forget its value. See SID. |
TempSource | see tN2kTempSource |
Temperature | Temperature in K. Use CToKelvin, if you want to use °C. |
HumiditySource | see tN2kHumiditySource. |
Humidity | Humidity in % |
AtmosphericPressure | Atmospheric pressure in Pascals. Use mBarToPascal, if you like to use mBar |
Definition at line 1849 of file N2kMessages.cpp.
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".
N2kMsg | Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send. |
SID | Sequence ID. Normally you can just forget its value. See SID. |
TempInstance | This should be unique at least on one device. May be best to have it unique over all devices sending this PGN. |
TempSource | see tN2kTempSource |
ActualTemperature | Temperature in K. Use CToKelvin, if you want to use °C. |
SetTemperature | Temperature 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. |
Definition at line 1878 of file N2kMessages.cpp.
|
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.
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.
N2kMsg | Reference to a N2kMsg Object, |
SID | Sequence ID. Normally you can just forget its value. See SID. |
HumidityInstance | This should be unique at least on one device. May be best to have it unique over all devices sending this PGN. |
HumiditySource | source of measurement, see tN2kHumiditySource |
ActualHumidity | Humidity in percent |
SetHumidity | Set value of Humidity in percent |
Definition at line 1906 of file N2kMessages.cpp.
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
N2kMsg | Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send. |
SID | Sequence ID. Normally you can just forget its value. See SID. |
PressureInstance | This should be unique at least on one device. May be best to have it unique over all devices sending this PGN. |
PressureSource | source of measurement, see tN2kPressureSource |
Pressure | actual in Pascals. Use function mBarToPascal, if you like to use mBar |
Definition at line 1932 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send. |
SID | Sequence ID. Normally you can just forget its value. See SID. |
TempInstance | This should be unique at least on one device. May be best to have it unique over all devices sending this PGN. |
TempSource | source of measurement, see tN2kTempSource |
ActualTemperature | Actual Temperature in K. Use CToKelvin, if you want to use °C. |
SetTemperature | Set Temperature in K. Use CToKelvin, if you want to use °C. |
Definition at line 1971 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, |
N2kData | Meterological Station Data, see tN2kMeteorlogicalStationData |
Definition at line 2005 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, |
PortTrimTab | Port trim tab position |
StbdTrimTab | Starboard trim tab position |
Definition at line 2043 of file N2kMessages.cpp.
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.
N2kMsg | Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send. |
DataMode | Data mode, see tN2kDataMode |
CogReference | True or Magnetic |
SID | Sequence ID. Normally you can just forget its value. See SID. |
COG | Course Over Ground in radians |
SOG | Speed Over Ground in m/s |
Heading | Heading in radians |
SpeedThroughWater | Speed through water in m/s |
Set | Set in radians |
Drift | drift in m/s |
Definition at line 2083 of file N2kMessages.cpp.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.