Merge pull request #396 from lsoltero/fixupN2klib-working

Add new PGNs and expand AIS PGNs
ttlappalainen · May 10, 2024 · c0e04c3 · c0e04c3
2 parents 62bcd64 + 8562107
commit c0e04c3
Show file tree

Hide file tree

Showing 7 changed files with 582 additions and 126 deletions.
diff --git a/Documents/src/changes.md b/Documents/src/changes.md
@@ -1,6 +1,11 @@
 # Changes to the Library {#changes}
 \tableofcontents
 
+## 25.03.2024
+- Added PGN 127510
+- Added PGN 127750
+- Modidified AIS PGN PGN 129038, 129039, 129794, 129809, and 129810 to include AIS Transceiver Info and SID (where applicable)
+
 ## 25.03.2024
 
 - Fix for ParseN2kPGN129810 parameter list.

diff --git a/library.json b/library.json
@@ -13,7 +13,7 @@
     "url": "http://www.kave.fi",
     "maintainer": true
   },
-  "version": "4.21.3",
+  "version": "4.21.4",
   "license": "MIT",
   "frameworks": "*",
   "platforms": "*"

diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=NMEA2000
-version=4.21.3
+version=4.21.4
 author=Timo Lappalainen
 maintainer=Kave Oy <www.kave.fi>
 sentence=NMEA 2000 library for building compatible devices for NMEA 2000 bus.

diff --git a/src/N2kMessages.cpp b/src/N2kMessages.cpp
@@ -785,6 +785,46 @@ bool ParseN2kPGN127508(const tN2kMsg &N2kMsg, unsigned char &BatteryInstance, do
   return true;
 }
 
+//*****************************************************************************
+// Charger Configuration Status
+void SetN2kPGN127510(tN2kMsg &N2kMsg, unsigned char ChargerInsance, unsigned char BatteryInstance, tN2kOnOff Enable,
+                     unsigned char ChargeCurrentLimit, tN2kChargingAlgorithm ChargingAlgorithm, tN2kChargerMode ChargerMode, tBattTempNoSensor BatteryTemperature,
+                               tN2kOnOff EqualizationEnabled, tN2kOnOff OverChargeEnable, uint16_t EqualizationTimeRemaining) {
+
+  N2kMsg.SetPGN(127510L);
+  N2kMsg.Priority=6;
+  N2kMsg.AddByte(ChargerInsance);
+  N2kMsg.AddByte(BatteryInstance);
+  N2kMsg.AddByte(0x03&Enable);
+  N2kMsg.AddByte(ChargeCurrentLimit);   // 0-252%
+  N2kMsg.AddByte( ((0x0f&ChargerMode) << 4) | (0x0f&ChargingAlgorithm) );
+  N2kMsg.AddByte( ((0x03&OverChargeEnable) << 6) | ((0x03&EqualizationEnabled) << 4) | (0x0f&BatteryTemperature));
+  N2kMsg.Add2ByteUInt(EqualizationTimeRemaining);
+}
+
+bool ParseN2kPGN127510(const tN2kMsg &N2kMsg, unsigned char &ChargerInsance, unsigned char &BatteryInstance, tN2kOnOff &Enable,
+                     unsigned char &ChargeCurrentLimit, tN2kChargingAlgorithm &ChargingAlgorithm, tN2kChargerMode &ChargerMode, tBattTempNoSensor &BatteryTemperature,
+                               tN2kOnOff &EqualizationEnabled, tN2kOnOff &OverChargeEnable, uint16_t &EqualizationTimeRemaining) {
+
+  if (N2kMsg.PGN!=127510L) return false;
+  int Index=0;
+  ChargerInsance = N2kMsg.GetByte(Index);
+  BatteryInstance = N2kMsg.GetByte(Index);
+  unsigned char v = N2kMsg.GetByte(Index);
+  Enable = (tN2kOnOff)(v&0x03);
+  ChargeCurrentLimit = N2kMsg.GetByte(Index);
+  v=N2kMsg.GetByte(Index);
+  ChargingAlgorithm = (tN2kChargingAlgorithm) (v&0x0f);
+  ChargerMode = (tN2kChargerMode) ((v>>4)&0x0f);
+  v = N2kMsg.GetByte(Index);
+  OverChargeEnable = (tN2kOnOff)( (v>>6)&0x03);
+  EqualizationEnabled = (tN2kOnOff)((v>>4)&0x03);
+  BatteryTemperature = (tBattTempNoSensor)(v&0x04);
+  EqualizationTimeRemaining = N2kMsg.Get2ByteUInt(Index);
+
+  return true;
+}
+
 //*****************************************************************************
 // Battery Configuration Status
 void SetN2kPGN127513(tN2kMsg &N2kMsg, unsigned char BatInstance, tN2kBatType BatType, tN2kBatEqSupport SupportsEqual,
@@ -820,6 +860,41 @@ bool ParseN2kPGN127513(const tN2kMsg &N2kMsg, unsigned char &BatInstance, tN2kBa
   return true;
 }
 
+//*****************************************************************************
+// Converter (Inverter/Charger) Status 127750
+void SetN2kPGN127750(tN2kMsg &N2kMsg, unsigned char SID, unsigned char ConnectionNumber, tN2kConvMode OperatingState, tN2kTemperatureState TemperatureState,
+                              tN2kOverloadState OverloadState, tN2kDCVolgateState LowDcVoltageState, tN2kRippleState RippleState) {
+    N2kMsg.SetPGN(127750L);
+    N2kMsg.Priority=6;
+    N2kMsg.AddByte(SID);
+    N2kMsg.AddByte(ConnectionNumber);
+    N2kMsg.AddByte(OperatingState);   // note: might be tN2kChargeState
+    N2kMsg.AddByte((RippleState & 0x03) << 6 | (LowDcVoltageState & 0x03) << 4 | (OverloadState & 0x03) << 2 | (TemperatureState & 0x03));
+    N2kMsg.Add4ByteUInt(0xFFFFFFFF); // Reserved.
+}
+
+//*****************************************************************************
+bool ParseN2kPGN127750(const tN2kMsg &N2kMsg, unsigned char &SID, unsigned char &ConnectionNumber, tN2kConvMode &OperatingState, tN2kTemperatureState &TemperatureState,
+                              tN2kOverloadState &OverloadState, tN2kDCVolgateState &LowDcVoltageState, tN2kRippleState &RippleState) {
+
+  if (N2kMsg.PGN!=127750L) return false;
+
+  unsigned char v;
+  int Index=0;
+
+  SID=N2kMsg.GetByte(Index);
+  ConnectionNumber=N2kMsg.GetByte(Index);
+  OperatingState=(tN2kConvMode)N2kMsg.GetByte(Index);  // might be tN2kChargeState
+  v=N2kMsg.GetByte(Index);
+  RippleState=(tN2kRippleState)((v>>6)&0x03);
+  LowDcVoltageState=(tN2kDCVolgateState)((v>>4)&0x03);
+  OverloadState=(tN2kOverloadState)((v>>2)&0x03);
+  TemperatureState=(tN2kTemperatureState)(v&0x03);
+
+  return true;
+}
+
+
 //*****************************************************************************
 // Leeway
 void SetN2kPGN128000(tN2kMsg &N2kMsg, unsigned char SID, double Leeway) {
@@ -1328,9 +1403,9 @@ bool ParseN2kPGN129540(const tN2kMsg& N2kMsg, uint8_t SVIndex, tSatelliteInfo& S
 // Latitude and Longitude in degrees (1e7)
 // COG and Heading in radians (1e4)
 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)
+		     double Latitude, double Longitude, bool Accuracy, bool RAIM,
+		     uint8_t Seconds, double COG, double SOG, tN2kAISTransceiverInformation AISTransceiverInformation,
+		     double Heading, double ROT, tN2kAISNavStatus NavStatus, uint8_t SID)
 {
     N2kMsg.SetPGN(129038L);
     N2kMsg.Priority=4;
@@ -1348,11 +1423,13 @@ void SetN2kPGN129038(tN2kMsg &N2kMsg, uint8_t MessageID, tN2kAISRepeat Repeat, u
     N2kMsg.Add2ByteDouble(ROT, 3.125E-05); // 1e-3/32.0
     N2kMsg.AddByte(0xF0 | (NavStatus & 0x0f));
     N2kMsg.AddByte(0xff); // Reserved
+    N2kMsg.AddByte(SID);
 }
 
 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)
+		       double &Latitude, double &Longitude, bool &Accuracy, bool &RAIM, uint8_t &Seconds,
+		       double &COG, double &SOG, double &Heading, double &ROT, tN2kAISNavStatus &NavStatus,
+		       tN2kAISTransceiverInformation &AISTransceiverInformation, uint8_t &SID)
 {
     if (N2kMsg.PGN!=129038L) return false;
 
@@ -1369,11 +1446,12 @@ bool ParseN2kPGN129038(const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat
     vb=N2kMsg.GetByte(Index); // Communication State (19 bits)
     vb=N2kMsg.GetByte(Index);
     vb=N2kMsg.GetByte(Index); // AIS transceiver information (5 bits)
+    AISTransceiverInformation = (tN2kAISTransceiverInformation) ((vb>>3) & 0x1f);
     Heading=N2kMsg.Get2ByteUDouble(1e-04, Index);
     ROT=N2kMsg.Get2ByteDouble(3.125E-05, Index); // 1e-3/32.0
     vb=N2kMsg.GetByte(Index); NavStatus=(tN2kAISNavStatus)(vb & 0x0f);
     vb=N2kMsg.GetByte(Index); // Reserved
-
+    SID=N2kMsg.GetByte(Index);
     return true;
 }
 
@@ -1407,10 +1485,10 @@ void SetN2kPGN129039(tN2kMsg &N2kMsg, uint8_t MessageID, tN2kAISRepeat Repeat, u
 
 
 bool ParseN2kPGN129039(const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat &Repeat, uint32_t &UserID,
-                        double &Latitude, double &Longitude, bool &Accuracy, bool &RAIM,
-                        uint8_t &Seconds, double &COG, double &SOG, tN2kAISTransceiverInformation &AISTransceiverInformation,
-                        double &Heading, tN2kAISUnit &Unit, bool &Display, bool &DSC, bool &Band, bool &Msg22,
-                        tN2kAISMode &Mode, bool &State)
+		       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, uint8_t &SID)
 {
     if (N2kMsg.PGN!=129039L) return false;
 
@@ -1434,7 +1512,7 @@ bool ParseN2kPGN129039(const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat
     Unit=(tN2kAISUnit)(vb>>2 & 0x01); Display=(vb>>3 & 0x01); DSC=(vb>>4 & 0x01);
     Band=(vb>>5 & 0x01); Msg22=(vb>>6 & 0x01); Mode=(tN2kAISMode)(vb>>7 & 0x01);
     vb=N2kMsg.GetByte(Index); State=(vb & 0x01);
-
+    SID=N2kMsg.GetByte(Index);
     return true;
 }
 
@@ -1611,10 +1689,10 @@ bool AppendN2kPGN129285(tN2kMsg &N2kMsg, uint16_t ID, const char* Name, double L
 //*****************************************************************************
 // AIS static data A
 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)
+		     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, uint8_t SID)
 {
     N2kMsg.SetPGN(129794L);
     N2kMsg.Priority=6;
@@ -1635,13 +1713,14 @@ void SetN2kPGN129794(tN2kMsg &N2kMsg, uint8_t MessageID, tN2kAISRepeat Repeat, u
     N2kMsg.AddByte((DTE & 0x01)<<6 | (GNSStype & 0x0f)<<2 | (AISversion & 0x03));
     N2kMsg.AddByte(0xe0 | (AISinfo & 0x1f));
     N2kMsg.AddByte(0xff);
+    N2kMsg.AddByte(SID);
 }
 
 bool ParseN2kPGN129794(const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat &Repeat, uint32_t &UserID,
-                        uint32_t &IMOnumber, char *Callsign, size_t CallsignBufSize, char *Name, size_t NameBufSize,uint8_t &VesselType, double &Length,
-                        double &Beam, double &PosRefStbd, double &PosRefBow, uint16_t &ETAdate, double &ETAtime,
-                        double &Draught, char *Destination, size_t DestinationBufSize, tN2kAISVersion &AISversion, tN2kGNSStype &GNSStype,
-                        tN2kAISDTE &DTE, tN2kAISTransceiverInformation &AISinfo)
+		       uint32_t &IMOnumber, char *Callsign, size_t CallsignBufSize, char *Name, size_t NameBufSize,uint8_t &VesselType, double &Length,
+		       double &Beam, double &PosRefStbd, double &PosRefBow, uint16_t &ETAdate, double &ETAtime,
+		       double &Draught, char *Destination, size_t DestinationBufSize, tN2kAISVersion &AISversion, tN2kGNSStype &GNSStype,
+		       tN2kAISDTE &DTE, tN2kAISTransceiverInformation &AISinfo, uint8_t &SID)
 {
     if (N2kMsg.PGN!=129794L) return false;
 
@@ -1664,22 +1743,25 @@ bool ParseN2kPGN129794(const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat
     N2kMsg.GetStr(DestinationBufSize, Destination, 20, '@', Index);
     vb=N2kMsg.GetByte(Index); AISversion=(tN2kAISVersion)(vb & 0x03); GNSStype=(tN2kGNSStype)(vb>>2 & 0x0f); DTE=(tN2kAISDTE)(vb>>6 & 0x01);
     vb=N2kMsg.GetByte(Index); AISinfo=(tN2kAISTransceiverInformation)(vb & 0x1f);
-
+    SID = N2kMsg.GetByte(Index);
     return true;
 }
 
 //*****************************************************************************
 // AIS static data class B part A
-void SetN2kPGN129809(tN2kMsg &N2kMsg, uint8_t MessageID, tN2kAISRepeat Repeat, uint32_t UserID, const char *Name)
+void SetN2kPGN129809(tN2kMsg &N2kMsg, uint8_t MessageID, tN2kAISRepeat Repeat, uint32_t UserID, const char *Name, tN2kAISTransceiverInformation AISInfo, uint8_t SID)
 {
     N2kMsg.SetPGN(129809L);
     N2kMsg.Priority=6;
     N2kMsg.AddByte((Repeat & 0x03)<<6 | (MessageID & 0x3f));
     N2kMsg.Add4ByteUInt(UserID);
     N2kMsg.AddAISStr(Name, 20);
+    N2kMsg.AddByte(0xe0 | (AISInfo & 0x1f)); // AIS Transceiver info + Reserved
+    N2kMsg.AddByte(SID);
 }
 
-bool ParseN2kPGN129809(const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat &Repeat, uint32_t &UserID, char *Name, size_t NameBufSize)
+bool ParseN2kPGN129809(const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat &Repeat, uint32_t &UserID, char *Name, size_t NameBufSize,
+		       tN2kAISTransceiverInformation &AISInfo, uint8_t &SID)
 {
     if (N2kMsg.PGN!=129809L) return false;
 
@@ -1689,16 +1771,17 @@ bool ParseN2kPGN129809(const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat
     vb=N2kMsg.GetByte(Index); MessageID=(vb & 0x3f); Repeat=(tN2kAISRepeat)(vb>>6 & 0x03);
     UserID=N2kMsg.Get4ByteUInt(Index);
     N2kMsg.GetStr(NameBufSize, Name, 20, '@', Index);
-
+    vb=N2kMsg.GetByte(Index);
+    AISInfo = (tN2kAISTransceiverInformation) (vb & 0x1f);
+    SID = N2kMsg.GetByte(Index);
     return true;
 }
 
 //*****************************************************************************
 // AIS static data class B part B
 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)
+		     uint8_t VesselType, const char *Vendor, const char *Callsign, double Length, double Beam,
+		     double PosRefStbd, double PosRefBow, uint32_t MothershipID, tN2kAISTransceiverInformation AISInfo, uint8_t SID)
 {
     N2kMsg.SetPGN(129810L);
     N2kMsg.Priority=6;
@@ -1713,14 +1796,13 @@ void SetN2kPGN129810(tN2kMsg &N2kMsg, uint8_t MessageID, tN2kAISRepeat Repeat, u
     N2kMsg.Add2ByteUDouble(PosRefBow, 0.1);
     N2kMsg.Add4ByteUInt(MothershipID);
     N2kMsg.AddByte(0x03);  // Reserved + AIS spare
-    N2kMsg.AddByte(0xe3);  // Channel B VDL transmission + reserved
-    N2kMsg.AddByte(0xff);  // SID
+    N2kMsg.AddByte(0xe0 | (AISInfo & 0x1f));  // AIS Tranceiver info +  reserved
+    N2kMsg.AddByte(SID);
 }
 
 bool ParseN2kPGN129810(const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat &Repeat, uint32_t &UserID,
-                      uint8_t &VesselType, char *Vendor, size_t VendorBufSize, char *Callsign, size_t CallsignBufSize,
-                      double &Length, double &Beam,
-                      double &PosRefStbd, double &PosRefBow, uint32_t &MothershipID)
+		       uint8_t &VesselType, char *Vendor, size_t VendorBufSize, char *Callsign, size_t CallsignBufSize, double &Length, double &Beam,
+		       double &PosRefStbd, double &PosRefBow, uint32_t &MothershipID, tN2kAISTransceiverInformation &AISInfo, uint8_t &SID)
 {
     if (N2kMsg.PGN!=129810L) return false;
 
@@ -1737,6 +1819,10 @@ bool ParseN2kPGN129810(const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat
     PosRefStbd = N2kMsg.Get2ByteUDouble(0.1, Index);
     PosRefBow = N2kMsg.Get2ByteUDouble(0.1, Index);
     MothershipID = N2kMsg.Get4ByteUInt(Index);
+    vb=N2kMsg.GetByte(Index); // 2-reserved, 6-spare
+    vb=N2kMsg.GetByte(Index);
+    AISInfo = (tN2kAISTransceiverInformation)(vb & 0x1f);
+    SID = N2kMsg.GetByte(Index);
 
     return true;
 }