diff --git a/ground/src/plugins/uavobjectbrowser/treeitem.h b/ground/src/plugins/uavobjectbrowser/treeitem.h index c4113c08a..2c5898025 100644 --- a/ground/src/plugins/uavobjectbrowser/treeitem.h +++ b/ground/src/plugins/uavobjectbrowser/treeitem.h @@ -53,6 +53,12 @@ public: int childCount() const; int columnCount() const; QVariant data(int column = 1) const; + QString description() { return m_description; } + void setDescription(QString d) { // Split around 40 characters + int idx = d.indexOf(" ",40); + d.insert(idx,QString("
")); + m_description = d; + } // only column 1 (TreeItem::dataColumn) is changed with setData currently // other columns are initialized in constructor virtual void setData(QVariant value, int column = 1); @@ -78,8 +84,9 @@ private slots: private: QList m_children; - // m_data contains: [0] property name, [1] value, and [2] unit + // m_data contains: [0] property name, [1] value, [2] unit QList m_data; + QString m_description; TreeItem *m_parent; bool m_highlight; bool m_changed; @@ -120,7 +127,7 @@ public: TreeItem(data, parent), m_obj(0) { } ObjectTreeItem(const QVariant &data, TreeItem *parent = 0) : TreeItem(data, parent), m_obj(0) { } - void setObject(UAVObject *obj) { m_obj = obj; } + void setObject(UAVObject *obj) { m_obj = obj; setDescription(obj->getDescription()); } inline UAVObject *object() { return m_obj; } private: UAVObject *m_obj; diff --git a/ground/src/plugins/uavobjectbrowser/uavobjecttreemodel.cpp b/ground/src/plugins/uavobjectbrowser/uavobjecttreemodel.cpp index ef8fe6ebd..aac831c57 100644 --- a/ground/src/plugins/uavobjectbrowser/uavobjecttreemodel.cpp +++ b/ground/src/plugins/uavobjectbrowser/uavobjecttreemodel.cpp @@ -281,6 +281,11 @@ QVariant UAVObjectTreeModel::data(const QModelIndex &index, int role) const // if (role == Qt::DecorationRole) // return QIcon(":/core/images/openpilot_logo_128.png"); + if (role == Qt::ToolTipRole) { + TreeItem *item = static_cast(index.internalPointer()); + return item->description(); + } + TreeItem *item = static_cast(index.internalPointer()); if (index.column() == 0 && role == Qt::BackgroundRole) { diff --git a/ground/src/plugins/uavobjects/OPLogConvert.m b/ground/src/plugins/uavobjects/OPLogConvert.m index a1b8cf097..d3eef6d0d 100644 --- a/ground/src/plugins/uavobjects/OPLogConvert.m +++ b/ground/src/plugins/uavobjects/OPLogConvert.m @@ -292,20 +292,21 @@ function [] = OPLogConvert() pipxtrememodemsettingsIdx = 1; PipXtremeModemSettings.timestamp = 0; + PipXtremeModemSettings(1).Mode = 0; + PipXtremeModemSettings(1).Serial_Baudrate = 0; PipXtremeModemSettings(1).Frequency_Calibration = 0; PipXtremeModemSettings(1).Frequency_Min = 0; PipXtremeModemSettings(1).Frequency_Max = 0; PipXtremeModemSettings(1).Frequency = 0; - PipXtremeModemSettings(1).RF_Bandwidth = 0; + PipXtremeModemSettings(1).Max_RF_Bandwidth = 0; PipXtremeModemSettings(1).Max_Tx_Power = 0; PipXtremeModemSettings(1).AES_Encryption = 0; PipXtremeModemSettings(1).AES_EncryptionKey = zeros(1,16); - PipXtremeModemSettings(1).Paired_Serial_Number_CRC = 0; + PipXtremeModemSettings(1).Paired_Serial_Number = 0; pipxtrememodemstatusIdx = 1; PipXtremeModemStatus.timestamp = 0; - PipXtremeModemStatus(1).Serial_Number = zeros(1,24); - PipXtremeModemStatus(1).Serial_Number_CRC = 0; + PipXtremeModemStatus(1).Serial_Number = 0; PipXtremeModemStatus(1).Up_Time = 0; PipXtremeModemStatus(1).Frequency = 0; PipXtremeModemStatus(1).RF_Bandwidth = 0; @@ -487,10 +488,10 @@ function [] = OPLogConvert() case 572614706 ObjectPersistence(objectpersistenceIdx) = ReadObjectPersistenceObject(fid, timestamp); objectpersistenceIdx = objectpersistenceIdx + 1; - case 2660664364 + case 3822692478 PipXtremeModemSettings(pipxtrememodemsettingsIdx) = ReadPipXtremeModemSettingsObject(fid, timestamp); pipxtrememodemsettingsIdx = pipxtrememodemsettingsIdx + 1; - case 3920019084 + case 539085060 PipXtremeModemStatus(pipxtrememodemstatusIdx) = ReadPipXtremeModemStatusObject(fid, timestamp); pipxtrememodemstatusIdx = pipxtrememodemstatusIdx + 1; case 3765671478 @@ -1090,15 +1091,17 @@ function [PipXtremeModemSettings] = ReadPipXtremeModemSettingsObject(fid, timest end PipXtremeModemSettings.timestamp = timestamp; + PipXtremeModemSettings.Mode = double(fread(fid, 1, 'uint8')); + PipXtremeModemSettings.Serial_Baudrate = double(fread(fid, 1, 'uint8')); PipXtremeModemSettings.Frequency_Calibration = double(fread(fid, 1, 'uint8')); PipXtremeModemSettings.Frequency_Min = double(fread(fid, 1, 'uint32')); PipXtremeModemSettings.Frequency_Max = double(fread(fid, 1, 'uint32')); PipXtremeModemSettings.Frequency = double(fread(fid, 1, 'uint32')); - PipXtremeModemSettings.RF_Bandwidth = double(fread(fid, 1, 'uint8')); + PipXtremeModemSettings.Max_RF_Bandwidth = double(fread(fid, 1, 'uint8')); PipXtremeModemSettings.Max_Tx_Power = double(fread(fid, 1, 'uint8')); PipXtremeModemSettings.AES_Encryption = double(fread(fid, 1, 'uint8')); PipXtremeModemSettings.AES_EncryptionKey = double(fread(fid, 16, 'uint8')); - PipXtremeModemSettings.Paired_Serial_Number_CRC = double(fread(fid, 1, 'uint32')); + PipXtremeModemSettings.Paired_Serial_Number = double(fread(fid, 1, 'uint32')); % read CRC fread(fid, 1, 'uint8'); end @@ -1112,8 +1115,7 @@ function [PipXtremeModemStatus] = ReadPipXtremeModemStatusObject(fid, timestamp) end PipXtremeModemStatus.timestamp = timestamp; - PipXtremeModemStatus.Serial_Number = double(fread(fid, 24, 'uint8')); - PipXtremeModemStatus.Serial_Number_CRC = double(fread(fid, 1, 'uint32')); + PipXtremeModemStatus.Serial_Number = double(fread(fid, 1, 'uint32')); PipXtremeModemStatus.Up_Time = double(fread(fid, 1, 'uint32')); PipXtremeModemStatus.Frequency = double(fread(fid, 1, 'uint32')); PipXtremeModemStatus.RF_Bandwidth = double(fread(fid, 1, 'uint32')); diff --git a/ground/src/plugins/uavobjects/actuatorcommand.cpp b/ground/src/plugins/uavobjects/actuatorcommand.cpp index 7e6026b2c..7f0c6bdeb 100644 --- a/ground/src/plugins/uavobjects/actuatorcommand.cpp +++ b/ground/src/plugins/uavobjects/actuatorcommand.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString ActuatorCommand::NAME = QString("ActuatorCommand"); +const QString ActuatorCommand::DESCRIPTION = QString("Contains the pulse duration sent to each of the channels. Set by @ref ActuatorModule"); /** * Constructor @@ -57,6 +58,8 @@ ActuatorCommand::ActuatorCommand(): UAVDataObject(OBJID, ISSINGLEINST, ISSETTING initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/actuatorcommand.h b/ground/src/plugins/uavobjects/actuatorcommand.h index 49e151748..b28e5dbb1 100644 --- a/ground/src/plugins/uavobjects/actuatorcommand.h +++ b/ground/src/plugins/uavobjects/actuatorcommand.h @@ -56,6 +56,7 @@ public: // Constants static const quint32 OBJID = 3909877022U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 0; static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/actuatordesired.cpp b/ground/src/plugins/uavobjects/actuatordesired.cpp index b49485e8b..76a685857 100644 --- a/ground/src/plugins/uavobjects/actuatordesired.cpp +++ b/ground/src/plugins/uavobjects/actuatordesired.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString ActuatorDesired::NAME = QString("ActuatorDesired"); +const QString ActuatorDesired::DESCRIPTION = QString("Desired raw, pitch and yaw actuator settings. Comes from either @ref StabilizationModule or @ref ManualControlModule depending on FlightMode."); /** * Constructor @@ -65,6 +66,8 @@ ActuatorDesired::ActuatorDesired(): UAVDataObject(OBJID, ISSINGLEINST, ISSETTING initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/actuatordesired.h b/ground/src/plugins/uavobjects/actuatordesired.h index 5ce639c94..3f8d8b693 100644 --- a/ground/src/plugins/uavobjects/actuatordesired.h +++ b/ground/src/plugins/uavobjects/actuatordesired.h @@ -64,6 +64,7 @@ public: // Constants static const quint32 OBJID = 3562104706U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 0; static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/actuatorsettings.cpp b/ground/src/plugins/uavobjects/actuatorsettings.cpp index e18579d0f..c2062cc15 100644 --- a/ground/src/plugins/uavobjects/actuatorsettings.cpp +++ b/ground/src/plugins/uavobjects/actuatorsettings.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString ActuatorSettings::NAME = QString("ActuatorSettings"); +const QString ActuatorSettings::DESCRIPTION = QString("Settings for the @ref ActuatorModule that controls the channel assignments for the mixer based on AircraftType"); /** * Constructor @@ -263,6 +264,8 @@ ActuatorSettings::ActuatorSettings(): UAVDataObject(OBJID, ISSINGLEINST, ISSETTI initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/actuatorsettings.h b/ground/src/plugins/uavobjects/actuatorsettings.h index 2e3dd56d3..caeb32cda 100644 --- a/ground/src/plugins/uavobjects/actuatorsettings.h +++ b/ground/src/plugins/uavobjects/actuatorsettings.h @@ -124,6 +124,7 @@ public: // Constants static const quint32 OBJID = 3054509114U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 1; static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/ahrscalibration.cpp b/ground/src/plugins/uavobjects/ahrscalibration.cpp index 6e1f2d624..6186c2abe 100644 --- a/ground/src/plugins/uavobjects/ahrscalibration.cpp +++ b/ground/src/plugins/uavobjects/ahrscalibration.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString AHRSCalibration::NAME = QString("AHRSCalibration"); +const QString AHRSCalibration::DESCRIPTION = QString("Contains the calibration settings for the @ref AHRSCommsModule"); /** * Constructor @@ -104,6 +105,8 @@ AHRSCalibration::AHRSCalibration(): UAVDataObject(OBJID, ISSINGLEINST, ISSETTING initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/ahrscalibration.h b/ground/src/plugins/uavobjects/ahrscalibration.h index 105bf090b..7c1ae93f8 100644 --- a/ground/src/plugins/uavobjects/ahrscalibration.h +++ b/ground/src/plugins/uavobjects/ahrscalibration.h @@ -114,6 +114,7 @@ public: // Constants static const quint32 OBJID = 3761202980U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 1; static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/ahrssettings.cpp b/ground/src/plugins/uavobjects/ahrssettings.cpp index c0d8aa311..810a08f6c 100644 --- a/ground/src/plugins/uavobjects/ahrssettings.cpp +++ b/ground/src/plugins/uavobjects/ahrssettings.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString AHRSSettings::NAME = QString("AHRSSettings"); +const QString AHRSSettings::DESCRIPTION = QString("Settings for the @ref AHRSCommsModule to control the algorithm and what is updated"); /** * Constructor @@ -76,6 +77,8 @@ AHRSSettings::AHRSSettings(): UAVDataObject(OBJID, ISSINGLEINST, ISSETTINGS, NAM initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/ahrssettings.h b/ground/src/plugins/uavobjects/ahrssettings.h index a910cdde4..3e61cdea5 100644 --- a/ground/src/plugins/uavobjects/ahrssettings.h +++ b/ground/src/plugins/uavobjects/ahrssettings.h @@ -70,6 +70,7 @@ public: // Constants static const quint32 OBJID = 3741078856U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 1; static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/ahrsstatus.cpp b/ground/src/plugins/uavobjects/ahrsstatus.cpp index febc2b8b5..e98c1fa94 100644 --- a/ground/src/plugins/uavobjects/ahrsstatus.cpp +++ b/ground/src/plugins/uavobjects/ahrsstatus.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString AhrsStatus::NAME = QString("AhrsStatus"); +const QString AhrsStatus::DESCRIPTION = QString("Status for the @ref AHRSCommsModule, including communication errors"); /** * Constructor @@ -99,6 +100,8 @@ AhrsStatus::AhrsStatus(): UAVDataObject(OBJID, ISSINGLEINST, ISSETTINGS, NAME) initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/ahrsstatus.h b/ground/src/plugins/uavobjects/ahrsstatus.h index c90d115e7..08161b08c 100644 --- a/ground/src/plugins/uavobjects/ahrsstatus.h +++ b/ground/src/plugins/uavobjects/ahrsstatus.h @@ -84,6 +84,7 @@ public: // Constants static const quint32 OBJID = 933623714U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 0; static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/attitudeactual.cpp b/ground/src/plugins/uavobjects/attitudeactual.cpp index b64624219..ec8906be0 100644 --- a/ground/src/plugins/uavobjects/attitudeactual.cpp +++ b/ground/src/plugins/uavobjects/attitudeactual.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString AttitudeActual::NAME = QString("AttitudeActual"); +const QString AttitudeActual::DESCRIPTION = QString("The updated Attitude estimation from @ref AHRSCommsModule."); /** * Constructor @@ -68,6 +69,8 @@ AttitudeActual::AttitudeActual(): UAVDataObject(OBJID, ISSINGLEINST, ISSETTINGS, initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/attitudeactual.h b/ground/src/plugins/uavobjects/attitudeactual.h index 322a66cd1..cf19be8dd 100644 --- a/ground/src/plugins/uavobjects/attitudeactual.h +++ b/ground/src/plugins/uavobjects/attitudeactual.h @@ -66,6 +66,7 @@ public: // Constants static const quint32 OBJID = 4233858292U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 0; static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/attitudedesired.cpp b/ground/src/plugins/uavobjects/attitudedesired.cpp index 031c5a064..76e9b9745 100644 --- a/ground/src/plugins/uavobjects/attitudedesired.cpp +++ b/ground/src/plugins/uavobjects/attitudedesired.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString AttitudeDesired::NAME = QString("AttitudeDesired"); +const QString AttitudeDesired::DESCRIPTION = QString("The desired attitude that @ref StabilizationModule will try and achieve if FlightMode is Stabilized. Comes from @ref ManaulControlModule."); /** * Constructor @@ -59,6 +60,8 @@ AttitudeDesired::AttitudeDesired(): UAVDataObject(OBJID, ISSINGLEINST, ISSETTING initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/attitudedesired.h b/ground/src/plugins/uavobjects/attitudedesired.h index 85eb56111..0cf707fbd 100644 --- a/ground/src/plugins/uavobjects/attitudedesired.h +++ b/ground/src/plugins/uavobjects/attitudedesired.h @@ -60,6 +60,7 @@ public: // Constants static const quint32 OBJID = 1412270808U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 0; static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/attituderaw.cpp b/ground/src/plugins/uavobjects/attituderaw.cpp index 266fbca59..37c5cb784 100644 --- a/ground/src/plugins/uavobjects/attituderaw.cpp +++ b/ground/src/plugins/uavobjects/attituderaw.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString AttitudeRaw::NAME = QString("AttitudeRaw"); +const QString AttitudeRaw::DESCRIPTION = QString("The raw attitude sensor data from @ref AHRSCommsModule. Not always updated."); /** * Constructor @@ -76,6 +77,8 @@ AttitudeRaw::AttitudeRaw(): UAVDataObject(OBJID, ISSINGLEINST, ISSETTINGS, NAME) initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/attituderaw.h b/ground/src/plugins/uavobjects/attituderaw.h index 12faecc6b..9e72c3137 100644 --- a/ground/src/plugins/uavobjects/attituderaw.h +++ b/ground/src/plugins/uavobjects/attituderaw.h @@ -88,6 +88,7 @@ public: // Constants static const quint32 OBJID = 1323193976U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 0; static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/baroaltitude.cpp b/ground/src/plugins/uavobjects/baroaltitude.cpp index 77f19278b..7da610ddf 100644 --- a/ground/src/plugins/uavobjects/baroaltitude.cpp +++ b/ground/src/plugins/uavobjects/baroaltitude.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString BaroAltitude::NAME = QString("BaroAltitude"); +const QString BaroAltitude::DESCRIPTION = QString("The raw data from the barometric sensor with pressure, temperature and altitude estimate."); /** * Constructor @@ -56,6 +57,8 @@ BaroAltitude::BaroAltitude(): UAVDataObject(OBJID, ISSINGLEINST, ISSETTINGS, NAM initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/baroaltitude.h b/ground/src/plugins/uavobjects/baroaltitude.h index e6baea55e..8a86b98c2 100644 --- a/ground/src/plugins/uavobjects/baroaltitude.h +++ b/ground/src/plugins/uavobjects/baroaltitude.h @@ -58,6 +58,7 @@ public: // Constants static const quint32 OBJID = 3980666102U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 0; static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/firmwareiapobj.cpp b/ground/src/plugins/uavobjects/firmwareiapobj.cpp index 0d0074645..367550fc0 100644 --- a/ground/src/plugins/uavobjects/firmwareiapobj.cpp +++ b/ground/src/plugins/uavobjects/firmwareiapobj.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString FirmwareIAPObj::NAME = QString("FirmwareIAPObj"); +const QString FirmwareIAPObj::DESCRIPTION = QString("Firmware IAP"); /** * Constructor @@ -164,6 +165,8 @@ FirmwareIAPObj::FirmwareIAPObj(): UAVDataObject(OBJID, ISSINGLEINST, ISSETTINGS, initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/firmwareiapobj.h b/ground/src/plugins/uavobjects/firmwareiapobj.h index 2b919a4eb..507578fc7 100644 --- a/ground/src/plugins/uavobjects/firmwareiapobj.h +++ b/ground/src/plugins/uavobjects/firmwareiapobj.h @@ -66,6 +66,7 @@ public: // Constants static const quint32 OBJID = 879185696U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 0; static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/flightbatterystate.cpp b/ground/src/plugins/uavobjects/flightbatterystate.cpp index 1957f6434..d4fbc0d7e 100644 --- a/ground/src/plugins/uavobjects/flightbatterystate.cpp +++ b/ground/src/plugins/uavobjects/flightbatterystate.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString FlightBatteryState::NAME = QString("FlightBatteryState"); +const QString FlightBatteryState::DESCRIPTION = QString("Battery status information. Not currently updated."); /** * Constructor @@ -56,6 +57,8 @@ FlightBatteryState::FlightBatteryState(): UAVDataObject(OBJID, ISSINGLEINST, ISS initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/flightbatterystate.h b/ground/src/plugins/uavobjects/flightbatterystate.h index ad776a21a..04ad47669 100644 --- a/ground/src/plugins/uavobjects/flightbatterystate.h +++ b/ground/src/plugins/uavobjects/flightbatterystate.h @@ -58,6 +58,7 @@ public: // Constants static const quint32 OBJID = 144318184U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 0; static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/flighttelemetrystats.cpp b/ground/src/plugins/uavobjects/flighttelemetrystats.cpp index 5ab4e4250..2d0ae79bf 100644 --- a/ground/src/plugins/uavobjects/flighttelemetrystats.cpp +++ b/ground/src/plugins/uavobjects/flighttelemetrystats.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString FlightTelemetryStats::NAME = QString("FlightTelemetryStats"); +const QString FlightTelemetryStats::DESCRIPTION = QString("Maintains the telemetry statistics from the OpenPilot flight computer."); /** * Constructor @@ -70,6 +71,8 @@ FlightTelemetryStats::FlightTelemetryStats(): UAVDataObject(OBJID, ISSINGLEINST, initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/flighttelemetrystats.h b/ground/src/plugins/uavobjects/flighttelemetrystats.h index 5acef4df8..c32260bb5 100644 --- a/ground/src/plugins/uavobjects/flighttelemetrystats.h +++ b/ground/src/plugins/uavobjects/flighttelemetrystats.h @@ -66,6 +66,7 @@ public: // Constants static const quint32 OBJID = 1712072286U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 0; static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/gcstelemetrystats.cpp b/ground/src/plugins/uavobjects/gcstelemetrystats.cpp index 04ca7a1c1..70a1ddb66 100644 --- a/ground/src/plugins/uavobjects/gcstelemetrystats.cpp +++ b/ground/src/plugins/uavobjects/gcstelemetrystats.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString GCSTelemetryStats::NAME = QString("GCSTelemetryStats"); +const QString GCSTelemetryStats::DESCRIPTION = QString("The telemetry statistics from the ground computer"); /** * Constructor @@ -70,6 +71,8 @@ GCSTelemetryStats::GCSTelemetryStats(): UAVDataObject(OBJID, ISSINGLEINST, ISSET initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/gcstelemetrystats.h b/ground/src/plugins/uavobjects/gcstelemetrystats.h index 6993ef8ac..4c8eef6d2 100644 --- a/ground/src/plugins/uavobjects/gcstelemetrystats.h +++ b/ground/src/plugins/uavobjects/gcstelemetrystats.h @@ -66,6 +66,7 @@ public: // Constants static const quint32 OBJID = 1998458950U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 0; static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/gpsposition.cpp b/ground/src/plugins/uavobjects/gpsposition.cpp index 06829e589..7f378d25e 100644 --- a/ground/src/plugins/uavobjects/gpsposition.cpp +++ b/ground/src/plugins/uavobjects/gpsposition.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString GPSPosition::NAME = QString("GPSPosition"); +const QString GPSPosition::DESCRIPTION = QString("Future object for the raw GPS data from @ref GPSModule. Only should be used by @ref AHRSCommsModule."); /** * Constructor @@ -85,6 +86,8 @@ GPSPosition::GPSPosition(): UAVDataObject(OBJID, ISSINGLEINST, ISSETTINGS, NAME) initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/gpsposition.h b/ground/src/plugins/uavobjects/gpsposition.h index 66e70ad9f..ea48c8d18 100644 --- a/ground/src/plugins/uavobjects/gpsposition.h +++ b/ground/src/plugins/uavobjects/gpsposition.h @@ -76,6 +76,7 @@ public: // Constants static const quint32 OBJID = 3041480770U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 0; static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/gpssatellites.cpp b/ground/src/plugins/uavobjects/gpssatellites.cpp index be7bdc1b2..5a85131cb 100644 --- a/ground/src/plugins/uavobjects/gpssatellites.cpp +++ b/ground/src/plugins/uavobjects/gpssatellites.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString GPSSatellites::NAME = QString("GPSSatellites"); +const QString GPSSatellites::DESCRIPTION = QString("Contains information about the GPS satellites in view from @ref GPSModule."); /** * Constructor @@ -122,6 +123,8 @@ GPSSatellites::GPSSatellites(): UAVDataObject(OBJID, ISSINGLEINST, ISSETTINGS, N initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/gpssatellites.h b/ground/src/plugins/uavobjects/gpssatellites.h index 91319dcd9..41521756f 100644 --- a/ground/src/plugins/uavobjects/gpssatellites.h +++ b/ground/src/plugins/uavobjects/gpssatellites.h @@ -70,6 +70,7 @@ public: // Constants static const quint32 OBJID = 3593446318U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 0; static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/gpstime.cpp b/ground/src/plugins/uavobjects/gpstime.cpp index 3fba6f51c..75e26e66e 100644 --- a/ground/src/plugins/uavobjects/gpstime.cpp +++ b/ground/src/plugins/uavobjects/gpstime.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString GPSTime::NAME = QString("GPSTime"); +const QString GPSTime::DESCRIPTION = QString("Contains the GPS time from @ref GPSModule. Required to compute the world magnetic model correctly when setting the home location."); /** * Constructor @@ -65,6 +66,8 @@ GPSTime::GPSTime(): UAVDataObject(OBJID, ISSINGLEINST, ISSETTINGS, NAME) initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/gpstime.h b/ground/src/plugins/uavobjects/gpstime.h index 472bffba7..dad0a0deb 100644 --- a/ground/src/plugins/uavobjects/gpstime.h +++ b/ground/src/plugins/uavobjects/gpstime.h @@ -64,6 +64,7 @@ public: // Constants static const quint32 OBJID = 1459613858U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 0; static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/guidancesettings.cpp b/ground/src/plugins/uavobjects/guidancesettings.cpp index ff1b1e7ba..e62704669 100644 --- a/ground/src/plugins/uavobjects/guidancesettings.cpp +++ b/ground/src/plugins/uavobjects/guidancesettings.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString GuidanceSettings::NAME = QString("GuidanceSettings"); +const QString GuidanceSettings::DESCRIPTION = QString("Settings for the @ref GuidanceModule"); /** * Constructor @@ -96,6 +97,8 @@ GuidanceSettings::GuidanceSettings(): UAVDataObject(OBJID, ISSINGLEINST, ISSETTI initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/guidancesettings.h b/ground/src/plugins/uavobjects/guidancesettings.h index c7b1762e1..bea9c9bfa 100644 --- a/ground/src/plugins/uavobjects/guidancesettings.h +++ b/ground/src/plugins/uavobjects/guidancesettings.h @@ -84,6 +84,7 @@ public: // Constants static const quint32 OBJID = 2071403670U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 1; static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/homelocation.cpp b/ground/src/plugins/uavobjects/homelocation.cpp index 46c6a7b72..a32e80b8b 100644 --- a/ground/src/plugins/uavobjects/homelocation.cpp +++ b/ground/src/plugins/uavobjects/homelocation.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString HomeLocation::NAME = QString("HomeLocation"); +const QString HomeLocation::DESCRIPTION = QString("HomeLocation setting which contains the constants to tranlate from longitutde and latitude to NED reference frame. Automatically set by @ref GPSModule after acquiring a 3D lock. Used by @ref AHRSCommsModule."); /** * Constructor @@ -83,6 +84,8 @@ HomeLocation::HomeLocation(): UAVDataObject(OBJID, ISSINGLEINST, ISSETTINGS, NAM initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/homelocation.h b/ground/src/plugins/uavobjects/homelocation.h index 1bcd8dcfc..7acec865f 100644 --- a/ground/src/plugins/uavobjects/homelocation.h +++ b/ground/src/plugins/uavobjects/homelocation.h @@ -74,6 +74,7 @@ public: // Constants static const quint32 OBJID = 3590360786U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 1; static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/i2cstats.cpp b/ground/src/plugins/uavobjects/i2cstats.cpp index b5281c033..837bee602 100644 --- a/ground/src/plugins/uavobjects/i2cstats.cpp +++ b/ground/src/plugins/uavobjects/i2cstats.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString I2CStats::NAME = QString("I2CStats"); +const QString I2CStats::DESCRIPTION = QString("Tracks statistics on the I2C bus."); /** * Constructor @@ -77,6 +78,8 @@ I2CStats::I2CStats(): UAVDataObject(OBJID, ISSINGLEINST, ISSETTINGS, NAME) initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/i2cstats.h b/ground/src/plugins/uavobjects/i2cstats.h index e9334482c..f5ebcca49 100644 --- a/ground/src/plugins/uavobjects/i2cstats.h +++ b/ground/src/plugins/uavobjects/i2cstats.h @@ -70,6 +70,7 @@ public: // Constants static const quint32 OBJID = 1063893720U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 0; static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/manualcontrolcommand.cpp b/ground/src/plugins/uavobjects/manualcontrolcommand.cpp index 1163c2321..3558b9d32 100644 --- a/ground/src/plugins/uavobjects/manualcontrolcommand.cpp +++ b/ground/src/plugins/uavobjects/manualcontrolcommand.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString ManualControlCommand::NAME = QString("ManualControlCommand"); +const QString ManualControlCommand::DESCRIPTION = QString("The output from the @ref ManualControlModule which descodes the receiver inputs. Overriden by GCS for fly-by-wire control."); /** * Constructor @@ -106,6 +107,8 @@ ManualControlCommand::ManualControlCommand(): UAVDataObject(OBJID, ISSINGLEINST, initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/manualcontrolcommand.h b/ground/src/plugins/uavobjects/manualcontrolcommand.h index 242f8dc7a..14b5a2c02 100644 --- a/ground/src/plugins/uavobjects/manualcontrolcommand.h +++ b/ground/src/plugins/uavobjects/manualcontrolcommand.h @@ -90,6 +90,7 @@ public: // Constants static const quint32 OBJID = 2841592332U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 0; static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/manualcontrolsettings.cpp b/ground/src/plugins/uavobjects/manualcontrolsettings.cpp index 3b1613177..48c38e6e6 100644 --- a/ground/src/plugins/uavobjects/manualcontrolsettings.cpp +++ b/ground/src/plugins/uavobjects/manualcontrolsettings.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString ManualControlSettings::NAME = QString("ManualControlSettings"); +const QString ManualControlSettings::DESCRIPTION = QString("Settings to indicate how to decode receiver input by @ref ManualControlModule."); /** * Constructor @@ -239,6 +240,8 @@ ManualControlSettings::ManualControlSettings(): UAVDataObject(OBJID, ISSINGLEINS initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/manualcontrolsettings.h b/ground/src/plugins/uavobjects/manualcontrolsettings.h index 99f6788af..df9a1655f 100644 --- a/ground/src/plugins/uavobjects/manualcontrolsettings.h +++ b/ground/src/plugins/uavobjects/manualcontrolsettings.h @@ -138,6 +138,7 @@ public: // Constants static const quint32 OBJID = 157988682U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 1; static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/mixersettings.cpp b/ground/src/plugins/uavobjects/mixersettings.cpp index dba5e1893..45ad3447a 100644 --- a/ground/src/plugins/uavobjects/mixersettings.cpp +++ b/ground/src/plugins/uavobjects/mixersettings.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString MixerSettings::NAME = QString("MixerSettings"); +const QString MixerSettings::DESCRIPTION = QString("Settings for the @ref ActuatorModule that controls the channel assignments for the mixer based on AircraftType"); /** * Constructor @@ -185,6 +186,8 @@ MixerSettings::MixerSettings(): UAVDataObject(OBJID, ISSINGLEINST, ISSETTINGS, N initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/mixersettings.h b/ground/src/plugins/uavobjects/mixersettings.h index 005e7a481..a2ba2d7c1 100644 --- a/ground/src/plugins/uavobjects/mixersettings.h +++ b/ground/src/plugins/uavobjects/mixersettings.h @@ -152,6 +152,7 @@ public: // Constants static const quint32 OBJID = 1336817486U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 1; static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/mixerstatus.cpp b/ground/src/plugins/uavobjects/mixerstatus.cpp index 17aef4fed..76d4dcb3f 100644 --- a/ground/src/plugins/uavobjects/mixerstatus.cpp +++ b/ground/src/plugins/uavobjects/mixerstatus.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString MixerStatus::NAME = QString("MixerStatus"); +const QString MixerStatus::DESCRIPTION = QString("Status for the matrix mixer showing the output of each mixer after all scaling"); /** * Constructor @@ -71,6 +72,8 @@ MixerStatus::MixerStatus(): UAVDataObject(OBJID, ISSINGLEINST, ISSETTINGS, NAME) initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/mixerstatus.h b/ground/src/plugins/uavobjects/mixerstatus.h index 316210313..9497f71f4 100644 --- a/ground/src/plugins/uavobjects/mixerstatus.h +++ b/ground/src/plugins/uavobjects/mixerstatus.h @@ -68,6 +68,7 @@ public: // Constants static const quint32 OBJID = 4137893648U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 0; static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/objectpersistence.cpp b/ground/src/plugins/uavobjects/objectpersistence.cpp index e2f9b92af..8d43922c5 100644 --- a/ground/src/plugins/uavobjects/objectpersistence.cpp +++ b/ground/src/plugins/uavobjects/objectpersistence.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString ObjectPersistence::NAME = QString("ObjectPersistence"); +const QString ObjectPersistence::DESCRIPTION = QString("Someone who knows please enter this"); /** * Constructor @@ -68,6 +69,8 @@ ObjectPersistence::ObjectPersistence(): UAVDataObject(OBJID, ISSINGLEINST, ISSET initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/objectpersistence.h b/ground/src/plugins/uavobjects/objectpersistence.h index 1a8edb4da..435225c74 100644 --- a/ground/src/plugins/uavobjects/objectpersistence.h +++ b/ground/src/plugins/uavobjects/objectpersistence.h @@ -64,6 +64,7 @@ public: // Constants static const quint32 OBJID = 572614706U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 0; static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/pipxtrememodemsettings.cpp b/ground/src/plugins/uavobjects/pipxtrememodemsettings.cpp index ae5d4bb9f..b35f35352 100644 --- a/ground/src/plugins/uavobjects/pipxtrememodemsettings.cpp +++ b/ground/src/plugins/uavobjects/pipxtrememodemsettings.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString PipXtremeModemSettings::NAME = QString("PipXtremeModemSettings"); +const QString PipXtremeModemSettings::DESCRIPTION = QString("Settings for the @ref PipXtremeModemSettings"); /** * Constructor @@ -135,6 +136,8 @@ PipXtremeModemSettings::PipXtremeModemSettings(): UAVDataObject(OBJID, ISSINGLEI initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/pipxtrememodemsettings.h b/ground/src/plugins/uavobjects/pipxtrememodemsettings.h index ff625ea42..7b3fc77e8 100644 --- a/ground/src/plugins/uavobjects/pipxtrememodemsettings.h +++ b/ground/src/plugins/uavobjects/pipxtrememodemsettings.h @@ -86,6 +86,7 @@ public: // Constants static const quint32 OBJID = 3822692478U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 1; static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/pipxtrememodemstatus.cpp b/ground/src/plugins/uavobjects/pipxtrememodemstatus.cpp index 812dc736d..bea415429 100644 --- a/ground/src/plugins/uavobjects/pipxtrememodemstatus.cpp +++ b/ground/src/plugins/uavobjects/pipxtrememodemstatus.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString PipXtremeModemStatus::NAME = QString("PipXtremeModemStatus"); +const QString PipXtremeModemStatus::DESCRIPTION = QString("Status for the @ref PipXtremeModem"); /** * Constructor @@ -79,6 +80,8 @@ PipXtremeModemStatus::PipXtremeModemStatus(): UAVDataObject(OBJID, ISSINGLEINST, initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/pipxtrememodemstatus.h b/ground/src/plugins/uavobjects/pipxtrememodemstatus.h index 287aa266d..0d0df59dd 100644 --- a/ground/src/plugins/uavobjects/pipxtrememodemstatus.h +++ b/ground/src/plugins/uavobjects/pipxtrememodemstatus.h @@ -72,6 +72,7 @@ public: // Constants static const quint32 OBJID = 539085060U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 0; static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/positionactual.cpp b/ground/src/plugins/uavobjects/positionactual.cpp index 5beca6b97..f59362525 100644 --- a/ground/src/plugins/uavobjects/positionactual.cpp +++ b/ground/src/plugins/uavobjects/positionactual.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString PositionActual::NAME = QString("PositionActual"); +const QString PositionActual::DESCRIPTION = QString("Contains the current position relative to @ref HomeLocation"); /** * Constructor @@ -56,6 +57,8 @@ PositionActual::PositionActual(): UAVDataObject(OBJID, ISSINGLEINST, ISSETTINGS, initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/positionactual.h b/ground/src/plugins/uavobjects/positionactual.h index 9aa10660a..42128b685 100644 --- a/ground/src/plugins/uavobjects/positionactual.h +++ b/ground/src/plugins/uavobjects/positionactual.h @@ -58,6 +58,7 @@ public: // Constants static const quint32 OBJID = 3765671478U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 0; static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/positiondesired.cpp b/ground/src/plugins/uavobjects/positiondesired.cpp index c55448ef3..79122e7ab 100644 --- a/ground/src/plugins/uavobjects/positiondesired.cpp +++ b/ground/src/plugins/uavobjects/positiondesired.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString PositionDesired::NAME = QString("PositionDesired"); +const QString PositionDesired::DESCRIPTION = QString("The position the craft is trying t achieve. Can come from GCS or @ref PathPlanner "); /** * Constructor @@ -56,6 +57,8 @@ PositionDesired::PositionDesired(): UAVDataObject(OBJID, ISSINGLEINST, ISSETTING initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/positiondesired.h b/ground/src/plugins/uavobjects/positiondesired.h index e41d29d39..785fa8e0e 100644 --- a/ground/src/plugins/uavobjects/positiondesired.h +++ b/ground/src/plugins/uavobjects/positiondesired.h @@ -58,6 +58,7 @@ public: // Constants static const quint32 OBJID = 801433018U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 0; static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/ratedesired.cpp b/ground/src/plugins/uavobjects/ratedesired.cpp index b11ef0353..e5b48197b 100644 --- a/ground/src/plugins/uavobjects/ratedesired.cpp +++ b/ground/src/plugins/uavobjects/ratedesired.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString RateDesired::NAME = QString("RateDesired"); +const QString RateDesired::DESCRIPTION = QString("Status for the matrix mixer showing the output of each mixer after all scaling"); /** * Constructor @@ -56,6 +57,8 @@ RateDesired::RateDesired(): UAVDataObject(OBJID, ISSINGLEINST, ISSETTINGS, NAME) initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/ratedesired.h b/ground/src/plugins/uavobjects/ratedesired.h index b9391e06c..a46494d5b 100644 --- a/ground/src/plugins/uavobjects/ratedesired.h +++ b/ground/src/plugins/uavobjects/ratedesired.h @@ -58,6 +58,7 @@ public: // Constants static const quint32 OBJID = 3124868380U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 0; static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/stabilizationsettings.cpp b/ground/src/plugins/uavobjects/stabilizationsettings.cpp index 3d521aeac..44ba597c8 100644 --- a/ground/src/plugins/uavobjects/stabilizationsettings.cpp +++ b/ground/src/plugins/uavobjects/stabilizationsettings.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString StabilizationSettings::NAME = QString("StabilizationSettings"); +const QString StabilizationSettings::DESCRIPTION = QString("PID settings used by the Stabilization module to combine the @ref AttitudeActual and @ref AttitudeDesired to compute @ref ActuatorDesired"); /** * Constructor @@ -96,6 +97,8 @@ StabilizationSettings::StabilizationSettings(): UAVDataObject(OBJID, ISSINGLEINS initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/stabilizationsettings.h b/ground/src/plugins/uavobjects/stabilizationsettings.h index 6f81e82f0..72f92e476 100644 --- a/ground/src/plugins/uavobjects/stabilizationsettings.h +++ b/ground/src/plugins/uavobjects/stabilizationsettings.h @@ -106,6 +106,7 @@ public: // Constants static const quint32 OBJID = 3792991236U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 1; static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/systemalarms.cpp b/ground/src/plugins/uavobjects/systemalarms.cpp index d3c514df2..09a12940a 100644 --- a/ground/src/plugins/uavobjects/systemalarms.cpp +++ b/ground/src/plugins/uavobjects/systemalarms.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString SystemAlarms::NAME = QString("SystemAlarms"); +const QString SystemAlarms::DESCRIPTION = QString("Alarms from OpenPilot to indicate failure conditions or warnings. Set by various modules."); /** * Constructor @@ -64,6 +65,8 @@ SystemAlarms::SystemAlarms(): UAVDataObject(OBJID, ISSINGLEINST, ISSETTINGS, NAM initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/systemalarms.h b/ground/src/plugins/uavobjects/systemalarms.h index f2d38974e..0ad5f2ad6 100644 --- a/ground/src/plugins/uavobjects/systemalarms.h +++ b/ground/src/plugins/uavobjects/systemalarms.h @@ -60,6 +60,7 @@ public: // Constants static const quint32 OBJID = 2311311584U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 0; static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/systemsettings.cpp b/ground/src/plugins/uavobjects/systemsettings.cpp index 6e01c3ed7..34d652bb0 100644 --- a/ground/src/plugins/uavobjects/systemsettings.cpp +++ b/ground/src/plugins/uavobjects/systemsettings.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString SystemSettings::NAME = QString("SystemSettings"); +const QString SystemSettings::DESCRIPTION = QString("Select airframe type. Currently used by @ref ActuatorModule to choose mixing from @ref ActuatorDesired to @ref ActuatorCommand"); /** * Constructor @@ -67,6 +68,8 @@ SystemSettings::SystemSettings(): UAVDataObject(OBJID, ISSINGLEINST, ISSETTINGS, initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/systemsettings.h b/ground/src/plugins/uavobjects/systemsettings.h index 0ae44dfcd..f588773a7 100644 --- a/ground/src/plugins/uavobjects/systemsettings.h +++ b/ground/src/plugins/uavobjects/systemsettings.h @@ -56,6 +56,7 @@ public: // Constants static const quint32 OBJID = 59202798U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 1; static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/systemstats.cpp b/ground/src/plugins/uavobjects/systemstats.cpp index 5ec46fe0a..207d02a59 100644 --- a/ground/src/plugins/uavobjects/systemstats.cpp +++ b/ground/src/plugins/uavobjects/systemstats.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString SystemStats::NAME = QString("SystemStats"); +const QString SystemStats::DESCRIPTION = QString("CPU and memory usage from OpenPilot computer. "); /** * Constructor @@ -56,6 +57,8 @@ SystemStats::SystemStats(): UAVDataObject(OBJID, ISSINGLEINST, ISSETTINGS, NAME) initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/systemstats.h b/ground/src/plugins/uavobjects/systemstats.h index b4b528664..ad8edfe4f 100644 --- a/ground/src/plugins/uavobjects/systemstats.h +++ b/ground/src/plugins/uavobjects/systemstats.h @@ -58,6 +58,7 @@ public: // Constants static const quint32 OBJID = 680908530U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 0; static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/telemetrysettings.cpp b/ground/src/plugins/uavobjects/telemetrysettings.cpp index 93e5f04fd..14021bb21 100644 --- a/ground/src/plugins/uavobjects/telemetrysettings.cpp +++ b/ground/src/plugins/uavobjects/telemetrysettings.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString TelemetrySettings::NAME = QString("TelemetrySettings"); +const QString TelemetrySettings::DESCRIPTION = QString("Select baud rate of telemetry. Warning - this must match your modem."); /** * Constructor @@ -58,6 +59,8 @@ TelemetrySettings::TelemetrySettings(): UAVDataObject(OBJID, ISSINGLEINST, ISSET initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/telemetrysettings.h b/ground/src/plugins/uavobjects/telemetrysettings.h index 44a2bafd7..681c2a261 100644 --- a/ground/src/plugins/uavobjects/telemetrysettings.h +++ b/ground/src/plugins/uavobjects/telemetrysettings.h @@ -56,6 +56,7 @@ public: // Constants static const quint32 OBJID = 2785592614U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 1; static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/uavobject.cpp b/ground/src/plugins/uavobjects/uavobject.cpp index 431ad7e82..e72f468df 100644 --- a/ground/src/plugins/uavobjects/uavobject.cpp +++ b/ground/src/plugins/uavobjects/uavobject.cpp @@ -116,6 +116,23 @@ QString UAVObject::getName() return name; } +/** + * Get the description of the object + */ +QString UAVObject::getDescription() +{ + return description; +} + +/** + * Set the description of the object + */ +void UAVObject::setDescription(const QString& description) +{ + this->description = description; +} + + /** * Get the total number of bytes of the object's data */ diff --git a/ground/src/plugins/uavobjects/uavobject.h b/ground/src/plugins/uavobjects/uavobject.h index e2a150eb0..e50860e18 100644 --- a/ground/src/plugins/uavobjects/uavobject.h +++ b/ground/src/plugins/uavobjects/uavobject.h @@ -88,6 +88,7 @@ public: quint32 getInstID(); bool isSingleInstance(); QString getName(); + QString getDescription(); quint32 getNumBytes(); qint32 pack(quint8* dataOut); qint32 unpack(const quint8* dataIn); @@ -128,12 +129,14 @@ protected: quint32 instID; bool isSingleInst; QString name; + QString description; quint32 numBytes; QMutex* mutex; quint8* data; QList fields; void initializeFields(QList& fields, quint8* data, quint32 numBytes); + void setDescription(const QString& description); }; #endif // UAVOBJECT_H diff --git a/ground/src/plugins/uavobjects/uavobjecttemplate.cpp b/ground/src/plugins/uavobjects/uavobjecttemplate.cpp index 1ea82efcc..cf7ce4b3b 100644 --- a/ground/src/plugins/uavobjects/uavobjecttemplate.cpp +++ b/ground/src/plugins/uavobjects/uavobjecttemplate.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString $(NAME)::NAME = QString("$(NAME)"); +const QString $(NAME)::DESCRIPTION = QString("$(DESCRIPTION)"); /** * Constructor @@ -47,6 +48,8 @@ $(FIELDSINIT) initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/uavobjecttemplate.h b/ground/src/plugins/uavobjects/uavobjecttemplate.h index e5a5a3126..5df99c975 100644 --- a/ground/src/plugins/uavobjects/uavobjecttemplate.h +++ b/ground/src/plugins/uavobjects/uavobjecttemplate.h @@ -52,6 +52,7 @@ $(DATAFIELDINFO) // Constants static const quint32 OBJID = $(OBJID)U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = $(ISSINGLEINST); static const bool ISSETTINGS = $(ISSETTINGS); static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/velocityactual.cpp b/ground/src/plugins/uavobjects/velocityactual.cpp index 5e4e6fdae..a417063c5 100644 --- a/ground/src/plugins/uavobjects/velocityactual.cpp +++ b/ground/src/plugins/uavobjects/velocityactual.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString VelocityActual::NAME = QString("VelocityActual"); +const QString VelocityActual::DESCRIPTION = QString("Updated by @ref AHRSCommsModule and used within @ref GuidanceModulefor velocity control"); /** * Constructor @@ -56,6 +57,8 @@ VelocityActual::VelocityActual(): UAVDataObject(OBJID, ISSINGLEINST, ISSETTINGS, initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/velocityactual.h b/ground/src/plugins/uavobjects/velocityactual.h index 75287293b..778534ca0 100644 --- a/ground/src/plugins/uavobjects/velocityactual.h +++ b/ground/src/plugins/uavobjects/velocityactual.h @@ -58,6 +58,7 @@ public: // Constants static const quint32 OBJID = 1207999624U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 0; static const quint32 NUMBYTES = sizeof(DataFields); diff --git a/ground/src/plugins/uavobjects/velocitydesired.cpp b/ground/src/plugins/uavobjects/velocitydesired.cpp index 7ff4aaf4d..56dc1ca19 100644 --- a/ground/src/plugins/uavobjects/velocitydesired.cpp +++ b/ground/src/plugins/uavobjects/velocitydesired.cpp @@ -34,6 +34,7 @@ #include "uavobjectfield.h" const QString VelocityDesired::NAME = QString("VelocityDesired"); +const QString VelocityDesired::DESCRIPTION = QString("Used within @ref GuidanceModule to communicate between the task computing the desired velocity and the PID loop to achieve it (running at different rates)."); /** * Constructor @@ -56,6 +57,8 @@ VelocityDesired::VelocityDesired(): UAVDataObject(OBJID, ISSINGLEINST, ISSETTING initializeFields(fields, (quint8*)&data, NUMBYTES); // Set the default field values setDefaultFieldValues(); + // Set the object description + setDescription(DESCRIPTION); } /** diff --git a/ground/src/plugins/uavobjects/velocitydesired.h b/ground/src/plugins/uavobjects/velocitydesired.h index abf0f45fa..9144a11de 100644 --- a/ground/src/plugins/uavobjects/velocitydesired.h +++ b/ground/src/plugins/uavobjects/velocitydesired.h @@ -58,6 +58,7 @@ public: // Constants static const quint32 OBJID = 305094202U; static const QString NAME; + static const QString DESCRIPTION; static const bool ISSINGLEINST = 1; static const bool ISSETTINGS = 0; static const quint32 NUMBYTES = sizeof(DataFields);