From d3b69a82acdb56558aa1678267f7e2724ca0bea4 Mon Sep 17 00:00:00 2001 From: Geoffrey Merck Date: Fri, 24 Dec 2021 07:18:46 +0100 Subject: [PATCH] Add wx Free AprsCollector --- APRSCollector.cpp | 561 ++++++++++++++++++++++++++++++++++++++++++++++ APRSCollector.h | 83 +++++++ 2 files changed, 644 insertions(+) create mode 100644 APRSCollector.cpp create mode 100644 APRSCollector.h diff --git a/APRSCollector.cpp b/APRSCollector.cpp new file mode 100644 index 0000000..511726e --- /dev/null +++ b/APRSCollector.cpp @@ -0,0 +1,561 @@ +/* + * Copyright (C) 2010,2012,2018 by Jonathan Naylor G4KLX + * Copyright (C) 2021 by Geoffrey Merck F4FXL / KC3FRA + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + */ + +#include +#include +#include +#include + +#include "APRSCollector.h" +#include "DStarDefines.h" +#include "Utils.h" + +const unsigned int APRS_CSUM_LENGTH = 4U; +const unsigned int APRS_DATA_LENGTH = 300U; +const unsigned int SLOW_DATA_BLOCK_LENGTH = 6U; + +const char APRS_OVERLAY = '\\'; +const char APRS_SYMBOL = 'K'; + +CAPRSCollector::CAPRSCollector() : +m_state(AS_NONE), +m_ggaData(NULL), +m_ggaLength(0U), +m_ggaValid(false), +m_rmcData(NULL), +m_rmcLength(0U), +m_rmcValid(false), +m_crcData(NULL), +m_crcLength(0U), +m_crcValid(false), +m_buffer(NULL), +m_slowData(SS_FIRST), +m_collector(), +m_callsign() +{ + m_ggaData = new unsigned char[APRS_DATA_LENGTH]; + m_rmcData = new unsigned char[APRS_DATA_LENGTH]; + m_crcData = new unsigned char[APRS_DATA_LENGTH]; + m_buffer = new unsigned char[SLOW_DATA_BLOCK_LENGTH]; +} + +CAPRSCollector::~CAPRSCollector() +{ + delete[] m_ggaData; + delete[] m_rmcData; + delete[] m_crcData; + delete[] m_buffer; +} + +void CAPRSCollector::writeHeader(const std::string& callsign) +{ + m_callsign = callsign; +} + +bool CAPRSCollector::writeData(const unsigned char* data) +{ + assert(data != NULL); + + switch (m_slowData) { + case SS_FIRST: + m_buffer[0U] = data[0U] ^ SCRAMBLER_BYTE1; + m_buffer[1U] = data[1U] ^ SCRAMBLER_BYTE2; + m_buffer[2U] = data[2U] ^ SCRAMBLER_BYTE3; + m_slowData = SS_SECOND; + return false; + + case SS_SECOND: + m_buffer[3U] = data[0U] ^ SCRAMBLER_BYTE1; + m_buffer[4U] = data[1U] ^ SCRAMBLER_BYTE2; + m_buffer[5U] = data[2U] ^ SCRAMBLER_BYTE3; + m_slowData = SS_FIRST; + break; + } + + // Is it GPS data? + if ((m_buffer[0U] & SLOW_DATA_TYPE_MASK) == SLOW_DATA_TYPE_GPS) + return addGPSData(m_buffer + 1U); + + return false; +} + +void CAPRSCollector::reset() +{ + m_state = AS_NONE; + m_ggaLength = 0U; + m_ggaValid = false; + m_rmcLength = 0U; + m_rmcValid = false; + m_crcLength = 0U; + m_crcValid = false; + m_slowData = SS_FIRST; + m_collector.clear(); + m_callsign.clear(); +} + +void CAPRSCollector::sync() +{ + m_slowData = SS_FIRST; +} + +bool CAPRSCollector::addGPSData(const unsigned char* data) +{ + assert(data != NULL); + + m_collector += std::string((char*)data, 5U); + + if (m_state == AS_GGA) { + addGGAData(); + return false; + } else if (m_state == AS_RMC) { + return addRMCData(); + } else if (m_state == AS_CRC) { + return addCRCData(); + } + + if (m_state != AS_GGA && m_collector.find("$GPGGA") != std::string::npos) { + m_state = AS_GGA; + m_ggaLength = 0U; + m_ggaValid = false; + m_rmcLength = 0U; + m_rmcValid = false; + return false; + } else if (m_state != AS_RMC && m_collector.find("$GPRMC") != std::string::npos) { + m_state = AS_RMC; + m_rmcLength = 0U; + m_rmcValid = false; + return false; + } else if (m_state != AS_CRC && m_collector.find("$$CRC") != std::string::npos) { + m_state = AS_CRC; + m_crcLength = 0U; + m_crcValid = false; + } + + return false; +} + +void CAPRSCollector::addGGAData() +{ + std::string::size_type n2 = m_collector.find_last_of('\x0A'); + if (n2 == std::string::npos) + return; + + std::string::size_type n1 = m_collector.find("$GPGGA"); + if (n1 == std::string::npos) + return; + + if (n2 < n1) + return; + + std::string::size_type len = n2 - n1; + + if (len >= APRS_DATA_LENGTH) { + m_ggaLength = 0U; + m_ggaValid = false; + m_state = AS_NONE; + return; + } + + m_ggaLength = 0U; + for (unsigned int i = n1; i <= n2; i++) { + m_ggaData[m_ggaLength] = m_collector[i]; + m_ggaData[m_ggaLength] &= 0x7FU; + m_ggaLength++; + } + + bool ret = checkXOR(m_ggaData + 1U, m_ggaLength - 1U); + if (ret) { + // CUtils::dump(wxT("$GPGGA Valid"), m_ggaData, m_ggaLength); + m_ggaValid = true; + m_state = AS_RMC; + } else { + // CUtils::dump(wxT("$GPGGA Bad checksum"), m_ggaData, m_ggaLength); + m_ggaLength = 0U; + m_ggaValid = false; + m_state = AS_RMC; + } + + m_collector = m_collector.substr(n2); +} + +bool CAPRSCollector::addRMCData() +{ + std::string::size_type n2 = m_collector.find_last_of('\x0A'); + if (n2 == std::string::npos) + return false; + + std::string::size_type n1 = m_collector.find("$GPRMC"); + if (n1 == std::string::npos) + return false; + + if (n2 < n1) + return false; + + unsigned int len = n2 - n1; + + if (len >= APRS_DATA_LENGTH) { + m_rmcLength = 0U; + m_rmcValid = false; + m_state = AS_NONE; + return false; + } + + m_rmcLength = 0U; + for (unsigned int i = n1; i <= n2; i++) { + m_rmcData[m_rmcLength] = m_collector[i]; + m_rmcData[m_rmcLength] &= 0x7FU; + m_rmcLength++; + } + + bool ret = checkXOR(m_rmcData + 1U, m_rmcLength - 1U); + if (ret) { + // CUtils::dump(wxT("$GPRMC Valid"), m_rmcData, m_rmcLength); + m_rmcValid = true; + } else { + // CUtils::dump(wxT("$GPRMC Bad checksum"), m_rmcData, m_rmcLength); + m_rmcLength = 0U; + m_rmcValid = false; + } + + m_collector = m_collector.substr(n2); + + m_state = AS_NONE; + + return true; +} + +bool CAPRSCollector::addCRCData() +{ + std::string::size_type n2 = m_collector.find_last_of('\x0D'); + if (n2 == std::string::npos) + return false; + + std::string::size_type n1 = m_collector.find("$$CRC"); + if (n1 == std::string::npos) + return false; + + if (n2 < n1) + return false; + + unsigned int len = n2 - n1; + + if (len >= APRS_DATA_LENGTH) { + m_crcLength = 0U; + m_crcValid = false; + m_state = AS_NONE; + return false; + } + + m_crcLength = 0U; + for (unsigned int i = n1; i <= n2; i++) { + m_crcData[m_crcLength] = m_collector[i]; + m_crcLength++; + } + + bool ret = checkCRC(m_crcData, m_crcLength); + if (ret) { + // CUtils::dump(wxT("$$CRC Valid"), m_crcData, m_crcLength); + m_crcValid = true; + m_state = AS_NONE; + m_collector = m_collector.substr(n2); + return true; + } else { + // CUtils::dump(wxT("$$CRC Bad checksum"), m_crcData, m_crcLength); + m_crcLength = 0U; + m_crcValid = false; + m_state = AS_NONE; + m_collector = m_collector.substr(n2); + return false; + } +} + +unsigned int CAPRSCollector::getData(unsigned char* data, unsigned int length) +{ + assert(data != NULL); + + // Have we got GPS-A data? + if (m_crcValid) { + unsigned int len = m_crcLength - 10U; + if (len > length) + len = length; + + ::memcpy(data, m_crcData + 10U, len); + + m_crcLength = 0U; + m_crcValid = false; + + return len; + } + + // Have we got GGA data? + if (m_ggaValid) { + unsigned int len = convertNMEA1(data, length); + + m_ggaLength = 0U; + m_rmcLength = 0U; + m_ggaValid = false; + m_rmcValid = false; + + return len; + } + + // Have we got RMC data? + if (m_rmcValid) { + unsigned int len = convertNMEA2(data, length); + + m_ggaLength = 0U; + m_rmcLength = 0U; + m_ggaValid = false; + m_rmcValid = false; + + return len; + } + + return 0U; +} + +bool CAPRSCollector::checkXOR(const unsigned char* data, unsigned int length) const +{ + unsigned int posStar = 0U; + for (unsigned int i = length - 1U; i > 0U; i--) { + if (data[i] == '*') { + posStar = i; + break; + } + } + + if (posStar == 0U) + return false; + + unsigned char csum = calcXOR(data, posStar); + + char buffer[10U]; + ::sprintf(buffer, "%02X", csum); + + return ::memcmp(buffer, data + posStar + 1U, 2U) == 0; +} + +unsigned char CAPRSCollector::calcXOR(const unsigned char* buffer, unsigned int length) const +{ + assert(buffer != NULL); + assert(length > 0U); + + unsigned char res = 0U; + + for (unsigned int i = 0U; i < length; i++) + res ^= buffer[i]; + + return res; +} + +bool CAPRSCollector::checkCRC(const unsigned char* data, unsigned int length) const +{ + unsigned int csum = calcCRC(data + 10U, length - 10U); + + char buffer[10U]; + ::sprintf(buffer, "%04X", csum); + + return ::memcmp(buffer, data + 5U, APRS_CSUM_LENGTH) == 0; +} + +unsigned int CAPRSCollector::calcCRC(const unsigned char* buffer, unsigned int length) const +{ + assert(buffer != NULL); + assert(length > 0U); + + unsigned int icomcrc = 0xFFFFU; + + for (unsigned int j = 0U; j < length; j++) { + unsigned char ch = buffer[j]; + + for (unsigned int i = 0U; i < 8U; i++) { + bool xorflag = (((icomcrc ^ ch) & 0x01U) == 0x01U); + + icomcrc >>= 1; + + if (xorflag) + icomcrc ^= 0x8408U; + + ch >>= 1; + } + } + + return ~icomcrc & 0xFFFFU; +} + +unsigned int CAPRSCollector::convertNMEA1(unsigned char* data, unsigned int) +{ + // Parse the $GPGGA string into tokens + char* pGGA[20U]; + ::memset(pGGA, 0x00U, 20U * sizeof(char*)); + unsigned int nGGA = 0U; + + char* str = (char*)m_ggaData; + while (nGGA < 20U) { + char* p = mystrsep(&str, ",\r\n"); + + pGGA[nGGA++] = p; + if (p == NULL) + break; + } + + // Is there any position data? + if (pGGA[2U] == NULL || pGGA[3U] == NULL || pGGA[4U] == NULL || pGGA[5U] == NULL || ::strlen(pGGA[2U]) == 0U || ::strlen(pGGA[3U]) == 0U || ::strlen(pGGA[4U]) == 0 || ::strlen(pGGA[5U]) == 0) + return 0U; + + // Is it a valid GPS fix? + if (::strcmp(pGGA[6U], "0") == 0) + return 0U; + + char callsign[10U]; + dstarCallsignToAPRS(m_callsign, callsign); + + ::sprintf((char*)data, "%s>APDPRS,DSTAR*:!%.7s%s%c%.8s%s%c", callsign, pGGA[2U], pGGA[3U], APRS_OVERLAY, pGGA[4U], pGGA[5U], APRS_SYMBOL); + + // Get the bearing and speed from the RMC data + if (m_rmcValid) { + // Parse the $GPRMC string into tokens + char* pRMC[20U]; + ::memset(pRMC, 0x00U, 20U * sizeof(char*)); + unsigned int nRMC = 0U; + + str = (char*)m_rmcData; + for (;;) { + char* p = mystrsep(&str, ",\r\n"); + + pRMC[nRMC++] = p; + if (p == NULL) + break; + } + + // Check that we have a bearing and speed + if (pRMC[7U] != NULL && pRMC[8U] != NULL && ::strlen(pRMC[7U]) > 0U && ::strlen(pRMC[8U]) > 0U) { + int bearing = ::atoi(pRMC[8U]); + int speed = ::atoi(pRMC[7U]); + + ::sprintf((char*)data + ::strlen((char*)data), "%03d/%03d", bearing, speed); + } + } + + if (pGGA[9U] != NULL && ::strlen(pGGA[9U]) > 0U) { + // Convert altitude from metres to feet + int altitude = ::atoi(pGGA[9U]); + ::sprintf((char*)data + ::strlen((char*)data), "/A=%06.0f", float(altitude) * 3.28F); + } + + return ::strlen((char*)data); +} + +unsigned int CAPRSCollector::convertNMEA2(unsigned char* data, unsigned int) +{ + // Parse the $GPRMC string into tokens + char* pRMC[20U]; + ::memset(pRMC, 0x00U, 20U * sizeof(char*)); + unsigned int nRMC = 0U; + + char* str = (char*)m_rmcData; + while (nRMC < 20U) { + char* p = mystrsep(&str, ",\r\n"); + + pRMC[nRMC++] = p; + if (p == NULL) + break; + } + + // Is there any position data? + if (pRMC[3U] == NULL || pRMC[4U] == NULL || pRMC[5U] == NULL || pRMC[6U] == NULL || ::strlen(pRMC[3U]) == 0U || ::strlen(pRMC[4U]) == 0U || ::strlen(pRMC[5U]) == 0 || ::strlen(pRMC[6U]) == 0) + return 0U; + + // Is it a valid GPS fix? + if (::strcmp(pRMC[2U], "A") != 0) + return 0U; + + char callsign[10U]; + dstarCallsignToAPRS(m_callsign, callsign); + + ::sprintf((char*)data, "%s>APDPRS,DSTAR*:!%.7s%s%c%.8s%s%c", callsign, pRMC[3U], pRMC[4U], APRS_OVERLAY, pRMC[5U], pRMC[6U], APRS_SYMBOL); + + if (pRMC[7U] != NULL && pRMC[8U] != NULL && ::strlen(pRMC[7U]) > 0U && ::strlen(pRMC[8U]) > 0U) { + int bearing = ::atoi(pRMC[8U]); + int speed = ::atoi(pRMC[7U]); + + ::sprintf((char*)data + ::strlen((char*)data), "%03d/%03d", bearing, speed); + } + + return ::strlen((char*)data); +} + +void CAPRSCollector::dstarCallsignToAPRS(const std::string& dstarCallsign, char* aprsCallsign) const +{ + assert(aprsCallsign != NULL); + + std::string dstarcallsignTmp(dstarCallsign); + + if(dstarcallsignTmp[dstarcallsignTmp.length() - 1] == ' ') { + boost::trim(dstarcallsignTmp); + } else { + //loop until got rid of all double blanks + while(dstarcallsignTmp.find(" ") != std::string::npos) { + boost::replace_all(dstarcallsignTmp, " ", " "); + } + boost::replace_all(dstarcallsignTmp, " ", "-");//replace remaining blank with a - + } + + unsigned int i = 0U; + for (; i < dstarcallsignTmp.length(); i++) { + aprsCallsign[i] = dstarcallsignTmp[i]; + } + aprsCallsign[i] = '\0'; + + + // std::string first = dstarCallsign.BeforeFirst(wxT(' ')); + // std::string last = dstarCallsign.AfterLast(wxT(' ')); + + // if (last.empty() || first == last) { + // unsigned int n = 0U; + // for (unsigned int i = 0U; i < first.length(); i++) + // aprsCallsign[n++] = first[i]; + // aprsCallsign[n++] = '\0'; + // } else { + // unsigned int n = 0U; + // for (unsigned int i = 0U; i < first.length(); i++) + // aprsCallsign[n++] = first[i]; + // aprsCallsign[n++] = '-'; + // for (unsigned int i = 0U; i < last.length(); i++) + // aprsCallsign[n++] = last[i]; + // aprsCallsign[n++] = '\0'; + // } +} + +// Source found at +char* CAPRSCollector::mystrsep(char** sp, const char* sep) const +{ + if (sp == NULL || *sp == NULL || **sp == '\0') + return NULL; + + char* s = *sp; + char* p = s + ::strcspn(s, sep); + + if (*p != '\0') + *p++ = '\0'; + + *sp = p; + + return s; +} diff --git a/APRSCollector.h b/APRSCollector.h new file mode 100644 index 0000000..ec44543 --- /dev/null +++ b/APRSCollector.h @@ -0,0 +1,83 @@ +/* + * Copyright (C) 2010,2012,2018 by Jonathan Naylor G4KLX + * Copyright (C) 2021 by Geoffrey Merck F4FXL / KC3FRA + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + */ + +#ifndef APRSCollector_H +#define APRSCollector_H + +#include "Defs.h" + +enum APRS_STATE { + AS_NONE, + AS_GGA, + AS_RMC, + AS_CRC +}; + +class CAPRSCollector { +public: + CAPRSCollector(); + ~CAPRSCollector(); + + void writeHeader(const std::string& callsign); + + bool writeData(const unsigned char* data); + + void reset(); + + void sync(); + + unsigned int getData(unsigned char* data, unsigned int length); + +private: + APRS_STATE m_state; + unsigned char* m_ggaData; + unsigned int m_ggaLength; + bool m_ggaValid; + unsigned char* m_rmcData; + unsigned int m_rmcLength; + bool m_rmcValid; + unsigned char* m_crcData; + unsigned int m_crcLength; + bool m_crcValid; + unsigned char* m_buffer; + SLOWDATA_STATE m_slowData; + std::string m_collector; + std::string m_callsign; + + bool addGPSData(const unsigned char* data); + + void addGGAData(); + bool addRMCData(); + bool addCRCData(); + + bool checkXOR(const unsigned char* data, unsigned int length) const; + unsigned char calcXOR(const unsigned char* buffer, unsigned int length) const; + + bool checkCRC(const unsigned char* data, unsigned int length) const; + unsigned int calcCRC(const unsigned char* buffer, unsigned int length) const; + + unsigned int convertNMEA1(unsigned char* data, unsigned int length); + unsigned int convertNMEA2(unsigned char* data, unsigned int length); + + void dstarCallsignToAPRS(const std::string& dstarCallsign, char* aprsCallsign) const; + + char* mystrsep(char** sp, const char* sep) const; +}; + +#endif