Skip to content

Commit

Permalink
Fix and code clean
Browse files Browse the repository at this point in the history 
- ForwardStream initialization was accidentaly deleted
- Clean code and more debug options.
  • Loading branch information
@ttlappalainen
ttlappalainen committed Jun 25, 2017
1 parent c1e28e7 commit d583724
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 27 deletions.
69 changes: 44 additions & 25 deletions NMEA2000.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,17 +31,26 @@ OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

#define DebugStream Serial

// #define NMEA2000_FRAME_DEBUG
// #define NMEA2000_FRAME_IN_DEBUG
// #define NMEA2000_FRAME_OUT_DEBUG
// #define NMEA2000_MSG_DEBUG
// #define NMEA2000_BUF_DEBUG
// #define NMEA2000_DEBUG

#if defined(NMEA2000_FRAME_DEBUG)
# define N2kFrameDbg(fmt, args...) DebugStream.print (fmt , ## args)
# define N2kFrameDbgln(fmt, args...) DebugStream.println (fmt , ## args)
#if defined(NMEA2000_FRAME_IN_DEBUG)
# define N2kFrameInDbg(fmt, args...) DebugStream.print (fmt , ## args)
# define N2kFrameInDbgln(fmt, args...) DebugStream.println (fmt , ## args)
#else
# define N2kFrameDbg(fmt, args...)
# define N2kFrameDbgln(fmt, args...)
# define N2kFrameInDbg(fmt, args...)
# define N2kFrameInDbgln(fmt, args...)
#endif

#if defined(NMEA2000_FRAME_OUT_DEBUG)
# define N2kFrameOutDbg(fmt, args...) DebugStream.print (fmt , ## args)
# define N2kFrameOutDbgln(fmt, args...) DebugStream.println (fmt , ## args)
#else
# define N2kFrameOutDbg(fmt, args...)
# define N2kFrameOutDbgln(fmt, args...)
#endif

#if defined(NMEA2000_MSG_DEBUG)
Expand Down Expand Up @@ -235,6 +244,7 @@ tNMEA2000::tNMEA2000() {
#if !defined(N2K_NO_GROUP_FUNCTION_SUPPORT)
pGroupFunctionHandlers=0;
#endif
ForwardStream=0;

SingleFrameMessages[0]=DefSingleFrameMessages;
FastPacketMessages[0]=DefFastPacketMessages;
Expand Down Expand Up @@ -277,6 +287,7 @@ void tNMEA2000::SetDeviceCount(const uint8_t _DeviceCount) {
//*****************************************************************************
void tNMEA2000::InitDevices() {
if ( Devices==0 ) {
N2kDbgln("Init devices");
Devices=new tDevice[DeviceCount];
MaxCANSendFrames*=DeviceCount; // We need bigger buffer for sending all information
// for (int i=0; i<DeviceCount; i++) Devices[i].tDevice();
Expand Down Expand Up @@ -479,6 +490,7 @@ void tNMEA2000::SetMode(tN2kMode _N2kMode, unsigned long _N2kSource) {
void tNMEA2000::InitCANFrameBuffers() {
if ( CANSendFrameBuf==0 && !IsInitialized() ) {
if ( MaxCANSendFrames>0 ) CANSendFrameBuf = new tCANSendFrame[MaxCANSendFrames];
N2kDbg("Initialize frame buffer. Size: "); N2kDbg(MaxCANSendFrames); N2kDbg(", address:"); N2kDbgln((uint32_t)CANSendFrameBuf);
CANSendFrameBufferWrite=0;
CANSendFrameBufferRead=0;
}
Expand Down Expand Up @@ -559,7 +571,7 @@ bool tNMEA2000::SendFrames()
temp = (CANSendFrameBufferRead + 1) % MaxCANSendFrames;
if ( CANSendFrame(CANSendFrameBuf[temp].id, CANSendFrameBuf[temp].len, CANSendFrameBuf[temp].buf, CANSendFrameBuf[temp].wait_sent) ) {
CANSendFrameBufferRead=temp;
N2kFrameDbg("Frame unbuffered "); N2kFrameDbgln(CANSendFrameBuf[temp].id);
N2kFrameOutDbg("Frame unbuffered "); N2kFrameOutDbgln(CANSendFrameBuf[temp].id);
} else return false;
}

Expand All @@ -572,14 +584,14 @@ bool tNMEA2000::SendFrame(unsigned long id, unsigned char len, const unsigned ch
if ( !SendFrames() || !CANSendFrame(id,len,buf,wait_sent) ) { // If we can not sent frame immediately, add it to buffer
tCANSendFrame *Frame=GetNextFreeCANSendFrame();
if ( Frame==0 ) {
N2kFrameDbg("Frame failed "); N2kFrameDbgln(id);
N2kFrameOutDbg("Frame failed "); N2kFrameOutDbgln(id);
return false;
}
Frame->id=id;
Frame->len=len;
Frame->wait_sent=wait_sent;
for (int i=0; i<len && i<8; i++) Frame->buf[i]=buf[i];
N2kFrameDbg("Frame buffered "); N2kFrameDbgln(id);
N2kFrameOutDbg("Frame buffered "); N2kFrameOutDbgln(id);
}

return true;
Expand Down Expand Up @@ -641,8 +653,8 @@ tNMEA2000::tCANSendFrame *tNMEA2000::GetNextFreeCANSendFrame() {
//*****************************************************************************
void tNMEA2000::SendPendingInformation() {
for (int i=0; i<DeviceCount; i++ ) {
if ( Devices[i].QueryPendingProductInformation() && SendProductInformation(i) ) Devices[i].ClearPendingProductInformation();
if ( Devices[i].QueryPendingConfigurationInformation() && SendConfigurationInformation(i) ) Devices[i].ClearPendingConfigurationInformation();
if ( Devices[i].QueryPendingProductInformation() ) SendProductInformation(i);
if ( Devices[i].QueryPendingConfigurationInformation() ) SendConfigurationInformation(i);
}
}

Expand Down Expand Up @@ -1003,7 +1015,7 @@ uint8_t tNMEA2000::SetN2kCANBufMsg(unsigned long canId, unsigned char len, unsig
KnownMessage=CheckKnownMessage(PGN,SystemMessage,FastPacket);
if ( KnownMessage || !HandleOnlyKnownMessages() ) {
if (FastPacket && !IsFastPacketFirstFrame(buf[0]) ) { // Not first frame
N2kFrameDbg("New frame="); N2kFrameDbg(PGN); N2kFrameDbg(" frame="); N2kFrameDbg(buf[0],HEX); N2kFrameDbgln();
N2kFrameInDbg("New frame="); N2kFrameInDbg(PGN); N2kFrameInDbg(" frame="); N2kFrameInDbg(buf[0],HEX); N2kFrameInDbgln();
// Find previous slot for this PGN
for (MsgIndex=0;
MsgIndex<MaxN2kCANMsgs && !(N2kCANMsgBuf[MsgIndex].N2kMsg.PGN==PGN && N2kCANMsgBuf[MsgIndex].N2kMsg.Source==Source);
Expand All @@ -1013,14 +1025,14 @@ uint8_t tNMEA2000::SetN2kCANBufMsg(unsigned long canId, unsigned char len, unsig
N2kCANMsgBuf[MsgIndex].LastFrame=buf[0];
CopyBufToCANMsg(N2kCANMsgBuf[MsgIndex],1,len,buf);
} else { // We have lost frame, so free this
N2kFrameDbg(millis()); N2kFrameDbg(", Lost frame "); N2kFrameDbg(N2kCANMsgBuf[MsgIndex].LastFrame); N2kFrameDbg("/"); N2kFrameDbg(buf[0]);
N2kFrameDbg(", source "); N2kFrameDbg(Source); N2kFrameDbg(" for: "); N2kFrameDbgln(PGN);
N2kFrameInDbg(millis()); N2kFrameInDbg(", Lost frame "); N2kFrameInDbg(N2kCANMsgBuf[MsgIndex].LastFrame); N2kFrameInDbg("/"); N2kFrameInDbg(buf[0]);
N2kFrameInDbg(", source "); N2kFrameInDbg(Source); N2kFrameInDbg(" for: "); N2kFrameInDbgln(PGN);
N2kCANMsgBuf[MsgIndex].FreeMessage();
MsgIndex=MaxN2kCANMsgs;
}
} else { // Orphan frame
N2kFrameDbg(millis()); N2kFrameDbg(", Orphan frame "); N2kFrameDbg(buf[0]); N2kFrameDbg(", source ");
N2kFrameDbg(Source); N2kFrameDbg(" for: "); N2kFrameDbgln(PGN);
N2kFrameInDbg(millis()); N2kFrameInDbg(", Orphan frame "); N2kFrameInDbg(buf[0]); N2kFrameInDbg(", source ");
N2kFrameInDbg(Source); N2kFrameInDbg(" for: "); N2kFrameInDbgln(PGN);
}
} else { // Handle first frame
FindFreeCANMsgIndex(PGN,Source,MsgIndex);
Expand All @@ -1032,12 +1044,12 @@ uint8_t tNMEA2000::SetN2kCANBufMsg(unsigned long canId, unsigned char len, unsig
N2kCANMsgBuf[MsgIndex].CopiedLen=0;
if (FastPacket) {
CopyBufToCANMsg(N2kCANMsgBuf[MsgIndex],2,len,buf);
N2kFrameDbg("First frame="); N2kFrameDbg(PGN); N2kFrameDbgln();
N2kFrameInDbg("First frame="); N2kFrameInDbg(PGN); N2kFrameInDbgln();
N2kCANMsgBuf[MsgIndex].LastFrame=buf[0];
N2kCANMsgBuf[MsgIndex].N2kMsg.DataLen=buf[1];
} else {
CopyBufToCANMsg(N2kCANMsgBuf[MsgIndex],0,len,buf);
N2kFrameDbg("Single frame="); N2kFrameDbg(PGN); N2kFrameDbgln();
N2kFrameInDbg("Single frame="); N2kFrameInDbg(PGN); N2kFrameInDbgln();
N2kCANMsgBuf[MsgIndex].LastFrame=0;
N2kCANMsgBuf[MsgIndex].N2kMsg.DataLen=len;
}
Expand Down Expand Up @@ -1266,7 +1278,14 @@ bool tNMEA2000::SendConfigurationInformation(int DeviceIndex) {
} else { // No information provided, so respond not available
SetN2kPGNISOAcknowledgement(RespondMsg,1,0xff,126998L);
}
return SendMsg(RespondMsg,DeviceIndex);

if (SendMsg(RespondMsg,DeviceIndex) ) {
Devices[DeviceIndex].ClearPendingConfigurationInformation();
return true;
}

Devices[DeviceIndex].SetPendingConfigurationInformation();
return false;
}

//*****************************************************************************
Expand All @@ -1281,15 +1300,15 @@ void tNMEA2000::RespondISORequest(const tN2kMsg &N2kMsg, unsigned long Requested
HandlePGNListRequest(N2kMsg.Source,iDev);
break;
case 126996L: /* Product information */
// If query was for us, try to respond immediately
if ( ( N2kMsg.Destination!=Devices[iDev].N2kSource ) || !SendProductInformation(iDev) ) {
Devices[iDev].SetPendingProductInformation();
// If query was for us, try to respond
if ( ( N2kMsg.Destination==Devices[iDev].N2kSource ) ) {
SendProductInformation(iDev);
}
break;
case 126998L: /* Configuration information */
// If query was for us, try to respond immediately
if ( ( N2kMsg.Destination!=Devices[iDev].N2kSource ) || !SendConfigurationInformation(iDev) ) {
Devices[iDev].SetPendingPendingConfigurationInformation();
// If query was for us, try to respond
if ( ( N2kMsg.Destination==Devices[iDev].N2kSource ) ) {
SendConfigurationInformation(iDev);
}
break;
default:
Expand Down
4 changes: 2 additions & 2 deletions NMEA2000.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ class tDeviceInformation {
void ClearPendingProductInformation() { PendingProductInformation=0; }
bool QueryPendingProductInformation() { return (PendingProductInformation?PendingProductInformation<millis():false); }

void SetPendingPendingConfigurationInformation() { PendingConfigurationInformation=millis()+187+N2kSource*10; } // Use strange increment to avoid synchronize
void SetPendingConfigurationInformation() { PendingConfigurationInformation=millis()+187+N2kSource*10; } // Use strange increment to avoid synchronize
void ClearPendingConfigurationInformation() { PendingConfigurationInformation=0; }
bool QueryPendingConfigurationInformation() { return (PendingConfigurationInformation?PendingConfigurationInformation<millis():false); }
};
Expand Down Expand Up @@ -274,7 +274,7 @@ class tDeviceInformation {

protected:
void InitDevices();
bool IsInitialized() { return (Devices!=0); }
bool IsInitialized() { return (N2kCANMsgBuf!=0); }
void FindFreeCANMsgIndex(unsigned long PGN, unsigned char Source, uint8_t &MsgIndex);
uint8_t SetN2kCANBufMsg(unsigned long canId, unsigned char len, unsigned char *buf);
bool IsFastPacket(unsigned long PGN);
Expand Down
6 changes: 6 additions & 0 deletions README.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,12 @@ Actisense message format handling I have learned from OpenSkipper project.
I also thank for anybody who has extended library with new PGNs or processor support.

== Changes ==
25.06.2017 Fix and cosmetic changes

- ForwardStream initialization was accidentaly deleted

- Clean code and more debug options.

22.06.2017 Fixes and cosmetic changes

- Crashed, if ForwardStream was not defined. I accidentaly forgot to comment some debug code.
Expand Down

0 comments on commit d583724

Please sign in to comment.