ircDDBGateway/Common/APRSWriter.cpp

/*
 *   Copyright (C) 2010-2014,2018,2020 by Jonathan Naylor G4KLX
 *
 *   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 "APRSWriter.h"

#include "DStarDefines.h"
#include "Defs.h"

CAPRSEntry::CAPRSEntry(const wxString& callsign, const wxString& band, double frequency, double offset, double range, double latitude, double longitude, double agl) :
m_callsign(callsign),
m_band(band),
m_frequency(frequency),
m_offset(offset),
m_range(range),
m_latitude(latitude),
m_longitude(longitude),
m_agl(agl),
m_timer(1000U, 10U),
m_first(true),
m_collector(NULL)
{
	m_callsign.Trim();

	m_collector = new CAPRSCollector;
}

CAPRSEntry::~CAPRSEntry()
{
	delete m_collector;
}

wxString CAPRSEntry::getCallsign() const
{
	return m_callsign;
}

wxString CAPRSEntry::getBand() const
{
	return m_band;
}

double CAPRSEntry::getFrequency() const
{
	return m_frequency;
}

double CAPRSEntry::getOffset() const
{
	return m_offset;
}

double CAPRSEntry::getRange() const
{
	return m_range;
}

double CAPRSEntry::getLatitude() const
{
	return m_latitude;
}

double CAPRSEntry::getLongitude() const
{
	return m_longitude;
}

double CAPRSEntry::getAGL() const
{
	return m_agl;
}

CAPRSCollector* CAPRSEntry::getCollector() const
{
	return m_collector;
}

void CAPRSEntry::reset()
{
	m_first = true;
	m_timer.stop();
	m_collector->reset();
}

void CAPRSEntry::clock(unsigned int ms)
{
	m_timer.clock(ms);
}

bool CAPRSEntry::isOK()
{
	if (m_first) {
		m_first = false;
		m_timer.start();
		return true;
	}

	if (m_timer.hasExpired()) {
		m_timer.start();
		return true;
	} else {
		m_timer.start();
		return false;
	}
}

CAPRSWriter::CAPRSWriter(const wxString& address, unsigned int port, const wxString& gateway) :
m_idTimer(1000U),
m_gateway(),
m_array(),
m_aprsAddress(),
m_aprsPort(port),
m_aprsSocket()
#if defined(USE_GPSD)
,m_gpsdEnabled(false),
m_gpsdAddress(),
m_gpsdPort(),
m_gpsdData()
#endif
{
	wxASSERT(!address.IsEmpty());
	wxASSERT(port > 0U);
	wxASSERT(!gateway.IsEmpty());

	m_gateway = gateway;
	m_gateway.Truncate(LONG_CALLSIGN_LENGTH - 1U);
	m_gateway.Trim();

	m_aprsAddress = CUDPReaderWriter::lookup(address);
}

CAPRSWriter::~CAPRSWriter()
{
	for (CEntry_t::iterator it = m_array.begin(); it != m_array.end(); ++it)
		delete it->second;

	m_array.clear();
}

void CAPRSWriter::setPortFixed(const wxString& callsign, const wxString& band, double frequency, double offset, double range, double latitude, double longitude, double agl)
{
	wxString temp = callsign;
	temp.resize(LONG_CALLSIGN_LENGTH - 1U, wxT(' '));
	temp.Append(band);

	m_array[temp] = new CAPRSEntry(callsign, band, frequency, offset, range, latitude, longitude, agl);
}

void CAPRSWriter::setPortGPSD(const wxString& callsign, const wxString& band, double frequency, double offset, double range, const wxString& address, const wxString& port)
{
#if defined(USE_GPSD)
	wxASSERT(!address.IsEmpty());
	wxASSERT(!port.IsEmpty());

	wxString temp = callsign;
	temp.resize(LONG_CALLSIGN_LENGTH - 1U, wxT(' '));
	temp.Append(band);

	m_array[temp] = new CAPRSEntry(callsign, band, frequency, offset, range, 0.0, 0.0, 0.0);

	m_gpsdEnabled = true;
	m_gpsdAddress = address;
	m_gpsdPort    = port;
#endif
}

bool CAPRSWriter::open()
{
#if defined(USE_GPSD)
	if (m_gpsdEnabled) {
		int ret = ::gps_open(m_gpsdAddress.mb_str(), m_gpsdPort.mb_str(), &m_gpsdData);
		if (ret != 0) {
			wxLogError(wxT("Error when opening access to gpsd - %d - %s"), errno, ::gps_errstr(errno));
			return false;
		}

		::gps_stream(&m_gpsdData, WATCH_ENABLE | WATCH_JSON, NULL);

		wxLogMessage(wxT("Connected to GPSD"));
	}
#endif
	bool ret = m_aprsSocket.open();
	if (!ret)
		return false;

	wxLogMessage(wxT("Opened connection to the APRS Gateway"));

	m_idTimer.setTimeout(60U);
	m_idTimer.start();

	return true;
}

void CAPRSWriter::writeHeader(const wxString& callsign, const CHeaderData& header)
{
	CAPRSEntry* entry = m_array[callsign];
	if (entry == NULL) {
		wxLogError(wxT("Cannot find the callsign \"%s\" in the APRS array"), callsign.c_str());
		return;
	}

	entry->reset();

	CAPRSCollector* collector = entry->getCollector();

	collector->writeHeader(header.getMyCall1());
}

void CAPRSWriter::writeData(const wxString& callsign, const CAMBEData& data)
{
	if (data.isEnd())
		return;

	CAPRSEntry* entry = m_array[callsign];
	if (entry == NULL) {
		wxLogError(wxT("Cannot find the callsign \"%s\" in the APRS array"), callsign.c_str());
		return;
	}

	CAPRSCollector* collector = entry->getCollector();

	if (data.isSync()) {
		collector->sync();
		return;
	}

	unsigned char buffer[400U];
	data.getData(buffer, DV_FRAME_MAX_LENGTH_BYTES);

	bool complete = collector->writeData(buffer + VOICE_FRAME_LENGTH_BYTES);
	if (!complete)
		return;

	// Check the transmission timer
	bool ok = entry->isOK();
	if (!ok) {
		collector->reset();
		return;
	}

	unsigned int length = collector->getData(buffer, 400U);
	wxString text((char*)buffer, wxConvLocal, length);

	int n = text.Find(wxT(':'));
	if (n == wxNOT_FOUND) {
		collector->reset();
		return;
	}

	wxString header = text.Left(n);
	wxString body   = text.Mid(n + 1U);

	// If we already have a q-construct, don't send it on
	n = header.Find(wxT('q'));
	if (n != wxNOT_FOUND)
		return;

	// Remove the trailing \r
	n = body.Find(wxT('\r'));
	if (n != wxNOT_FOUND)
		body = body.Left(n);

	wxString output;
	output.Printf(wxT("%s,qAR,%s-%s:%s\r\n"), header.c_str(), entry->getCallsign().c_str(), entry->getBand().c_str(), body.c_str());

	char ascii[500U];
	::memset(ascii, 0x00, 500U);
	for (unsigned int i = 0U; i < output.Len(); i++)
		ascii[i] = output.GetChar(i);

	wxLogDebug(wxT("APRS ==> %s"), output.c_str());

	m_aprsSocket.write((unsigned char*)ascii, (unsigned int)::strlen(ascii), m_aprsAddress, m_aprsPort);

	collector->reset();
}

void CAPRSWriter::clock(unsigned int ms)
{
	m_idTimer.clock(ms);

#if defined(USE_GPSD)
	if (m_gpsdEnabled) {
		if (m_idTimer.hasExpired()) {
			sendIdFramesMobile();
			m_idTimer.start();
		}

	} else {
#endif
		if (m_idTimer.hasExpired()) {
			sendIdFramesFixed();
			m_idTimer.setTimeout(20U * 60U);
			m_idTimer.start();
		}
#if defined(USE_GPSD)
	}
#endif
	for (CEntry_t::iterator it = m_array.begin(); it != m_array.end(); ++it)
		it->second->clock(ms);
}

void CAPRSWriter::close()
{
	m_aprsSocket.close();

#if defined(USE_GPSD)
	if (m_gpsdEnabled) {
		::gps_stream(&m_gpsdData, WATCH_DISABLE, NULL);
		::gps_close(&m_gpsdData);
	}
#endif
}

void CAPRSWriter::sendIdFramesFixed()
{
	time_t now;
	::time(&now);
	struct tm* tm = ::gmtime(&now);

	for (CEntry_t::iterator it = m_array.begin(); it != m_array.end(); ++it) {
		CAPRSEntry* entry = it->second;
		if (entry == NULL)
			continue;

		// Default values aren't passed on
		if (entry->getLatitude() == 0.0 && entry->getLongitude() == 0.0)
			continue;

		wxString desc;
		if (entry->getBand().Len() > 1U) {
			if (entry->getFrequency() != 0.0)
				desc.Printf(wxT("Data (D-Star) %.5lfMHz"), entry->getFrequency());
			else
				desc = wxT("Data (D-Star)");
		} else {
			if (entry->getFrequency() != 0.0)
				desc.Printf(wxT("Voice (D-Star) %.5lfMHz %c%.4lfMHz"),
						entry->getFrequency(),
						entry->getOffset() < 0.0 ? wxT('-') : wxT('+'),
						::fabs(entry->getOffset()));
			else
				desc = wxT("Voice (D-Star)");
		}

		wxString band;
		if (entry->getFrequency() >= 1200.0)
			band = wxT("23cm/1.2GHz");
		else if (entry->getFrequency() >= 420.0)
			band = wxT("70cm");
		else if (entry->getFrequency() >= 144.0)
			band = wxT("2m");
		else if (entry->getFrequency() >= 50.0)
			band = wxT("6m");
		else if (entry->getFrequency() >= 28.0)
			band = wxT("10m");

		double tempLat  = ::fabs(entry->getLatitude());
		double tempLong = ::fabs(entry->getLongitude());

		double latitude  = ::floor(tempLat);
		double longitude = ::floor(tempLong);

		latitude  = (tempLat  - latitude)  * 60.0 + latitude  * 100.0;
		longitude = (tempLong - longitude) * 60.0 + longitude * 100.0;

		wxString lat;
		if (latitude >= 1000.0F)
			lat.Printf(wxT("%.2lf"), latitude);
		else if (latitude >= 100.0F)
			lat.Printf(wxT("0%.2lf"), latitude);
		else if (latitude >= 10.0F)
			lat.Printf(wxT("00%.2lf"), latitude);
		else
			lat.Printf(wxT("000%.2lf"), latitude);

		wxString lon;
		if (longitude >= 10000.0F)
			lon.Printf(wxT("%.2lf"), longitude);
		else if (longitude >= 1000.0F)
			lon.Printf(wxT("0%.2lf"), longitude);
		else if (longitude >= 100.0F)
			lon.Printf(wxT("00%.2lf"), longitude);
		else if (longitude >= 10.0F)
			lon.Printf(wxT("000%.2lf"), longitude);
		else
			lon.Printf(wxT("0000%.2lf"), longitude);

		// Convert commas to periods in the latitude and longitude
		lat.Replace(wxT(","), wxT("."));
		lon.Replace(wxT(","), wxT("."));

		wxString output;
		output.Printf(wxT("%s-S>APDG01,TCPIP*,qAC,%s-GS:;%-7s%-2s*%02d%02d%02dz%s%cD%s%caRNG%04.0lf/A=%06.0lf %s %s\r\n"),
			m_gateway.c_str(), m_gateway.c_str(), entry->getCallsign().c_str(), entry->getBand().c_str(),
			tm->tm_mday, tm->tm_hour, tm->tm_min,
			lat.c_str(), (entry->getLatitude() < 0.0F)  ? wxT('S') : wxT('N'),
			lon.c_str(), (entry->getLongitude() < 0.0F) ? wxT('W') : wxT('E'),
			entry->getRange() * 0.6214, entry->getAGL() * 3.28, band.c_str(), desc.c_str());

		char ascii[300U];
		::memset(ascii, 0x00, 300U);
		for (unsigned int i = 0U; i < output.Len(); i++)
			ascii[i] = output.GetChar(i);

		wxLogDebug(wxT("APRS ==> %s"), output.c_str());

		m_aprsSocket.write((unsigned char*)ascii, (unsigned int)::strlen(ascii), m_aprsAddress, m_aprsPort);

		if (entry->getBand().Len() == 1U) {
			output.Printf(wxT("%s-%s>APDG02,TCPIP*,qAC,%s-%sS:!%s%cD%s%c&RNG%04.0lf/A=%06.0lf %s %s\r\n"),
				entry->getCallsign().c_str(), entry->getBand().c_str(), entry->getCallsign().c_str(), entry->getBand().c_str(),
				lat.c_str(), (entry->getLatitude() < 0.0F)  ? wxT('S') : wxT('N'),
				lon.c_str(), (entry->getLongitude() < 0.0F) ? wxT('W') : wxT('E'),
				entry->getRange() * 0.6214, entry->getAGL() * 3.28, band.c_str(), desc.c_str());

			::memset(ascii, 0x00, 300U);
			for (unsigned int i = 0U; i < output.Len(); i++)
				ascii[i] = output.GetChar(i);

			wxLogDebug(wxT("APRS ==> %s"), output.c_str());

			m_aprsSocket.write((unsigned char*)ascii, (unsigned int)::strlen(ascii), m_aprsAddress, m_aprsPort);
		}
	}
}

#if defined(USE_GPSD)
void CAPRSWriter::sendIdFramesMobile()
{
	if (!m_gpsdEnabled)
		return;

	if (!::gps_waiting(&m_gpsdData, 0))
		return;

#if GPSD_API_MAJOR_VERSION >= 7
	if (::gps_read(&m_gpsdData, NULL, 0) <= 0)
		return;
#else
	if (::gps_read(&m_gpsdData) <= 0)
		return;
#endif

#if GPSD_API_MAJOR_VERSION >= 10
	if (m_gpsdData.fix.status != STATUS_FIX)
#else
	if (m_gpsdData.status != STATUS_FIX)
#endif
		return;

	bool latlonSet   = (m_gpsdData.set & LATLON_SET) == LATLON_SET;
	bool altitudeSet = (m_gpsdData.set & ALTITUDE_SET) == ALTITUDE_SET;
	bool velocitySet = (m_gpsdData.set & SPEED_SET) == SPEED_SET;
	bool bearingSet  = (m_gpsdData.set & TRACK_SET) == TRACK_SET;

	if (!latlonSet)
		return;

	float rawLatitude  = float(m_gpsdData.fix.latitude);
	float rawLongitude = float(m_gpsdData.fix.longitude);
#if GPSD_API_MAJOR_VERSION >= 9
	float rawAltitude  = float(m_gpsdData.fix.altMSL);
#else
	float rawAltitude  = float(m_gpsdData.fix.altitude);
#endif
	float rawVelocity  = float(m_gpsdData.fix.speed);
	float rawBearing   = float(m_gpsdData.fix.track);

	time_t now;
	::time(&now);
	struct tm* tm = ::gmtime(&now);

	for (CEntry_t::iterator it = m_array.begin(); it != m_array.end(); ++it) {
		CAPRSEntry* entry = it->second;
		if (entry == NULL)
			continue;

		wxString desc;
		if (entry->getBand().Len() > 1U) {
			if (entry->getFrequency() != 0.0)
				desc.Printf(wxT("Data (D-Star) %.5lfMHz"), entry->getFrequency());
			else
				desc = wxT("Data (D-Star)");
		} else {
			if (entry->getFrequency() != 0.0)
				desc.Printf(wxT("Voice (D-Star) %.5lfMHz %c%.4lfMHz"),
						entry->getFrequency(),
						entry->getOffset() < 0.0 ? wxT('-') : wxT('+'),
						::fabs(entry->getOffset()));
			else
				desc = wxT("Voice (D-Star)");
		}

		wxString band;
		if (entry->getFrequency() >= 1200.0)
			band = wxT("23cm/1.2GHz");
		else if (entry->getFrequency() >= 420.0)
			band = wxT("70cm");
		else if (entry->getFrequency() >= 144.0)
			band = wxT("2m");
		else if (entry->getFrequency() >= 50.0)
			band = wxT("6m");
		else if (entry->getFrequency() >= 28.0)
			band = wxT("10m");

		double tempLat  = ::fabs(rawLatitude);
		double tempLong = ::fabs(rawLongitude);

		double latitude  = ::floor(tempLat);
		double longitude = ::floor(tempLong);

		latitude  = (tempLat  - latitude)  * 60.0 + latitude  * 100.0;
		longitude = (tempLong - longitude) * 60.0 + longitude * 100.0;

		wxString lat;
		if (latitude >= 1000.0F)
			lat.Printf(wxT("%.2lf"), latitude);
		else if (latitude >= 100.0F)
			lat.Printf(wxT("0%.2lf"), latitude);
		else if (latitude >= 10.0F)
			lat.Printf(wxT("00%.2lf"), latitude);
		else
			lat.Printf(wxT("000%.2lf"), latitude);

		wxString lon;
		if (longitude >= 10000.0F)
			lon.Printf(wxT("%.2lf"), longitude);
		else if (longitude >= 1000.0F)
			lon.Printf(wxT("0%.2lf"), longitude);
		else if (longitude >= 100.0F)
			lon.Printf(wxT("00%.2lf"), longitude);
		else if (longitude >= 10.0F)
			lon.Printf(wxT("000%.2lf"), longitude);
		else
			lon.Printf(wxT("0000%.2lf"), longitude);

		// Convert commas to periods in the latitude and longitude
		lat.Replace(wxT(","), wxT("."));
		lon.Replace(wxT(","), wxT("."));

		wxString output1;
		output1.Printf(wxT("%s-S>APDG01,TCPIP*,qAC,%s-GS:;%-7s%-2s*%02d%02d%02dz%s%cD%s%ca/A=%06.0lf"),
			m_gateway.c_str(), m_gateway.c_str(), entry->getCallsign().c_str(), entry->getBand().c_str(),
			tm->tm_mday, tm->tm_hour, tm->tm_min,
			lat.c_str(), (rawLatitude < 0.0)  ? wxT('S') : wxT('N'),
			lon.c_str(), (rawLongitude < 0.0) ? wxT('W') : wxT('E'),
			rawAltitude * 3.28);

		wxString output2;
		if (bearingSet && velocitySet)
			output2.Printf(wxT("%03.0lf/%03.0lf"), rawBearing, rawVelocity * 0.539957F);

		wxString output3;
		output3.Printf(wxT("RNG%04.0lf %s %s\r\n"), entry->getRange() * 0.6214, band.c_str(), desc.c_str());

		char ascii[300U];
		::memset(ascii, 0x00, 300U);
		unsigned int n = 0U;
		for (unsigned int i = 0U; i < output1.Len(); i++, n++)
			ascii[n] = output1.GetChar(i);
		for (unsigned int i = 0U; i < output2.Len(); i++, n++)
			ascii[n] = output2.GetChar(i);
		for (unsigned int i = 0U; i < output3.Len(); i++, n++)
			ascii[n] = output3.GetChar(i);

		wxLogDebug(wxT("APRS ==> %s%s%s"), output1.c_str(), output2.c_str(), output3.c_str());

		m_aprsSocket.write((unsigned char*)ascii, (unsigned int)::strlen(ascii), m_aprsAddress, m_aprsPort);

		if (entry->getBand().Len() == 1U) {
			if (altitudeSet)
				output1.Printf(wxT("%s-%s>APDG02,TCPIP*,qAC,%s-%sS:!%s%cD%s%c&/A=%06.0lf"),
					entry->getCallsign().c_str(), entry->getBand().c_str(), entry->getCallsign().c_str(), entry->getBand().c_str(),
					lat.c_str(), (rawLatitude < 0.0)  ? wxT('S') : wxT('N'),
					lon.c_str(), (rawLongitude < 0.0) ? wxT('W') : wxT('E'),
					rawAltitude * 3.28);
			else
				output1.Printf(wxT("%s-%s>APDG02,TCPIP*,qAC,%s-%sS:!%s%cD%s%c&"),
					entry->getCallsign().c_str(), entry->getBand().c_str(), entry->getCallsign().c_str(), entry->getBand().c_str(),
					lat.c_str(), (rawLatitude < 0.0)  ? wxT('S') : wxT('N'),
					lon.c_str(), (rawLongitude < 0.0) ? wxT('W') : wxT('E'));

			::memset(ascii, 0x00, 300U);
			unsigned int n = 0U;
			for (unsigned int i = 0U; i < output1.Len(); i++, n++)
				ascii[n] = output1.GetChar(i);
			for (unsigned int i = 0U; i < output2.Len(); i++, n++)
				ascii[n] = output2.GetChar(i);
			for (unsigned int i = 0U; i < output3.Len(); i++, n++)
				ascii[n] = output3.GetChar(i);

			wxLogDebug(wxT("APRS ==> %s%s%s"), output1.c_str(), output2.c_str(), output3.c_str());

			m_aprsSocket.write((unsigned char*)ascii, (unsigned int)::strlen(ascii), m_aprsAddress, m_aprsPort);
		}
	}
}
#endif