List of functions which sets up the data of tN2kMsg objects so that it can be send out to the bus. More...

Collaboration diagram for Setting up tN2kMsg objects:

Classes
struct	tSatelliteInfo
	Dedicated structure to handle GNSS satellite information. More...

Functions
bool	AppendN2kPGN129285 (tN2kMsg &N2kMsg, uint16_t WPID, const char *WPName, double Latitude, double Longitude)
	Append another Waypoint to PGN 129285 "Route/WP information". More...

bool	AppendN2kPGN129540 (tN2kMsg &N2kMsg, const tSatelliteInfo &SatelliteInfo)
	Append a new satellite info to PGN 129540 Message "GNSS Satellites in View". More...

bool	AppendN2kPGN130074 (tN2kMsg &N2kMsg, uint16_t ID, char *Name, double Latitude, double Longitude)
	Append a Waypoint to PGN 130074 Message " Route and WP Service - WP List - WP Name & Position". More...

bool	AppendN2kRouteWPInfo (tN2kMsg &N2kMsg, uint16_t WPID, const char *WPName, double Latitude, double Longitude)
	Append another Waypoint to "Route/WP information"- PGN 129285. More...

bool	AppendN2kWaypointList (tN2kMsg &N2kMsg, uint16_t ID, char *Name, double Latitude, double Longitude)
	Append a Waypoint to Message "Route and WP Service - WP List - WP Name & Position" - PGN 130074. More...

bool	ParseN2kSwitchbankControl (const tN2kMsg &N2kMsg, unsigned char &TargetBankInstance, tN2kBinaryStatus &BankStatus)
	Parse PGN 127502 "Switch Bank Control" message. More...

void	SetN2kAISAtoNReport (tN2kMsg &N2kMsg, const tN2kAISAtoNReportData &N2kData)
	Setting up Message "AIS Aids to Navigation (AtoN) Report" - PGN 129041. More...

void	SetN2kAISClassAPosition (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, double ROT, tN2kAISNavStatus NavStatus)
	Setting up Message "AIS position reports for Class A" - PGN 129038. More...

void	SetN2kAISClassAStatic (tN2kMsg &N2kMsg, uint8_t MessageID, tN2kAISRepeat Repeat, uint32_t UserID, uint32_t IMOnumber, const char Callsign, const char Name, uint8_t VesselType, double Length, double Beam, double PosRefStbd, double PosRefBow, uint16_t ETAdate, double ETAtime, double Draught, char const *Destination, tN2kAISVersion AISversion, tN2kGNSStype GNSStype, tN2kAISDTE DTE, tN2kAISTransceiverInformation AISinfo)
	Setting up Message "AIS static data class A" - PGN 129794. More...

void	SetN2kAISClassBPosition (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)
	Setting up Message "AIS position reports for Class B" - PGN 129039 [DEPRECATED]. More...

void	SetN2kAISClassBPosition (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, unsigned char SID=0xff)
	Setting up Message "AIS position reports for Class B" - PGN 129039 (Latest inline version) More...

void	SetN2kAISClassBStaticPartA (tN2kMsg &N2kMsg, uint8_t MessageID, tN2kAISRepeat Repeat, uint32_t UserID, const char *Name)
	Setting up Message "AIS static data class B part A" - PGN 129809. More...

void	SetN2kAISClassBStaticPartB (tN2kMsg &N2kMsg, uint8_t MessageID, tN2kAISRepeat Repeat, uint32_t UserID, uint8_t VesselType, const char Vendor, const char Callsign, double Length, double Beam, double PosRefStbd, double PosRefBow, uint32_t MothershipID)
	Setting up Message "AIS static data class B part B" - PGN 129810. More...

void	SetN2kAISSafetyRelatedBroadcastMsg (tN2kMsg &N2kMsg, uint8_t MessageID, tN2kAISRepeat Repeat, uint32_t SourceID, tN2kAISTransceiverInformation AISTransceiverInformation, char *SafetyRelatedText)
	Setting up Message "AIS Safety Related Broadcast Message" - PGN 129802. More...

void	SetN2kAttitude (tN2kMsg &N2kMsg, unsigned char SID, double Yaw, double Pitch, double Roll)
	Setting up Message "Attitude" - PGN 127257. More...

void	SetN2kBatConf (tN2kMsg &N2kMsg, unsigned char BatInstance, tN2kBatType BatType, tN2kBatEqSupport SupportsEqual, tN2kBatNomVolt BatNominalVoltage, tN2kBatChem BatChemistry, double BatCapacity, int8_t BatTemperatureCoefficient, double PeukertExponent, int8_t ChargeEfficiencyFactor)
	Setting up Message "Battery Configuration Status" - PGN 127513. More...

void	SetN2kBinaryStatus (tN2kMsg &N2kMsg, unsigned char DeviceBankInstance, tN2kBinaryStatus BankStatus)
	Setting up Message "Universal Binary Status Report" - PGN 127501. More...

void	SetN2kBinaryStatus (tN2kMsg &N2kMsg, unsigned char DeviceBankInstance, tN2kOnOff Status1, tN2kOnOff Status2=N2kOnOff_Unavailable, tN2kOnOff Status3=N2kOnOff_Unavailable, tN2kOnOff Status4=N2kOnOff_Unavailable)
	Setting up Message "Universal Binary Status Report" - PGN 127501. More...

void	SetN2kBoatSpeed (tN2kMsg &N2kMsg, unsigned char SID, double WaterReferenced, double GroundReferenced=N2kDoubleNA, tN2kSpeedWaterReferenceType SWRT=N2kSWRT_Paddle_wheel)
	Setting up Message "Boat Speed, Water Referenced" - PGN 128259. More...

void	SetN2kChargerStatus (tN2kMsg &N2kMsg, unsigned char Instance, unsigned char BatteryInstance, tN2kChargeState ChargeState, tN2kChargerMode ChargerMode=N2kCM_Standalone, tN2kOnOff Enabled=N2kOnOff_On, tN2kOnOff EqualizationPending=N2kOnOff_Unavailable, double EqualizationTimeRemaining=N2kDoubleNA)
	Setting up Message "DC Charger Status" - PGN 127507. More...

void	SetN2kCOGSOGRapid (tN2kMsg &N2kMsg, unsigned char SID, tN2kHeadingReference ref, double COG, double SOG)
	Setting up Message "COG SOG rapid update" - PGN 129026. More...

void	SetN2kDCBatStatus (tN2kMsg &N2kMsg, unsigned char BatteryInstance, double BatteryVoltage, double BatteryCurrent=N2kDoubleNA, double BatteryTemperature=N2kDoubleNA, unsigned char SID=1)
	Setting up Message "Battery Status" - PGN 127508. More...

void	SetN2kDCStatus (tN2kMsg &N2kMsg, unsigned char SID, unsigned char DCInstance, tN2kDCType DCType, unsigned char StateOfCharge, unsigned char StateOfHealth, double TimeRemaining, double RippleVoltage=N2kDoubleNA, double Capacity=N2kDoubleNA)
	Setting up Message "DC Detailed Status" - PGN 127506. More...

void	SetN2kDirectionData (tN2kMsg &N2kMsg, tN2kDataMode DataMode, tN2kHeadingReference CogReference, unsigned char SID, double COG, double SOG, double Heading, double SpeedThroughWater, double Set, double Drift)
	Setting up Message "Direction Data" - PGN 130577. More...

void	SetN2kDistanceLog (tN2kMsg &N2kMsg, uint16_t DaysSince1970, double SecondsSinceMidnight, uint32_t Log, uint32_t TripLog)
	Setting up Message "Distance log" - PGN 128275. More...

void	SetN2kEngineDynamicParam (tN2kMsg &N2kMsg, unsigned char EngineInstance, double EngineOilPress, double EngineOilTemp, double EngineCoolantTemp, double AltenatorVoltage, double FuelRate, double EngineHours, double EngineCoolantPress=N2kDoubleNA, double EngineFuelPress=N2kDoubleNA, int8_t EngineLoad=N2kInt8NA, int8_t EngineTorque=N2kInt8NA, bool flagCheckEngine=false, bool flagOverTemp=false, bool flagLowOilPress=false, bool flagLowOilLevel=false, bool flagLowFuelPress=false, bool flagLowSystemVoltage=false, bool flagLowCoolantLevel=false, bool flagWaterFlow=false, bool flagWaterInFuel=false, bool flagChargeIndicator=false, bool flagPreheatIndicator=false, bool flagHighBoostPress=false, bool flagRevLimitExceeded=false, bool flagEgrSystem=false, bool flagTPS=false, bool flagEmergencyStopMode=false, bool flagWarning1=false, bool flagWarning2=false, bool flagPowerReduction=false, bool flagMaintenanceNeeded=false, bool flagEngineCommError=false, bool flagSubThrottle=false, bool flagNeutralStartProtect=false, bool flagEngineShuttingDown=false)
	Setting up Message "Engine parameters dynamic" - PGN 127489. More...

void	SetN2kEngineDynamicParam (tN2kMsg &N2kMsg, unsigned char EngineInstance, double EngineOilPress, double EngineOilTemp, double EngineCoolantTemp, double AltenatorVoltage, double FuelRate, double EngineHours, double EngineCoolantPress=N2kDoubleNA, double EngineFuelPress=N2kDoubleNA, int8_t EngineLoad=N2kInt8NA, int8_t EngineTorque=N2kInt8NA, tN2kEngineDiscreteStatus1 Status1=0, tN2kEngineDiscreteStatus2 Status2=0)
	Setting up Message "Engine parameters dynamic" - PGN 127489. More...

void	SetN2kEngineParamRapid (tN2kMsg &N2kMsg, unsigned char EngineInstance, double EngineSpeed, double EngineBoostPressure=N2kDoubleNA, int8_t EngineTiltTrim=N2kInt8NA)
	Setting up Message "Engine parameters rapid" - PGN 127488. More...

void	SetN2kEngineTripParameters (tN2kMsg &N2kMsg, unsigned char EngineInstance, double TripFuelUsed, double FuelRateAverage, double FuelRateEconomy=N2kDoubleNA, double InstantaneousFuelEconomy=N2kDoubleNA)
	Setting up Message "Trip Parameters, Engine" - PGN 127497. More...

void	SetN2kEnvironmentalParameters (tN2kMsg &N2kMsg, unsigned char SID, tN2kTempSource TempSource, double Temperature, tN2kHumiditySource HumiditySource=N2khs_Undef, double Humidity=N2kDoubleNA, double AtmosphericPressure=N2kDoubleNA)
	Setting up Message "Environmental Parameters - DEPRECATED" - PGN 130311. More...

void	SetN2kFluidLevel (tN2kMsg &N2kMsg, unsigned char Instance, tN2kFluidType FluidType, double Level, double Capacity)
	Setting up Message "Fluid level" - PGN 127505. More...

void	SetN2kGNSS (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=0, double GeoidalSeparation=0, unsigned char nReferenceStations=0, tN2kGNSStype ReferenceStationType=N2kGNSSt_GPS, uint16_t ReferenceSationID=0, double AgeOfCorrection=0)
	Setting up Message "GNSS Position Data" - PGN 129029. More...

void	SetN2kGNSSDOPData (tN2kMsg &N2kMsg, unsigned char SID, tN2kGNSSDOPmode DesiredMode, tN2kGNSSDOPmode ActualMode, double HDOP, double VDOP, double TDOP)
	Setting up Message "GNSS DOP data - PGN 129539. More...

void	SetN2kGNSSSatellitesInView (tN2kMsg &N2kMsg, unsigned char SID=0xff, tN2kRangeResidualMode Mode=N2kDD072_Unavailable)
	Setting up Message "GNSS DOP data" - PGN 129540. More...

void	SetN2kHeadingTrackControl (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)
	Setting up Message "Heading/Track control" - PGN 127237. More...

void	SetN2kHeave (tN2kMsg &N2kMsg, unsigned char SID, double Heave, double Delay=N2kDoubleNA, tN2kDelaySource DelaySource=N2kDD374_DataNotAvailable)
	Setting up Message "Rate of Turn" - PGN 127252. More...

void	SetN2kHumidity (tN2kMsg &N2kMsg, unsigned char SID, unsigned char HumidityInstance, tN2kHumiditySource HumiditySource, double ActualHumidity, double SetHumidity=N2kDoubleNA)
	Setting up Message "Humidity" - PGN 130313. More...

void	SetN2kLatLonRapid (tN2kMsg &N2kMsg, double Latitude, double Longitude)
	Setting up Message "Position, Rapid Update" - PGN 129025. More...

void	SetN2kLeeway (tN2kMsg &N2kMsg, unsigned char SID, double Leeway)
	Setting up Message "Nautical Leeway Angle" - PGN 128000. More...

void	SetN2kLocalOffset (tN2kMsg &N2kMsg, uint16_t DaysSince1970, double SecondsSinceMidnight, int16_t LocalOffset)
	Setting up Message "Date,Time & Local offset" - PGN 129033. More...

void	SetN2kMagneticHeading (tN2kMsg &N2kMsg, unsigned char SID, double Heading, double Deviation=N2kDoubleNA, double Variation=N2kDoubleNA)
	Setting up Message "Vessel Heading" - PGN 127250. More...

void	SetN2kMagneticVariation (tN2kMsg &N2kMsg, unsigned char SID, tN2kMagneticVariation Source, uint16_t DaysSince1970, double Variation)
	Setting up Message "Magnetic Variation" - PGN 127258. More...

void	SetN2kMeteorlogicalStationData (tN2kMsg &N2kMsg, const tN2kMeteorlogicalStationData &N2kData)
	Setting up Message "Meterological Station Data" - PGN 130323. More...

void	SetN2kMOBNotification (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)
	Setting up Message "Man Overboard Notification" - PGN 127233. More...

void	SetN2kNavigationInfo (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)
	Setting up Message "Navigation Data" - PGN 129284. More...

void	SetN2kOutsideEnvironmentalParameters (tN2kMsg &N2kMsg, unsigned char SID, double WaterTemperature, double OutsideAmbientAirTemperature=N2kDoubleNA, double AtmosphericPressure=N2kDoubleNA)
	Setting up Message "Environmental Parameters - DEPRECATED" - PGN 130310. More...

void	SetN2kPGN126992 (tN2kMsg &N2kMsg, unsigned char SID, uint16_t SystemDate, double SystemTime, tN2kTimeSource TimeSource=N2ktimes_GPS)
	Setting up PGN126992 Message "System date/time". More...

void	SetN2kPGN127233 (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)
	Setting up PGN127233 Message "Man Overboard Notification". More...

void	SetN2kPGN127237 (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)
	Setting up PGN127237 Message "Heading/Track control". More...

void	SetN2kPGN127245 (tN2kMsg &N2kMsg, double RudderPosition, unsigned char Instance=0, tN2kRudderDirectionOrder RudderDirectionOrder=N2kRDO_NoDirectionOrder, double AngleOrder=N2kDoubleNA)
	Setting up PGN127245 Message "Rudder". More...

void	SetN2kPGN127250 (tN2kMsg &N2kMsg, unsigned char SID, double Heading, double Deviation, double Variation, tN2kHeadingReference ref)
	Setting up PGN127250 Message "Vessel Heading". More...

void	SetN2kPGN127251 (tN2kMsg &N2kMsg, unsigned char SID, double RateOfTurn)
	Setting up PGN 127251 Message "Rate of Turn". More...

void	SetN2kPGN127252 (tN2kMsg &N2kMsg, unsigned char SID, double Heave, double Delay=N2kDoubleNA, tN2kDelaySource DelaySource=N2kDD374_DataNotAvailable)
	Setting up PGN 127252 Message "Heave". More...

void	SetN2kPGN127257 (tN2kMsg &N2kMsg, unsigned char SID, double Yaw, double Pitch, double Roll)
	Setting up PGN 127257 Message "Attitude". More...

void	SetN2kPGN127258 (tN2kMsg &N2kMsg, unsigned char SID, tN2kMagneticVariation Source, uint16_t DaysSince1970, double Variation)
	Setting up PGN 127258 Message "Magnetic Variation". More...

void	SetN2kPGN127488 (tN2kMsg &N2kMsg, unsigned char EngineInstance, double EngineSpeed, double EngineBoostPressure=N2kDoubleNA, int8_t EngineTiltTrim=N2kInt8NA)
	Setting up PGN 127488 Message "Engine parameters rapid". More...

void	SetN2kPGN127489 (tN2kMsg &N2kMsg, unsigned char EngineInstance, double EngineOilPress, double EngineOilTemp, double EngineCoolantTemp, double AltenatorVoltage, double FuelRate, double EngineHours, double EngineCoolantPress=N2kDoubleNA, double EngineFuelPress=N2kDoubleNA, int8_t EngineLoad=N2kInt8NA, int8_t EngineTorque=N2kInt8NA, bool flagCheckEngine=false, bool flagOverTemp=false, bool flagLowOilPress=false, bool flagLowOilLevel=false, bool flagLowFuelPress=false, bool flagLowSystemVoltage=false, bool flagLowCoolantLevel=false, bool flagWaterFlow=false, bool flagWaterInFuel=false, bool flagChargeIndicator=false, bool flagPreheatIndicator=false, bool flagHighBoostPress=false, bool flagRevLimitExceeded=false, bool flagEgrSystem=false, bool flagTPS=false, bool flagEmergencyStopMode=false, bool flagWarning1=false, bool flagWarning2=false, bool flagPowerReduction=false, bool flagMaintenanceNeeded=false, bool flagEngineCommError=false, bool flagSubThrottle=false, bool flagNeutralStartProtect=false, bool flagEngineShuttingDown=false)
	Setting up PGN 127489 Message "Engine parameters dynamic". More...

void	SetN2kPGN127489 (tN2kMsg &N2kMsg, unsigned char EngineInstance, double EngineOilPress, double EngineOilTemp, double EngineCoolantTemp, double AltenatorVoltage, double FuelRate, double EngineHours, double EngineCoolantPress=N2kDoubleNA, double EngineFuelPress=N2kDoubleNA, int8_t EngineLoad=N2kInt8NA, int8_t EngineTorque=N2kInt8NA, tN2kEngineDiscreteStatus1 Status1=0, tN2kEngineDiscreteStatus2 Status2=0)
	Setting up PGN 127489 Message "Engine parameters dynamic". More...

void	SetN2kPGN127493 (tN2kMsg &N2kMsg, unsigned char EngineInstance, tN2kTransmissionGear TransmissionGear, double OilPressure, double OilTemperature, unsigned char DiscreteStatus1=0)
	Setting up PGN 127493 Message "Transmission parameters, dynamic". More...

void	SetN2kPGN127497 (tN2kMsg &N2kMsg, unsigned char EngineInstance, double TripFuelUsed, double FuelRateAverage, double FuelRateEconomy=N2kDoubleNA, double InstantaneousFuelEconomy=N2kDoubleNA)
	Setting up PGN 127497 Message "Trip Parameters, Engine". More...

void	SetN2kPGN127501 (tN2kMsg &N2kMsg, unsigned char DeviceBankInstance, tN2kBinaryStatus BankStatus)
	Setting up PGN 127501 Message "Universal Binary Status Report". More...

void	SetN2kPGN127501 (tN2kMsg &N2kMsg, unsigned char DeviceBankInstance, tN2kOnOff Status1, tN2kOnOff Status2=N2kOnOff_Unavailable, tN2kOnOff Status3=N2kOnOff_Unavailable, tN2kOnOff Status4=N2kOnOff_Unavailable)
	Setting up PGN 127501 Message "Universal Binary Status Report". More...

void	SetN2kPGN127502 (tN2kMsg &N2kMsg, unsigned char TargetBankInstance, tN2kBinaryStatus BankStatus)
	Set up PGN 127502 "Switch Bank Control" message. More...

void	SetN2kPGN127505 (tN2kMsg &N2kMsg, unsigned char Instance, tN2kFluidType FluidType, double Level, double Capacity)
	Setting up PGN 127505 Message "Fluid level". More...

void	SetN2kPGN127506 (tN2kMsg &N2kMsg, unsigned char SID, unsigned char DCInstance, tN2kDCType DCType, unsigned char StateOfCharge, unsigned char StateOfHealth, double TimeRemaining, double RippleVoltage=N2kDoubleNA, double Capacity=N2kDoubleNA)
	Setting up PGN 127506 Message "DC Detailed Status". More...

void	SetN2kPGN127507 (tN2kMsg &N2kMsg, unsigned char Instance, unsigned char BatteryInstance, tN2kChargeState ChargeState, tN2kChargerMode ChargerMode=N2kCM_Standalone, tN2kOnOff Enabled=N2kOnOff_On, tN2kOnOff EqualizationPending=N2kOnOff_Unavailable, double EqualizationTimeRemaining=N2kDoubleNA)
	Setting up PGN 127507 Message "DC Charger Status". More...

void	SetN2kPGN127508 (tN2kMsg &N2kMsg, unsigned char BatteryInstance, double BatteryVoltage, double BatteryCurrent=N2kDoubleNA, double BatteryTemperature=N2kDoubleNA, unsigned char SID=0xff)
	Setting up PGN 127508 Message "Battery Status". More...

void	SetN2kPGN127513 (tN2kMsg &N2kMsg, unsigned char BatInstance, tN2kBatType BatType, tN2kBatEqSupport SupportsEqual, tN2kBatNomVolt BatNominalVoltage, tN2kBatChem BatChemistry, double BatCapacity, int8_t BatTemperatureCoefficient, double PeukertExponent, int8_t ChargeEfficiencyFactor)
	Setting up PGN 127513 Message "Battery Configuration Status". More...

void	SetN2kPGN128000 (tN2kMsg &N2kMsg, unsigned char SID, double Leeway)
	Setting up PGN 128000 Message "Nautical Leeway Angle". More...

void	SetN2kPGN128259 (tN2kMsg &N2kMsg, unsigned char SID, double WaterReferenced, double GroundReferenced=N2kDoubleNA, tN2kSpeedWaterReferenceType SWRT=N2kSWRT_Paddle_wheel)
	Setting up PGN 128259 Message "Boat Speed, Water Referenced". More...

void	SetN2kPGN128267 (tN2kMsg &N2kMsg, unsigned char SID, double DepthBelowTransducer, double Offset, double Range=N2kDoubleNA)
	Setting up PGN 128267 Message "Water depth". More...

void	SetN2kPGN128275 (tN2kMsg &N2kMsg, uint16_t DaysSince1970, double SecondsSinceMidnight, uint32_t Log, uint32_t TripLog)
	Setting up PGN 128275 Message "Distance log". More...

void	SetN2kPGN128776 (tN2kMsg &N2kMsg, unsigned char SID, unsigned char WindlassIdentifier, tN2kWindlassDirectionControl WindlassDirectionControl, unsigned char SpeedControl, tN2kSpeedType SpeedControlType=N2kDD488_DataNotAvailable, tN2kGenericStatusPair AnchorDockingControl=N2kDD002_Unavailable, tN2kGenericStatusPair PowerEnable=N2kDD002_Unavailable, tN2kGenericStatusPair MechanicalLock=N2kDD002_Unavailable, tN2kGenericStatusPair DeckAndAnchorWash=N2kDD002_Unavailable, tN2kGenericStatusPair AnchorLight=N2kDD002_Unavailable, double CommandTimeout=0.4, const tN2kWindlassControlEvents &WindlassControlEvents=tN2kWindlassControlEvents())
	Setting up PGN 128776 Message "Anchor Windlass Control Status". More...

void	SetN2kPGN128777 (tN2kMsg &N2kMsg, unsigned char SID, unsigned char WindlassIdentifier, double RodeCounterValue, double WindlassLineSpeed=N2kDoubleNA, tN2kWindlassMotionStates WindlassMotionStatus=N2kDD480_Unavailable, tN2kRodeTypeStates RodeTypeStatus=N2kDD481_Unavailable, tN2kDD482 AnchorDockingStatus=N2kDD482_DataNotAvailable, const tN2kWindlassOperatingEvents &WindlassOperatingEvents=tN2kWindlassOperatingEvents())
	Setting up PGN 128777 Message "Anchor Windlass Operating Status". More...

void	SetN2kPGN128778 (tN2kMsg &N2kMsg, unsigned char SID, unsigned char WindlassIdentifier, double TotalMotorTime, double ControllerVoltage=N2kDoubleNA, double MotorCurrent=N2kDoubleNA, const tN2kWindlassMonitoringEvents &WindlassMonitoringEvents=tN2kWindlassMonitoringEvents())
	Setting up PGN 128778Message "Anchor Windlass Monitoring Status". More...

void	SetN2kPGN129025 (tN2kMsg &N2kMsg, double Latitude, double Longitude)
	Setting up PGN 129025 Message "Position, Rapid Update". More...

void	SetN2kPGN129026 (tN2kMsg &N2kMsg, unsigned char SID, tN2kHeadingReference ref, double COG, double SOG)
	Setting up PGN 129026 Message "COG SOG rapid update". More...

void	SetN2kPGN129029 (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=0, double GeoidalSeparation=0, unsigned char nReferenceStations=0, tN2kGNSStype ReferenceStationType=N2kGNSSt_GPS, uint16_t ReferenceSationID=0, double AgeOfCorrection=0)
	Setting up PGN 129029 Message "GNSS Position Data". More...

void	SetN2kPGN129033 (tN2kMsg &N2kMsg, uint16_t DaysSince1970, double SecondsSinceMidnight, int16_t LocalOffset)
	Setting up PGN 129033 Message "Date,Time & Local offset". More...

void	SetN2kPGN129038 (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, double ROT, tN2kAISNavStatus NavStatus)
	Setting up PGN 129038 Message "AIS position reports for Class A". More...

void	SetN2kPGN129039 (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, unsigned char SID=0xff)
	Setting up PGN 129039 Message "AIS position reports for Class B". More...

void	SetN2kPGN129041 (tN2kMsg &N2kMsg, const tN2kAISAtoNReportData &N2kData)
	Setting up PGN 129041 Message "AIS Aids to Navigation (AtoN) Report". More...

void	SetN2kPGN129283 (tN2kMsg &N2kMsg, unsigned char SID, tN2kXTEMode XTEMode, bool NavigationTerminated, double XTE)
	Setting up PGN 129283 Message "Cross Track Error". More...

void	SetN2kPGN129284 (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)
	Setting up PGN 129284 Message "Navigation Data". More...

void	SetN2kPGN129285 (tN2kMsg &N2kMsg, uint16_t Start, uint16_t Database, uint16_t Route, bool NavDirection, bool SupplementaryData, char *RouteName)
	Setting up Message "Route/WP information" - PGN 129285 (for backwards compatibility) More...

void	SetN2kPGN129285 (tN2kMsg &N2kMsg, uint16_t Start, uint16_t Database, uint16_t Route, tN2kNavigationDirection NavDirection, const char *RouteName, tN2kGenericStatusPair SupplementaryData=N2kDD002_No)
	Setting up PGN 129285 Message "Route/WP information". More...

void	SetN2kPGN129539 (tN2kMsg &N2kMsg, unsigned char SID, tN2kGNSSDOPmode DesiredMode, tN2kGNSSDOPmode ActualMode, double HDOP, double VDOP, double TDOP)
	Setting up PGN 129539 Message "GNSS DOP data". More...

void	SetN2kPGN129540 (tN2kMsg &N2kMsg, unsigned char SID=0xff, tN2kRangeResidualMode Mode=N2kDD072_Unavailable)
	Setting up PGN 129540 Message "GNSS Satellites in View". More...

void	SetN2kPGN129794 (tN2kMsg &N2kMsg, uint8_t MessageID, tN2kAISRepeat Repeat, uint32_t UserID, uint32_t IMOnumber, const char Callsign, const char Name, uint8_t VesselType, double Length, double Beam, double PosRefStbd, double PosRefBow, uint16_t ETAdate, double ETAtime, double Draught, const char *Destination, tN2kAISVersion AISversion, tN2kGNSStype GNSStype, tN2kAISDTE DTE, tN2kAISTransceiverInformation AISinfo)
	Setting up PGN 129794 Message "AIS static data class A". More...

void	SetN2kPGN129802 (tN2kMsg &N2kMsg, uint8_t MessageID, tN2kAISRepeat Repeat, uint32_t SourceID, tN2kAISTransceiverInformation AISTransceiverInformation, char *SafetyRelatedText)
	Setting up PGN129802 Message "AIS Safety Related Broadcast Message". More...

void	SetN2kPGN129809 (tN2kMsg &N2kMsg, uint8_t MessageID, tN2kAISRepeat Repeat, uint32_t UserID, const char *Name)
	Setting up PGN 129809 Message "AIS static data class B part A". More...

void	SetN2kPGN129810 (tN2kMsg &N2kMsg, uint8_t MessageID, tN2kAISRepeat Repeat, uint32_t UserID, uint8_t VesselType, const char Vendor, const char Callsign, double Length, double Beam, double PosRefStbd, double PosRefBow, uint32_t MothershipID)
	Setting up PGN 129810 Message "AIS static data class B part B". More...

void	SetN2kPGN130074 (tN2kMsg &N2kMsg, uint16_t Start, uint16_t NumWaypoints, uint16_t Database)
	Setting up PGN 130074 Message " Route and WP Service - WP List - WP Name & Position". More...

void	SetN2kPGN130306 (tN2kMsg &N2kMsg, unsigned char SID, double WindSpeed, double WindAngle, tN2kWindReference WindReference)
	Setting up PGN 130306 Message "Wind Data". More...

void	SetN2kPGN130310 (tN2kMsg &N2kMsg, unsigned char SID, double WaterTemperature, double OutsideAmbientAirTemperature=N2kDoubleNA, double AtmosphericPressure=N2kDoubleNA)
	Setting up PGN 130310 Message " Environmental Parameters - DEPRECATED". More...

void	SetN2kPGN130311 (tN2kMsg &N2kMsg, unsigned char SID, tN2kTempSource TempSource, double Temperature, tN2kHumiditySource HumiditySource=N2khs_Undef, double Humidity=N2kDoubleNA, double AtmosphericPressure=N2kDoubleNA)
	Setting up PGN 130311 Message "Environmental Parameters - DEPRECATED". More...

void	SetN2kPGN130312 (tN2kMsg &N2kMsg, unsigned char SID, unsigned char TempInstance, tN2kTempSource TempSource, double ActualTemperature, double SetTemperature=N2kDoubleNA)
	Setting up PGN 130312 Message "Temperature - DEPRECATED". More...

void	SetN2kPGN130313 (tN2kMsg &N2kMsg, unsigned char SID, unsigned char HumidityInstance, tN2kHumiditySource HumiditySource, double ActualHumidity, double SetHumidity=N2kDoubleNA)
	Setting up PGN 130313 Message "Humidity". More...

void	SetN2kPGN130314 (tN2kMsg &N2kMsg, unsigned char SID, unsigned char PressureInstance, tN2kPressureSource PressureSource, double Pressure)
	Setting up PGN 130314 Message "Actual Pressure". More...

void	SetN2kPGN130315 (tN2kMsg &N2kMsg, unsigned char SID, unsigned char PressureInstance, tN2kPressureSource PressureSource, double SetPressure)
	Setting up PGN 130315 Message "Set Pressure". More...

void	SetN2kPGN130316 (tN2kMsg &N2kMsg, unsigned char SID, unsigned char TempInstance, tN2kTempSource TempSource, double ActualTemperature, double SetTemperature=N2kDoubleNA)
	Setting up PGN 130316 Message "Temperature, Extended Range". More...

void	SetN2kPGN130323 (tN2kMsg &N2kMsg, const tN2kMeteorlogicalStationData &N2kData)
	Setting up PGN 130323 Message "Meterological Station Data". More...

void	SetN2kPGN130576 (tN2kMsg &N2kMsg, int8_t PortTrimTab, int8_t StbdTrimTab)
	Setting up PGN 130576 Message "Trim Tab Status". More...

void	SetN2kPGN130577 (tN2kMsg &N2kMsg, tN2kDataMode DataMode, tN2kHeadingReference CogReference, unsigned char SID, double COG, double SOG, double Heading, double SpeedThroughWater, double Set, double Drift)
	Setting up PGN 130577 Message "Direction Data". More...

void	SetN2kPressure (tN2kMsg &N2kMsg, unsigned char SID, unsigned char PressureInstance, tN2kPressureSource PressureSource, double Pressure)
	Setting up Message "Actual Pressure" - PGN 130314. More...

void	SetN2kRateOfTurn (tN2kMsg &N2kMsg, unsigned char SID, double RateOfTurn)
	Setting up Message "Rate of Turn" - PGN 127251. More...

void	SetN2kRouteWPInfo (tN2kMsg &N2kMsg, uint16_t Start, uint16_t Database, uint16_t Route, tN2kNavigationDirection NavDirection, const char *RouteName, tN2kGenericStatusPair SupplementaryData=N2kDD002_No)
	Setting up Message "Route/WP information" - PGN 129285. More...

void	SetN2kRudder (tN2kMsg &N2kMsg, double RudderPosition, unsigned char Instance=0, tN2kRudderDirectionOrder RudderDirectionOrder=N2kRDO_NoDirectionOrder, double AngleOrder=N2kDoubleNA)
	Setting up Message "Rudder" - PGN 127245. More...

void	SetN2kSetPressure (tN2kMsg &N2kMsg, unsigned char SID, unsigned char PressureInstance, tN2kPressureSource PressureSource, double SetPressure)
	Setting up Message "Set Pressure" - PGN 130315. More...

void	SetN2kSwitchbankControl (tN2kMsg &N2kMsg, unsigned char TargetBankInstance, tN2kBinaryStatus BankStatus)
	Set up PGN 127502 "Switch Bank Control" message. More...

void	SetN2kSystemTime (tN2kMsg &N2kMsg, unsigned char SID, uint16_t SystemDate, double SystemTime, tN2kTimeSource TimeSource=N2ktimes_GPS)
	Setting up Message "System date/time" - PGN 126992. More...

void	SetN2kTemperature (tN2kMsg &N2kMsg, unsigned char SID, unsigned char TempInstance, tN2kTempSource TempSource, double ActualTemperature, double SetTemperature=N2kDoubleNA)
	Setting up Message "Temperature - DEPRECATED" - PGN 130312. More...

void	SetN2kTemperatureExt (tN2kMsg &N2kMsg, unsigned char SID, unsigned char TempInstance, tN2kTempSource TempSource, double ActualTemperature, double SetTemperature=N2kDoubleNA)
	Setting up Message "Temperature, Extended Range" - PGN 130316. More...

void	SetN2kTransmissionParameters (tN2kMsg &N2kMsg, unsigned char EngineInstance, tN2kTransmissionGear TransmissionGear, double OilPressure, double OilTemperature, bool flagCheck, bool flagOverTemp, bool flagLowOilPressure=false, bool flagLowOilLevel=false, bool flagSailDrive=false)
	Setting up Message "Transmission parameters, dynamic" - PGN 127493. More...

void	SetN2kTransmissionParameters (tN2kMsg &N2kMsg, unsigned char EngineInstance, tN2kTransmissionGear TransmissionGear, double OilPressure, double OilTemperature, unsigned char DiscreteStatus1=0)
	Setting up Message "Transmission parameters, dynamic" - PGN 127493. More...

void	SetN2kTrimTab (tN2kMsg &N2kMsg, int8_t PortTrimTab, int8_t StbdTrimTab)
	Setting up Message "Trim Tab Status" - PGN 130576. More...

void	SetN2kTrueHeading (tN2kMsg &N2kMsg, unsigned char SID, double Heading)
	Setting up Message "Vessel Heading" - PGN 127250. More...

void	SetN2kWaterDepth (tN2kMsg &N2kMsg, unsigned char SID, double DepthBelowTransducer, double Offset, double Range=N2kDoubleNA)
	Setting up Message "Water depth" - PGN 128267. More...

void	SetN2kWaypointList (tN2kMsg &N2kMsg, uint16_t Start, uint16_t NumWaypoints, uint16_t Database)
	Setting up Message "Route and WP Service - WP List - WP Name & Position" - PGN 130074. More...

void	SetN2kWindSpeed (tN2kMsg &N2kMsg, unsigned char SID, double WindSpeed, double WindAngle, tN2kWindReference WindReference)
	Setting up Message "Wind Data" - PGN 130306. More...

void	SetN2kXTE (tN2kMsg &N2kMsg, unsigned char SID, tN2kXTEMode XTEMode, bool NavigationTerminated, double XTE)
	Setting up Message "Cross Track Error" - PGN 129283. More...

Detailed Description

List of functions which sets up the data of tN2kMsg objects so that it can be send out to the bus.

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

Library contains functions to e.g. create message named with PGN like SetN2kPGN129025 and alias easy for humans to read like SetN2kLatLonRapid.

Each SetN2kPNGxxx function sets related message PGN and its default priority. The default priority can be different for each PGN. So if you want to change priority on function, you have to do it after Setxxx call.

See also: n2kMessages.h

Function Documentation

◆ AppendN2kPGN129285()

bool AppendN2kPGN129285	(	tN2kMsg &	N2kMsg,
		uint16_t	WPID,
		const char *	WPName,
		double	Latitude,
		double	Longitude
	)

Append another Waypoint to PGN 129285 "Route/WP information".

This function appends another waypoint data to an N2kMsg created with SetN2kPGN129285.

Parameters

N2kMsg	Reference to a N2kMsg Object,
WPID	The ID of the current waypoint
WPName	The name of the current waypoint
Latitude	The latitude of the current waypoint
Longitude	The longitude of the current waypoint

Returns: true if there was enough space in the message; false

Definition at line 1588 of file N2kMessages.cpp.

◆ AppendN2kPGN129540()

bool AppendN2kPGN129540	(	tN2kMsg &	N2kMsg,
		const tSatelliteInfo &	SatelliteInfo
	)

Append a new satellite info to PGN 129540 Message "GNSS Satellites in View".

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SatelliteInfo	Requested satellite info, see tSatelliteInfo

Returns: true function succeeded; false no more satellites can be added or try to use wrong or uninitialized message.

See also: SetN2kPGN129540

Definition at line 1265 of file N2kMessages.cpp.

◆ AppendN2kPGN130074()

bool AppendN2kPGN130074	(	tN2kMsg &	N2kMsg,
		uint16_t	ID,
		char *	Name,
		double	Latitude,
		double	Longitude
	)

Append a Waypoint to PGN 130074 Message " Route and WP Service - WP List - WP Name & Position".

This functions adds a waypoint to the "Route and WP Service - WP List - WP Name & Position" (PGN130074)

See also: SetN2kPGN130074

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
ID	The ID of the waypoint
Name	The name of the waypoint
Latitude	The latitude of the waypoint
Longitude	The Longitude of the waypoint

Returns: true waypoint successfully added; false aborted

Definition at line 1753 of file N2kMessages.cpp.

◆ AppendN2kRouteWPInfo()

bool AppendN2kRouteWPInfo	(	tN2kMsg &	N2kMsg,
		uint16_t	WPID,
		const char *	WPName,
		double	Latitude,
		double	Longitude
	)

inline

Append another Waypoint to "Route/WP information"- PGN 129285.

This alias was introduced to improve the readability of the source code. See parameter details on AppendN2kPGN129285

Definition at line 4038 of file N2kMessages.h.

◆ AppendN2kWaypointList()

bool AppendN2kWaypointList	(	tN2kMsg &	N2kMsg,
		uint16_t	ID,
		char *	Name,
		double	Latitude,
		double	Longitude
	)

inline

Append a Waypoint to Message "Route and WP Service - WP List - WP Name & Position" - PGN 130074.

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

Definition at line 4680 of file N2kMessages.h.

◆ ParseN2kSwitchbankControl()

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

inline

Parse PGN 127502 "Switch Bank Control" message.

Alias of ParseN2kPGN127502. This alias was introduced to improve the readability of the source code.

Definition at line 1818 of file N2kMessages.h.

◆ SetN2kAISAtoNReport()

void SetN2kAISAtoNReport	(	tN2kMsg &	N2kMsg,
		const tN2kAISAtoNReportData &	N2kData
	)

inline

Setting up Message "AIS Aids to Navigation (AtoN) Report" - PGN 129041.

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

Definition at line 3744 of file N2kMessages.h.

◆ SetN2kAISClassAPosition()

void SetN2kAISClassAPosition	(	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,
		double	ROT,
		tN2kAISNavStatus	NavStatus
	)

inline

Setting up Message "AIS position reports for Class A" - PGN 129038.

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

Definition at line 3267 of file N2kMessages.h.

◆ SetN2kAISClassAStatic()

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

inline

Setting up Message "AIS static data class A" - PGN 129794.

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

Definition at line 4334 of file N2kMessages.h.

◆ SetN2kAISClassBPosition() [1/2]

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

inline

Setting up Message "AIS position reports for Class B" - PGN 129039 [DEPRECATED].

Note: PPrevious inline version for backwards compatibility, using N2kaischannel_A_VDL_reception(0) as default value

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

Definition at line 3444 of file N2kMessages.h.

◆ SetN2kAISClassBPosition() [2/2]

void SetN2kAISClassBPosition	(	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,
		unsigned char	SID = `0xff`
	)

inline

Setting up Message "AIS position reports for Class B" - 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 SetN2kPGN129039

Definition at line 3424 of file N2kMessages.h.

◆ SetN2kAISClassBStaticPartA()

void SetN2kAISClassBStaticPartA	(	tN2kMsg &	N2kMsg,
		uint8_t	MessageID,
		tN2kAISRepeat	Repeat,
		uint32_t	UserID,
		const char *	Name
	)

inline

Setting up Message "AIS static data class B part A" - PGN 129809.

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

Definition at line 4458 of file N2kMessages.h.

◆ SetN2kAISClassBStaticPartB()

void SetN2kAISClassBStaticPartB	(	tN2kMsg &	N2kMsg,
		uint8_t	MessageID,
		tN2kAISRepeat	Repeat,
		uint32_t	UserID,
		uint8_t	VesselType,
		const char *	Vendor,
		const char *	Callsign,
		double	Length,
		double	Beam,
		double	PosRefStbd,
		double	PosRefBow,
		uint32_t	MothershipID
	)

inline

Setting up Message "AIS static data class B part B" - PGN 129810.

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

Definition at line 4551 of file N2kMessages.h.

◆ SetN2kAISSafetyRelatedBroadcastMsg()

void SetN2kAISSafetyRelatedBroadcastMsg	(	tN2kMsg &	N2kMsg,
		uint8_t	MessageID,
		tN2kAISRepeat	Repeat,
		uint32_t	SourceID,
		tN2kAISTransceiverInformation	AISTransceiverInformation,
		char *	SafetyRelatedText
	)

inline

Setting up Message "AIS Safety Related Broadcast Message" - PGN 129802.

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

Definition at line 276 of file N2kMessages.h.

◆ SetN2kAttitude()

void SetN2kAttitude	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		double	Yaw,
		double	Pitch,
		double	Roll
	)

inline

Setting up Message "Attitude" - PGN 127257.

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

Definition at line 957 of file N2kMessages.h.

◆ SetN2kBatConf()

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

inline

Setting up Message "Battery Configuration Status" - PGN 127513.

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

Definition at line 2190 of file N2kMessages.h.

◆ SetN2kBinaryStatus() [1/2]

void SetN2kBinaryStatus	(	tN2kMsg &	N2kMsg,
		unsigned char	DeviceBankInstance,
		tN2kBinaryStatus	BankStatus
	)

inline

Setting up Message "Universal Binary Status Report" - PGN 127501.

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

Definition at line 1655 of file N2kMessages.h.

◆ SetN2kBinaryStatus() [2/2]

void SetN2kBinaryStatus	(	tN2kMsg &	N2kMsg,
		unsigned char	DeviceBankInstance,
		tN2kOnOff	Status1,
		tN2kOnOff	Status2 = `N2kOnOff_Unavailable`,
		tN2kOnOff	Status3 = `N2kOnOff_Unavailable`,
		tN2kOnOff	Status4 = `N2kOnOff_Unavailable`
	)

inline

Setting up Message "Universal Binary Status Report" - PGN 127501.

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

Definition at line 1693 of file N2kMessages.h.

◆ SetN2kBoatSpeed()

void SetN2kBoatSpeed	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		double	WaterReferenced,
		double	GroundReferenced = `N2kDoubleNA`,
		tN2kSpeedWaterReferenceType	SWRT = `N2kSWRT_Paddle_wheel`
	)

inline

Setting up Message "Boat Speed, Water Referenced" - PGN 128259.

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

Definition at line 2366 of file N2kMessages.h.

◆ SetN2kChargerStatus()

void SetN2kChargerStatus	(	tN2kMsg &	N2kMsg,
		unsigned char	Instance,
		unsigned char	BatteryInstance,
		tN2kChargeState	ChargeState,
		tN2kChargerMode	ChargerMode = `N2kCM_Standalone`,
		tN2kOnOff	Enabled = `N2kOnOff_On`,
		tN2kOnOff	EqualizationPending = `N2kOnOff_Unavailable`,
		double	EqualizationTimeRemaining = `N2kDoubleNA`
	)

inline

Setting up Message "DC Charger Status" - PGN 127507.

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

Definition at line 2040 of file N2kMessages.h.

◆ SetN2kCOGSOGRapid()

void SetN2kCOGSOGRapid	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		tN2kHeadingReference	ref,
		double	COG,
		double	SOG
	)

inline

Setting up Message "COG SOG rapid update" - PGN 129026.

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

Definition at line 2985 of file N2kMessages.h.

◆ SetN2kDCBatStatus()

void SetN2kDCBatStatus	(	tN2kMsg &	N2kMsg,
		unsigned char	BatteryInstance,
		double	BatteryVoltage,
		double	BatteryCurrent = `N2kDoubleNA`,
		double	BatteryTemperature = `N2kDoubleNA`,
		unsigned char	SID = `1`
	)

inline

Setting up Message "Battery Status" - PGN 127508.

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

Definition at line 2116 of file N2kMessages.h.

◆ SetN2kDCStatus()

void SetN2kDCStatus	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		unsigned char	DCInstance,
		tN2kDCType	DCType,
		unsigned char	StateOfCharge,
		unsigned char	StateOfHealth,
		double	TimeRemaining,
		double	RippleVoltage = `N2kDoubleNA`,
		double	Capacity = `N2kDoubleNA`
	)

inline

Setting up Message "DC Detailed Status" - PGN 127506.

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

Definition at line 1967 of file N2kMessages.h.

◆ SetN2kDirectionData()

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

inline

Setting up Message "Direction Data" - PGN 130577.

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

Definition at line 5513 of file N2kMessages.h.

◆ SetN2kDistanceLog()

void SetN2kDistanceLog	(	tN2kMsg &	N2kMsg,
		uint16_t	DaysSince1970,
		double	SecondsSinceMidnight,
		uint32_t	Log,
		uint32_t	TripLog
	)

inline

Setting up Message "Distance log" - PGN 128275.

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

Definition at line 2512 of file N2kMessages.h.

◆ SetN2kEngineDynamicParam() [1/2]

void SetN2kEngineDynamicParam	(	tN2kMsg &	N2kMsg,
		unsigned char	EngineInstance,
		double	EngineOilPress,
		double	EngineOilTemp,
		double	EngineCoolantTemp,
		double	AltenatorVoltage,
		double	FuelRate,
		double	EngineHours,
		double	EngineCoolantPress = `N2kDoubleNA`,
		double	EngineFuelPress = `N2kDoubleNA`,
		int8_t	EngineLoad = `N2kInt8NA`,
		int8_t	EngineTorque = `N2kInt8NA`,
		bool	flagCheckEngine = `false`,
		bool	flagOverTemp = `false`,
		bool	flagLowOilPress = `false`,
		bool	flagLowOilLevel = `false`,
		bool	flagLowFuelPress = `false`,
		bool	flagLowSystemVoltage = `false`,
		bool	flagLowCoolantLevel = `false`,
		bool	flagWaterFlow = `false`,
		bool	flagWaterInFuel = `false`,
		bool	flagChargeIndicator = `false`,
		bool	flagPreheatIndicator = `false`,
		bool	flagHighBoostPress = `false`,
		bool	flagRevLimitExceeded = `false`,
		bool	flagEgrSystem = `false`,
		bool	flagTPS = `false`,
		bool	flagEmergencyStopMode = `false`,
		bool	flagWarning1 = `false`,
		bool	flagWarning2 = `false`,
		bool	flagPowerReduction = `false`,
		bool	flagMaintenanceNeeded = `false`,
		bool	flagEngineCommError = `false`,
		bool	flagSubThrottle = `false`,
		bool	flagNeutralStartProtect = `false`,
		bool	flagEngineShuttingDown = `false`
	)

inline

Setting up Message "Engine parameters dynamic" - PGN 127489.

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

Definition at line 1269 of file N2kMessages.h.

◆ SetN2kEngineDynamicParam() [2/2]

void SetN2kEngineDynamicParam	(	tN2kMsg &	N2kMsg,
		unsigned char	EngineInstance,
		double	EngineOilPress,
		double	EngineOilTemp,
		double	EngineCoolantTemp,
		double	AltenatorVoltage,
		double	FuelRate,
		double	EngineHours,
		double	EngineCoolantPress = `N2kDoubleNA`,
		double	EngineFuelPress = `N2kDoubleNA`,
		int8_t	EngineLoad = `N2kInt8NA`,
		int8_t	EngineTorque = `N2kInt8NA`,
		tN2kEngineDiscreteStatus1	Status1 = `0`,
		tN2kEngineDiscreteStatus2	Status2 = `0`
	)

inline

Setting up Message "Engine parameters dynamic" - PGN 127489.

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

Definition at line 1165 of file N2kMessages.h.

◆ SetN2kEngineParamRapid()

void SetN2kEngineParamRapid	(	tN2kMsg &	N2kMsg,
		unsigned char	EngineInstance,
		double	EngineSpeed,
		double	EngineBoostPressure = `N2kDoubleNA`,
		int8_t	EngineTiltTrim = `N2kInt8NA`
	)

inline

Setting up Message "Engine parameters rapid" - PGN 127488.

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

Definition at line 1087 of file N2kMessages.h.

◆ SetN2kEngineTripParameters()

void SetN2kEngineTripParameters	(	tN2kMsg &	N2kMsg,
		unsigned char	EngineInstance,
		double	TripFuelUsed,
		double	FuelRateAverage,
		double	FuelRateEconomy = `N2kDoubleNA`,
		double	InstantaneousFuelEconomy = `N2kDoubleNA`
	)

inline

Setting up Message "Trip Parameters, Engine" - PGN 127497.

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

Definition at line 1542 of file N2kMessages.h.

◆ SetN2kEnvironmentalParameters()

void SetN2kEnvironmentalParameters	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		tN2kTempSource	TempSource,
		double	Temperature,
		tN2kHumiditySource	HumiditySource = `N2khs_Undef`,
		double	Humidity = `N2kDoubleNA`,
		double	AtmosphericPressure = `N2kDoubleNA`
	)

inline

Setting up Message "Environmental Parameters - DEPRECATED" - PGN 130311.

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

Definition at line 4876 of file N2kMessages.h.

◆ SetN2kFluidLevel()

void SetN2kFluidLevel	(	tN2kMsg &	N2kMsg,
		unsigned char	Instance,
		tN2kFluidType	FluidType,
		double	Level,
		double	Capacity
	)

inline

Setting up Message "Fluid level" - PGN 127505.

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

Definition at line 1894 of file N2kMessages.h.

◆ SetN2kGNSS()

void SetN2kGNSS	(	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 = `0`,
		double	GeoidalSeparation = `0`,
		unsigned char	nReferenceStations = `0`,
		tN2kGNSStype	ReferenceStationType = `N2kGNSSt_GPS`,
		uint16_t	ReferenceSationID = `0`,
		double	AgeOfCorrection = `0`
	)

inline

Setting up Message "GNSS Position Data" - PGN 129029.

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

Definition at line 3065 of file N2kMessages.h.

◆ SetN2kGNSSDOPData()

void SetN2kGNSSDOPData	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		tN2kGNSSDOPmode	DesiredMode,
		tN2kGNSSDOPmode	ActualMode,
		double	HDOP,
		double	VDOP,
		double	TDOP
	)

inline

Setting up Message "GNSS DOP data - PGN 129539.

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

Definition at line 4076 of file N2kMessages.h.

◆ SetN2kGNSSSatellitesInView()

void SetN2kGNSSSatellitesInView	(	tN2kMsg &	N2kMsg,
		unsigned char	SID = `0xff`,
		tN2kRangeResidualMode	Mode = `N2kDD072_Unavailable`
	)

inline

Setting up Message "GNSS DOP data" - PGN 129540.

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

Definition at line 4185 of file N2kMessages.h.

◆ SetN2kHeadingTrackControl()

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

inline

Setting up Message "Heading/Track control" - PGN 127237.

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

Definition at line 526 of file N2kMessages.h.

◆ SetN2kHeave()

void SetN2kHeave	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		double	Heave,
		double	Delay = `N2kDoubleNA`,
		tN2kDelaySource	DelaySource = `N2kDD374_DataNotAvailable`
	)

inline

Setting up Message "Rate of Turn" - PGN 127252.

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

Definition at line 878 of file N2kMessages.h.

◆ SetN2kHumidity()

void SetN2kHumidity	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		unsigned char	HumidityInstance,
		tN2kHumiditySource	HumiditySource,
		double	ActualHumidity,
		double	SetHumidity = `N2kDoubleNA`
	)

inline

Setting up Message "Humidity" - PGN 130313.

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

Definition at line 5040 of file N2kMessages.h.

◆ SetN2kLatLonRapid()

void SetN2kLatLonRapid	(	tN2kMsg &	N2kMsg,
		double	Latitude,
		double	Longitude
	)

inline

Setting up Message "Position, Rapid Update" - PGN 129025.

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

Definition at line 2920 of file N2kMessages.h.

◆ SetN2kLeeway()

void SetN2kLeeway	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		double	Leeway
	)

inline

Setting up Message "Nautical Leeway Angle" - PGN 128000.

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

Definition at line 2283 of file N2kMessages.h.

◆ SetN2kLocalOffset()

void SetN2kLocalOffset	(	tN2kMsg &	N2kMsg,
		uint16_t	DaysSince1970,
		double	SecondsSinceMidnight,
		int16_t	LocalOffset
	)

inline

Setting up Message "Date,Time & Local offset" - PGN 129033.

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

Definition at line 3173 of file N2kMessages.h.

◆ SetN2kMagneticHeading()

void SetN2kMagneticHeading	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		double	Heading,
		double	Deviation = `N2kDoubleNA`,
		double	Variation = `N2kDoubleNA`
	)

inline

Setting up Message "Vessel Heading" - PGN 127250.

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

Definition at line 754 of file N2kMessages.h.

◆ SetN2kMagneticVariation()

void SetN2kMagneticVariation	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		tN2kMagneticVariation	Source,
		uint16_t	DaysSince1970,
		double	Variation
	)

inline

Setting up Message "Magnetic Variation" - PGN 127258.

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

Definition at line 1024 of file N2kMessages.h.

◆ SetN2kMeteorlogicalStationData()

void SetN2kMeteorlogicalStationData	(	tN2kMsg &	N2kMsg,
		const tN2kMeteorlogicalStationData &	N2kData
	)

inline

Setting up Message "Meterological Station Data" - PGN 130323.

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

Definition at line 5395 of file N2kMessages.h.

◆ SetN2kMOBNotification()

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

inline

Setting up Message "Man Overboard Notification" - PGN 127233.

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

Definition at line 379 of file N2kMessages.h.

◆ SetN2kNavigationInfo()

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

inline

Setting up Message "Navigation Data" - PGN 129284.

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

Definition at line 3890 of file N2kMessages.h.

◆ SetN2kOutsideEnvironmentalParameters()

void SetN2kOutsideEnvironmentalParameters	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		double	WaterTemperature,
		double	OutsideAmbientAirTemperature = `N2kDoubleNA`,
		double	AtmosphericPressure = `N2kDoubleNA`
	)

inline

Setting up Message "Environmental Parameters - DEPRECATED" - PGN 130310.

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

Definition at line 4793 of file N2kMessages.h.

◆ SetN2kPGN126992()

void SetN2kPGN126992	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		uint16_t	SystemDate,
		double	SystemTime,
		tN2kTimeSource	TimeSource = `N2ktimes_GPS`
	)

Setting up PGN126992 Message "System date/time".

The purpose of this PGN is to provide a regular transmission of UTC time and date; optionally synchronized to other parameter groups from the same source.

The default Priority is set to 3.

Parameters

N2kMsg	Reference to a N2kMsg Object
SID	Sequence ID. In most cases you can use just 0xff for SID. See SID. SID has been designed to make difference between sensor sampling or calculation. Same SID in different PGNs sent by same device defines that values on PGN:s has been sampled or calculated at same time.
SystemDate	Days since 1970-01-01 (UTC)
SystemTime	seconds since midnight (UTC)
TimeSource	Source of the Systemtime

See also: SetN2kSystemTime, tN2kTimeSource

Definition at line 28 of file N2kMessages.cpp.

◆ SetN2kPGN127233()

void SetN2kPGN127233	(	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
	)

Setting up PGN127233 Message "Man Overboard Notification".

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

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SID	Sequence identifier. In most cases you can use just 0xff for SID. See SID. The sequence identifier field is used to tie different PGNs data together to same sampling or calculation time.
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 87 of file N2kMessages.cpp.

◆ SetN2kPGN127237()

void SetN2kPGN127237	(	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
	)

Setting up PGN127237 Message "Heading/Track control".

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

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
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 160 of file N2kMessages.cpp.

◆ SetN2kPGN127245()

void SetN2kPGN127245	(	tN2kMsg &	N2kMsg,
		double	RudderPosition,
		unsigned char	Instance = `0`,
		tN2kRudderDirectionOrder	RudderDirectionOrder = `N2kRDO_NoDirectionOrder`,
		double	AngleOrder = `N2kDoubleNA`
	)

Setting up PGN127245 Message "Rudder".

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

Parameters

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.

See also: tN2kRudderDirectionOrder

Definition at line 254 of file N2kMessages.cpp.

◆ SetN2kPGN127250()

void SetN2kPGN127250	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		double	Heading,
		double	Deviation,
		double	Variation,
		tN2kHeadingReference	ref
	)

Setting up PGN127250 Message "Vessel Heading".

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

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SID	Sequence identifier. In most cases you can use just 0xff for SID. See SID. The sequence identifier field is used to tie different PGNs data together to same sampling or calculation time.
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 281 of file N2kMessages.cpp.

◆ SetN2kPGN127251()

void SetN2kPGN127251	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		double	RateOfTurn
	)

Setting up PGN 127251 Message "Rate of Turn".

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

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SID	Sequence identifier. In most cases you can use just 0xff for SID. See SID. The sequence identifier field is used to tie different PGNs data together to same sampling or calculation time.
RateOfTurn	Change in heading in radians per second

Definition at line 308 of file N2kMessages.cpp.

◆ SetN2kPGN127252()

void SetN2kPGN127252	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		double	Heave,
		double	Delay = `N2kDoubleNA`,
		tN2kDelaySource	DelaySource = `N2kDD374_DataNotAvailable`
	)

Setting up PGN 127252 Message "Heave".

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

Parameters

N2kMsg	Reference to a N2kMsg Object,
SID	Sequence identifier. In most cases you can use just 0xff for SID. See SID. The sequence identifier field is used to tie different PGNs data together to same sampling or calculation time.
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 337 of file N2kMessages.cpp.

◆ SetN2kPGN127257()

void SetN2kPGN127257	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		double	Yaw,
		double	Pitch,
		double	Roll
	)

Setting up PGN 127257 Message "Attitude".

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

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SID	Sequence identifier. In most cases you can use just 0xff for SID. See SID. The sequence identifier field is used to tie different PGNs data together to same sampling or calculation time.
Yaw	Heading in radians.
Pitch	Pitch in radians. Positive, when your bow rises.
Roll	Roll in radians. Positive, when tilted right.

Definition at line 370 of file N2kMessages.cpp.

◆ SetN2kPGN127258()

void SetN2kPGN127258	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		tN2kMagneticVariation	Source,
		uint16_t	DaysSince1970,
		double	Variation
	)

Setting up PGN 127258 Message "Magnetic Variation".

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

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SID	Sequence identifier. In most cases you can use just 0xff for SID. See SID. The sequence identifier field is used to tie different PGNs data together to same sampling or calculation time.
Source	How was the variation value generated
DaysSince1970	Days since January 1, 1970
Variation	Magnetic variation/declination in radians

Definition at line 394 of file N2kMessages.cpp.

◆ SetN2kPGN127488()

void SetN2kPGN127488	(	tN2kMsg &	N2kMsg,
		unsigned char	EngineInstance,
		double	EngineSpeed,
		double	EngineBoostPressure = `N2kDoubleNA`,
		int8_t	EngineTiltTrim = `N2kInt8NA`
	)

Setting up PGN 127488 Message "Engine parameters rapid".

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

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
EngineInstance	Engine instance.
EngineSpeed	RPM (Revolutions Per Minute)
EngineBoostPressure	in Pascal
EngineTiltTrim	in %

Definition at line 418 of file N2kMessages.cpp.

◆ SetN2kPGN127489() [1/2]

void SetN2kPGN127489	(	tN2kMsg &	N2kMsg,
		unsigned char	EngineInstance,
		double	EngineOilPress,
		double	EngineOilTemp,
		double	EngineCoolantTemp,
		double	AltenatorVoltage,
		double	FuelRate,
		double	EngineHours,
		double	EngineCoolantPress = `N2kDoubleNA`,
		double	EngineFuelPress = `N2kDoubleNA`,
		int8_t	EngineLoad = `N2kInt8NA`,
		int8_t	EngineTorque = `N2kInt8NA`,
		bool	flagCheckEngine = `false`,
		bool	flagOverTemp = `false`,
		bool	flagLowOilPress = `false`,
		bool	flagLowOilLevel = `false`,
		bool	flagLowFuelPress = `false`,
		bool	flagLowSystemVoltage = `false`,
		bool	flagLowCoolantLevel = `false`,
		bool	flagWaterFlow = `false`,
		bool	flagWaterInFuel = `false`,
		bool	flagChargeIndicator = `false`,
		bool	flagPreheatIndicator = `false`,
		bool	flagHighBoostPress = `false`,
		bool	flagRevLimitExceeded = `false`,
		bool	flagEgrSystem = `false`,
		bool	flagTPS = `false`,
		bool	flagEmergencyStopMode = `false`,
		bool	flagWarning1 = `false`,
		bool	flagWarning2 = `false`,
		bool	flagPowerReduction = `false`,
		bool	flagMaintenanceNeeded = `false`,
		bool	flagEngineCommError = `false`,
		bool	flagSubThrottle = `false`,
		bool	flagNeutralStartProtect = `false`,
		bool	flagEngineShuttingDown = `false`
	)

inline

Setting up PGN 127489 Message "Engine parameters dynamic".

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

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
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 %
flagCheckEngine	Status flag CheckEngine
flagOverTemp	Status flag OverTemp
flagLowOilPress	Status flag LowOilPress
flagLowOilLevel	Status flag LowOilLevel
flagLowFuelPress	Status flag LowFuelPress
flagLowSystemVoltage	Status flag LowSystemVoltage
flagLowCoolantLevel	Status flag LowCoolantLevel
flagWaterFlow	Status flag WaterFlow
flagWaterInFuel	Status flag WaterInFuel
flagChargeIndicator	Status flag ChargeIndicator
flagPreheatIndicator	Status flag PreheatIndicator
flagHighBoostPress	Status flag HighBoostPress
flagRevLimitExceeded	Status flag RevLimitExceeded
flagEgrSystem	Status flag EgrSystem
flagTPS	Status flag TPS
flagEmergencyStopMode	Status flag EmergencyStopMode
flagWarning1	Status flag Warning1
flagWarning2	Status flag Warning2
flagPowerReduction	Status flag PowerReduction
flagMaintenanceNeeded	Status flag MaintenanceNeeded
flagEngineCommError	Status flag EngineCommError
flagSubThrottle	Status flag SubThrottle
flagNeutralStartProtect	Status flag NeutralStartProtect
flagEngineShuttingDown	Status flag EngineShuttingDown

Definition at line 1221 of file N2kMessages.h.

◆ SetN2kPGN127489() [2/2]

void SetN2kPGN127489	(	tN2kMsg &	N2kMsg,
		unsigned char	EngineInstance,
		double	EngineOilPress,
		double	EngineOilTemp,
		double	EngineCoolantTemp,
		double	AltenatorVoltage,
		double	FuelRate,
		double	EngineHours,
		double	EngineCoolantPress = `N2kDoubleNA`,
		double	EngineFuelPress = `N2kDoubleNA`,
		int8_t	EngineLoad = `N2kInt8NA`,
		int8_t	EngineTorque = `N2kInt8NA`,
		tN2kEngineDiscreteStatus1	Status1 = `0`,
		tN2kEngineDiscreteStatus2	Status2 = `0`
	)

Setting up PGN 127489 Message "Engine parameters dynamic".

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

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
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 446 of file N2kMessages.cpp.

◆ SetN2kPGN127493()

void SetN2kPGN127493	(	tN2kMsg &	N2kMsg,
		unsigned char	EngineInstance,
		tN2kTransmissionGear	TransmissionGear,
		double	OilPressure,
		double	OilTemperature,
		unsigned char	DiscreteStatus1 = `0`
	)

Setting up PGN 127493 Message "Transmission parameters, dynamic".

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

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
EngineInstance	Engine instance.
TransmissionGear	Selected transmission. tN2kTransmissionGear
OilPressure	in Pascal
OilTemperature	in Kelvin
DiscreteStatus1	in %

Definition at line 499 of file N2kMessages.cpp.

◆ SetN2kPGN127497()

void SetN2kPGN127497	(	tN2kMsg &	N2kMsg,
		unsigned char	EngineInstance,
		double	TripFuelUsed,
		double	FuelRateAverage,
		double	FuelRateEconomy = `N2kDoubleNA`,
		double	InstantaneousFuelEconomy = `N2kDoubleNA`
	)

Setting up PGN 127497 Message "Trip Parameters, Engine".

Engine related trip / fuel information.

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
EngineInstance	Engine instance
TripFuelUsed	in litres
FuelRateAverage	in litres/hour
FuelRateEconomy	in litres/hour
InstantaneousFuelEconomy	in litres/hour

Definition at line 528 of file N2kMessages.cpp.

◆ SetN2kPGN127501() [1/2]

void SetN2kPGN127501	(	tN2kMsg &	N2kMsg,
		unsigned char	DeviceBankInstance,
		tN2kBinaryStatus	BankStatus
	)

Setting up 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.

Parameters

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 578 of file N2kMessages.cpp.

◆ SetN2kPGN127501() [2/2]

void SetN2kPGN127501	(	tN2kMsg &	N2kMsg,
		unsigned char	DeviceBankInstance,
		tN2kOnOff	Status1,
		tN2kOnOff	Status2 = `N2kOnOff_Unavailable`,
		tN2kOnOff	Status3 = `N2kOnOff_Unavailable`,
		tN2kOnOff	Status4 = `N2kOnOff_Unavailable`
	)

Setting up PGN 127501 Message "Universal Binary Status Report".

Note: This function uses only the first four states of the bank status.

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

Parameters

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 587 of file N2kMessages.cpp.

◆ SetN2kPGN127502()

void SetN2kPGN127502	(	tN2kMsg &	N2kMsg,
		unsigned char	TargetBankInstance,
		tN2kBinaryStatus	BankStatus
	)

Set up PGN 127502 "Switch Bank Control" message.

Command channel states on a remote switch bank. Up to 28 remote binary states can be controlled.

When you create a tN2kBinaryStatus object for use with this function you should ensure that you only command (that is set ON or OFF) those channels which you intend to operate. Channels in which you have no interest should not be commanded but set not available.

Review N2kResetBinaryStatus, N2kSetStatusOnBinaryStatus and the documentation of tN2kOnOff for information on how to set up bank status.

Remember as well, that transmission of a PGN 127502 message is equivalent to issuing a command, so do not send the same message repeatdly: once should be enough. You can always check that the target switchbank has responded by checking its PGN 127501 broadcasts.

Note: This PGN is deprecated by NMEA and modern switch bank devices may well not support it, favouring PGN 126208 Command Group Function.

Parameters

N2kMsg	Reference to an N2kMsg Object which will be configured for sending on the NMEA bus.
DeviceBankInstance	Instance number of the target switchbank (i.e. the device to be controlled).
BankStatus	Full bank status containing the channel states to be commanded on the remote switchbank. N2kGetStatusOnBinaryStatus

Definition at line 651 of file N2kMessages.cpp.

◆ SetN2kPGN127505()

void SetN2kPGN127505	(	tN2kMsg &	N2kMsg,
		unsigned char	Instance,
		tN2kFluidType	FluidType,
		double	Level,
		double	Capacity
	)

Setting up PGN 127505 Message "Fluid level".

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

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
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 660 of file N2kMessages.cpp.

◆ SetN2kPGN127506()

void SetN2kPGN127506	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		unsigned char	DCInstance,
		tN2kDCType	DCType,
		unsigned char	StateOfCharge,
		unsigned char	StateOfHealth,
		double	TimeRemaining,
		double	RippleVoltage = `N2kDoubleNA`,
		double	Capacity = `N2kDoubleNA`
	)

Setting up PGN 127506 Message "DC Detailed Status".

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

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SID	Sequence identifier. In most cases you can use just 0xff for SID. See SID. The sequence identifier field is used to tie different PGNs data together to same sampling or calculation time.
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

◆ SetN2kPGN127507()

void SetN2kPGN127507	(	tN2kMsg &	N2kMsg,
		unsigned char	Instance,
		unsigned char	BatteryInstance,
		tN2kChargeState	ChargeState,
		tN2kChargerMode	ChargerMode = `N2kCM_Standalone`,
		tN2kOnOff	Enabled = `N2kOnOff_On`,
		tN2kOnOff	EqualizationPending = `N2kOnOff_Unavailable`,
		double	EqualizationTimeRemaining = `N2kDoubleNA`
	)

Setting up PGN 127507 Message "DC Charger Status".

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

Note: This PGN is DEPRECATED

Parameters

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 729 of file N2kMessages.cpp.

◆ SetN2kPGN127508()

void SetN2kPGN127508	(	tN2kMsg &	N2kMsg,
		unsigned char	BatteryInstance,
		double	BatteryVoltage,
		double	BatteryCurrent = `N2kDoubleNA`,
		double	BatteryTemperature = `N2kDoubleNA`,
		unsigned char	SID = `0xff`
	)

Setting up PGN 127508 Message "Battery Status".

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

Parameters

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 identifier. In most cases you can use just 0xff for SID. See SID. The sequence identifier field is used to tie different PGNs data together to same sampling or calculation time.

Definition at line 763 of file N2kMessages.cpp.

◆ SetN2kPGN127513()

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

Setting up PGN 127513 Message "Battery Configuration Status".

Any device connected to a battery may transmit this message.

Parameters

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 790 of file N2kMessages.cpp.

◆ SetN2kPGN128000()

void SetN2kPGN128000	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		double	Leeway
	)

Setting up PGN 128000 Message "Nautical Leeway Angle".

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

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

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

NMEA2000 document

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SID	Sequence identifier. In most cases you can use just 0xff for SID. See SID. The sequence identifier field is used to tie different PGNs data together to same sampling or calculation time.
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 825 of file N2kMessages.cpp.

◆ SetN2kPGN128259()

void SetN2kPGN128259	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		double	WaterReferenced,
		double	GroundReferenced = `N2kDoubleNA`,
		tN2kSpeedWaterReferenceType	SWRT = `N2kSWRT_Paddle_wheel`
	)

Setting up PGN 128259 Message "Boat Speed, Water Referenced".

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

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SID	Sequence identifier. In most cases you can use just 0xff for SID. See SID. The sequence identifier field is used to tie different PGNs data together to same sampling or calculation time.
WaterReferenced	Speed over water in m/s
GroundReferenced	Speed over Ground in m/s
SWRT	Type of transducer. See tN2kSpeedWaterReferenceType

Todo:: There is an additional 4bit field "speed direction" in this PGN this could be added for the future.

Definition at line 850 of file N2kMessages.cpp.

◆ SetN2kPGN128267()

void SetN2kPGN128267	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		double	DepthBelowTransducer,
		double	Offset,
		double	Range = `N2kDoubleNA`
	)

Setting up PGN 128267 Message "Water depth".

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

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SID	Sequence identifier. In most cases you can use just 0xff for SID. See SID. The sequence identifier field is used to tie different PGNs data together to same sampling or calculation time.
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 876 of file N2kMessages.cpp.

◆ SetN2kPGN128275()

void SetN2kPGN128275	(	tN2kMsg &	N2kMsg,
		uint16_t	DaysSince1970,
		double	SecondsSinceMidnight,
		uint32_t	Log,
		uint32_t	TripLog
	)

Setting up PGN 128275 Message "Distance log".

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

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
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 899 of file N2kMessages.cpp.

◆ SetN2kPGN128776()

void SetN2kPGN128776	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		unsigned char	WindlassIdentifier,
		tN2kWindlassDirectionControl	WindlassDirectionControl,
		unsigned char	SpeedControl,
		tN2kSpeedType	SpeedControlType = `N2kDD488_DataNotAvailable`,
		tN2kGenericStatusPair	AnchorDockingControl = `N2kDD002_Unavailable`,
		tN2kGenericStatusPair	PowerEnable = `N2kDD002_Unavailable`,
		tN2kGenericStatusPair	MechanicalLock = `N2kDD002_Unavailable`,
		tN2kGenericStatusPair	DeckAndAnchorWash = `N2kDD002_Unavailable`,
		tN2kGenericStatusPair	AnchorLight = `N2kDD002_Unavailable`,
		double	CommandTimeout = `0.4`,
		const tN2kWindlassControlEvents &	WindlassControlEvents = `tN2kWindlassControlEvents()`
	)

Setting up PGN 128776 Message "Anchor Windlass Control Status".

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

See also: https://www.nmea.org/Assets/20190613%20windlass%20amendment,%20128776,%20128777,%20128778.pdf

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SID	Sequence identifier. In most cases you can use just 0xff for SID. See SID. The sequence identifier field is used to tie different PGNs data together to same sampling or calculation time.
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	(optional) see tN2kSpeedType
AnchorDockingControl	(optional) see tN2kGenericStatusPair
PowerEnable	(optional) see tN2kGenericStatusPair
MechanicalLock	(optional) see tN2kGenericStatusPair
DeckAndAnchorWash	(optional) see tN2kGenericStatusPair
AnchorLight	(optional) see tN2kGenericStatusPair
CommandTimeout	(optional) range 0.25 ... 1.26sec -> If timeout elapses the thruster stops operating and reverts to static mode.
WindlassControlEvents	(optional) 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 926 of file N2kMessages.cpp.

◆ SetN2kPGN128777()

void SetN2kPGN128777	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		unsigned char	WindlassIdentifier,
		double	RodeCounterValue,
		double	WindlassLineSpeed = `N2kDoubleNA`,
		tN2kWindlassMotionStates	WindlassMotionStatus = `N2kDD480_Unavailable`,
		tN2kRodeTypeStates	RodeTypeStatus = `N2kDD481_Unavailable`,
		tN2kDD482	AnchorDockingStatus = `N2kDD482_DataNotAvailable`,
		const tN2kWindlassOperatingEvents &	WindlassOperatingEvents = `tN2kWindlassOperatingEvents()`
	)

Setting up PGN 128777 Message "Anchor Windlass Operating Status".

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

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SID	Sequence identifier. In most cases you can use just 0xff for SID. See SID. The sequence identifier field is used to tie different PGNs data together to same sampling or calculation time.
WindlassIdentifier	Unique Identifier of a function within a Virtual Device: 0 - 255
RodeCounterValue	amount of rode deployed in meters
WindlassLineSpeed	(optional) Amount of rode deployed or retrieved per minute.
WindlassMotionStatus	(optional) Indicates current physical state of windlass movement. see tN2kWindlassMotionStates
RodeTypeStatus	(optional) Indicates whether chain or rope is currently being deployed or retrieved. see tN2kRodeTypeStates
AnchorDockingStatus	(optional) 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 991 of file N2kMessages.cpp.

◆ SetN2kPGN128778()

void SetN2kPGN128778	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		unsigned char	WindlassIdentifier,
		double	TotalMotorTime,
		double	ControllerVoltage = `N2kDoubleNA`,
		double	MotorCurrent = `N2kDoubleNA`,
		const tN2kWindlassMonitoringEvents &	WindlassMonitoringEvents = `tN2kWindlassMonitoringEvents()`
	)

Setting up PGN 128778Message "Anchor Windlass Monitoring Status".

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

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SID	Sequence identifier. In most cases you can use just 0xff for SID. See SID. The sequence identifier field is used to tie different PGNs data together to same sampling or calculation time.
WindlassIdentifier	Unique Identifier of a function within a Virtual Device: 0 - 255
TotalMotorTime	Total time windlass has operated since last reset in seconds
ControllerVoltage	(optional) Supply voltage of electronic windlass controller in Volt
MotorCurrent	(optional) Load current of electric windlass motor in Ampere
WindlassMonitoringEvents	(optional) 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 1043 of file N2kMessages.cpp.

◆ SetN2kPGN129025()

void SetN2kPGN129025	(	tN2kMsg &	N2kMsg,
		double	Latitude,
		double	Longitude
	)

Setting up PGN 129025 Message "Position, Rapid Update".

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

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
Latitude	Latitude in degrees
Longitude	Longitude in degrees

Definition at line 1085 of file N2kMessages.cpp.

◆ SetN2kPGN129026()

void SetN2kPGN129026	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		tN2kHeadingReference	ref,
		double	COG,
		double	SOG
	)

Setting up PGN 129026 Message "COG SOG rapid update".

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

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SID	Sequence identifier. In most cases you can use just 0xff for SID. See SID. The sequence identifier field is used to tie different PGNs data together to same sampling or calculation time.
ref	COG reference, see tN2kHeadingReference
COG	Course Over Ground in radians
SOG	Speed Over Ground in m/s

Definition at line 1104 of file N2kMessages.cpp.

◆ SetN2kPGN129029()

void SetN2kPGN129029	(	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 = `0`,
		double	GeoidalSeparation = `0`,
		unsigned char	nReferenceStations = `0`,
		tN2kGNSStype	ReferenceStationType = `N2kGNSSt_GPS`,
		uint16_t	ReferenceSationID = `0`,
		double	AgeOfCorrection = `0`
	)

Setting up PGN 129029 Message "GNSS Position Data".

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

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SID	Sequence identifier. In most cases you can use just 0xff for SID. See SID. The sequence identifier field is used to tie different PGNs data together to same sampling or calculation time.
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

Definition at line 1130 of file N2kMessages.cpp.

◆ SetN2kPGN129033()

void SetN2kPGN129033	(	tN2kMsg &	N2kMsg,
		uint16_t	DaysSince1970,
		double	SecondsSinceMidnight,
		int16_t	LocalOffset
	)

Setting up PGN 129033 Message "Date,Time & Local offset".

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

See also: SetN2kPGN126992 , ParseN2kPGN126992

Parameters

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 1200 of file N2kMessages.cpp.

◆ SetN2kPGN129038()

void SetN2kPGN129038	(	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,
		double	ROT,
		tN2kAISNavStatus	NavStatus
	)

Setting up PGN 129038 Message "AIS position reports for Class A".

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

See also: ITU-R M.1371

Parameters

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 0 = default 1 = high (≤10 m) 0 = low (>10 m)
RAIM	{bool}Receiver autonomous integrity monitoring (RAIM) flag of electronic position fixing device 0 = RAIM not in use = default 1 = RAIM in use
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
AISTransceiverInformation	see tN2kAISTransceiverInformation
Heading	heading
ROT	Rate of turn
NavStatus	Navigational status, see tN2kAISNavStatus

Definition at line 1330 of file N2kMessages.cpp.

◆ SetN2kPGN129039()

void SetN2kPGN129039	(	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,
		unsigned char	SID = `0xff`
	)

Setting up PGN 129039 Message "AIS position reports for Class B".

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

See also: ITU-R M.1371

Parameters

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 0 = default 1 = high (≤10 m) 0 = low (>10 m)
RAIM	{bool}Receiver autonomous integrity monitoring (RAIM) flag of electronic position fixing device 0 = RAIM not in use = default 1 = RAIM in use
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, 0 = No display available; not capable of displaying AIS Message 12 and 14 1 = Equipped with integrated display displaying AIS Message 12 and 14
DSC	Class B DSC flag 0 = Not equipped with DSC function 1 = Equipped with DSC function (dedicated or time-shared)
Band	Class B band flag 0 = Capable of operating over the upper 525 kHz band of the marine band 1 = Capable of operating over the whole marine band (irrelevant if “Class B Message 22 flag” is 0)
Msg22	Class B Message22 flag 0 = No frequency management via Message 22 , operating on AIS1, AIS2 only 1 = Frequency management via Message 22
Mode	Station Operating Mode flag, see tN2kAISMode
State	Communication State Selector Flag 0 = SOTDMA communication state follows 1 = ITDMA communication state follows (always “1” for Class-B “CS”)
SID	Sequence identifier. In most cases you can use just 0xff for SID. See SID. The sequence identifier field is used to tie different PGNs data together to same sampling or calculation time.

Definition at line 1382 of file N2kMessages.cpp.

◆ SetN2kPGN129041()

void SetN2kPGN129041	(	tN2kMsg &	N2kMsg,
		const tN2kAISAtoNReportData &	N2kData
	)

Setting up PGN 129041 Message "AIS Aids to Navigation (AtoN) Report".

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

Parameters

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 1443 of file N2kMessages.cpp.

◆ SetN2kPGN129283()

void SetN2kPGN129283	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		tN2kXTEMode	XTEMode,
		bool	NavigationTerminated,
		double	XTE
	)

Setting up PGN 129283 Message "Cross Track Error".

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

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SID	Sequence identifier. In most cases you can use just 0xff for SID. See SID. The sequence identifier field is used to tie different PGNs data together to same sampling or calculation time.
XTEMode	CrossTrackError Mode, see tN2kXTEMode
NavigationTerminated	{bool] Navigation has been terminated
XTE	CrossTrackError in meter

Definition at line 1496 of file N2kMessages.cpp.

◆ SetN2kPGN129284()

void SetN2kPGN129284	(	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
	)

Setting up PGN 129284 Message "Navigation Data".

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

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SID	Sequence identifier. In most cases you can use just 0xff for SID. See SID. The sequence identifier field is used to tie different PGNs data together to same sampling or calculation time.
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 1522 of file N2kMessages.cpp.

◆ SetN2kPGN129285() [1/2]

void SetN2kPGN129285	(	tN2kMsg &	N2kMsg,
		uint16_t	Start,
		uint16_t	Database,
		uint16_t	Route,
		bool	NavDirection,
		bool	SupplementaryData,
		char *	RouteName
	)

inline

Setting up Message "Route/WP information" - PGN 129285 (for backwards compatibility)

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

Definition at line 4004 of file N2kMessages.h.

◆ SetN2kPGN129285() [2/2]

void SetN2kPGN129285	(	tN2kMsg &	N2kMsg,
		uint16_t	Start,
		uint16_t	Database,
		uint16_t	Route,
		tN2kNavigationDirection	NavDirection,
		const char *	RouteName,
		tN2kGenericStatusPair	SupplementaryData = `N2kDD002_No`
	)

Setting up PGN 129285 Message "Route/WP information".

This parameter group returns Route and WP data ahead in the Active Route. It can be requested or may be transmitted without a request, typically at each Waypoint advance.

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
Start	The ID of the first waypoint
Database	Database ID
Route	Route ID
NavDirection	Navigation direction in route, see tN2kNavigationDirection
SupplementaryData	Supplementary Route/WP data available
RouteName	The name of the current route

Definition at line 1575 of file N2kMessages.cpp.

◆ SetN2kPGN129539()

void SetN2kPGN129539	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		tN2kGNSSDOPmode	DesiredMode,
		tN2kGNSSDOPmode	ActualMode,
		double	HDOP,
		double	VDOP,
		double	TDOP
	)

Setting up PGN 129539 Message "GNSS DOP data".

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

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SID	Sequence identifier. In most cases you can use just 0xff for SID. See SID. The sequence identifier field is used to tie different PGNs data together to same sampling or calculation time.
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 1221 of file N2kMessages.cpp.

◆ SetN2kPGN129540()

void SetN2kPGN129540	(	tN2kMsg &	N2kMsg,
		unsigned char	SID = `0xff`,
		tN2kRangeResidualMode	Mode = `N2kDD072_Unavailable`
	)

Setting up PGN 129540 Message "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.

To add satellites use AppendN2kPGN129540 and tSatelliteInfo

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SID	Sequence identifier. In most cases you can use just 0xff for SID. See SID. The sequence identifier field is used to tie different PGNs data together to same sampling or calculation time.
Mode	Range residual mode, see tN2kRangeResidualMode

See also: AppendN2kPGN129540, SetN2kGNSSSatellitesInView

Definition at line 1257 of file N2kMessages.cpp.

◆ SetN2kPGN129794()

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

Setting up PGN 129794 Message "AIS static data class A".

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

See also: ITU-R M.1371

Parameters

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 - Max. 7 chars will be used. Input string will be converted to contain only SixBit ASCII character set (see. ITU-R M.1371-1)
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)
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 Input string will be converted to contain only SixBit ASCII character set (see. ITU-R M.1371-1)
AISversion	AIS version, see tN2kAISVersion
GNSStype	Type of GNSS, see tN2kGNSStype
DTE	Data terminal equipment (DTE) ready 0 = available 1 = not available = default
AISinfo	AIS Transceiver Information, see tN2kAISTransceiverInformation

Definition at line 1613 of file N2kMessages.cpp.

◆ SetN2kPGN129802()

void SetN2kPGN129802	(	tN2kMsg &	N2kMsg,
		uint8_t	MessageID,
		tN2kAISRepeat	Repeat,
		uint32_t	SourceID,
		tN2kAISTransceiverInformation	AISTransceiverInformation,
		char *	SafetyRelatedText
	)

Setting up PGN129802 Message "AIS Safety Related Broadcast Message".

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

Parameters

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

See also: tN2kAISTransceiverInformation

Definition at line 55 of file N2kMessages.cpp.

◆ SetN2kPGN129809()

void SetN2kPGN129809	(	tN2kMsg &	N2kMsg,
		uint8_t	MessageID,
		tN2kAISRepeat	Repeat,
		uint32_t	UserID,
		const char *	Name
	)

Setting up PGN 129809 Message "AIS static data class B part A".

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

See also: ITU-R M.1371; SetN2kPGN129810 and ParseN2kPGN129810

Parameters

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)

Definition at line 1673 of file N2kMessages.cpp.

◆ SetN2kPGN129810()

void SetN2kPGN129810	(	tN2kMsg &	N2kMsg,
		uint8_t	MessageID,
		tN2kAISRepeat	Repeat,
		uint32_t	UserID,
		uint8_t	VesselType,
		const char *	Vendor,
		const char *	Callsign,
		double	Length,
		double	Beam,
		double	PosRefStbd,
		double	PosRefBow,
		uint32_t	MothershipID
	)

Setting up PGN 129810 Message "AIS static data class B part B".

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

See also: ITU-R M.1371; SetN2kPGN129809 and ParseN2kPGN129809

Parameters

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 Max. 7 chars will be used. Input string will be converted to contain only SixBit ASCII character set (see. ITU-R M.1371-1)
Callsign	Call Sign - Max. 7 chars will be used. Input string will be converted to contain only SixBit ASCII character set (see. ITU-R M.1371-1)
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

Definition at line 1698 of file N2kMessages.cpp.

◆ SetN2kPGN130074()

void SetN2kPGN130074	(	tN2kMsg &	N2kMsg,
		uint16_t	Start,
		uint16_t	NumWaypoints,
		uint16_t	Database
	)

Setting up PGN 130074 Message " Route and WP Service - WP List - WP Name & Position".

Complex request of this PGN should return the Waypoints of a WP-List.

This function sets up the basic Message with some general information about the waypoint list. To add certain waypoints see AppendN2kPGN130074.

See also: AppendN2kPGN130074

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
Start	The ID of the first waypoint
NumWaypoints	Number of valid WPs in the WP-List
Database	Database ID

Definition at line 1742 of file N2kMessages.cpp.

◆ SetN2kPGN130306()

void SetN2kPGN130306	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		double	WindSpeed,
		double	WindAngle,
		tN2kWindReference	WindReference
	)

Setting up PGN 130306 Message "Wind Data".

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

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SID	Sequence identifier. In most cases you can use just 0xff for SID. See SID. The sequence identifier field is used to tie different PGNs data together to same sampling or calculation time.
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 1788 of file N2kMessages.cpp.

◆ SetN2kPGN130310()

void SetN2kPGN130310	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		double	WaterTemperature,
		double	OutsideAmbientAirTemperature = `N2kDoubleNA`,
		double	AtmosphericPressure = `N2kDoubleNA`
	)

Setting up PGN 130310 Message " Environmental Parameters - DEPRECATED".

Local atmospheric environmental conditions.

Note: This PGN has been depricated. Specific PGNs 130316 Temperature, 130313 Relative Humidity, 130314 Actual Pressure, 130315 Set Pressure shall be used.

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SID	Sequence identifier. In most cases you can use just 0xff for SID. See SID. The sequence identifier field is used to tie different PGNs data together to same sampling or calculation time.
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 1812 of file N2kMessages.cpp.

◆ SetN2kPGN130311()

void SetN2kPGN130311	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		tN2kTempSource	TempSource,
		double	Temperature,
		tN2kHumiditySource	HumiditySource = `N2khs_Undef`,
		double	Humidity = `N2kDoubleNA`,
		double	AtmosphericPressure = `N2kDoubleNA`
	)

Setting up PGN 130311 Message "Environmental Parameters - DEPRECATED".

Note: This PGN has been deprecated. Specific PGNs 130316 Temperature, 130313 Relative Humidity, 130314 Actual Pressure, 130315 Set Pressure shall be used.; In PGN 130311 TempInstance is named as TempSource (other then in PGN 130312 where TempSource really means source of temperature)

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SID	Sequence identifier. In most cases you can use just 0xff for SID. See SID. The sequence identifier field is used to tie different PGNs data together to same sampling or calculation time.
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 1838 of file N2kMessages.cpp.

◆ SetN2kPGN130312()

void SetN2kPGN130312	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		unsigned char	TempInstance,
		tN2kTempSource	TempSource,
		double	ActualTemperature,
		double	SetTemperature = `N2kDoubleNA`
	)

Setting up PGN 130312 Message "Temperature - DEPRECATED".

Note: Temperature as measured by a specific temperature source. This PGN has been deprecated. Please use PGN 130316 (Temperature-Extended Range) for all new designs.

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SID	Sequence identifier. In most cases you can use just 0xff for SID. See SID. The sequence identifier field is used to tie different PGNs data together to same sampling or calculation time.
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 1866 of file N2kMessages.cpp.

◆ SetN2kPGN130313()

void SetN2kPGN130313	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		unsigned char	HumidityInstance,
		tN2kHumiditySource	HumiditySource,
		double	ActualHumidity,
		double	SetHumidity = `N2kDoubleNA`
	)

Setting up PGN 130313 Message "Humidity".

Humidity as measured by a specific humidity source.

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SID	Sequence identifier. In most cases you can use just 0xff for SID. See SID. The sequence identifier field is used to tie different PGNs data together to same sampling or calculation time.
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 1894 of file N2kMessages.cpp.

◆ SetN2kPGN130314()

void SetN2kPGN130314	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		unsigned char	PressureInstance,
		tN2kPressureSource	PressureSource,
		double	Pressure
	)

Setting up PGN 130314 Message "Actual Pressure".

Pressure as measured by a specific pressure source

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SID	Sequence identifier. In most cases you can use just 0xff for SID. See SID. The sequence identifier field is used to tie different PGNs data together to same sampling or calculation time.
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 pressure in Pascals. Use function mBarToPascal, if you like to use mBar

Definition at line 1921 of file N2kMessages.cpp.

◆ SetN2kPGN130315()

void SetN2kPGN130315	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		unsigned char	PressureInstance,
		tN2kPressureSource	PressureSource,
		double	SetPressure
	)

Setting up PGN 130315 Message "Set Pressure".

This parameter group can be sent to a device that controls pressure to change its targeted pressure, or it can be sent out by the control device to indicate its current targeted pressure.

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SID	Sequence identifier. In most cases you can use just 0xff for SID. See SID. The sequence identifier field is used to tie different PGNs data together to same sampling or calculation time.
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
SetPressure	Set pressure in Pascals. Use function mBarToPascal, if you like to use mBar

Definition at line 1946 of file N2kMessages.cpp.

◆ SetN2kPGN130316()

void SetN2kPGN130316	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		unsigned char	TempInstance,
		tN2kTempSource	TempSource,
		double	ActualTemperature,
		double	SetTemperature = `N2kDoubleNA`
	)

Setting up PGN 130316 Message "Temperature, Extended Range".

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

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
SID	Sequence identifier. In most cases you can use just 0xff for SID. See SID. The sequence identifier field is used to tie different PGNs data together to same sampling or calculation time.
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 1960 of file N2kMessages.cpp.

◆ SetN2kPGN130323()

void SetN2kPGN130323	(	tN2kMsg &	N2kMsg,
		const tN2kMeteorlogicalStationData &	N2kData
	)

Setting up PGN 130323 Message "Meterological Station Data".

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

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
N2kData	Meterological Station Data, see tN2kMeteorlogicalStationData

Definition at line 1986 of file N2kMessages.cpp.

◆ SetN2kPGN130576()

void SetN2kPGN130576	(	tN2kMsg &	N2kMsg,
		int8_t	PortTrimTab,
		int8_t	StbdTrimTab
	)

Setting up PGN 130576 Message "Trim Tab Status".

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

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
PortTrimTab	Port trim tab position
StbdTrimTab	Starboard trim tab position

Definition at line 2034 of file N2kMessages.cpp.

◆ SetN2kPGN130577()

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

Setting up PGN 130577 Message "Direction Data".

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

Parameters

N2kMsg	Reference to a N2kMsg Object, Output: NMEA2000 message ready to be send.
DataMode	Data mode, see tN2kDataMode
CogReference	True or Magnetic
SID	Sequence identifier. In most cases you can use just 0xff for SID. See SID. The sequence identifier field is used to tie different PGNs data together to same sampling or calculation time.
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 2055 of file N2kMessages.cpp.

◆ SetN2kPressure()

void SetN2kPressure	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		unsigned char	PressureInstance,
		tN2kPressureSource	PressureSource,
		double	Pressure
	)

inline

Setting up Message "Actual Pressure" - PGN 130314.

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

Definition at line 5136 of file N2kMessages.h.

◆ SetN2kRateOfTurn()

void SetN2kRateOfTurn	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		double	RateOfTurn
	)

inline

Setting up Message "Rate of Turn" - PGN 127251.

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

Definition at line 819 of file N2kMessages.h.

◆ SetN2kRouteWPInfo()

void SetN2kRouteWPInfo	(	tN2kMsg &	N2kMsg,
		uint16_t	Start,
		uint16_t	Database,
		uint16_t	Route,
		tN2kNavigationDirection	NavDirection,
		const char *	RouteName,
		tN2kGenericStatusPair	SupplementaryData = `N2kDD002_No`
	)

inline

Setting up Message "Route/WP information" - PGN 129285.

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

Definition at line 3991 of file N2kMessages.h.

◆ SetN2kRudder()

void SetN2kRudder	(	tN2kMsg &	N2kMsg,
		double	RudderPosition,
		unsigned char	Instance = `0`,
		tN2kRudderDirectionOrder	RudderDirectionOrder = `N2kRDO_NoDirectionOrder`,
		double	AngleOrder = `N2kDoubleNA`
	)

inline

Setting up Message "Rudder" - PGN 127245.

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

Definition at line 657 of file N2kMessages.h.

◆ SetN2kSetPressure()

void SetN2kSetPressure	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		unsigned char	PressureInstance,
		tN2kPressureSource	PressureSource,
		double	SetPressure
	)

inline

Setting up Message "Set Pressure" - PGN 130315.

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

Definition at line 5208 of file N2kMessages.h.

◆ SetN2kSwitchbankControl()

void SetN2kSwitchbankControl	(	tN2kMsg &	N2kMsg,
		unsigned char	TargetBankInstance,
		tN2kBinaryStatus	BankStatus
	)

inline

Set up PGN 127502 "Switch Bank Control" message.

Alias of SetN2kPGN127502. This alias was introduced to improve the readability of the source code.

Definition at line 1862 of file N2kMessages.h.

◆ SetN2kSystemTime()

void SetN2kSystemTime	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		uint16_t	SystemDate,
		double	SystemTime,
		tN2kTimeSource	TimeSource = `N2ktimes_GPS`
	)

inline

Setting up Message "System date/time" - PGN 126992.

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

Definition at line 208 of file N2kMessages.h.

◆ SetN2kTemperature()

void SetN2kTemperature	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		unsigned char	TempInstance,
		tN2kTempSource	TempSource,
		double	ActualTemperature,
		double	SetTemperature = `N2kDoubleNA`
	)

inline

Setting up Message "Temperature - DEPRECATED" - PGN 130312.

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

Definition at line 4962 of file N2kMessages.h.

◆ SetN2kTemperatureExt()

void SetN2kTemperatureExt	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		unsigned char	TempInstance,
		tN2kTempSource	TempSource,
		double	ActualTemperature,
		double	SetTemperature = `N2kDoubleNA`
	)

inline

Setting up Message "Temperature, Extended Range" - PGN 130316.

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

Definition at line 5246 of file N2kMessages.h.

◆ SetN2kTransmissionParameters() [1/2]

void SetN2kTransmissionParameters	(	tN2kMsg &	N2kMsg,
		unsigned char	EngineInstance,
		tN2kTransmissionGear	TransmissionGear,
		double	OilPressure,
		double	OilTemperature,
		bool	flagCheck,
		bool	flagOverTemp,
		bool	flagLowOilPressure = `false`,
		bool	flagLowOilLevel = `false`,
		bool	flagSailDrive = `false`
	)

inline

Setting up Message "Transmission parameters, dynamic" - PGN 127493.

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

Definition at line 1442 of file N2kMessages.h.

◆ SetN2kTransmissionParameters() [2/2]

void SetN2kTransmissionParameters	(	tN2kMsg &	N2kMsg,
		unsigned char	EngineInstance,
		tN2kTransmissionGear	TransmissionGear,
		double	OilPressure,
		double	OilTemperature,
		unsigned char	DiscreteStatus1 = `0`
	)

inline

Setting up Message "Transmission parameters, dynamic" - PGN 127493.

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

Definition at line 1430 of file N2kMessages.h.

◆ SetN2kTrimTab()

void SetN2kTrimTab	(	tN2kMsg &	N2kMsg,
		int8_t	PortTrimTab,
		int8_t	StbdTrimTab
	)

inline

Setting up Message "Trim Tab Status" - PGN 130576.

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

Definition at line 5445 of file N2kMessages.h.

◆ SetN2kTrueHeading()

void SetN2kTrueHeading	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		double	Heading
	)

inline

Setting up Message "Vessel Heading" - PGN 127250.

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

Definition at line 743 of file N2kMessages.h.

◆ SetN2kWaterDepth()

void SetN2kWaterDepth	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		double	DepthBelowTransducer,
		double	Offset,
		double	Range = `N2kDoubleNA`
	)

inline

Setting up Message "Water depth" - PGN 128267.

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

Definition at line 2432 of file N2kMessages.h.

◆ SetN2kWaypointList()

void SetN2kWaypointList	(	tN2kMsg &	N2kMsg,
		uint16_t	Start,
		uint16_t	NumWaypoints,
		uint16_t	Database
	)

inline

Setting up Message "Route and WP Service - WP List - WP Name & Position" - PGN 130074.

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

Definition at line 4646 of file N2kMessages.h.

◆ SetN2kWindSpeed()

void SetN2kWindSpeed	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		double	WindSpeed,
		double	WindAngle,
		tN2kWindReference	WindReference
	)

inline

Setting up Message "Wind Data" - PGN 130306.

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

Definition at line 4717 of file N2kMessages.h.

◆ SetN2kXTE()

void SetN2kXTE	(	tN2kMsg &	N2kMsg,
		unsigned char	SID,
		tN2kXTEMode	XTEMode,
		bool	NavigationTerminated,
		double	XTE
	)

inline

Setting up Message "Cross Track Error" - PGN 129283.

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

Definition at line 3806 of file N2kMessages.h.

Classes

Functions

Detailed Description

Function Documentation

◆ AppendN2kPGN129285()

◆ AppendN2kPGN129540()

◆ AppendN2kPGN130074()

◆ AppendN2kRouteWPInfo()

◆ AppendN2kWaypointList()

◆ ParseN2kSwitchbankControl()

◆ SetN2kAISAtoNReport()

◆ SetN2kAISClassAPosition()

◆ SetN2kAISClassAStatic()

◆ SetN2kAISClassBPosition() [1/2]

◆ SetN2kAISClassBPosition() [2/2]

◆ SetN2kAISClassBStaticPartA()

◆ SetN2kAISClassBStaticPartB()

◆ SetN2kAISSafetyRelatedBroadcastMsg()

◆ SetN2kAttitude()

◆ SetN2kBatConf()

◆ SetN2kBinaryStatus() [1/2]

◆ SetN2kBinaryStatus() [2/2]

◆ SetN2kBoatSpeed()

◆ SetN2kChargerStatus()

◆ SetN2kCOGSOGRapid()

◆ SetN2kDCBatStatus()

◆ SetN2kDCStatus()

◆ SetN2kDirectionData()

◆ SetN2kDistanceLog()

◆ SetN2kEngineDynamicParam() [1/2]

◆ SetN2kEngineDynamicParam() [2/2]

◆ SetN2kEngineParamRapid()

◆ SetN2kEngineTripParameters()

◆ SetN2kEnvironmentalParameters()

◆ SetN2kFluidLevel()

◆ SetN2kGNSS()

◆ SetN2kGNSSDOPData()

◆ SetN2kGNSSSatellitesInView()

◆ SetN2kHeadingTrackControl()

◆ SetN2kHeave()

◆ SetN2kHumidity()

◆ SetN2kLatLonRapid()

◆ SetN2kLeeway()

◆ SetN2kLocalOffset()

◆ SetN2kMagneticHeading()

◆ SetN2kMagneticVariation()

◆ SetN2kMeteorlogicalStationData()

◆ SetN2kMOBNotification()

◆ SetN2kNavigationInfo()

◆ SetN2kOutsideEnvironmentalParameters()

◆ SetN2kPGN126992()

◆ SetN2kPGN127233()

◆ SetN2kPGN127237()

◆ SetN2kPGN127245()

◆ SetN2kPGN127250()

◆ SetN2kPGN127251()

◆ SetN2kPGN127252()

◆ SetN2kPGN127257()

◆ SetN2kPGN127258()

◆ SetN2kPGN127488()

◆ SetN2kPGN127489() [1/2]

◆ SetN2kPGN127489() [2/2]

◆ SetN2kPGN127493()

◆ SetN2kPGN127497()

◆ SetN2kPGN127501() [1/2]

◆ SetN2kPGN127501() [2/2]

◆ SetN2kPGN127502()

◆ SetN2kPGN127505()

◆ SetN2kPGN127506()

◆ SetN2kPGN127507()

◆ SetN2kPGN127508()

◆ SetN2kPGN127513()

◆ SetN2kPGN128000()

◆ SetN2kPGN128259()

◆ SetN2kPGN128267()

◆ SetN2kPGN128275()

◆ SetN2kPGN128776()

◆ SetN2kPGN128777()

◆ SetN2kPGN128778()

◆ SetN2kPGN129025()