/////////////////////////////////////////////////////////////////////////////////// // Copyright (C) 2020 Jon Beniston, M7RCE // // Copyright (C) 2020 Edouard Griffiths, F4EXB // // // // 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 as version 3 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 V3 for more details. // // // // You should have received a copy of the GNU General Public License // // along with this program. If not, see . // /////////////////////////////////////////////////////////////////////////////////// #include #include #include #include #include #include "SWGFeatureSettings.h" #include "SWGFeatureReport.h" #include "SWGFeatureActions.h" #include "SWGDeviceState.h" #include "SWGTargetAzimuthElevation.h" #include "dsp/dspengine.h" #include "device/deviceset.h" #include "feature/featureset.h" #include "maincore.h" #include "gs232controller.h" #include "gs232controllerworker.h" #include "gs232controllerreport.h" MESSAGE_CLASS_DEFINITION(GS232Controller::MsgConfigureGS232Controller, Message) MESSAGE_CLASS_DEFINITION(GS232Controller::MsgStartStop, Message) MESSAGE_CLASS_DEFINITION(GS232Controller::MsgReportWorker, Message) const char* const GS232Controller::m_featureIdURI = "sdrangel.feature.gs232controller"; const char* const GS232Controller::m_featureId = "GS232Controller"; GS232Controller::GS232Controller(WebAPIAdapterInterface *webAPIAdapterInterface) : Feature(m_featureIdURI, webAPIAdapterInterface) { qDebug("GS232Controller::GS232Controller: webAPIAdapterInterface: %p", webAPIAdapterInterface); setObjectName(m_featureId); m_worker = new GS232ControllerWorker(); m_state = StIdle; m_errorMessage = "GS232Controller error"; m_selectedPipe = nullptr; connect(&m_updatePipesTimer, SIGNAL(timeout()), this, SLOT(updatePipes())); m_updatePipesTimer.start(1000); m_networkManager = new QNetworkAccessManager(); connect(m_networkManager, SIGNAL(finished(QNetworkReply*)), this, SLOT(networkManagerFinished(QNetworkReply*))); } GS232Controller::~GS232Controller() { disconnect(m_networkManager, SIGNAL(finished(QNetworkReply*)), this, SLOT(networkManagerFinished(QNetworkReply*))); delete m_networkManager; if (m_worker->isRunning()) { stop(); } delete m_worker; } void GS232Controller::start() { qDebug("GS232Controller::start"); m_worker->reset(); m_worker->setMessageQueueToFeature(getInputMessageQueue()); bool ok = m_worker->startWork(); m_state = ok ? StRunning : StError; m_thread.start(); GS232ControllerWorker::MsgConfigureGS232ControllerWorker *msg = GS232ControllerWorker::MsgConfigureGS232ControllerWorker::create(m_settings, true); m_worker->getInputMessageQueue()->push(msg); } void GS232Controller::stop() { qDebug("GS232Controller::stop"); m_worker->stopWork(); m_state = StIdle; m_thread.quit(); m_thread.wait(); } bool GS232Controller::handleMessage(const Message& cmd) { if (MsgConfigureGS232Controller::match(cmd)) { MsgConfigureGS232Controller& cfg = (MsgConfigureGS232Controller&) cmd; qDebug() << "GS232Controller::handleMessage: MsgConfigureGS232Controller"; applySettings(cfg.getSettings(), cfg.getForce()); return true; } else if (MsgStartStop::match(cmd)) { MsgStartStop& cfg = (MsgStartStop&) cmd; qDebug() << "GS232Controller::handleMessage: MsgStartStop: start:" << cfg.getStartStop(); if (cfg.getStartStop()) { start(); } else { stop(); } return true; } else if (MsgReportWorker::match(cmd)) { MsgReportWorker& report = (MsgReportWorker&) cmd; if (report.getMessage() == "Connected") m_state = StRunning; else if (report.getMessage() == "Disconnected") m_state = StIdle; else { m_state = StError; m_errorMessage = report.getMessage(); } return true; } else if (GS232ControllerReport::MsgReportAzAl::match(cmd)) { GS232ControllerReport::MsgReportAzAl& report = (GS232ControllerReport::MsgReportAzAl&) cmd; // Save state for Web report/getOnTarget m_currentAzimuth = report.getAzimuth(); m_currentElevation = report.getElevation(); // Forward to GUI if (getMessageQueueToGUI()) { getMessageQueueToGUI()->push(new GS232ControllerReport::MsgReportAzAl(report)); } return true; } else if (MainCore::MsgTargetAzimuthElevation::match(cmd)) { // New source from another plugin if ((m_state == StRunning) && m_settings.m_track) { MainCore::MsgTargetAzimuthElevation& msg = (MainCore::MsgTargetAzimuthElevation&) cmd; // Is it from the selected pipe? if (msg.getPipeSource() == m_selectedPipe) { if (getMessageQueueToGUI()) { // Forward to GUI - which will then send us updated settings getMessageQueueToGUI()->push(new MainCore::MsgTargetAzimuthElevation(msg)); } else { // No GUI, so save source - applySettings will propagate to worker SWGSDRangel::SWGTargetAzimuthElevation *swgTarget = msg.getSWGTargetAzimuthElevation(); m_settings.m_azimuth = swgTarget->getAzimuth(); m_settings.m_elevation = swgTarget->getElevation(); applySettings(m_settings); } } else qDebug() << "GS232Controller::handleMessage: No match " << msg.getPipeSource() << " " << m_selectedPipe; } return true; } else { return false; } } // Calculate whether last received az/el was on target bool GS232Controller::getOnTarget() const { float targetAziumth, targetElevation; m_settings.calcTargetAzEl(targetAziumth, targetElevation); float readTolerance = m_settings.m_tolerance + 0.5f; bool onTarget = (abs(m_currentAzimuth - targetAziumth) < readTolerance) && (abs(m_currentElevation - targetElevation) < readTolerance); return onTarget; } void GS232Controller::updatePipes() { QList availablePipes = updateAvailablePipeSources("target", GS232ControllerSettings::m_pipeTypes, GS232ControllerSettings::m_pipeURIs, this); if (availablePipes != m_availablePipes) { m_availablePipes = availablePipes; if (getMessageQueueToGUI()) { MsgReportPipes *msgToGUI = MsgReportPipes::create(); QList& msgAvailablePipes = msgToGUI->getAvailablePipes(); msgAvailablePipes.append(availablePipes); getMessageQueueToGUI()->push(msgToGUI); } } } QByteArray GS232Controller::serialize() const { return m_settings.serialize(); } bool GS232Controller::deserialize(const QByteArray& data) { if (m_settings.deserialize(data)) { MsgConfigureGS232Controller *msg = MsgConfigureGS232Controller::create(m_settings, true); m_inputMessageQueue.push(msg); return true; } else { m_settings.resetToDefaults(); MsgConfigureGS232Controller *msg = MsgConfigureGS232Controller::create(m_settings, true); m_inputMessageQueue.push(msg); return false; } } void GS232Controller::applySettings(const GS232ControllerSettings& settings, bool force) { qDebug() << "GS232Controller::applySettings:" << " m_azimuth: " << settings.m_azimuth << " m_elevation: " << settings.m_elevation << " m_azimuthOffset: " << settings.m_azimuthOffset << " m_elevationOffset: " << settings.m_elevationOffset << " m_azimuthMin: " << settings.m_azimuthMin << " m_azimuthMax: " << settings.m_azimuthMax << " m_elevationMin: " << settings.m_elevationMin << " m_elevationMax: " << settings.m_elevationMax << " m_tolerance: " << settings.m_tolerance << " m_protocol: " << settings.m_protocol << " m_serialPort: " << settings.m_serialPort << " m_baudRate: " << settings.m_baudRate << " m_track: " << settings.m_track << " m_source: " << settings.m_source << " m_title: " << settings.m_title << " m_rgbColor: " << settings.m_rgbColor << " m_useReverseAPI: " << settings.m_useReverseAPI << " m_reverseAPIAddress: " << settings.m_reverseAPIAddress << " m_reverseAPIPort: " << settings.m_reverseAPIPort << " m_reverseAPIFeatureSetIndex: " << settings.m_reverseAPIFeatureSetIndex << " m_reverseAPIFeatureIndex: " << settings.m_reverseAPIFeatureIndex << " force: " << force; QList reverseAPIKeys; if ((m_settings.m_azimuth != settings.m_azimuth) || force) { reverseAPIKeys.append("azimuth"); } if ((m_settings.m_elevation != settings.m_elevation) || force) { reverseAPIKeys.append("elevation"); } if ((m_settings.m_serialPort != settings.m_serialPort) || force) { reverseAPIKeys.append("serialPort"); } if ((m_settings.m_baudRate != settings.m_baudRate) || force) { reverseAPIKeys.append("baudRate"); } if ((m_settings.m_track != settings.m_track) || force) { reverseAPIKeys.append("track"); } if ((m_settings.m_source != settings.m_source) || (!settings.m_source.isEmpty() && (m_selectedPipe == nullptr)) // Change in available pipes || force) { if (!settings.m_source.isEmpty()) { m_selectedPipe = getPipeEndPoint(settings.m_source, m_availablePipes); if (m_selectedPipe == nullptr) { qDebug() << "GS232Controller::applySettings: No plugin corresponding to source " << settings.m_source; } } reverseAPIKeys.append("source"); } if ((m_settings.m_azimuthOffset != settings.m_azimuthOffset) || force) { reverseAPIKeys.append("azimuthOffset"); } if ((m_settings.m_elevationOffset != settings.m_elevationOffset) || force) { reverseAPIKeys.append("elevationOffset"); } if ((m_settings.m_azimuthMin != settings.m_azimuthMin) || force) { reverseAPIKeys.append("azimuthMin"); } if ((m_settings.m_azimuthMax != settings.m_azimuthMax) || force) { reverseAPIKeys.append("azimuthMax"); } if ((m_settings.m_elevationMin != settings.m_elevationMin) || force) { reverseAPIKeys.append("elevationMin"); } if ((m_settings.m_tolerance != settings.m_tolerance) || force) { reverseAPIKeys.append("tolerance"); } if ((m_settings.m_protocol != settings.m_protocol) || force) { reverseAPIKeys.append("m_protocol"); } if ((m_settings.m_title != settings.m_title) || force) { reverseAPIKeys.append("title"); } if ((m_settings.m_rgbColor != settings.m_rgbColor) || force) { reverseAPIKeys.append("rgbColor"); } GS232ControllerWorker::MsgConfigureGS232ControllerWorker *msg = GS232ControllerWorker::MsgConfigureGS232ControllerWorker::create( settings, force ); m_worker->getInputMessageQueue()->push(msg); if (settings.m_useReverseAPI) { bool fullUpdate = ((m_settings.m_useReverseAPI != settings.m_useReverseAPI) && settings.m_useReverseAPI) || (m_settings.m_reverseAPIAddress != settings.m_reverseAPIAddress) || (m_settings.m_reverseAPIPort != settings.m_reverseAPIPort) || (m_settings.m_reverseAPIFeatureSetIndex != settings.m_reverseAPIFeatureSetIndex) || (m_settings.m_reverseAPIFeatureIndex != settings.m_reverseAPIFeatureIndex); webapiReverseSendSettings(reverseAPIKeys, settings, fullUpdate || force); } m_settings = settings; } int GS232Controller::webapiRun(bool run, SWGSDRangel::SWGDeviceState& response, QString& errorMessage) { (void) errorMessage; getFeatureStateStr(*response.getState()); MsgStartStop *msg = MsgStartStop::create(run); getInputMessageQueue()->push(msg); return 202; } int GS232Controller::webapiSettingsGet( SWGSDRangel::SWGFeatureSettings& response, QString& errorMessage) { (void) errorMessage; response.setGs232ControllerSettings(new SWGSDRangel::SWGGS232ControllerSettings()); response.getGs232ControllerSettings()->init(); webapiFormatFeatureSettings(response, m_settings); return 200; } int GS232Controller::webapiSettingsPutPatch( bool force, const QStringList& featureSettingsKeys, SWGSDRangel::SWGFeatureSettings& response, QString& errorMessage) { (void) errorMessage; GS232ControllerSettings settings = m_settings; webapiUpdateFeatureSettings(settings, featureSettingsKeys, response); MsgConfigureGS232Controller *msg = MsgConfigureGS232Controller::create(settings, force); m_inputMessageQueue.push(msg); if (m_guiMessageQueue) // forward to GUI if any { MsgConfigureGS232Controller *msgToGUI = MsgConfigureGS232Controller::create(settings, force); m_guiMessageQueue->push(msgToGUI); } webapiFormatFeatureSettings(response, settings); return 200; } int GS232Controller::webapiReportGet( SWGSDRangel::SWGFeatureReport& response, QString& errorMessage) { (void) errorMessage; response.setGs232ControllerReport(new SWGSDRangel::SWGGS232ControllerReport()); response.getGs232ControllerReport()->init(); webapiFormatFeatureReport(response); return 200; } void GS232Controller::webapiFormatFeatureSettings( SWGSDRangel::SWGFeatureSettings& response, const GS232ControllerSettings& settings) { response.getGs232ControllerSettings()->setAzimuth(settings.m_azimuth); response.getGs232ControllerSettings()->setElevation(settings.m_elevation); response.getGs232ControllerSettings()->setSerialPort(new QString(settings.m_serialPort)); response.getGs232ControllerSettings()->setBaudRate(settings.m_baudRate); response.getGs232ControllerSettings()->setTrack(settings.m_track); response.getGs232ControllerSettings()->setSource(new QString(settings.m_source)); response.getGs232ControllerSettings()->setAzimuthOffset(settings.m_azimuthOffset); response.getGs232ControllerSettings()->setElevationOffset(settings.m_elevationOffset); response.getGs232ControllerSettings()->setAzimuthMin(settings.m_azimuthMin); response.getGs232ControllerSettings()->setAzimuthMax(settings.m_azimuthMax); response.getGs232ControllerSettings()->setElevationMin(settings.m_elevationMin); response.getGs232ControllerSettings()->setElevationMax(settings.m_elevationMax); response.getGs232ControllerSettings()->setTolerance(settings.m_tolerance); response.getGs232ControllerSettings()->setProtocol(settings.m_protocol); if (response.getGs232ControllerSettings()->getTitle()) { *response.getGs232ControllerSettings()->getTitle() = settings.m_title; } else { response.getGs232ControllerSettings()->setTitle(new QString(settings.m_title)); } response.getGs232ControllerSettings()->setRgbColor(settings.m_rgbColor); response.getGs232ControllerSettings()->setUseReverseApi(settings.m_useReverseAPI ? 1 : 0); if (response.getGs232ControllerSettings()->getReverseApiAddress()) { *response.getGs232ControllerSettings()->getReverseApiAddress() = settings.m_reverseAPIAddress; } else { response.getGs232ControllerSettings()->setReverseApiAddress(new QString(settings.m_reverseAPIAddress)); } response.getGs232ControllerSettings()->setReverseApiPort(settings.m_reverseAPIPort); response.getGs232ControllerSettings()->setReverseApiFeatureSetIndex(settings.m_reverseAPIFeatureSetIndex); response.getGs232ControllerSettings()->setReverseApiFeatureIndex(settings.m_reverseAPIFeatureIndex); } void GS232Controller::webapiUpdateFeatureSettings( GS232ControllerSettings& settings, const QStringList& featureSettingsKeys, SWGSDRangel::SWGFeatureSettings& response) { if (featureSettingsKeys.contains("azimuth")) { settings.m_azimuth = response.getGs232ControllerSettings()->getAzimuth(); } if (featureSettingsKeys.contains("elevation")) { settings.m_elevation = response.getGs232ControllerSettings()->getElevation(); } if (featureSettingsKeys.contains("serialPort")) { settings.m_serialPort = *response.getGs232ControllerSettings()->getSerialPort(); } if (featureSettingsKeys.contains("baudRate")) { settings.m_baudRate = response.getGs232ControllerSettings()->getBaudRate(); } if (featureSettingsKeys.contains("track")) { settings.m_track = response.getGs232ControllerSettings()->getTrack() != 0; } if (featureSettingsKeys.contains("source")) { settings.m_source = *response.getGs232ControllerSettings()->getSource(); } if (featureSettingsKeys.contains("azimuthOffset")) { settings.m_azimuthOffset = response.getGs232ControllerSettings()->getAzimuthOffset(); } if (featureSettingsKeys.contains("elevationOffset")) { settings.m_elevationOffset = response.getGs232ControllerSettings()->getElevationOffset(); } if (featureSettingsKeys.contains("azimuthMin")) { settings.m_azimuthMin = response.getGs232ControllerSettings()->getAzimuthMin(); } if (featureSettingsKeys.contains("azimuthMax")) { settings.m_azimuthMax = response.getGs232ControllerSettings()->getAzimuthMax(); } if (featureSettingsKeys.contains("elevationMin")) { settings.m_elevationMin = response.getGs232ControllerSettings()->getElevationMin(); } if (featureSettingsKeys.contains("elevationMax")) { settings.m_elevationMax = response.getGs232ControllerSettings()->getElevationMax(); } if (featureSettingsKeys.contains("tolerance")) { settings.m_tolerance = response.getGs232ControllerSettings()->getTolerance(); } if (featureSettingsKeys.contains("protocol")) { settings.m_protocol = (GS232ControllerSettings::Protocol)response.getGs232ControllerSettings()->getProtocol(); } if (featureSettingsKeys.contains("title")) { settings.m_title = *response.getGs232ControllerSettings()->getTitle(); } if (featureSettingsKeys.contains("rgbColor")) { settings.m_rgbColor = response.getGs232ControllerSettings()->getRgbColor(); } if (featureSettingsKeys.contains("useReverseAPI")) { settings.m_useReverseAPI = response.getGs232ControllerSettings()->getUseReverseApi() != 0; } if (featureSettingsKeys.contains("reverseAPIAddress")) { settings.m_reverseAPIAddress = *response.getGs232ControllerSettings()->getReverseApiAddress(); } if (featureSettingsKeys.contains("reverseAPIPort")) { settings.m_reverseAPIPort = response.getGs232ControllerSettings()->getReverseApiPort(); } if (featureSettingsKeys.contains("reverseAPIFeatureSetIndex")) { settings.m_reverseAPIFeatureSetIndex = response.getGs232ControllerSettings()->getReverseApiFeatureSetIndex(); } if (featureSettingsKeys.contains("reverseAPIFeatureIndex")) { settings.m_reverseAPIFeatureIndex = response.getGs232ControllerSettings()->getReverseApiFeatureIndex(); } } void GS232Controller::webapiReverseSendSettings(QList& featureSettingsKeys, const GS232ControllerSettings& settings, bool force) { SWGSDRangel::SWGFeatureSettings *swgFeatureSettings = new SWGSDRangel::SWGFeatureSettings(); // swgFeatureSettings->setOriginatorFeatureIndex(getIndexInDeviceSet()); // swgFeatureSettings->setOriginatorFeatureSetIndex(getDeviceSetIndex()); swgFeatureSettings->setFeatureType(new QString("GS232Controller")); swgFeatureSettings->setGs232ControllerSettings(new SWGSDRangel::SWGGS232ControllerSettings()); SWGSDRangel::SWGGS232ControllerSettings *swgGS232ControllerSettings = swgFeatureSettings->getGs232ControllerSettings(); // transfer data that has been modified. When force is on transfer all data except reverse API data if (featureSettingsKeys.contains("azimuth") || force) { swgGS232ControllerSettings->setAzimuth(settings.m_azimuth); } if (featureSettingsKeys.contains("elevation") || force) { swgGS232ControllerSettings->setElevation(settings.m_elevation); } if (featureSettingsKeys.contains("serialPort") || force) { swgGS232ControllerSettings->setSerialPort(new QString(settings.m_serialPort)); } if (featureSettingsKeys.contains("baudRate") || force) { swgGS232ControllerSettings->setBaudRate(settings.m_baudRate); } if (featureSettingsKeys.contains("track") || force) { swgGS232ControllerSettings->setTrack(settings.m_track); } if (featureSettingsKeys.contains("source") || force) { swgGS232ControllerSettings->setSource(new QString(settings.m_source)); } if (featureSettingsKeys.contains("azimuthOffset") || force) { swgGS232ControllerSettings->setAzimuthOffset(settings.m_azimuthOffset); } if (featureSettingsKeys.contains("elevationOffset") || force) { swgGS232ControllerSettings->setElevationOffset(settings.m_elevationOffset); } if (featureSettingsKeys.contains("azimuthMin") || force) { swgGS232ControllerSettings->setAzimuthMin(settings.m_azimuthMin); } if (featureSettingsKeys.contains("azimuthMax") || force) { swgGS232ControllerSettings->setAzimuthMax(settings.m_azimuthMax); } if (featureSettingsKeys.contains("elevationMin") || force) { swgGS232ControllerSettings->setElevationMin(settings.m_elevationMin); } if (featureSettingsKeys.contains("elevationMax") || force) { swgGS232ControllerSettings->setElevationMax(settings.m_elevationMax); } if (featureSettingsKeys.contains("tolerance") || force) { swgGS232ControllerSettings->setTolerance(settings.m_tolerance); } if (featureSettingsKeys.contains("protocol") || force) { swgGS232ControllerSettings->setProtocol((int)settings.m_protocol); } if (featureSettingsKeys.contains("title") || force) { swgGS232ControllerSettings->setTitle(new QString(settings.m_title)); } if (featureSettingsKeys.contains("rgbColor") || force) { swgGS232ControllerSettings->setRgbColor(settings.m_rgbColor); } QString channelSettingsURL = QString("http://%1:%2/sdrangel/featureset/%3/feature/%4/settings") .arg(settings.m_reverseAPIAddress) .arg(settings.m_reverseAPIPort) .arg(settings.m_reverseAPIFeatureSetIndex) .arg(settings.m_reverseAPIFeatureIndex); m_networkRequest.setUrl(QUrl(channelSettingsURL)); m_networkRequest.setHeader(QNetworkRequest::ContentTypeHeader, "application/json"); QBuffer *buffer = new QBuffer(); buffer->open((QBuffer::ReadWrite)); buffer->write(swgFeatureSettings->asJson().toUtf8()); buffer->seek(0); // Always use PATCH to avoid passing reverse API settings QNetworkReply *reply = m_networkManager->sendCustomRequest(m_networkRequest, "PATCH", buffer); buffer->setParent(reply); delete swgFeatureSettings; } void GS232Controller::webapiFormatFeatureReport(SWGSDRangel::SWGFeatureReport& response) { response.getGs232ControllerReport()->setSources(new QList()); for (int i = 0; i < m_availablePipes.size(); i++) { response.getGs232ControllerReport()->getSources()->append(new QString(m_availablePipes.at(i).getName())); } QList serialPorts = QSerialPortInfo::availablePorts(); QListIterator i(serialPorts); response.getGs232ControllerReport()->setSerialPorts(new QList()); while (i.hasNext()) { QSerialPortInfo info = i.next(); response.getGs232ControllerReport()->getSerialPorts()->append(new QString(info.portName())); } float azimuth, elevation; m_settings.calcTargetAzEl(azimuth, elevation); response.getGs232ControllerReport()->setTargetAzimuth(azimuth); response.getGs232ControllerReport()->setTargetElevation(elevation); response.getGs232ControllerReport()->setCurrentAzimuth(m_currentAzimuth); response.getGs232ControllerReport()->setCurrentElevation(m_currentElevation); response.getGs232ControllerReport()->setOnTarget(getOnTarget()); } void GS232Controller::networkManagerFinished(QNetworkReply *reply) { QNetworkReply::NetworkError replyError = reply->error(); if (replyError) { qWarning() << "GS232Controller::networkManagerFinished:" << " error(" << (int) replyError << "): " << replyError << ": " << reply->errorString(); } else { QString answer = reply->readAll(); answer.chop(1); // remove last \n qDebug("GS232Controller::networkManagerFinished: reply:\n%s", answer.toStdString().c_str()); } reply->deleteLater(); }