Skip to content

Instantly share code, notes, and snippets.

@sixstringsg

sixstringsg/N2kMessages.h

Created August 1, 2016 18:30
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save sixstringsg/7a94ecfdda132578bb9facd2284e7868 to your computer and use it in GitHub Desktop.
Save sixstringsg/7a94ecfdda132578bb9facd2284e7868 to your computer and use it in GitHub Desktop.
Download ZIP
Updated N2kMessages for DynamicTranny flags
Raw
N2kMessages.h
/*
N2kMessages.h
2015-2016 Copyright (c) Kave Oy, www.kave.fi All right reserved.
Author: Timo Lappalainen
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-
1301 USA
This is collection of functions for handling NMEA2000 bus messages.
Library contains functions to e.g. create message named with PGN like SetN2kPGN129025 and
inline alias for them like SetN2kLatLonRapid.
Each Setxxx funtion sets related message PGN and its default priority. So if you want to change
priority on function, you have to do it after Setxxx call.
If you do not send anything to NMEA2000 bus, you do not need this library. Funtions for
BUS handling PGN:s like 60928 "ISO Address Claim" has been defined in bus device library
NMEA2000.h
*/
#ifndef _N2kMessages_H_
#define _N2kMessages_H_
#include <N2kMsg.h>
inline double RadToDeg(double v) { return v*180.0/3.1415926535897932384626433832795; }
inline double DegToRad(double v) { return v/180.0*3.1415926535897932384626433832795; }
inline double CToKelvin(double v) { return v+273.15; }
inline double KelvinToC(double v) { return v-273.15; }
inline double mBarToPascal(double v) { return v*100; }
inline double PascalTomBar(double v) { return v/100; }
inline double AhToCoulomb(double v) { return v*3600; }
inline double CoulombToAh(double v) { return v/3600; }
inline double hToSeconds(double v) { return v*3600; }
inline double SecondsToh(double v) { return v/3600; }
enum tN2kHeadingReference {
N2khr_true=0,
N2khr_magnetic=1
};
enum tN2kDistanceCalculationType {
N2kdct_GreatCircle=0,
N2kdct_RhumbLine=1
};
enum tN2kXTEMode {
N2kxtem_Autonomous=0,
N2kxtem_Differential=1,
N2kxtem_Estimated=2,
N2kxtem_Simulator=3,
N2kxtem_Manual=4
};
enum tN2kGNSStype {
N2kGNSSt_GPS=0,
N2kGNSSt_GLONASS=1,
N2kGNSSt_GPSGLONASS=2,
N2kGNSSt_GPSSBASWAAS=3,
N2kGNSSt_GPSSBASWAASGLONASS=4,
N2kGNSSt_Chayka=5,
N2kGNSSt_integrated=6,
N2kGNSSt_surveyed=7,
N2kGNSSt_Galileo=8
};
enum tN2kGNSSmethod {
N2kGNSSm_noGNSS=0,
N2kGNSSm_GNSSfix=1,
N2kGNSSm_DGNSS=2,
N2kGNSSm_PreciseGNSS=3
};
enum tN2kTempSource {
N2kts_SeaTemperature=0,
N2kts_OutsideTemperature=1,
N2kts_InsideTemperature=2,
N2kts_EngineRoomTemperature=3,
N2kts_MainCabinTemperature=4,
N2kts_LiveWellTemperature=5,
N2kts_BaitWellTemperature=6,
N2kts_RefridgerationTemperature=7,
N2kts_HeatingSystemTemperature=8,
N2kts_DewPointTemperature=9,
N2kts_ApparentWindChillTemperature=10,
N2kts_TheoreticalWindChillTemperature=11,
N2kts_HeatIndexTemperature=12,
N2kts_FreezerTemperature=13,
N2kts_ExhaustGasTemperature=14
};
enum tN2kHumiditySource {
N2khs_InsideHumidity=0,
N2khs_OutsideHumidity=1,
N2khs_Undef=1
};
enum tN2kTimeSource {
N2ktimes_GPS=0,
N2ktimes_GLONASS=1,
N2ktimes_RadioStation=2,
N2ktimes_LocalCesiumClock=3,
N2ktimes_LocalRubidiumClock=4,
N2ktimes_LocalCrystalClock=5
};
enum tN2kFluidType {
N2kft_Fuel=0,
N2kft_Water=1,
N2kft_GrayWater=2,
N2kft_LiveWell=3,
N2kft_Oil=4,
N2kft_BlackWater=5
};
enum tN2kWindReference {
N2kWind_True_North=0,
N2kWind_Magnetic=1,
N2kWind_Apprent=2,
N2kWind_True_boat=3
};
enum tN2kSpeedWaterReferenceType {
N2kSWRT_Paddle_wheel=0,
N2kSWRT_Pitot_tube=1,
N2kSWRT_Doppler_log=2,
N2kSWRT_Ultra_Sound=3,
N2kSWRT_Electro_magnetic=4
};
enum tN2kRudderDirectionOrder {
N2kRDO_NoDirectioOrder=0,
N2kRDO_MoveToStarboard=1,
N2kRDO_MoveToPort=2
};
enum tN2kDCType {
N2kDCt_Battery=0,
N2kDCt_Alternator=1,
N2kDCt_Converter=2,
N2kDCt_SolarCell=3,
N2kDCt_WindGenerator=4
};
enum tN2kBatType {
N2kDCbt_Flooded=0,
N2kDCbt_Gel=1,
N2kDCbt_AGM=2
};
enum tN2kBatEqSupport {
N2kDCES_No=0, // No, Off, Disabled
N2kDCES_Yes=1, // Yes, On, Enabled
N2kDCES_Error=2, // Error
N2kDCES_Unavailable=3 // Unavailable
};
enum tN2kBatChem {
N2kDCbc_LeadAcid=0,
N2kDCbc_LiIon=1,
N2kDCbc_NiCad=2,
N2kDCbc_NiMh=3
};
enum tN2kBatNomVolt {
N2kDCbnv_6v=0,
N2kDCbnv_12v=1,
N2kDCbnv_24v=2,
N2kDCbnv_32v=3,
N2kDCbnv_62v=4,
N2kDCbnv_42v=5,
N2kDCbnv_48v=6
};
enum tN2kTransmissionGear {
N2kTG_Forward=0,
N2kTG_Neutral=1,
N2kTG_Reverse=2,
N2kTG_Unknown=3,
};
enum tN2kAISRepeat {
N2kaisr_Initial=0,
N2kaisr_First=1,
N2kaisr_Second=2,
N2kaisr_Final=3,
};
enum tN2kAISVersion {
N2kaisv_ITU_R_M_1371_1=0,
N2kaisv_ITU_R_M_1371_3=1,
};
enum tN2kAISTranceiverInfo {
N2kaisti_Channel_A_VDL_reception=0,
N2kaisti_Channel_B_VDL_reception=1,
N2kaisti_Channel_A_VDL_transmission=2,
N2kaisti_Channel_B_VDL_transmission=3,
N2kaisti_Own_information_not_broadcast=4,
N2kaisti_Reserved=5
};
enum tN2kAISNavStatus {
N2kaisns_Under_Way_Motoring=0,
N2kaisns_At_Anchor=1,
N2kaisns_Not_Under_Command=2,
N2kaisns_Restricted_Manoeuverability=3,
N2kaisns_Constrained_By_Draught=4,
N2kaisns_Moored=5,
N2kaisns_Aground=6,
N2kaisns_Fishing=7,
N2kaisns_Under_Way_Sailing=8,
N2kaisns_Hazardous_Material_High_Speed=9,
N2kaisns_Hazardous_Material_Wing_In_Ground=10,
N2kaisns_AIS_SART=14,
};
enum tN2kAISDTE {
N2kaisdte_Ready=0,
N2kaisdte_NotReady=1,
};
enum tN2kAISUnit {
N2kaisunit_ClassB_SOTDMA=0,
N2kaisunit_ClassB_CS=1,
};
enum tN2kAISMode {
N2kaismode_Autonomous=0,
N2kaismode_Assigned=1,
};
//*****************************************************************************
// System date/time
// Input:
// - SID Sequence ID. If your device is e.g. boat speed and heading at same time, you can set same SID for different messages
// to indicate that they are measured at same time.
// - SystemDate Days since 1979-01-01
// - SystemTime seconds since midnight
// - TimeSource see tN2kTimeSource
// Output:
// - N2kMsg NMEA2000 message ready to be send.
void SetN2kPGN126992(tN2kMsg &N2kMsg, unsigned char SID, uint16_t SystemDate,
double SystemTime, tN2kTimeSource TimeSource=N2ktimes_GPS);
inline void SetN2kSystemTime(tN2kMsg &N2kMsg, unsigned char SID, uint16_t SystemDate,
double SystemTime, tN2kTimeSource TimeSource=N2ktimes_GPS) {
SetN2kPGN126992(N2kMsg,SID,SystemDate,SystemTime,TimeSource);
}
bool ParseN2kPGN126992(const tN2kMsg &N2kMsg, unsigned char &SID, uint16_t &SystemDate,
double &SystemTime, tN2kTimeSource &TimeSource);
inline bool ParseN2kSystemTime(const tN2kMsg &N2kMsg, unsigned char &SID, uint16_t &SystemDate,
double &SystemTime, tN2kTimeSource &TimeSource) {
return ParseN2kPGN126992(N2kMsg,SID,SystemDate,SystemTime,TimeSource);
}
//*****************************************************************************
// Rudder
// Input:
// - RudderPosition Current rudder postion in radians.
// - Instance Rudder instance.
// - RudderDirectionOrder See tN2kRudderDirectionOrder. Direction, where rudder should be turned.
// - AngleOrder In radians angle where rudder should be turned.
// Output:
// - N2kMsg NMEA2000 message ready to be send.
void SetN2kPGN127245(tN2kMsg &N2kMsg, double RudderPosition, unsigned char Instance=0,
tN2kRudderDirectionOrder RudderDirectionOrder=N2kRDO_NoDirectioOrder, double AngleOrder=N2kDoubleNA);
inline void SetN2kRudder(tN2kMsg &N2kMsg, double RudderPosition, unsigned char Instance=0,
tN2kRudderDirectionOrder RudderDirectionOrder=N2kRDO_NoDirectioOrder, double AngleOrder=N2kDoubleNA) {
SetN2kPGN127245(N2kMsg,RudderPosition,Instance,RudderDirectionOrder,AngleOrder);
}
//*****************************************************************************
// Vessel Heading
// Input:
// - SID Sequence ID. If your device is e.g. boat speed and heading at same time, you can set same SID for different messages
// to indicate that they are measured at same time.
// - Heading Heading in radians
// - Deviation Magnetic deviation in radians. Use N2kDoubleNA for undefined value.
// - Variation Magnetic variation in radians. Use N2kDoubleNA for undefined value.
// - ref Heading reference. See definition of tN2kHeadingReference.
// Output:
// - N2kMsg NMEA2000 message ready to be send.
void SetN2kPGN127250(tN2kMsg &N2kMsg, unsigned char SID, double Heading, double Deviation, double Variation, tN2kHeadingReference ref);
inline void SetN2kTrueHeading(tN2kMsg &N2kMsg, unsigned char SID, double Heading) {
SetN2kPGN127250(N2kMsg,SID,Heading,N2kDoubleNA,N2kDoubleNA,N2khr_true);
}
inline void SetN2kMagneticHeading(tN2kMsg &N2kMsg, unsigned char SID, double Heading, double Deviation=N2kDoubleNA, double Variation=N2kDoubleNA) {
SetN2kPGN127250(N2kMsg,SID,Heading,Deviation,Variation,N2khr_magnetic);
}
bool ParseN2kPGN127250(const tN2kMsg &N2kMsg, unsigned char &SID, double &Heading, double &Deviation, double &Variation, tN2kHeadingReference &ref);
inline bool ParseN2kHeading(const tN2kMsg &N2kMsg, unsigned char &SID, double &Heading, double &Deviation, double &Variation, tN2kHeadingReference &ref) {
return ParseN2kPGN127250(N2kMsg,SID,Heading,Deviation,Variation,ref);
}
//*****************************************************************************
// Rate of Turn
// Input:
// - SID Sequence ID. If your device is e.g. boat speed and heading at same time, you can set same SID for different messages
// to indicate that they are measured at same time.
// - Rate of turn Change in heading in radians per second
// Output:
// - N2kMsg NMEA2000 message ready to be send.
void SetN2kPGN127251(tN2kMsg &N2kMsg, unsigned char SID, double RateOfTurn);
inline void SetN2kRateOfTurn(tN2kMsg &N2kMsg, unsigned char SID, double RateOfTurn) {
SetN2kPGN127251(N2kMsg,SID,RateOfTurn);
}
bool ParseN2kPGN127251(const tN2kMsg &N2kMsg, unsigned char &SID, double &RateOfTurn);
inline bool ParseN2kRateOfTurn(const tN2kMsg &N2kMsg, unsigned char &SID, double &RateOfTurn) {
return ParseN2kPGN127251(N2kMsg,SID,RateOfTurn);
}
//*****************************************************************************
// Attitude
// Input:
// - SID Sequence ID. If your device is e.g. boat speed and heading at same time, you can set same SID for different messages
// to indicate that they are measured at same time.
// - Yaw Heading in radians.
// - Pitch Pitch in radians. Positive, when your bow rises.
// - Roll Roll in radians. Positive, when tilted right.
// Output:
// - N2kMsg NMEA2000 message ready to be send.
void SetN2kPGN127257(tN2kMsg &N2kMsg, unsigned char SID, double Yaw, double Pitch, double Roll);
inline void SetN2kAttitude(tN2kMsg &N2kMsg, unsigned char SID, double Yaw, double Pitch, double Roll) {
SetN2kPGN127257(N2kMsg,SID, Yaw, Pitch, Roll);
}
bool ParseN2kPGN127257(const tN2kMsg &N2kMsg, unsigned char &SID, double &Yaw, double &Pitch, double &Roll);
inline bool ParseN2kAttitude(const tN2kMsg &N2kMsg, unsigned char &SID, double &Yaw, double &Pitch, double &Roll) {
return ParseN2kPGN127257(N2kMsg,SID, Yaw, Pitch, Roll);
}
//*****************************************************************************
// Engine parameters rapid
// Input:
// - EngineInstance Engine instance.
// - EngineSpeed RPM (Revolutions Per Minute)
// - EngineBoostPressure in Pascal
// - EngineTiltTrim in %
// Output:
// - N2kMsg NMEA2000 message ready to be send.
void SetN2kPGN127488(tN2kMsg &N2kMsg, unsigned char EngineInstance, double EngineSpeed,
double EngineBoostPressure=N2kDoubleNA, int8_t EngineTiltTrim=N2kInt8NA);
inline void SetN2kEngineParamRapid(tN2kMsg &N2kMsg, unsigned char EngineInstance, double EngineSpeed,
double EngineBoostPressure=N2kDoubleNA, int8_t EngineTiltTrim=N2kInt8NA) {
SetN2kPGN127488(N2kMsg,EngineInstance,EngineSpeed,EngineBoostPressure,EngineTiltTrim);
}
bool ParseN2kPGN127488(const tN2kMsg &N2kMsg, unsigned char &EngineInstance, double &EngineSpeed,
double &EngineBoostPressure, int8_t &EngineTiltTrim);
inline bool ParseN2kEngineParamRapid(const tN2kMsg &N2kMsg, unsigned char &EngineInstance, double &EngineSpeed,
double &EngineBoostPressure, int8_t &EngineTiltTrim) {
return ParseN2kPGN127488(N2kMsg,EngineInstance,EngineSpeed,EngineBoostPressure,EngineTiltTrim);
}
//*****************************************************************************
// Engine parameters dynamic
// Input:
// - 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 %
// Output:
// - N2kMsg NMEA2000 message ready to be send.
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 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) {
SetN2kPGN127489(N2kMsg,EngineInstance, EngineOilPress, EngineOilTemp, EngineCoolantTemp, AltenatorVoltage,
FuelRate, EngineHours, EngineCoolantPress, EngineFuelPress, EngineLoad, EngineTorque,
flagCheckEngine, flagOverTemp, flagLowOilPress, flagLowOilLevel,
flagLowFuelPress, flagLowSystemVoltage, flagLowCoolantLevel, flagWaterFlow,
flagWaterInFuel, flagChargeIndicator, flagPreheatIndicator, flagHighBoostPress,
flagRevLimitExceeded, flagEgrSystem, flagTPS, flagEmergencyStopMode,
flagWarning1, flagWarning2, flagPowerReduction, flagMaintenanceNeeded,
flagEngineCommError, flagSubThrottle, flagNeutralStartProtect, flagEngineShuttingDown);
}
bool ParseN2kPGN127489(const tN2kMsg &N2kMsg, unsigned char &EngineInstance, double &EngineOilPress,
double &EngineOilTemp, double &EngineCoolantTemp, double &AltenatorVoltage,
double &FuelRate, double &EngineHours, double &EngineCoolantPress, double &EngineFuelPress,
int8_t &EngineLoad, int8_t &EngineTorque);
inline bool ParseN2kEngineDynamicParam(const tN2kMsg &N2kMsg, unsigned char &EngineInstance, double &EngineOilPress,
double &EngineOilTemp, double &EngineCoolantTemp, double &AltenatorVoltage,
double &FuelRate, double &EngineHours, double &EngineCoolantPress, double &EngineFuelPress,
int8_t &EngineLoad, int8_t &EngineTorque) {
return ParseN2kPGN127489(N2kMsg, EngineInstance, EngineOilPress,
EngineOilTemp, EngineCoolantTemp, AltenatorVoltage,
FuelRate, EngineHours,EngineCoolantPress, EngineFuelPress,
EngineLoad, EngineTorque);
}
inline bool ParseN2kEngineDynamicParam(const tN2kMsg &N2kMsg, unsigned char &EngineInstance, double &EngineOilPress,
double &EngineOilTemp, double &EngineCoolantTemp, double &AltenatorVoltage,
double &FuelRate, double &EngineHours) {
double EngineCoolantPress, EngineFuelPress;
int8_t EngineLoad, EngineTorque;
return ParseN2kPGN127489(N2kMsg, EngineInstance, EngineOilPress,
EngineOilTemp, EngineCoolantTemp, AltenatorVoltage,
FuelRate, EngineHours,EngineCoolantPress, EngineFuelPress,
EngineLoad, EngineTorque);
}
//*****************************************************************************
// Transmission parameters, dynamic
// Input:
// - EngineInstance Engine instance.
// - TransmissionGear Selected transmission. See tN2kTransmissionGear
// - OilPressure in Pascal
// - OilTemperature in K
// - EngineTiltTrim in %
// Output:
// - N2kMsg NMEA2000 message ready to be send.
void SetN2kPGN127493(tN2kMsg &N2kMsg, unsigned char EngineInstance, tN2kTransmissionGear TransmissionGear,
double OilPressure, double OilTemperature, unsigned char DiscreteStatus1);
inline void SetN2kTransmissionParameters(tN2kMsg &N2kMsg, unsigned char EngineInstance, tN2kTransmissionGear TransmissionGear,
double OilPressure, double OilTemperature, unsigned char DiscreteStatus1) {
SetN2kPGN127493(N2kMsg, EngineInstance, TransmissionGear, OilPressure, OilTemperature, DiscreteStatus1);
}
inline void SetN2kTransmissionParameters(tN2kMsg &N2kMsg, unsigned char
EngineInstance, tN2kTransmissionGear TransmissionGear,
double OilPressure, double OilTemperature,
bool flagCheck=false, bool
flagOverTemp=false, bool flagLowOilPressure=false, bool
flagLowOilLevel=false,
bool flagSailDrive=false) {
unsigned char DiscreteStatus1=0;
if (flagCheck) DiscreteStatus1 |= B00000001;
if (flagOverTemp) DiscreteStatus1 |= B00000010;
if (flagLowOilPressure) DiscreteStatus1 |= B00000100;
if (flagLowOilLevel) DiscreteStatus1 |= B00001000;
if (flagSailDrive) DiscreteStatus1 |= B00010000;
SetN2kPGN127493(N2kMsg, EngineInstance, TransmissionGear,
OilPressure, OilTemperature,DiscreteStatus1);
}
bool ParseN2kPGN127493(const tN2kMsg &N2kMsg, unsigned char &EngineInstance, tN2kTransmissionGear &TransmissionGear,
double &OilPressure, double &OilTemperature, unsigned char &DiscreteStatus1);
inline bool ParseN2kTransmissionParameters(const tN2kMsg &N2kMsg, unsigned char &EngineInstance, tN2kTransmissionGear &TransmissionGear,
double &OilPressure, double &OilTemperature, unsigned char &DiscreteStatus1) {
return ParseN2kPGN127493(N2kMsg, EngineInstance, TransmissionGear, OilPressure, OilTemperature, DiscreteStatus1);
}
//*****************************************************************************
// Fluid level
// Input:
// - Instance Tank instance. Different devices handles this a bit differently. So it is best to have instance unique over
// all devices on the bus.
// - FluidType Defines type of fluid. See definition of tN2kFluidType
// - Level Tank level in % of full tank.
// - Capacity Tank Capacity in litres
// Output:
// - N2kMsg NMEA2000 message ready to be send.
void SetN2kPGN127505(tN2kMsg &N2kMsg, unsigned char Instance, tN2kFluidType FluidType, double Level, double Capacity);
inline void SetN2kFluidLevel(tN2kMsg &N2kMsg, unsigned char Instance, tN2kFluidType FluidType, double Level, double Capacity) {
SetN2kPGN127505(N2kMsg, Instance, FluidType, Level, Capacity);
}
// Parse fluid level message
// Output:
// - Instance Tank instance.
// - FluidType Defines type of fluid. See definition of tN2kFluidType
// - Level Tank level in % of full tank.
// - Capacity Tank Capacity in litres
bool ParseN2kPGN127505(const tN2kMsg &N2kMsg, unsigned char &Instance, tN2kFluidType &FluidType, double &Level, double &Capacity);
inline bool ParseN2kFluidLevel(const tN2kMsg &N2kMsg, unsigned char &Instance, tN2kFluidType &FluidType, double &Level, double &Capacity) {
return ParseN2kPGN127505(N2kMsg, Instance, FluidType, Level, Capacity);
}
//*****************************************************************************
// DC Detailed Status
// Input:
// - SID Sequence ID. If your device is e.g. boat speed and heading at same time, you can set same SID for different messages
// to indicate that they are measured at same time.
// - DCInstance DC instance.
// - DCType Defines type of DC source. See definition of tN2kDCType
// - StateOfCharge % of charge
// - StateOfHealth % of heath
// - TimeRemaining Time remaining in minutes
// - RippleVoltage DC output voltage ripple in V
void SetN2kPGN127506(tN2kMsg &N2kMsg, unsigned char SID, unsigned char DCInstance, tN2kDCType DCType,
unsigned char StateOfCharge, unsigned char StateOfHealth, double TimeRemaining, double RippleVoltage);
inline void SetN2kDCStatus(tN2kMsg &N2kMsg, unsigned char SID, unsigned char DCInstance, tN2kDCType DCType,
unsigned char StateOfCharge, unsigned char StateOfHealth, double TimeRemaining, double RippleVoltage) {
SetN2kPGN127506(N2kMsg,SID,DCInstance,DCType,StateOfCharge,StateOfHealth,TimeRemaining,RippleVoltage);
}
bool ParseN2kPGN127506(const tN2kMsg &N2kMsg, unsigned char &SID, unsigned char &DCInstance, tN2kDCType &DCType,
unsigned char &StateOfCharge, unsigned char &StateOfHealth, double &TimeRemaining, double &RippleVoltage);
inline bool ParseN2kDCStatus(const tN2kMsg &N2kMsg, unsigned char &SID, unsigned char &DCInstance, tN2kDCType &DCType,
unsigned char &StateOfCharge, unsigned char &StateOfHealth, double &TimeRemaining, double &RippleVoltage) {
return ParseN2kPGN127506(N2kMsg,SID,DCInstance,DCType,StateOfCharge,StateOfHealth,TimeRemaining,RippleVoltage);
}
//*****************************************************************************
// Battery Status
// Input:
// - BatteryInstance BatteryInstance.
// - BatteryVoltage Battery voltage in V
// - BatteryCurrent Current in A
// - BatteryTemperature Battery temperature in °K. Use function CToKelvin, if you want to use °C.
// - SID Sequence ID.
void SetN2kPGN127508(tN2kMsg &N2kMsg, unsigned char BatteryInstance, double BatteryVoltage, double BatteryCurrent=N2kDoubleNA,
double BatteryTemperature=N2kDoubleNA, unsigned char SID=1);
inline void SetN2kDCBatStatus(tN2kMsg &N2kMsg, unsigned char BatteryInstance, double BatteryVoltage, double BatteryCurrent=N2kDoubleNA,
double BatteryTemperature=N2kDoubleNA, unsigned char SID=1) {
SetN2kPGN127508(N2kMsg,BatteryInstance,BatteryVoltage,BatteryCurrent,BatteryTemperature,SID);
}
bool ParseN2kPGN127508(const tN2kMsg &N2kMsg, unsigned char &BatteryInstance, double &BatteryVoltage, double &BatteryCurrent,
double &BatteryTemperature, unsigned char &SID);
inline bool ParseN2kDCBatStatus(const tN2kMsg &N2kMsg, unsigned char &BatteryInstance, double &BatteryVoltage, double &BatteryCurrent,
double &BatteryTemperature, unsigned char &SID) {
return ParseN2kPGN127508(N2kMsg, BatteryInstance, BatteryVoltage, BatteryCurrent, BatteryTemperature, SID);
}
//*****************************************************************************
// Battery Configuration Status
// Note this has not yet confirmed to be right. Specially Peukert Exponent can have in
// this configuration values from 1 to 1.504. And I expect on code that I have to send
// value PeukertExponent-1 to the bus.
// Input:
// - BatteryInstance BatteryInstance.
// - BatType Type of battery. See definition of tN2kBatType
// - SupportsEqual Supports equalization. See definition of tN2kBatEqSupport
// - BatNominalVoltage Battery nominal voltage. See definition of tN2kBatNomVolt
// - BatChemistry Battery See definition of tN2kBatChem
// - BatCapacity Battery capacity in Coulombs. Use AhToCoulombs, if you have your value in Ah.
// - BatTemperatureCoeff Battery temperature coefficient in %
// - PeukertExponent Peukert Exponent
// - ChargeEfficiencyFactor Charge efficiency factor
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);
inline 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) {
SetN2kPGN127513(N2kMsg,BatInstance,BatType,SupportsEqual,BatNominalVoltage,BatChemistry,BatCapacity,BatTemperatureCoefficient,
PeukertExponent,ChargeEfficiencyFactor);
}
bool ParseN2kPGN127513(const tN2kMsg &N2kMsg, unsigned char &BatInstance, tN2kBatType &BatType, tN2kBatEqSupport &SupportsEqual,
tN2kBatNomVolt &BatNominalVoltage, tN2kBatChem &BatChemistry, double &BatCapacity, int8_t &BatTemperatureCoefficient,
double &PeukertExponent, int8_t &ChargeEfficiencyFactor);
inline bool ParseN2kBatConf(const tN2kMsg &N2kMsg, unsigned char &BatInstance, tN2kBatType &BatType, tN2kBatEqSupport &SupportsEqual,
tN2kBatNomVolt &BatNominalVoltage, tN2kBatChem &BatChemistry, double &BatCapacity, int8_t &BatTemperatureCoefficient,
double &PeukertExponent, int8_t &ChargeEfficiencyFactor) {
return ParseN2kPGN127513(N2kMsg,BatInstance,BatType,SupportsEqual,BatNominalVoltage,BatChemistry,BatCapacity,BatTemperatureCoefficient,
PeukertExponent,ChargeEfficiencyFactor);
}
//*****************************************************************************
// Boat speed
// Input:
// - SID Sequence ID. If your device is e.g. boat speed and wind at same time, you can set same SID for different messages
// to indicate that they are measured at same time.
// - WaterRefereced Speed over water in m/s
// - GroundReferenced Ground referenced speed in m/s
// - SWRT Type of transducer. See definition for tN2kSpeedWaterReferenceType
// Output:
// - N2kMsg NMEA2000 message ready to be send.
void SetN2kPGN128259(tN2kMsg &N2kMsg, unsigned char SID, double WaterRefereced, double GroundReferenced=N2kDoubleNA, tN2kSpeedWaterReferenceType SWRT=N2kSWRT_Paddle_wheel);
inline void SetN2kBoatSpeed(tN2kMsg &N2kMsg, unsigned char SID, double WaterRefereced, double GroundReferenced=N2kDoubleNA, tN2kSpeedWaterReferenceType SWRT=N2kSWRT_Paddle_wheel) {
SetN2kPGN128259(N2kMsg,SID,WaterRefereced,GroundReferenced,SWRT);
}
bool ParseN2kPGN128259(const tN2kMsg &N2kMsg, unsigned char &SID, double &WaterRefereced, double &GroundReferenced, tN2kSpeedWaterReferenceType &SWRT);
inline bool ParseN2kBoatSpeed(const tN2kMsg &N2kMsg, unsigned char &SID, double &WaterRefereced, double &GroundReferenced, tN2kSpeedWaterReferenceType &SWRT) {
return ParseN2kPGN128259(N2kMsg, SID, WaterRefereced, GroundReferenced, SWRT);
}
//*****************************************************************************
// Water depth
// Input:
// - SID Sequence ID. If your device is e.g. boat speed and depth at same time, you can set same SID for different messages
// to indicate that they are measured at same time.
// - DepthBelowTransducer Depth below transducer in meters
// - Offset Distance in meters between transducer and surface (positive) or transducer and keel (negative)
// Output:
// - N2kMsg NMEA2000 message ready to be send.
void SetN2kPGN128267(tN2kMsg &N2kMsg, unsigned char SID, double DepthBelowTransducer, double Offset);
inline void SetN2kWaterDepth(tN2kMsg &N2kMsg, unsigned char SID, double DepthBelowTransducer, double Offset) {
SetN2kPGN128267(N2kMsg,SID,DepthBelowTransducer,Offset);
}
bool ParseN2kPGN128267(const tN2kMsg &N2kMsg, unsigned char &SID, double &DepthBelowTransducer, double &Offset);
inline bool ParseN2kWaterDepth(const tN2kMsg &N2kMsg, unsigned char &SID, double &DepthBelowTransducer, double &Offset) {
return ParseN2kPGN128267(N2kMsg, SID, DepthBelowTransducer, Offset);
}
//*****************************************************************************
// Distance log
// Input:
// - DaysSince1970 Timestamp
// - SecondsSinceMidnight Timestamp
// - Log Total meters travelled
// - Trip Log Meters travelled since last reset
// Output:
// - N2kMsg NMEA2000 message ready to be send.
void SetN2kPGN128275(tN2kMsg &N2kMsg, uint16_t DaysSince1970, double SecondsSinceMidnight, uint32_t Log, uint32_t TripLog);
inline void SetN2kDistanceLog(tN2kMsg &N2kMsg, uint16_t DaysSince1970, double SecondsSinceMidnight, uint32_t Log, uint32_t TripLog) {
SetN2kPGN128275(N2kMsg,DaysSince1970,SecondsSinceMidnight,Log,TripLog);
}
bool ParseN2kPGN128275(const tN2kMsg &N2kMsg, uint16_t &DaysSince1970, double &SecondsSinceMidnight, uint32_t &Log, uint32_t &TripLog);
inline bool ParseN2kDistanceLog(const tN2kMsg &N2kMsg, uint16_t &DaysSince1970, double &SecondsSinceMidnight, uint32_t &Log, uint32_t &TripLog) {
return ParseN2kPGN128275(N2kMsg,DaysSince1970,SecondsSinceMidnight,Log,TripLog);
}
//*****************************************************************************
// Lat/lon rapid
// Input:
// - Latitude Latitude in degrees
// - Longitude Longitude in degrees
// Output:
// - N2kMsg NMEA2000 message ready to be send.
void SetN2kPGN129025(tN2kMsg &N2kMsg, double Latitude, double Longitude);
inline void SetN2kLatLonRapid(tN2kMsg &N2kMsg, double Latitude, double Longitude) {
SetN2kPGN129025(N2kMsg,Latitude,Longitude);
}
//*****************************************************************************
// COG SOG rapid
// Input:
// - COG Cource Over Ground in radians
// - SOG Speed Over Ground in m/s
// Output:
// - N2kMsg NMEA2000 message ready to be send.
void SetN2kPGN129026(tN2kMsg &N2kMsg, unsigned char SID, tN2kHeadingReference ref, double COG, double SOG);
inline void SetN2kCOGSOGRapid(tN2kMsg &N2kMsg, unsigned char SID, tN2kHeadingReference ref, double COG, double SOG) {
SetN2kPGN129026(N2kMsg,SID,ref,COG,SOG);
}
bool ParseN2kPGN129026(const tN2kMsg &N2kMsg, unsigned char &SID, tN2kHeadingReference &ref, double &COG, double &SOG);
inline bool ParseN2kCOGSOGRapid(const tN2kMsg &N2kMsg, unsigned char &SID, tN2kHeadingReference &ref, double &COG, double &SOG) {
return ParseN2kPGN129026(N2kMsg,SID,ref,COG,SOG);
}
//*****************************************************************************
// GNSS Position Data
// Input:
// - SID Sequence ID. If your device is e.g. boat speed and GPS at same time, you can set same SID for different messages
// to indicate that they are measured at same time.
// - DaysSince1970 Days since 1.1.1970. You can find sample how to convert e.g. NMEA0183 date info to this on my NMEA0183 library on
// NMEA0183Messages.cpp on function NMEA0183ParseRMC_nc
// - Latitude Latitude in degrees
// - Longitude Longitude in degrees
// - Altitude Altitude in meters
// - GNSStype GNSS type. See definition of tN2kGNSStype
// - GNSSmethod GNSS method type. See definition of tN2kGNSSmethod
// - nSatellites 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
// Output:
// - N2kMsg NMEA2000 message ready to be send.
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
);
inline 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
) {
SetN2kPGN129029(N2kMsg,SID,DaysSince1970,SecondsSinceMidnight,
Latitude,Longitude,Altitude,
GNSStype,GNSSmethod,
nSatellites,HDOP,PDOP,GeoidalSeparation,
nReferenceStations,ReferenceStationType,ReferenceSationID,
AgeOfCorrection);
}
bool ParseN2kPGN129029(const tN2kMsg &N2kMsg, unsigned char &SID, uint16_t &DaysSince1970, double &SecondsSinceMidnight,
double &Latitude, double &Longitude, double &Altitude,
tN2kGNSStype &GNSStype, tN2kGNSSmethod &GNSSmethod,
unsigned char &nSatellites, double &HDOP, double &PDOP, double &GeoidalSeparation,
unsigned char &nReferenceStations, tN2kGNSStype &ReferenceStationType, uint16_t &ReferenceSationID,
double &AgeOfCorrection
);
inline bool ParseN2kGNSS(const tN2kMsg &N2kMsg, unsigned char &SID, uint16_t &DaysSince1970, double &SecondsSinceMidnight,
double &Latitude, double &Longitude, double &Altitude,
tN2kGNSStype &GNSStype, tN2kGNSSmethod &GNSSmethod,
unsigned char &nSatellites, double &HDOP, double &PDOP, double &GeoidalSeparation,
unsigned char &nReferenceStations, tN2kGNSStype &ReferenceStationType, uint16_t &ReferenceSationID,
double &AgeOfCorrection
) {
return ParseN2kPGN129029(N2kMsg, SID, DaysSince1970, SecondsSinceMidnight,
Latitude, Longitude, Altitude,
GNSStype, GNSSmethod,
nSatellites, HDOP, PDOP, GeoidalSeparation,
nReferenceStations, ReferenceStationType, ReferenceSationID,
AgeOfCorrection
);
}
//*****************************************************************************
// AIS position reports for Class A
// Input:
// - N2kMsg NMEA2000 message to decode
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, double Heading, double ROT, tN2kAISNavStatus NavStatus);
inline 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, double Heading, double ROT, tN2kAISNavStatus NavStatus) {
SetN2kPGN129038(N2kMsg, MessageID, Repeat, UserID, Latitude, Longitude, Accuracy, RAIM, Seconds, COG, SOG, Heading, ROT, NavStatus);
}
bool ParseN2kPGN129038(const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat &Repeat, uint32_t &UserID, double &Latitude, double &Longitude,
bool &Accuracy, bool &RAIM, uint8_t &Seconds, double &COG, double &SOG, double &Heading, double &ROT, tN2kAISNavStatus &NavStatus);
inline bool ParseN2kAISClassAPosition(const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat &Repeat, uint32_t &UserID, double &Latitude, double &Longitude,
bool &Accuracy, bool &RAIM, uint8_t &Seconds, double &COG, double &SOG, double &Heading, double &ROT, tN2kAISNavStatus & NavStatus) {
return ParseN2kPGN129038(N2kMsg, MessageID, Repeat, UserID, Latitude, Longitude, Accuracy, RAIM, Seconds, COG, SOG, Heading, ROT, NavStatus);
}
//*****************************************************************************
// AIS position reports for Class B
// Input:
// - N2kMsg NMEA2000 message to decode
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, double Heading, tN2kAISUnit Unit,
bool Display, bool DSC, bool Band, bool Msg22, tN2kAISMode Mode, bool State);
inline 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) {
SetN2kPGN129039(N2kMsg, MessageID, Repeat, UserID, Latitude, Longitude, Accuracy, RAIM, Seconds,
COG, SOG, Heading, Unit, Display, DSC, Band, Msg22, Mode, State);
}
bool ParseN2kPGN129039(const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat &Repeat, uint32_t &UserID,
double &Latitude, double &Longitude, bool &Accuracy, bool &RAIM,
uint8_t &Seconds, double &COG, double &SOG, double &Heading, tN2kAISUnit &Unit,
bool &Display, bool &DSC, bool &Band, bool &Msg22, tN2kAISMode &Mode, bool &State);
inline bool ParseN2kAISClassBPosition(const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat &Repeat, uint32_t &UserID,
double &Latitude, double &Longitude, bool &Accuracy, bool &RAIM,
uint8_t &Seconds, double &COG, double &SOG, double &Heading, tN2kAISUnit &Unit,
bool &Display, bool &DSC, bool &Band, bool &Msg22, tN2kAISMode &Mode, bool &State) {
return ParseN2kPGN129039(N2kMsg, MessageID, Repeat, UserID, Latitude, Longitude, Accuracy,
RAIM, Seconds, COG, SOG, Heading, Unit, Display, DSC, Band, Msg22, Mode, State);
}
//*****************************************************************************
// Cross Track Error
// Output:
// - N2kMsg NMEA2000 message ready to be send.
void SetN2kPGN129283(tN2kMsg &N2kMsg, unsigned char SID, tN2kXTEMode XTEMode, bool NavigationTerminated, double XTE);
inline void SetN2kXTE(tN2kMsg &N2kMsg, unsigned char SID, tN2kXTEMode XTEMode, bool NavigationTerminated, double XTE) {
SetN2kPGN129283(N2kMsg, SID, XTEMode, NavigationTerminated, XTE);
}
//*****************************************************************************
// Navigation info
// Output:
// - N2kMsg NMEA2000 message ready to be send.
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,
uint8_t OriginWaypointNumber, uint8_t DestinationWaypointNumber,
double DestinationLatitude, double DestinationLongitude, double WaypointClosingVelocity);
inline 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,
uint8_t OriginWaypointNumber, uint8_t DestinationWaypointNumber,
double DestinationLatitude, double DestinationLongitude, double WaypointClosingVelocity) {
SetN2kPGN129284(N2kMsg, SID, DistanceToWaypoint, BearingReference,
PerpendicularCrossed, ArrivalCircleEntered, CalculationType,
ETATime, ETADate, BearingOriginToDestinationWaypoint, BearingPositionToDestinationWaypoint,
OriginWaypointNumber, DestinationWaypointNumber,
DestinationLatitude, DestinationLongitude, WaypointClosingVelocity);
}
//*****************************************************************************
// Waypoint list
// Input:
// - Start The ID of the first waypoint
// - Database Database ID
// - Route Route ID
// - RouteName The name of the current route
// - ID The ID of the current waypoint
// - Name The name of the current waypoint
// - Latitude The latitude of the current waypoint
// - Longitude The longitude of the current waypoint
// Output:
// - N2kMsg NMEA2000 message ready to be send.
void SetN2kPGN129285(tN2kMsg &N2kMsg, uint16_t Start, uint16_t Database, uint16_t Route,
bool NavDirection, bool SupplementaryData, char* RouteName);
bool AppendN2kPGN129285(tN2kMsg &N2kMsg, uint16_t WPID2, char* WPName2, double Latitude2, double Longitude2);
//*****************************************************************************
// AIS static data class A
// Input:
// - MessageID Message type
// - Repeat Repeat indicator
// - UserID MMSI
// Output:
// - N2kMsg NMEA2000 message ready to be send.
void SetN2kPGN129794(tN2kMsg &N2kMsg, uint8_t MessageID, tN2kAISRepeat Repeat, uint32_t UserID,
uint32_t IMOnumber, char *Callsign, char *Name, uint8_t VesselType, double Length,
double Beam, double PosRefStbd, double PosRefBow, uint16_t ETAdate, double ETAtime,
double Draught, char *Destination, tN2kAISVersion AISversion, tN2kGNSStype GNSStype,
tN2kAISDTE DTE, tN2kAISTranceiverInfo AISinfo);
inline void SetN2kAISClassAStatic(tN2kMsg &N2kMsg, uint8_t MessageID, tN2kAISRepeat Repeat, uint32_t UserID,
uint32_t IMOnumber, char *Callsign, char *Name, uint8_t VesselType, double Length,
double Beam, double PosRefStbd, double PosRefBow, uint16_t ETAdate, double ETAtime,
double Draught, char *Destination, tN2kAISVersion AISversion, tN2kGNSStype GNSStype,
tN2kAISDTE DTE, tN2kAISTranceiverInfo AISinfo) {
SetN2kPGN129794(N2kMsg, MessageID, Repeat, UserID, IMOnumber, Callsign, Name, VesselType, Length,
Beam, PosRefStbd, PosRefBow, ETAdate, ETAtime, Draught, Destination, AISversion, GNSStype, DTE, AISinfo);
}
bool ParseN2kPGN129794(const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat &Repeat, uint32_t &UserID,
uint32_t &IMOnumber, char *Callsign, char *Name, uint8_t &VesselType, double &Length,
double &Beam, double &PosRefStbd, double &PosRefBow, uint16_t &ETAdate, double &ETAtime,
double &Draught, char *Destination, tN2kAISVersion &AISversion, tN2kGNSStype &GNSStype,
tN2kAISDTE &DTE, tN2kAISTranceiverInfo &AISinfo);
inline bool ParseN2kAISClassAStatic(const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat &Repeat, uint32_t &UserID,
uint32_t & IMOnumber, char *Callsign, char *Name, uint8_t &VesselType, double &Length,
double &Beam, double &PosRefStbd, double &PosRefBow, uint16_t &ETAdate, double &ETAtime,
double &Draught, char *Destination, tN2kAISVersion &AISversion, tN2kGNSStype &GNSStype,
tN2kAISDTE &DTE, tN2kAISTranceiverInfo &AISinfo) {
return ParseN2kPGN129794(N2kMsg, MessageID, Repeat, UserID, IMOnumber, Callsign, Name, VesselType, Length,
Beam, PosRefStbd, PosRefBow, ETAdate, ETAtime, Draught, Destination, AISversion,
GNSStype, DTE, AISinfo);
}
//*****************************************************************************
// AIS static data class B part A
// Input:
// - MessageID Message type
// - Repeat Repeat indicator
// - UserID MMSI
// - Name Vessel name
// Output:
// - N2kMsg NMEA2000 message ready to be send.
void SetN2kPGN129809(tN2kMsg &N2kMsg, uint8_t MessageID, tN2kAISRepeat Repeat, uint32_t UserID, char *Name);
inline void SetN2kAISClassBStaticPartA(tN2kMsg &N2kMsg, uint8_t MessageID, tN2kAISRepeat Repeat, uint32_t UserID, char *Name) {
SetN2kPGN129809(N2kMsg, MessageID, Repeat, UserID, Name);
}
bool ParseN2kPGN129809(const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat &Repeat, uint32_t &UserID, char *Name);
inline bool ParseN2kAISClassBStaticPartA(const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat &Repeat, uint32_t &UserID, char *Name) {
return ParseN2kPGN129809(N2kMsg, MessageID, Repeat, UserID, Name);
}
//*****************************************************************************
// AIS static data class B part B
// Input:
// - MessageID Message type
// - Repeat Repeat indicator
// - UserID MMSI
// - Name Vessel name
// Output:
// - N2kMsg NMEA2000 message ready to be send.
void SetN2kPGN129810(tN2kMsg &N2kMsg, uint8_t MessageID, tN2kAISRepeat Repeat, uint32_t UserID,
uint8_t VesselType, char *Vendor, char *Callsign, double Length, double Beam,
double PosRefStbd, double PosRefBow, uint32_t MothershipID);
inline void SetN2kAISClassBStaticPartB(tN2kMsg &N2kMsg, uint8_t MessageID, tN2kAISRepeat Repeat, uint32_t UserID,
uint8_t VesselType, char *Vendor, char *Callsign, double Length, double Beam,
double PosRefStbd, double PosRefBow, uint32_t MothershipID) {
SetN2kPGN129810(N2kMsg, MessageID, Repeat, UserID, VesselType, Vendor, Callsign, Length, Beam,
PosRefStbd, PosRefBow, MothershipID);
}
bool ParseN2kPGN129810(const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat &Repeat, uint32_t &UserID,
uint8_t &VesselType, char *Vendor, char *Callsign, double &Length, double &Beam,
double &PosRefStbd, double &PosRefBow, uint32_t &MothershipID);
inline bool ParseN2kAISClassBStaticPartB(const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat &Repeat, uint32_t &UserID,
uint8_t &VesselType, char *Vendor, char *Callsign, double &Length, double &Beam,
double &PosRefStbd, double &PosRefBow, uint32_t &MothershipID) {
return ParseN2kPGN129810(N2kMsg, MessageID, Repeat, UserID, VesselType, Vendor, Callsign,
Length, Beam, PosRefStbd, PosRefBow, MothershipID);
}
//*****************************************************************************
// Waypoint list
// Input:
// - Start The ID of the first waypoint
// NumItems
// - NumWaypoints Number of valid WPs in the WP-List
// - Database Database ID
// - ID The ID of the current waypoint
// - Name The name of the current waypoint
// - Latitude The latitude of the current waypoint
// - Longitude The longitude of the current waypoint
// Output:
// - N2kMsg NMEA2000 message ready to be send.
void SetN2kPGN130074(tN2kMsg &N2kMsg, uint16_t Start, uint16_t NumWaypoints, uint16_t Database);
inline void SetN2kWaypointList(tN2kMsg &N2kMsg, uint16_t Start, uint16_t NumWaypoints, uint16_t Database) {
SetN2kPGN130074(N2kMsg,Start,NumWaypoints,Database);
}
bool AppendN2kPGN130074(tN2kMsg &N2kMsg, uint16_t ID, char* Name, double Latitude, double Longitude);
inline bool AppendN2kWaypointList(tN2kMsg &N2kMsg, uint16_t ID, char* Name, double Latitude, double Longitude) {
return AppendN2kPGN130074(N2kMsg,ID,Name,Latitude,Longitude);
}
//*****************************************************************************
// Wind Speed
// Input:
// - SID Sequence ID. If your device is e.g. boat speed and wind at same time, you can set same SID for different messages
// to indicate that they are measured at same time.
// - WindSpeed Measured wind speed in m/s
// - WindAngle Measured wind angle in radians. If you have value in degrees, use function DegToRad(myval) in call.
// - WindReference Wind reference, see definition of tN2kWindReference
// Output:
// - N2kMsg NMEA2000 message ready to be send.
void SetN2kPGN130306(tN2kMsg &N2kMsg, unsigned char SID, double WindSpeed, double WindAngle, tN2kWindReference WindReference);
inline void SetN2kWindSpeed(tN2kMsg &N2kMsg, unsigned char SID, double WindSpeed, double WindAngle, tN2kWindReference WindReference) {
SetN2kPGN130306(N2kMsg,SID,WindSpeed,WindAngle,WindReference);
}
bool ParseN2kPGN130306(const tN2kMsg &N2kMsg, unsigned char &SID, double &WindSpeed, double &WindAngle, tN2kWindReference &WindReference);
inline bool ParseN2kWindSpeed(const tN2kMsg &N2kMsg, unsigned char &SID, double &WindSpeed, double &WindAngle, tN2kWindReference &WindReference) {
return ParseN2kPGN130306(N2kMsg,SID,WindSpeed,WindAngle,WindReference);
}
//*****************************************************************************
// Outside Environmental parameters
// Input:
// - SID Sequence ID.
// - WaterTemperature Water temperature in °K. Use function CToKelvin, if you want to use °C.
// - OutsideAmbientAirTemperature Outside ambient temperature in °K. Use function CToKelvin, if you want to use °C.
// - AtmosphericPressure Atmospheric pressure in Pascals. Use function mBarToPascal, if you like to use mBar
// Output:
// - N2kMsg NMEA2000 message ready to be send.
void SetN2kPGN130310(tN2kMsg &N2kMsg, unsigned char SID, double WaterTemperature,
double OutsideAmbientAirTemperature=N2kDoubleNA, double AtmosphericPressure=N2kDoubleNA);
inline void SetN2kOutsideEnvironmentalParameters(tN2kMsg &N2kMsg, unsigned char SID, double WaterTemperature,
double OutsideAmbientAirTemperature=N2kDoubleNA, double AtmosphericPressure=N2kDoubleNA) {
SetN2kPGN130310(N2kMsg,SID,WaterTemperature,OutsideAmbientAirTemperature,AtmosphericPressure);
}
bool ParseN2kPGN130310(const tN2kMsg &N2kMsg, unsigned char &SID, double &WaterTemperature,
double &OutsideAmbientAirTemperature, double &AtmosphericPressure);
inline bool ParseN2kOutsideEnvironmentalParameters(const tN2kMsg &N2kMsg, unsigned char &SID, double &WaterTemperature,
double &OutsideAmbientAirTemperature, double &AtmosphericPressure) {
return ParseN2kPGN130310(N2kMsg, SID,WaterTemperature,OutsideAmbientAirTemperature,AtmosphericPressure);
}
//*****************************************************************************
// Environmental parameters
// Note that in PGN 130311 TempInstance is as TempSource in PGN 130312. I do not know why this
// renaming is confusing.
// Pressure has to be in pascal. Use function mBarToPascal, if you like to use mBar
// Input:
// - SID Sequence ID.
// - TempInstance see tN2kTempSource
// - Temperature Temperature in °K. Use function CToKelvin, if you want to use °C.
// - HumidityInstance see tN2kHumiditySource.
// - Humidity Humidity in %
// - AtmosphericPressure Atmospheric pressure in Pascals. Use function mBarToPascal, if you like to use mBar
// Output:
// - N2kMsg NMEA2000 message ready to be send.
void SetN2kPGN130311(tN2kMsg &N2kMsg, unsigned char SID, tN2kTempSource TempInstance, double Temperature,
tN2kHumiditySource HumidityInstance=N2khs_Undef, double Humidity=N2kDoubleNA, double AtmosphericPressure=N2kDoubleNA);
inline void SetN2kEnvironmentalParameters(tN2kMsg &N2kMsg, unsigned char SID, tN2kTempSource TempInstance, double Temperature,
tN2kHumiditySource HumidityInstance=N2khs_Undef, double Humidity=N2kDoubleNA, double AtmosphericPressure=N2kDoubleNA) {
SetN2kPGN130311(N2kMsg,SID,TempInstance,Temperature,HumidityInstance,Humidity,AtmosphericPressure);
}
//*****************************************************************************
// Temperature
// Temperatures should be in Kelvins
// Input:
// - SID Sequence ID.
// - TempInstance This should be unic at least on one device. May be best to have it unic over all devices sending this PGN.
// - TempSource see tN2kTempSource
// - ActualTemperature Temperature in °K. Use function CToKelvin, if you want to use °C.
// - SetTemperature Set temperature in °K. Use function CToKelvin, if you want to use °C. This is meaningfull for temperatures,
// which can be controlled like cabin, freezer, refridgeration temperature. God can use value for this for
// outside and sea temperature values.
// Output:
// - N2kMsg NMEA2000 message ready to be send.
void SetN2kPGN130312(tN2kMsg &N2kMsg, unsigned char SID, unsigned char TempInstance, tN2kTempSource TempSource,
double ActualTemperature, double SetTemperature=N2kDoubleNA);
inline void SetN2kTemperature(tN2kMsg &N2kMsg, unsigned char SID, unsigned char TempInstance, tN2kTempSource TempSource,
double ActualTemperature, double SetTemperature=N2kDoubleNA) {
SetN2kPGN130312(N2kMsg,SID,TempInstance,TempSource,ActualTemperature,SetTemperature);
}
bool ParseN2kPGN130312(const tN2kMsg &N2kMsg, unsigned char &SID, unsigned char &TempInstance, tN2kTempSource &TempSource,
double &ActualTemperature, double &SetTemperature);
inline bool ParseN2kTemperature(const tN2kMsg &N2kMsg, unsigned char &SID, unsigned char &TempInstance, tN2kTempSource &TempSource,
double &ActualTemperature, double &SetTemperature) {
return ParseN2kPGN130312(N2kMsg, SID, TempInstance, TempSource, ActualTemperature, SetTemperature);
}
//*****************************************************************************
// Temperature
// Temperatures should be in Kelvins
// Input:
// - SID Sequence ID.
// - TempInstance This should be unic at least on one device. May be best to have it unic over all devices sending this PGN.
// - TempSource see tN2kTempSource
// - ActualTemperature Temperature in °K. Use function CToKelvin, if you want to use °C.
// - SetTemperature Set temperature in °K. Use function CToKelvin, if you want to use °C. This is meaningfull for temperatures,
// which can be controlled like cabin, freezer, refridgeration temperature. God can use value for this for
// outside and sea temperature values.
// Output:
// - N2kMsg NMEA2000 message ready to be send.
void SetN2kPGN130316(tN2kMsg &N2kMsg, unsigned char SID, unsigned char TempInstance, tN2kTempSource TempSource,
double ActualTemperature, double SetTemperature=N2kDoubleNA);
inline void SetN2kTemperatureExt(tN2kMsg &N2kMsg, unsigned char SID, unsigned char TempInstance, tN2kTempSource TempSource,
double ActualTemperature, double SetTemperature=N2kDoubleNA) {
SetN2kPGN130316(N2kMsg,SID,TempInstance,TempSource,ActualTemperature,SetTemperature);
}
bool ParseN2kPGN130316(const tN2kMsg &N2kMsg, unsigned char &SID, unsigned char &TempInstance, tN2kTempSource &TempSource,
double &ActualTemperature, double &SetTemperature);
inline bool ParseN2kTemperatureExt(const tN2kMsg &N2kMsg, unsigned char &SID, unsigned char &TempInstance, tN2kTempSource &TempSource,
double &ActualTemperature, double &SetTemperature) {
return ParseN2kPGN130316(N2kMsg, SID, TempInstance, TempSource, ActualTemperature, SetTemperature);
}
#endif
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment