Merge pull request #36 from LeeLeahy2/get-sentence-name

Add semp*GetSentenceName to return the sentence name string

Author: nseidle

Examples/Mixed_Parser/Mixed_Parser.ino

@@ -207,7 +207,6 @@ void loop()
 // Process a complete message incoming from parser
 void processMessage(SEMP_PARSE_STATE *parse, uint16_t type)
 {
-    SEMP_SCRATCH_PAD *scratchPad = (SEMP_SCRATCH_PAD *)parse->scratchPad;
     static bool displayOnce = true;
     uint32_t byteIndex;
     uint32_t offset;
@@ -226,7 +225,7 @@ void processMessage(SEMP_PARSE_STATE *parse, uint16_t type)
                 byteIndex -= 1;
             }
             Serial.printf("Valid NMEA Sentence: %s, %d bytes at 0x%08x (%d)\r\n",
-                          scratchPad->nmea.sentenceName, parse->length, offset, offset);
+                          sempNmeaGetSentenceName(parse), parse->length, offset, offset);
             break;
 
         case UBLOX_PARSER_INDEX:

Examples/Multiple_Parsers/Multiple_Parsers.ino

@@ -223,7 +223,6 @@ void loop()
 // Process a complete message incoming from parser
 void nmeaSentence(SEMP_PARSE_STATE *parse, uint16_t type)
 {
-    SEMP_SCRATCH_PAD *scratchPad = (SEMP_SCRATCH_PAD *)parse->scratchPad;
     uint32_t byteIndex;
     static bool displayOnce = true;
     uint32_t offset;
@@ -240,7 +239,7 @@ void nmeaSentence(SEMP_PARSE_STATE *parse, uint16_t type)
     // Display the raw sentence
     Serial.println();
     Serial.printf("Valid NMEA Sentence: %s, %d bytes at 0x%08x (%d)\r\n",
-                  scratchPad->nmea.sentenceName, parse->length, offset, offset);
+                  sempNmeaGetSentenceName(parse), parse->length, offset, offset);
     dumpBuffer(parse->buffer, parse->length);
 
     // Display the parser state

Examples/NMEA_Test/NMEA_Test.ino

@@ -122,7 +122,6 @@ void loop()
 // Process a complete message incoming from parser
 void processMessage(SEMP_PARSE_STATE *parse, uint16_t type)
 {
-    SEMP_SCRATCH_PAD *scratchPad = (SEMP_SCRATCH_PAD *)parse->scratchPad;
     static bool displayOnce = true;
     uint32_t offset;
 
@@ -134,7 +133,7 @@ void processMessage(SEMP_PARSE_STATE *parse, uint16_t type)
     // Display the raw message
     Serial.println();
         Serial.printf("Valid NMEA Sentence: %s, %d bytes at 0x%08x (%d)\r\n",
-                  scratchPad->nmea.sentenceName, parse->length, offset, offset);
+                  sempNmeaGetSentenceName(parse), parse->length, offset, offset);
     dumpBuffer(parse->buffer, parse->length);
 
     // Display the parser state

Examples/Unicore_Hash_Test/Unicore_Hash_Test.ino

@@ -153,7 +153,6 @@ bool badUnicoreHashChecksum(SEMP_PARSE_STATE *parse)
 // Process a complete message incoming from parser
 void processMessage(SEMP_PARSE_STATE *parse, uint16_t type)
 {
-    SEMP_SCRATCH_PAD *scratchPad = (SEMP_SCRATCH_PAD *)parse->scratchPad;
     uint32_t offset;
 
     // Determine the raw data stream offset
@@ -164,7 +163,7 @@ void processMessage(SEMP_PARSE_STATE *parse, uint16_t type)
     // Display the raw message
     Serial.println();
     Serial.printf("Valid Unicore Hash (#) Sentence: %s, %d bytes at 0x%08x (%d)\r\n",
-              scratchPad->unicoreHash.sentenceName, parse->length, offset, offset);
+              sempUnicoreHashGetSentenceName(parse), parse->length, offset, offset);
     dumpBuffer(parse->buffer, parse->length);
 }
 

src/Parse_NMEA.cpp

@@ -287,3 +287,10 @@ const char * sempNmeaGetStateName(const SEMP_PARSE_STATE *parse)
         return "sempNmeaLineFeed";
     return nullptr;
 }
+
+// Return the NMEA sentence name as a string
+const char * sempNmeaGetSentenceName(const SEMP_PARSE_STATE *parse)
+{
+    SEMP_SCRATCH_PAD *scratchPad = (SEMP_SCRATCH_PAD *)parse->scratchPad;
+    return (const char *)scratchPad->nmea.sentenceName;
+}

src/Parse_Unicore_Hash.cpp

@@ -358,3 +358,10 @@ const char * sempUnicoreHashGetStateName(const SEMP_PARSE_STATE *parse)
         return "sempUnicoreHashLineFeed";
     return nullptr;
 }
+
+// Return the Unicore hash (#) sentence name as a string
+const char * sempUnicoreHashGetSentenceName(const SEMP_PARSE_STATE *parse)
+{
+    SEMP_SCRATCH_PAD *scratchPad = (SEMP_SCRATCH_PAD *)parse->scratchPad;
+    return (const char *)scratchPad->unicoreHash.sentenceName;
+}

src/SparkFun_Extensible_Message_Parser.h

@@ -272,6 +272,7 @@ void sempDisableErrorOutput(SEMP_PARSE_STATE *parse);
 bool sempNmeaPreamble(SEMP_PARSE_STATE *parse, uint8_t data);
 bool sempNmeaFindFirstComma(SEMP_PARSE_STATE *parse, uint8_t data);
 const char * sempNmeaGetStateName(const SEMP_PARSE_STATE *parse);
+const char * sempNmeaGetSentenceName(const SEMP_PARSE_STATE *parse);
 
 // RTCM parse routines
 bool sempRtcmPreamble(SEMP_PARSE_STATE *parse, uint8_t data);
@@ -290,5 +291,6 @@ void sempUnicoreBinaryPrintHeader(SEMP_PARSE_STATE *parse);
 bool sempUnicoreHashPreamble(SEMP_PARSE_STATE *parse, uint8_t data);
 const char * sempUnicoreHashGetStateName(const SEMP_PARSE_STATE *parse);
 void sempUnicoreHashPrintHeader(SEMP_PARSE_STATE *parse);
+const char * sempUnicoreHashGetSentenceName(const SEMP_PARSE_STATE *parse);
 
 #endif  // __SPARKFUN_EXTENSIBLE_MESSAGE_PARSER_H__