/*===================================================================== QGroundControl Open Source Ground Control Station (c) 2009, 2010 QGROUNDCONTROL PROJECT This file is part of the QGROUNDCONTROL project QGROUNDCONTROL 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 3 of the License, or (at your option) any later version. QGROUNDCONTROL 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 QGROUNDCONTROL. If not, see . ======================================================================*/ /** * @file * @brief Implementation of class QGCParamWidget * @author Lorenz Meier */ #include #include #include #include #include #include #include "QGCParamWidget.h" #include "UASInterface.h" #include #include "QGC.h" /** * @param uas MAV to set the parameters on * @param parent Parent widget */ QGCParamWidget::QGCParamWidget(UASInterface* uas, QWidget *parent) : QGCUASParamManager(uas, parent), components(new QMap()) { // Load settings loadSettings(); // Create tree widget tree = new QTreeWidget(this); statusLabel = new QLabel(); statusLabel->setAutoFillBackground(true); tree->setColumnWidth(0, 150); // Set tree widget as widget onto this component QGridLayout* horizontalLayout; //form->setAutoFillBackground(false); horizontalLayout = new QGridLayout(this); horizontalLayout->setSpacing(6); horizontalLayout->setMargin(0); horizontalLayout->setSizeConstraint(QLayout::SetMinimumSize); // Parameter tree horizontalLayout->addWidget(tree, 0, 0, 1, 3); // Status line statusLabel->setText(tr("Click refresh to download parameters")); horizontalLayout->addWidget(statusLabel, 1, 0, 1, 3); // BUTTONS QPushButton* refreshButton = new QPushButton(tr("Refresh")); refreshButton->setToolTip(tr("Load parameters currently in non-permanent memory of aircraft.")); refreshButton->setWhatsThis(tr("Load parameters currently in non-permanent memory of aircraft.")); connect(refreshButton, SIGNAL(clicked()), this, SLOT(requestParameterList())); horizontalLayout->addWidget(refreshButton, 2, 0); QPushButton* setButton = new QPushButton(tr("Transmit")); setButton->setToolTip(tr("Set current parameters in non-permanent onboard memory")); setButton->setWhatsThis(tr("Set current parameters in non-permanent onboard memory")); connect(setButton, SIGNAL(clicked()), this, SLOT(setParameters())); horizontalLayout->addWidget(setButton, 2, 1); QPushButton* writeButton = new QPushButton(tr("Write (ROM)")); writeButton->setToolTip(tr("Copy current parameters in non-permanent memory of the aircraft to permanent memory. Transmit your parameters first to write these.")); writeButton->setWhatsThis(tr("Copy current parameters in non-permanent memory of the aircraft to permanent memory. Transmit your parameters first to write these.")); connect(writeButton, SIGNAL(clicked()), this, SLOT(writeParameters())); horizontalLayout->addWidget(writeButton, 2, 2); QPushButton* loadFileButton = new QPushButton(tr("Load File")); loadFileButton->setToolTip(tr("Load parameters from a file on this computer in the view. To write them to the aircraft, use transmit after loading them.")); loadFileButton->setWhatsThis(tr("Load parameters from a file on this computer in the view. To write them to the aircraft, use transmit after loading them.")); connect(loadFileButton, SIGNAL(clicked()), this, SLOT(loadParameters())); horizontalLayout->addWidget(loadFileButton, 3, 0); QPushButton* saveFileButton = new QPushButton(tr("Save File")); saveFileButton->setToolTip(tr("Save parameters in this view to a file on this computer.")); saveFileButton->setWhatsThis(tr("Save parameters in this view to a file on this computer.")); connect(saveFileButton, SIGNAL(clicked()), this, SLOT(saveParameters())); horizontalLayout->addWidget(saveFileButton, 3, 1); QPushButton* readButton = new QPushButton(tr("Read (ROM)")); readButton->setToolTip(tr("Copy parameters from permanent memory to non-permanent current memory of aircraft. DOES NOT update the parameters in this view, click refresh after copying them to get them.")); readButton->setWhatsThis(tr("Copy parameters from permanent memory to non-permanent current memory of aircraft. DOES NOT update the parameters in this view, click refresh after copying them to get them.")); connect(readButton, SIGNAL(clicked()), this, SLOT(readParameters())); horizontalLayout->addWidget(readButton, 3, 2); // Set layout this->setLayout(horizontalLayout); // Set header QStringList headerItems; headerItems.append("Parameter"); headerItems.append("Value"); tree->setHeaderLabels(headerItems); tree->setColumnCount(2); tree->setExpandsOnDoubleClick(true); // Connect signals/slots connect(this, SIGNAL(parameterChanged(int,QString,float)), mav, SLOT(setParameter(int,QString,float))); connect(tree, SIGNAL(itemChanged(QTreeWidgetItem*,int)), this, SLOT(parameterItemChanged(QTreeWidgetItem*,int))); // New parameters from UAS connect(uas, SIGNAL(parameterChanged(int,int,int,int,QString,float)), this, SLOT(addParameter(int,int,int,int,QString,float))); // Connect retransmission guard connect(this, SIGNAL(requestParameter(int,int)), uas, SLOT(requestParameter(int,int))); connect(&retransmissionTimer, SIGNAL(timeout()), this, SLOT(retransmissionGuardTick())); } void QGCParamWidget::loadSettings() { QSettings settings; settings.beginGroup("QGC_MAVLINK_PROTOCOL"); bool ok; int temp = settings.value("PARAMETER_RETRANSMISSION_TIMEOUT", retransmissionTimeout).toInt(&ok); if (ok) retransmissionTimeout = temp; temp = settings.value("PARAMETER_REWRITE_TIMEOUT", rewriteTimeout).toInt(&ok); if (ok) rewriteTimeout = temp; settings.endGroup(); } /** * @return The MAV of this widget. Unless the MAV object has been destroyed, this * pointer is never zero. */ UASInterface* QGCParamWidget::getUAS() { return mav; } /** * * @param uas System which has the component * @param component id of the component * @param componentName human friendly name of the component */ void QGCParamWidget::addComponent(int uas, int component, QString componentName) { Q_UNUSED(uas); if (components->contains(component)) { // Update existing components->value(component)->setData(0, Qt::DisplayRole, componentName); components->value(component)->setData(1, Qt::DisplayRole, QString::number(component)); } else { // Add new QStringList list; list.append(componentName); list.append(QString::number(component)); QTreeWidgetItem* comp = new QTreeWidgetItem(list); components->insert(component, comp); // Create grouping and update maps paramGroups.insert(component, new QMap()); tree->addTopLevelItem(comp); tree->update(); // Create map in parameters if (!parameters.contains(component)) { parameters.insert(component, new QMap()); } // Create map in changed parameters if (!changedValues.contains(component)) { changedValues.insert(component, new QMap()); } } } /** * @param uas System which has the component * @param component id of the component * @param parameterName human friendly name of the parameter */ void QGCParamWidget::addParameter(int uas, int component, int paramCount, int paramId, QString parameterName, float value) { addParameter(uas, component, parameterName, value); // Missing packets list has to be instantiated for all components if (!transmissionMissingPackets.contains(component)) { transmissionMissingPackets.insert(component, new QList()); } // List mode is different from single parameter transfers if (transmissionListMode) { // Only accept the list size once on the first packet from // each component if (!transmissionListSizeKnown.contains(component)) { // Mark list size as known transmissionListSizeKnown.insert(component, true); // Mark all parameters as missing for (int i = 0; i < paramCount; ++i) { if (!transmissionMissingPackets.value(component)->contains(i)) { transmissionMissingPackets.value(component)->append(i); } } // There is only one transmission timeout for all components // since components do not manage their transmission, // the longest timeout is safe for all components. quint64 thisTransmissionTimeout = QGC::groundTimeMilliseconds() + ((paramCount/retransmissionBurstRequestSize+5)*retransmissionTimeout); if (thisTransmissionTimeout > transmissionTimeout) { transmissionTimeout = thisTransmissionTimeout; } } // Start retransmission guard // or reset timer setRetransmissionGuardEnabled(true); } // Mark this parameter as received in read list int index = transmissionMissingPackets.value(component)->indexOf(paramId); // If the MAV sent the parameter without request, it wont be in missing list if (index != -1) transmissionMissingPackets.value(component)->removeAt(index); bool justWritten = false; bool writeMismatch = false; //bool lastWritten = false; // Mark this parameter as received in write ACK list QMap* map = transmissionMissingWriteAckPackets.value(component); if (map && map->contains(parameterName)) { justWritten = true; if (map->value(parameterName) != value) { writeMismatch = true; } map->remove(parameterName); } int missCount = 0; foreach (int key, transmissionMissingPackets.keys()) { missCount += transmissionMissingPackets.value(key)->count(); } int missWriteCount = 0; foreach (int key, transmissionMissingWriteAckPackets.keys()) { missWriteCount += transmissionMissingWriteAckPackets.value(key)->count(); } if (justWritten && !writeMismatch && missWriteCount == 0) { // Just wrote one and count went to 0 - this was the last missing write parameter statusLabel->setText(tr("SUCCESS: WROTE ALL PARAMETERS")); QPalette pal = statusLabel->palette(); pal.setColor(backgroundRole(), QGC::colorGreen); statusLabel->setPalette(pal); } else if (justWritten && !writeMismatch) { statusLabel->setText(tr("SUCCESS: Wrote %2 (#%1/%4): %3").arg(paramId+1).arg(parameterName).arg(value).arg(paramCount)); QPalette pal = statusLabel->palette(); pal.setColor(backgroundRole(), QGC::colorGreen); statusLabel->setPalette(pal); } else if (justWritten && writeMismatch) { // Mismatch, tell user QPalette pal = statusLabel->palette(); pal.setColor(backgroundRole(), QGC::colorRed); statusLabel->setPalette(pal); statusLabel->setText(tr("FAILURE: Wrote %1: sent %2 != onboard %3").arg(parameterName).arg(map->value(parameterName)).arg(value)); } else { if (missCount > 0) { QPalette pal = statusLabel->palette(); pal.setColor(backgroundRole(), QGC::colorOrange); statusLabel->setPalette(pal); } else { QPalette pal = statusLabel->palette(); pal.setColor(backgroundRole(), QGC::colorGreen); statusLabel->setPalette(pal); } statusLabel->setText(tr("Got %2 (#%1/%5): %3 (%4 missing)").arg(paramId+1).arg(parameterName).arg(value).arg(missCount).arg(paramCount)); } // Check if last parameter was received if (missCount == 0 && missWriteCount == 0) { this->transmissionActive = false; this->transmissionListMode = false; transmissionListSizeKnown.clear(); foreach (int key, transmissionMissingPackets.keys()) { transmissionMissingPackets.value(key)->clear(); } } } /** * @param uas System which has the component * @param component id of the component * @param parameterName human friendly name of the parameter */ void QGCParamWidget::addParameter(int uas, int component, QString parameterName, float value) { Q_UNUSED(uas); // Reference to item in tree QTreeWidgetItem* parameterItem = NULL; // Get component if (!components->contains(component)) { QString componentName; switch (component) { case MAV_COMP_ID_CAMERA: componentName = tr("Camera (#%1)").arg(component); break; case MAV_COMP_ID_IMU: componentName = tr("IMU (#%1)").arg(component); break; default: componentName = tr("Component #").arg(component); break; } addComponent(uas, component, componentName); } // Replace value in map // FIXME if (parameters.value(component)->contains(parameterName)) parameters.value(component)->remove(parameterName); parameters.value(component)->insert(parameterName, value); QString splitToken = "_"; // Check if auto-grouping can work if (parameterName.contains(splitToken)) { QString parent = parameterName.section(splitToken, 0, 0, QString::SectionSkipEmpty); QMap* compParamGroups = paramGroups.value(component); if (!compParamGroups->contains(parent)) { // Insert group item QStringList glist; glist.append(parent); QTreeWidgetItem* item = new QTreeWidgetItem(glist); compParamGroups->insert(parent, item); components->value(component)->addChild(item); } // Append child to group bool found = false; QTreeWidgetItem* parentItem = compParamGroups->value(parent); for (int i = 0; i < parentItem->childCount(); i++) { QTreeWidgetItem* child = parentItem->child(i); QString key = child->data(0, Qt::DisplayRole).toString(); if (key == parameterName) { //qDebug() << "UPDATED CHILD"; parameterItem = child; parameterItem->setData(1, Qt::DisplayRole, value); found = true; } } if (!found) { // Insert parameter into map QStringList plist; plist.append(parameterName); plist.append(QString::number(value)); // CREATE PARAMETER ITEM parameterItem = new QTreeWidgetItem(plist); // CONFIGURE PARAMETER ITEM compParamGroups->value(parent)->addChild(parameterItem); parameterItem->setFlags(parameterItem->flags() | Qt::ItemIsEditable); } } else { bool found = false; QTreeWidgetItem* parent = components->value(component); for (int i = 0; i < parent->childCount(); i++) { QTreeWidgetItem* child = parent->child(i); QString key = child->data(0, Qt::DisplayRole).toString(); if (key == parameterName) { //qDebug() << "UPDATED CHILD"; parameterItem = child; parameterItem->setData(1, Qt::DisplayRole, value); found = true; } } if (!found) { // Insert parameter into map QStringList plist; plist.append(parameterName); plist.append(QString::number(value)); // CREATE PARAMETER ITEM parameterItem = new QTreeWidgetItem(plist); // CONFIGURE PARAMETER ITEM components->value(component)->addChild(parameterItem); parameterItem->setFlags(parameterItem->flags() | Qt::ItemIsEditable); } //tree->expandAll(); } // Reset background color parameterItem->setBackground(0, QBrush(QColor(0, 0, 0))); parameterItem->setBackground(1, Qt::NoBrush); //tree->update(); if (changedValues.contains(component)) changedValues.value(component)->remove(parameterName); } /** * Send a request to deliver the list of onboard parameters * to the MAV. */ void QGCParamWidget::requestParameterList() { // FIXME This call does not belong here // Once the comm handling is moved to a new // Param manager class the settings can be directly // loaded from MAVLink protocol loadSettings(); // End of FIXME // Clear view and request param list clear(); parameters.clear(); received.clear(); // Clear transmission state transmissionListMode = true; transmissionListSizeKnown.clear(); foreach (int key, transmissionMissingPackets.keys()) { transmissionMissingPackets.value(key)->clear(); } transmissionActive = true; // Set status text statusLabel->setText(tr("Requested param list.. waiting")); // Request twice as mean of forward error correction mav->requestParameters(); QGC::SLEEP::msleep(10); mav->requestParameters(); } void QGCParamWidget::parameterItemChanged(QTreeWidgetItem* current, int column) { if (current && column > 0) { QTreeWidgetItem* parent = current->parent(); while (parent->parent() != NULL) { parent = parent->parent(); } // Parent is now top-level component int key = components->key(parent); if (!changedValues.contains(key)) { changedValues.insert(key, new QMap()); } QMap* map = changedValues.value(key, NULL); if (map) { bool ok; QString str = current->data(0, Qt::DisplayRole).toString(); float value = current->data(1, Qt::DisplayRole).toDouble(&ok); // Set parameter on changed list to be transmitted to MAV if (ok) { if (ok) { statusLabel->setText(tr("Changed Param %1:%2: %3").arg(key).arg(str).arg(value)); //qDebug() << "PARAM CHANGED: COMP:" << key << "KEY:" << str << "VALUE:" << value; // Changed values list if (map->contains(str)) map->remove(str); map->insert(str, value); // Check if the value was numerically changed if (!parameters.value(key)->contains(str) || parameters.value(key)->value(str, 0.0f) != value) { current->setBackground(0, QBrush(QColor(QGC::colorOrange))); current->setBackground(1, QBrush(QColor(QGC::colorOrange))); } // All parameters list if (parameters.value(key)->contains(str)) parameters.value(key)->remove(str); parameters.value(key)->insert(str, value); } } } } } void QGCParamWidget::saveParameters() { QString fileName = QFileDialog::getSaveFileName(this, tr("Save File"), "./parameters.txt", tr("Parameter File (*.txt)")); QFile file(fileName); if (!file.open(QIODevice::WriteOnly | QIODevice::Text)) { return; } QTextStream in(&file); in << "# Onboard parameters for system " << mav->getUASName() << "\n"; in << "#\n"; in << "# MAV ID COMPONENT ID PARAM NAME VALUE (FLOAT)\n"; // Iterate through all components, through all parameters and emit them QMap*>::iterator i; for (i = parameters.begin(); i != parameters.end(); ++i) { // Iterate through the parameters of the component int compid = i.key(); QMap* comp = i.value(); { QMap::iterator j; for (j = comp->begin(); j != comp->end(); ++j) { QString paramValue("%1"); paramValue = paramValue.arg(j.value(), 25, 'g', 12); in << mav->getUASID() << "\t" << compid << "\t" << j.key() << "\t" << paramValue << "\n"; in.flush(); } } } file.close(); } void QGCParamWidget::loadParameters() { QString fileName = QFileDialog::getOpenFileName(this, tr("Load File"), ".", tr("Parameter file (*.txt)")); QFile file(fileName); if (!file.open(QIODevice::ReadOnly | QIODevice::Text)) return; // Clear list clear(); QTextStream in(&file); while (!in.atEnd()) { QString line = in.readLine(); if (!line.startsWith("#")) { QStringList wpParams = line.split("\t"); if (wpParams.size() == 4) { // Only load parameters for right mav if (mav->getUASID() == wpParams.at(0).toInt()) { bool changed = false; int component = wpParams.at(1).toInt(); QString parameterName = wpParams.at(2); if (!parameters.contains(component) || parameters.value(component)->value(parameterName, 0.0f) != (float)wpParams.at(3).toDouble()) { changed = true; } // Set parameter value addParameter(wpParams.at(0).toInt(), wpParams.at(1).toInt(), wpParams.at(2), wpParams.at(3).toDouble()); if (changed) { // Create changed values data structure if necessary if (!changedValues.contains(wpParams.at(1).toInt())) { changedValues.insert(wpParams.at(1).toInt(), new QMap()); } // Add to changed values if (changedValues.value(wpParams.at(1).toInt())->contains(wpParams.at(2))) { changedValues.value(wpParams.at(1).toInt())->remove(wpParams.at(2)); } changedValues.value(wpParams.at(1).toInt())->insert(wpParams.at(2), (float)wpParams.at(3).toDouble()); //qDebug() << "MARKING COMP" << wpParams.at(1).toInt() << "PARAM" << wpParams.at(2) << "VALUE" << (float)wpParams.at(3).toDouble() << "AS CHANGED"; // Mark in UI } } } } } file.close(); } /** * Enabling the retransmission guard enables the parameter widget to track * dropped parameters and to re-request them. This works for both individual * parameter reads as well for whole list requests. * * @param enabled True if retransmission checking should be enabled, false else */ void QGCParamWidget::setRetransmissionGuardEnabled(bool enabled) { if (enabled) { retransmissionTimer.start(retransmissionTimeout); } else { retransmissionTimer.stop(); } } void QGCParamWidget::retransmissionGuardTick() { if (transmissionActive) { qDebug() << __FILE__ << __LINE__ << "RETRANSMISSION GUARD ACTIVE, CHECKING FOR DROPS.."; // Check for timeout // stop retransmission attempts on timeout if (QGC::groundTimeMilliseconds() > transmissionTimeout) { setRetransmissionGuardEnabled(false); transmissionActive = false; // Empty read retransmission list // Empty write retransmission list int missingReadCount = 0; QList readKeys = transmissionMissingPackets.keys(); foreach (int component, readKeys) { missingReadCount += transmissionMissingPackets.value(component)->count(); transmissionMissingPackets.value(component)->clear(); } // Empty write retransmission list int missingWriteCount = 0; QList writeKeys = transmissionMissingWriteAckPackets.keys(); foreach (int component, writeKeys) { missingWriteCount += transmissionMissingWriteAckPackets.value(component)->count(); transmissionMissingWriteAckPackets.value(component)->clear(); } statusLabel->setText(tr("TIMEOUT! MISSING: %1 read, %2 write.").arg(missingReadCount).arg(missingWriteCount)); } // Re-request at maximum retransmissionBurstRequestSize parameters at once // to prevent link flooding QMap*>::iterator i; for (i = parameters.begin(); i != parameters.end(); ++i) { // Iterate through the parameters of the component int component = i.key(); // Request n parameters from this component (at maximum) QList * paramList = transmissionMissingPackets.value(component, NULL); if (paramList) { int count = 0; foreach (int id, *paramList) { if (count < retransmissionBurstRequestSize) { qDebug() << __FILE__ << __LINE__ << "RETRANSMISSION GUARD REQUESTS RETRANSMISSION OF PARAM #" << id << "FROM COMPONENT #" << component; emit requestParameter(component, id); statusLabel->setText(tr("Requested retransmission of #%1").arg(id+1)); count++; } else { break; } } } } // Re-request at maximum retransmissionBurstRequestSize parameters at once // to prevent write-request link flooding // Empty write retransmission list QList writeKeys = transmissionMissingWriteAckPackets.keys(); foreach (int component, writeKeys) { int count = 0; QMap * missingParams = transmissionMissingWriteAckPackets.value(component); foreach (QString key, missingParams->keys()) { if (count < retransmissionBurstRequestSize) { // Re-request write operation emit parameterChanged(component, key, missingParams->value(key)); statusLabel->setText(tr("Requested rewrite of: %1: %2").arg(key).arg(missingParams->value(key))); count++; } else { break; } } } } else { qDebug() << __FILE__ << __LINE__ << "STOPPING RETRANSMISSION GUARD GRACEFULLY"; setRetransmissionGuardEnabled(false); } } /** * The .. signal is emitted */ void QGCParamWidget::requestParameterUpdate(int component, const QString& parameter) { } /** * @param component the subsystem which has the parameter * @param parameterName name of the parameter, as delivered by the system * @param value value of the parameter */ void QGCParamWidget::setParameter(int component, QString parameterName, float value) { emit parameterChanged(component, parameterName, value); // Wait for parameter to be written back // mark it therefore as missing if (!transmissionMissingWriteAckPackets.contains(component)) { transmissionMissingWriteAckPackets.insert(component, new QMap()); } // Insert it in missing write ACK list transmissionMissingWriteAckPackets.value(component)->insert(parameterName, value); // Set timeouts transmissionActive = true; quint64 newTransmissionTimeout = QGC::groundTimeMilliseconds() + 5*rewriteTimeout; if (newTransmissionTimeout > transmissionTimeout) { transmissionTimeout = newTransmissionTimeout; } // Enable guard / reset timeouts setRetransmissionGuardEnabled(true); } /** * Set all parameter in the parameter tree on the MAV */ void QGCParamWidget::setParameters() { // Iterate through all components, through all parameters and emit them int parametersSent = 0; QMap*>::iterator i; for (i = changedValues.begin(); i != changedValues.end(); ++i) { // Iterate through the parameters of the component int compid = i.key(); QMap* comp = i.value(); { QMap::iterator j; for (j = comp->begin(); j != comp->end(); ++j) { setParameter(compid, j.key(), j.value()); parametersSent++; } } } // Change transmission status if necessary if (parametersSent == 0) { statusLabel->setText(tr("No transmission: No changed values.")); } else { statusLabel->setText(tr("Transmitting %1 parameters.").arg(parametersSent)); // Set timeouts transmissionActive = true; quint64 newTransmissionTimeout = QGC::groundTimeMilliseconds() + (parametersSent/retransmissionBurstRequestSize+5)*rewriteTimeout; if (newTransmissionTimeout > transmissionTimeout) { transmissionTimeout = newTransmissionTimeout; } // Enable guard setRetransmissionGuardEnabled(true); } changedValues.clear(); } /** * Write the current onboard parameters from RAM into * permanent storage, e.g. EEPROM or harddisk */ void QGCParamWidget::writeParameters() { mav->writeParametersToStorage(); } void QGCParamWidget::readParameters() { mav->readParametersFromStorage(); } /** * Clear all data in the parameter widget */ void QGCParamWidget::clear() { tree->clear(); components->clear(); }