diff --git a/flight/OpenPilot/UAVObjects/actuatorcommand.c b/flight/OpenPilot/UAVObjects/actuatorcommand.c index 0b3abb9ab..dd1cfccb5 100644 --- a/flight/OpenPilot/UAVObjects/actuatorcommand.c +++ b/flight/OpenPilot/UAVObjects/actuatorcommand.c @@ -1,5 +1,12 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup ActuatorCommand ActuatorCommand + * @brief Contains the pulse duration sent to each of the channels. Set by @ref ActuatorModule + * + * Autogenerated files and functions for ActuatorCommand Object + * @{ * * @file actuatorcommand.c * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -98,5 +105,7 @@ UAVObjHandle ActuatorCommandHandle() return handle; } - +/** + * @} + */ diff --git a/flight/OpenPilot/UAVObjects/actuatordesired.c b/flight/OpenPilot/UAVObjects/actuatordesired.c index b5bec47dd..2df0c80f9 100644 --- a/flight/OpenPilot/UAVObjects/actuatordesired.c +++ b/flight/OpenPilot/UAVObjects/actuatordesired.c @@ -1,5 +1,12 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup ActuatorDesired ActuatorDesired + * @brief Desired raw, pitch and yaw actuator settings. Comes from either @ref StabilizationModule or @ref ManualControlModule depending on FlightMode. + * + * Autogenerated files and functions for ActuatorDesired Object + * @{ * * @file actuatordesired.c * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -98,5 +105,7 @@ UAVObjHandle ActuatorDesiredHandle() return handle; } - +/** + * @} + */ diff --git a/flight/OpenPilot/UAVObjects/actuatorsettings.c b/flight/OpenPilot/UAVObjects/actuatorsettings.c index 4b8e927e1..a6d6dcc78 100644 --- a/flight/OpenPilot/UAVObjects/actuatorsettings.c +++ b/flight/OpenPilot/UAVObjects/actuatorsettings.c @@ -1,5 +1,12 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup ActuatorSettings ActuatorSettings + * @brief Settings for the @ref ActuatorModule that controls the channel assignments for the mixer based on AircraftType + * + * Autogenerated files and functions for ActuatorSettings Object + * @{ * * @file actuatorsettings.c * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -162,5 +169,7 @@ UAVObjHandle ActuatorSettingsHandle() return handle; } - +/** + * @} + */ diff --git a/flight/OpenPilot/UAVObjects/ahrscalibration.c b/flight/OpenPilot/UAVObjects/ahrscalibration.c index 597da92ae..8e668689b 100644 --- a/flight/OpenPilot/UAVObjects/ahrscalibration.c +++ b/flight/OpenPilot/UAVObjects/ahrscalibration.c @@ -1,5 +1,12 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup AHRSCalibration AHRSCalibration + * @brief Contains the calibration settings for the @ref AHRSCommsModule + * + * Autogenerated files and functions for AHRSCalibration Object + * @{ * * @file ahrscalibration.c * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -123,5 +130,7 @@ UAVObjHandle AHRSCalibrationHandle() return handle; } - +/** + * @} + */ diff --git a/flight/OpenPilot/UAVObjects/ahrssettings.c b/flight/OpenPilot/UAVObjects/ahrssettings.c index a18dd9704..4d0fcedf7 100644 --- a/flight/OpenPilot/UAVObjects/ahrssettings.c +++ b/flight/OpenPilot/UAVObjects/ahrssettings.c @@ -1,5 +1,12 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup AHRSSettings AHRSSettings + * @brief Settings for the @ref AHRSCommsModule to control the algorithm and what is updated + * + * Autogenerated files and functions for AHRSSettings Object + * @{ * * @file ahrssettings.c * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -102,5 +109,7 @@ UAVObjHandle AHRSSettingsHandle() return handle; } - +/** + * @} + */ diff --git a/flight/OpenPilot/UAVObjects/ahrsstatus.c b/flight/OpenPilot/UAVObjects/ahrsstatus.c index d66117e98..114ce614c 100644 --- a/flight/OpenPilot/UAVObjects/ahrsstatus.c +++ b/flight/OpenPilot/UAVObjects/ahrsstatus.c @@ -1,5 +1,12 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup AhrsStatus AhrsStatus + * @brief Status for the @ref AHRSCommsModule, including communication errors + * + * Autogenerated files and functions for AhrsStatus Object + * @{ * * @file ahrsstatus.c * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -98,5 +105,7 @@ UAVObjHandle AhrsStatusHandle() return handle; } - +/** + * @} + */ diff --git a/flight/OpenPilot/UAVObjects/attitudeactual.c b/flight/OpenPilot/UAVObjects/attitudeactual.c index 2c20efab2..851eb16f8 100644 --- a/flight/OpenPilot/UAVObjects/attitudeactual.c +++ b/flight/OpenPilot/UAVObjects/attitudeactual.c @@ -1,5 +1,12 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup AttitudeActual AttitudeActual + * @brief The updated Attitude estimation from @ref AHRSCommsModule. + * + * Autogenerated files and functions for AttitudeActual Object + * @{ * * @file attitudeactual.c * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -98,5 +105,7 @@ UAVObjHandle AttitudeActualHandle() return handle; } - +/** + * @} + */ diff --git a/flight/OpenPilot/UAVObjects/attitudedesired.c b/flight/OpenPilot/UAVObjects/attitudedesired.c index 6a3329406..16e8fb778 100644 --- a/flight/OpenPilot/UAVObjects/attitudedesired.c +++ b/flight/OpenPilot/UAVObjects/attitudedesired.c @@ -1,5 +1,12 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup AttitudeDesired AttitudeDesired + * @brief The desired attitude that @ref StabilizationModule will try and achieve if FlightMode is Stabilized. Comes from @ref ManaulControlModule. + * + * Autogenerated files and functions for AttitudeDesired Object + * @{ * * @file attitudedesired.c * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -98,5 +105,7 @@ UAVObjHandle AttitudeDesiredHandle() return handle; } - +/** + * @} + */ diff --git a/flight/OpenPilot/UAVObjects/attituderaw.c b/flight/OpenPilot/UAVObjects/attituderaw.c index 9ab1d1972..ba7226d4f 100644 --- a/flight/OpenPilot/UAVObjects/attituderaw.c +++ b/flight/OpenPilot/UAVObjects/attituderaw.c @@ -1,5 +1,12 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup AttitudeRaw AttitudeRaw + * @brief The raw attitude sensor data from @ref AHRSCommsModule. Not always updated. + * + * Autogenerated files and functions for AttitudeRaw Object + * @{ * * @file attituderaw.c * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -98,5 +105,7 @@ UAVObjHandle AttitudeRawHandle() return handle; } - +/** + * @} + */ diff --git a/flight/OpenPilot/UAVObjects/baroaltitude.c b/flight/OpenPilot/UAVObjects/baroaltitude.c index 74bf60a68..e25150061 100644 --- a/flight/OpenPilot/UAVObjects/baroaltitude.c +++ b/flight/OpenPilot/UAVObjects/baroaltitude.c @@ -1,5 +1,12 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup BaroAltitude BaroAltitude + * @brief The raw data from the barometric sensor with pressure, temperature and altitude estimate. + * + * Autogenerated files and functions for BaroAltitude Object + * @{ * * @file baroaltitude.c * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -98,5 +105,7 @@ UAVObjHandle BaroAltitudeHandle() return handle; } - +/** + * @} + */ diff --git a/flight/OpenPilot/UAVObjects/exampleobject1.c b/flight/OpenPilot/UAVObjects/exampleobject1.c index aa8ac5ef7..30ca7c2b2 100644 --- a/flight/OpenPilot/UAVObjects/exampleobject1.c +++ b/flight/OpenPilot/UAVObjects/exampleobject1.c @@ -1,5 +1,12 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup ExampleObject1 ExampleObject1 + * @brief Example object + * + * Autogenerated files and functions for ExampleObject1 Object + * @{ * * @file exampleobject1.c * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -98,5 +105,7 @@ UAVObjHandle ExampleObject1Handle() return handle; } - +/** + * @} + */ diff --git a/flight/OpenPilot/UAVObjects/exampleobject2.c b/flight/OpenPilot/UAVObjects/exampleobject2.c index eebfd369f..694da4a8c 100644 --- a/flight/OpenPilot/UAVObjects/exampleobject2.c +++ b/flight/OpenPilot/UAVObjects/exampleobject2.c @@ -1,5 +1,12 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup ExampleObject2 ExampleObject2 + * @brief Example object + * + * Autogenerated files and functions for ExampleObject2 Object + * @{ * * @file exampleobject2.c * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -98,5 +105,7 @@ UAVObjHandle ExampleObject2Handle() return handle; } - +/** + * @} + */ diff --git a/flight/OpenPilot/UAVObjects/examplesettings.c b/flight/OpenPilot/UAVObjects/examplesettings.c index 43cc3862d..a8f4c832c 100644 --- a/flight/OpenPilot/UAVObjects/examplesettings.c +++ b/flight/OpenPilot/UAVObjects/examplesettings.c @@ -1,5 +1,12 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup ExampleSettings ExampleSettings + * @brief Example settings object + * + * Autogenerated files and functions for ExampleSettings Object + * @{ * * @file examplesettings.c * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -101,5 +108,7 @@ UAVObjHandle ExampleSettingsHandle() return handle; } - +/** + * @} + */ diff --git a/flight/OpenPilot/UAVObjects/flightbatterystate.c b/flight/OpenPilot/UAVObjects/flightbatterystate.c index 32029a419..59f23e664 100644 --- a/flight/OpenPilot/UAVObjects/flightbatterystate.c +++ b/flight/OpenPilot/UAVObjects/flightbatterystate.c @@ -1,5 +1,12 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup FlightBatteryState FlightBatteryState + * @brief Battery status information. Not currently updated. + * + * Autogenerated files and functions for FlightBatteryState Object + * @{ * * @file flightbatterystate.c * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -98,5 +105,7 @@ UAVObjHandle FlightBatteryStateHandle() return handle; } - +/** + * @} + */ diff --git a/flight/OpenPilot/UAVObjects/flightsituationactual.c b/flight/OpenPilot/UAVObjects/flightsituationactual.c index a5dfd63e5..b2592dd77 100644 --- a/flight/OpenPilot/UAVObjects/flightsituationactual.c +++ b/flight/OpenPilot/UAVObjects/flightsituationactual.c @@ -1,5 +1,12 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup FlightSituationActual FlightSituationActual + * @brief Currently unused + * + * Autogenerated files and functions for FlightSituationActual Object + * @{ * * @file flightsituationactual.c * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -98,5 +105,7 @@ UAVObjHandle FlightSituationActualHandle() return handle; } - +/** + * @} + */ diff --git a/flight/OpenPilot/UAVObjects/flighttelemetrystats.c b/flight/OpenPilot/UAVObjects/flighttelemetrystats.c index 846ae3ec0..83bfe7e04 100644 --- a/flight/OpenPilot/UAVObjects/flighttelemetrystats.c +++ b/flight/OpenPilot/UAVObjects/flighttelemetrystats.c @@ -1,5 +1,12 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup FlightTelemetryStats FlightTelemetryStats + * @brief Maintains the telemetry statistics from the OpenPilot flight computer. + * + * Autogenerated files and functions for FlightTelemetryStats Object + * @{ * * @file flighttelemetrystats.c * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -98,5 +105,7 @@ UAVObjHandle FlightTelemetryStatsHandle() return handle; } - +/** + * @} + */ diff --git a/flight/OpenPilot/UAVObjects/gcstelemetrystats.c b/flight/OpenPilot/UAVObjects/gcstelemetrystats.c index c7a7217fd..de7fd1368 100644 --- a/flight/OpenPilot/UAVObjects/gcstelemetrystats.c +++ b/flight/OpenPilot/UAVObjects/gcstelemetrystats.c @@ -1,5 +1,12 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup GCSTelemetryStats GCSTelemetryStats + * @brief The telemetry statistics from the ground computer + * + * Autogenerated files and functions for GCSTelemetryStats Object + * @{ * * @file gcstelemetrystats.c * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -98,5 +105,7 @@ UAVObjHandle GCSTelemetryStatsHandle() return handle; } - +/** + * @} + */ diff --git a/flight/OpenPilot/UAVObjects/gpsposition.c b/flight/OpenPilot/UAVObjects/gpsposition.c index f14813149..682a68043 100644 --- a/flight/OpenPilot/UAVObjects/gpsposition.c +++ b/flight/OpenPilot/UAVObjects/gpsposition.c @@ -1,5 +1,12 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup GPSPosition GPSPosition + * @brief Future object for the raw GPS data from @ref GPSModule. Only should be used by @ref AHRSCommsModule. + * + * Autogenerated files and functions for GPSPosition Object + * @{ * * @file gpsposition.c * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -98,5 +105,7 @@ UAVObjHandle GPSPositionHandle() return handle; } - +/** + * @} + */ diff --git a/flight/OpenPilot/UAVObjects/homelocation.c b/flight/OpenPilot/UAVObjects/homelocation.c index a3fc36ebd..913256b84 100644 --- a/flight/OpenPilot/UAVObjects/homelocation.c +++ b/flight/OpenPilot/UAVObjects/homelocation.c @@ -1,5 +1,12 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup HomeLocation HomeLocation + * @brief 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. + * + * Autogenerated files and functions for HomeLocation Object + * @{ * * @file homelocation.c * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -117,5 +124,7 @@ UAVObjHandle HomeLocationHandle() return handle; } - +/** + * @} + */ diff --git a/flight/OpenPilot/UAVObjects/inc/actuatorcommand.h b/flight/OpenPilot/UAVObjects/inc/actuatorcommand.h index fe02a4d35..5a51016d4 100644 --- a/flight/OpenPilot/UAVObjects/inc/actuatorcommand.h +++ b/flight/OpenPilot/UAVObjects/inc/actuatorcommand.h @@ -1,5 +1,13 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup ActuatorCommand ActuatorCommand + * @brief Contains the pulse duration sent to each of the channels. Set by @ref ActuatorModule + * + * Autogenerated files and functions for ActuatorCommand Object + + * @{ * * @file actuatorcommand.h * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -41,6 +49,11 @@ #define ACTUATORCOMMAND_NUMBYTES sizeof(ActuatorCommandData) // Object access macros +/** + * @function ActuatorCommandGet(dataOut) + * @brief Populate a ActuatorCommandData object + * @param[out] dataOut + */ #define ActuatorCommandGet(dataOut) UAVObjGetData(ActuatorCommandHandle(), dataOut) #define ActuatorCommandSet(dataIn) UAVObjSetData(ActuatorCommandHandle(), dataIn) #define ActuatorCommandInstGet(instId, dataOut) UAVObjGetInstanceData(ActuatorCommandHandle(), instId, dataOut) @@ -54,6 +67,7 @@ #define ActuatorCommandInstUpdated(instId) UAVObjUpdated(ActuatorCommandHandle(), instId) #define ActuatorCommandGetMetadata(dataOut) UAVObjGetMetadata(ActuatorCommandHandle(), dataOut) #define ActuatorCommandSetMetadata(dataIn) UAVObjSetMetadata(ActuatorCommandHandle(), dataIn) +#define ActuatorCommandReadOnly(dataIn) UAVObjReadOnly(ActuatorCommandHandle(), dataIn) // Object data typedef struct { @@ -72,3 +86,8 @@ int32_t ActuatorCommandInitialize(); UAVObjHandle ActuatorCommandHandle(); #endif // ACTUATORCOMMAND_H + +/** + * @} + * @} + */ \ No newline at end of file diff --git a/flight/OpenPilot/UAVObjects/inc/actuatordesired.h b/flight/OpenPilot/UAVObjects/inc/actuatordesired.h index e7a2c51e7..c58d84ecc 100644 --- a/flight/OpenPilot/UAVObjects/inc/actuatordesired.h +++ b/flight/OpenPilot/UAVObjects/inc/actuatordesired.h @@ -1,5 +1,13 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup ActuatorDesired ActuatorDesired + * @brief Desired raw, pitch and yaw actuator settings. Comes from either @ref StabilizationModule or @ref ManualControlModule depending on FlightMode. + * + * Autogenerated files and functions for ActuatorDesired Object + + * @{ * * @file actuatordesired.h * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -41,6 +49,11 @@ #define ACTUATORDESIRED_NUMBYTES sizeof(ActuatorDesiredData) // Object access macros +/** + * @function ActuatorDesiredGet(dataOut) + * @brief Populate a ActuatorDesiredData object + * @param[out] dataOut + */ #define ActuatorDesiredGet(dataOut) UAVObjGetData(ActuatorDesiredHandle(), dataOut) #define ActuatorDesiredSet(dataIn) UAVObjSetData(ActuatorDesiredHandle(), dataIn) #define ActuatorDesiredInstGet(instId, dataOut) UAVObjGetInstanceData(ActuatorDesiredHandle(), instId, dataOut) @@ -54,6 +67,7 @@ #define ActuatorDesiredInstUpdated(instId) UAVObjUpdated(ActuatorDesiredHandle(), instId) #define ActuatorDesiredGetMetadata(dataOut) UAVObjGetMetadata(ActuatorDesiredHandle(), dataOut) #define ActuatorDesiredSetMetadata(dataIn) UAVObjSetMetadata(ActuatorDesiredHandle(), dataIn) +#define ActuatorDesiredReadOnly(dataIn) UAVObjReadOnly(ActuatorDesiredHandle(), dataIn) // Object data typedef struct { @@ -76,3 +90,8 @@ int32_t ActuatorDesiredInitialize(); UAVObjHandle ActuatorDesiredHandle(); #endif // ACTUATORDESIRED_H + +/** + * @} + * @} + */ \ No newline at end of file diff --git a/flight/OpenPilot/UAVObjects/inc/actuatorsettings.h b/flight/OpenPilot/UAVObjects/inc/actuatorsettings.h index fb566e753..afa27f286 100644 --- a/flight/OpenPilot/UAVObjects/inc/actuatorsettings.h +++ b/flight/OpenPilot/UAVObjects/inc/actuatorsettings.h @@ -1,5 +1,13 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup ActuatorSettings ActuatorSettings + * @brief Settings for the @ref ActuatorModule that controls the channel assignments for the mixer based on AircraftType + * + * Autogenerated files and functions for ActuatorSettings Object + + * @{ * * @file actuatorsettings.h * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -41,6 +49,11 @@ #define ACTUATORSETTINGS_NUMBYTES sizeof(ActuatorSettingsData) // Object access macros +/** + * @function ActuatorSettingsGet(dataOut) + * @brief Populate a ActuatorSettingsData object + * @param[out] dataOut + */ #define ActuatorSettingsGet(dataOut) UAVObjGetData(ActuatorSettingsHandle(), dataOut) #define ActuatorSettingsSet(dataIn) UAVObjSetData(ActuatorSettingsHandle(), dataIn) #define ActuatorSettingsInstGet(instId, dataOut) UAVObjGetInstanceData(ActuatorSettingsHandle(), instId, dataOut) @@ -54,6 +67,7 @@ #define ActuatorSettingsInstUpdated(instId) UAVObjUpdated(ActuatorSettingsHandle(), instId) #define ActuatorSettingsGetMetadata(dataOut) UAVObjGetMetadata(ActuatorSettingsHandle(), dataOut) #define ActuatorSettingsSetMetadata(dataIn) UAVObjSetMetadata(ActuatorSettingsHandle(), dataIn) +#define ActuatorSettingsReadOnly(dataIn) UAVObjReadOnly(ActuatorSettingsHandle(), dataIn) // Object data typedef struct { @@ -192,3 +206,8 @@ int32_t ActuatorSettingsInitialize(); UAVObjHandle ActuatorSettingsHandle(); #endif // ACTUATORSETTINGS_H + +/** + * @} + * @} + */ \ No newline at end of file diff --git a/flight/OpenPilot/UAVObjects/inc/ahrscalibration.h b/flight/OpenPilot/UAVObjects/inc/ahrscalibration.h index 1c62ed0de..c11904b61 100644 --- a/flight/OpenPilot/UAVObjects/inc/ahrscalibration.h +++ b/flight/OpenPilot/UAVObjects/inc/ahrscalibration.h @@ -1,5 +1,13 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup AHRSCalibration AHRSCalibration + * @brief Contains the calibration settings for the @ref AHRSCommsModule + * + * Autogenerated files and functions for AHRSCalibration Object + + * @{ * * @file ahrscalibration.h * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -41,6 +49,11 @@ #define AHRSCALIBRATION_NUMBYTES sizeof(AHRSCalibrationData) // Object access macros +/** + * @function AHRSCalibrationGet(dataOut) + * @brief Populate a AHRSCalibrationData object + * @param[out] dataOut + */ #define AHRSCalibrationGet(dataOut) UAVObjGetData(AHRSCalibrationHandle(), dataOut) #define AHRSCalibrationSet(dataIn) UAVObjSetData(AHRSCalibrationHandle(), dataIn) #define AHRSCalibrationInstGet(instId, dataOut) UAVObjGetInstanceData(AHRSCalibrationHandle(), instId, dataOut) @@ -54,6 +67,7 @@ #define AHRSCalibrationInstUpdated(instId) UAVObjUpdated(AHRSCalibrationHandle(), instId) #define AHRSCalibrationGetMetadata(dataOut) UAVObjGetMetadata(AHRSCalibrationHandle(), dataOut) #define AHRSCalibrationSetMetadata(dataIn) UAVObjSetMetadata(AHRSCalibrationHandle(), dataIn) +#define AHRSCalibrationReadOnly(dataIn) UAVObjReadOnly(AHRSCalibrationHandle(), dataIn) // Object data typedef struct { @@ -120,3 +134,8 @@ int32_t AHRSCalibrationInitialize(); UAVObjHandle AHRSCalibrationHandle(); #endif // AHRSCALIBRATION_H + +/** + * @} + * @} + */ \ No newline at end of file diff --git a/flight/OpenPilot/UAVObjects/inc/ahrssettings.h b/flight/OpenPilot/UAVObjects/inc/ahrssettings.h index 26b743e16..9fd7d9cf0 100644 --- a/flight/OpenPilot/UAVObjects/inc/ahrssettings.h +++ b/flight/OpenPilot/UAVObjects/inc/ahrssettings.h @@ -1,5 +1,13 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup AHRSSettings AHRSSettings + * @brief Settings for the @ref AHRSCommsModule to control the algorithm and what is updated + * + * Autogenerated files and functions for AHRSSettings Object + + * @{ * * @file ahrssettings.h * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -41,6 +49,11 @@ #define AHRSSETTINGS_NUMBYTES sizeof(AHRSSettingsData) // Object access macros +/** + * @function AHRSSettingsGet(dataOut) + * @brief Populate a AHRSSettingsData object + * @param[out] dataOut + */ #define AHRSSettingsGet(dataOut) UAVObjGetData(AHRSSettingsHandle(), dataOut) #define AHRSSettingsSet(dataIn) UAVObjSetData(AHRSSettingsHandle(), dataIn) #define AHRSSettingsInstGet(instId, dataOut) UAVObjGetInstanceData(AHRSSettingsHandle(), instId, dataOut) @@ -54,6 +67,7 @@ #define AHRSSettingsInstUpdated(instId) UAVObjUpdated(AHRSSettingsHandle(), instId) #define AHRSSettingsGetMetadata(dataOut) UAVObjGetMetadata(AHRSSettingsHandle(), dataOut) #define AHRSSettingsSetMetadata(dataIn) UAVObjSetMetadata(AHRSSettingsHandle(), dataIn) +#define AHRSSettingsReadOnly(dataIn) UAVObjReadOnly(AHRSSettingsHandle(), dataIn) // Object data typedef struct { @@ -82,3 +96,8 @@ int32_t AHRSSettingsInitialize(); UAVObjHandle AHRSSettingsHandle(); #endif // AHRSSETTINGS_H + +/** + * @} + * @} + */ \ No newline at end of file diff --git a/flight/OpenPilot/UAVObjects/inc/ahrsstatus.h b/flight/OpenPilot/UAVObjects/inc/ahrsstatus.h index 3b832974d..f39b68f55 100644 --- a/flight/OpenPilot/UAVObjects/inc/ahrsstatus.h +++ b/flight/OpenPilot/UAVObjects/inc/ahrsstatus.h @@ -1,5 +1,13 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup AhrsStatus AhrsStatus + * @brief Status for the @ref AHRSCommsModule, including communication errors + * + * Autogenerated files and functions for AhrsStatus Object + + * @{ * * @file ahrsstatus.h * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -41,6 +49,11 @@ #define AHRSSTATUS_NUMBYTES sizeof(AhrsStatusData) // Object access macros +/** + * @function AhrsStatusGet(dataOut) + * @brief Populate a AhrsStatusData object + * @param[out] dataOut + */ #define AhrsStatusGet(dataOut) UAVObjGetData(AhrsStatusHandle(), dataOut) #define AhrsStatusSet(dataIn) UAVObjSetData(AhrsStatusHandle(), dataIn) #define AhrsStatusInstGet(instId, dataOut) UAVObjGetInstanceData(AhrsStatusHandle(), instId, dataOut) @@ -54,6 +67,7 @@ #define AhrsStatusInstUpdated(instId) UAVObjUpdated(AhrsStatusHandle(), instId) #define AhrsStatusGetMetadata(dataOut) UAVObjGetMetadata(AhrsStatusHandle(), dataOut) #define AhrsStatusSetMetadata(dataIn) UAVObjSetMetadata(AhrsStatusHandle(), dataIn) +#define AhrsStatusReadOnly(dataIn) UAVObjReadOnly(AhrsStatusHandle(), dataIn) // Object data typedef struct { @@ -90,3 +104,8 @@ int32_t AhrsStatusInitialize(); UAVObjHandle AhrsStatusHandle(); #endif // AHRSSTATUS_H + +/** + * @} + * @} + */ \ No newline at end of file diff --git a/flight/OpenPilot/UAVObjects/inc/attitudeactual.h b/flight/OpenPilot/UAVObjects/inc/attitudeactual.h index 366154718..afdbeee11 100644 --- a/flight/OpenPilot/UAVObjects/inc/attitudeactual.h +++ b/flight/OpenPilot/UAVObjects/inc/attitudeactual.h @@ -1,5 +1,13 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup AttitudeActual AttitudeActual + * @brief The updated Attitude estimation from @ref AHRSCommsModule. + * + * Autogenerated files and functions for AttitudeActual Object + + * @{ * * @file attitudeactual.h * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -41,6 +49,11 @@ #define ATTITUDEACTUAL_NUMBYTES sizeof(AttitudeActualData) // Object access macros +/** + * @function AttitudeActualGet(dataOut) + * @brief Populate a AttitudeActualData object + * @param[out] dataOut + */ #define AttitudeActualGet(dataOut) UAVObjGetData(AttitudeActualHandle(), dataOut) #define AttitudeActualSet(dataIn) UAVObjSetData(AttitudeActualHandle(), dataIn) #define AttitudeActualInstGet(instId, dataOut) UAVObjGetInstanceData(AttitudeActualHandle(), instId, dataOut) @@ -54,6 +67,7 @@ #define AttitudeActualInstUpdated(instId) UAVObjUpdated(AttitudeActualHandle(), instId) #define AttitudeActualGetMetadata(dataOut) UAVObjGetMetadata(AttitudeActualHandle(), dataOut) #define AttitudeActualSetMetadata(dataIn) UAVObjSetMetadata(AttitudeActualHandle(), dataIn) +#define AttitudeActualReadOnly(dataIn) UAVObjReadOnly(AttitudeActualHandle(), dataIn) // Object data typedef struct { @@ -82,3 +96,8 @@ int32_t AttitudeActualInitialize(); UAVObjHandle AttitudeActualHandle(); #endif // ATTITUDEACTUAL_H + +/** + * @} + * @} + */ \ No newline at end of file diff --git a/flight/OpenPilot/UAVObjects/inc/attitudedesired.h b/flight/OpenPilot/UAVObjects/inc/attitudedesired.h index 6189eb33c..277648e8b 100644 --- a/flight/OpenPilot/UAVObjects/inc/attitudedesired.h +++ b/flight/OpenPilot/UAVObjects/inc/attitudedesired.h @@ -1,5 +1,13 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup AttitudeDesired AttitudeDesired + * @brief The desired attitude that @ref StabilizationModule will try and achieve if FlightMode is Stabilized. Comes from @ref ManaulControlModule. + * + * Autogenerated files and functions for AttitudeDesired Object + + * @{ * * @file attitudedesired.h * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -41,6 +49,11 @@ #define ATTITUDEDESIRED_NUMBYTES sizeof(AttitudeDesiredData) // Object access macros +/** + * @function AttitudeDesiredGet(dataOut) + * @brief Populate a AttitudeDesiredData object + * @param[out] dataOut + */ #define AttitudeDesiredGet(dataOut) UAVObjGetData(AttitudeDesiredHandle(), dataOut) #define AttitudeDesiredSet(dataIn) UAVObjSetData(AttitudeDesiredHandle(), dataIn) #define AttitudeDesiredInstGet(instId, dataOut) UAVObjGetInstanceData(AttitudeDesiredHandle(), instId, dataOut) @@ -54,6 +67,7 @@ #define AttitudeDesiredInstUpdated(instId) UAVObjUpdated(AttitudeDesiredHandle(), instId) #define AttitudeDesiredGetMetadata(dataOut) UAVObjGetMetadata(AttitudeDesiredHandle(), dataOut) #define AttitudeDesiredSetMetadata(dataIn) UAVObjSetMetadata(AttitudeDesiredHandle(), dataIn) +#define AttitudeDesiredReadOnly(dataIn) UAVObjReadOnly(AttitudeDesiredHandle(), dataIn) // Object data typedef struct { @@ -76,3 +90,8 @@ int32_t AttitudeDesiredInitialize(); UAVObjHandle AttitudeDesiredHandle(); #endif // ATTITUDEDESIRED_H + +/** + * @} + * @} + */ \ No newline at end of file diff --git a/flight/OpenPilot/UAVObjects/inc/attituderaw.h b/flight/OpenPilot/UAVObjects/inc/attituderaw.h index 1be0b13aa..fff0abbce 100644 --- a/flight/OpenPilot/UAVObjects/inc/attituderaw.h +++ b/flight/OpenPilot/UAVObjects/inc/attituderaw.h @@ -1,5 +1,13 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup AttitudeRaw AttitudeRaw + * @brief The raw attitude sensor data from @ref AHRSCommsModule. Not always updated. + * + * Autogenerated files and functions for AttitudeRaw Object + + * @{ * * @file attituderaw.h * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -41,6 +49,11 @@ #define ATTITUDERAW_NUMBYTES sizeof(AttitudeRawData) // Object access macros +/** + * @function AttitudeRawGet(dataOut) + * @brief Populate a AttitudeRawData object + * @param[out] dataOut + */ #define AttitudeRawGet(dataOut) UAVObjGetData(AttitudeRawHandle(), dataOut) #define AttitudeRawSet(dataIn) UAVObjSetData(AttitudeRawHandle(), dataIn) #define AttitudeRawInstGet(instId, dataOut) UAVObjGetInstanceData(AttitudeRawHandle(), instId, dataOut) @@ -54,6 +67,7 @@ #define AttitudeRawInstUpdated(instId) UAVObjUpdated(AttitudeRawHandle(), instId) #define AttitudeRawGetMetadata(dataOut) UAVObjGetMetadata(AttitudeRawHandle(), dataOut) #define AttitudeRawSetMetadata(dataIn) UAVObjSetMetadata(AttitudeRawHandle(), dataIn) +#define AttitudeRawReadOnly(dataIn) UAVObjReadOnly(AttitudeRawHandle(), dataIn) // Object data typedef struct { @@ -104,3 +118,8 @@ int32_t AttitudeRawInitialize(); UAVObjHandle AttitudeRawHandle(); #endif // ATTITUDERAW_H + +/** + * @} + * @} + */ \ No newline at end of file diff --git a/flight/OpenPilot/UAVObjects/inc/baroaltitude.h b/flight/OpenPilot/UAVObjects/inc/baroaltitude.h index 4f7f48b08..fa68b822e 100644 --- a/flight/OpenPilot/UAVObjects/inc/baroaltitude.h +++ b/flight/OpenPilot/UAVObjects/inc/baroaltitude.h @@ -1,5 +1,13 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup BaroAltitude BaroAltitude + * @brief The raw data from the barometric sensor with pressure, temperature and altitude estimate. + * + * Autogenerated files and functions for BaroAltitude Object + + * @{ * * @file baroaltitude.h * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -41,6 +49,11 @@ #define BAROALTITUDE_NUMBYTES sizeof(BaroAltitudeData) // Object access macros +/** + * @function BaroAltitudeGet(dataOut) + * @brief Populate a BaroAltitudeData object + * @param[out] dataOut + */ #define BaroAltitudeGet(dataOut) UAVObjGetData(BaroAltitudeHandle(), dataOut) #define BaroAltitudeSet(dataIn) UAVObjSetData(BaroAltitudeHandle(), dataIn) #define BaroAltitudeInstGet(instId, dataOut) UAVObjGetInstanceData(BaroAltitudeHandle(), instId, dataOut) @@ -54,6 +67,7 @@ #define BaroAltitudeInstUpdated(instId) UAVObjUpdated(BaroAltitudeHandle(), instId) #define BaroAltitudeGetMetadata(dataOut) UAVObjGetMetadata(BaroAltitudeHandle(), dataOut) #define BaroAltitudeSetMetadata(dataIn) UAVObjSetMetadata(BaroAltitudeHandle(), dataIn) +#define BaroAltitudeReadOnly(dataIn) UAVObjReadOnly(BaroAltitudeHandle(), dataIn) // Object data typedef struct { @@ -74,3 +88,8 @@ int32_t BaroAltitudeInitialize(); UAVObjHandle BaroAltitudeHandle(); #endif // BAROALTITUDE_H + +/** + * @} + * @} + */ \ No newline at end of file diff --git a/flight/OpenPilot/UAVObjects/inc/exampleobject1.h b/flight/OpenPilot/UAVObjects/inc/exampleobject1.h index 0c08fda2a..2486fada9 100644 --- a/flight/OpenPilot/UAVObjects/inc/exampleobject1.h +++ b/flight/OpenPilot/UAVObjects/inc/exampleobject1.h @@ -1,5 +1,13 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup ExampleObject1 ExampleObject1 + * @brief Example object + * + * Autogenerated files and functions for ExampleObject1 Object + + * @{ * * @file exampleobject1.h * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -41,6 +49,11 @@ #define EXAMPLEOBJECT1_NUMBYTES sizeof(ExampleObject1Data) // Object access macros +/** + * @function ExampleObject1Get(dataOut) + * @brief Populate a ExampleObject1Data object + * @param[out] dataOut + */ #define ExampleObject1Get(dataOut) UAVObjGetData(ExampleObject1Handle(), dataOut) #define ExampleObject1Set(dataIn) UAVObjSetData(ExampleObject1Handle(), dataIn) #define ExampleObject1InstGet(instId, dataOut) UAVObjGetInstanceData(ExampleObject1Handle(), instId, dataOut) @@ -54,6 +67,7 @@ #define ExampleObject1InstUpdated(instId) UAVObjUpdated(ExampleObject1Handle(), instId) #define ExampleObject1GetMetadata(dataOut) UAVObjGetMetadata(ExampleObject1Handle(), dataOut) #define ExampleObject1SetMetadata(dataIn) UAVObjSetMetadata(ExampleObject1Handle(), dataIn) +#define ExampleObject1ReadOnly(dataIn) UAVObjReadOnly(ExampleObject1Handle(), dataIn) // Object data typedef struct { @@ -88,3 +102,8 @@ int32_t ExampleObject1Initialize(); UAVObjHandle ExampleObject1Handle(); #endif // EXAMPLEOBJECT1_H + +/** + * @} + * @} + */ \ No newline at end of file diff --git a/flight/OpenPilot/UAVObjects/inc/exampleobject2.h b/flight/OpenPilot/UAVObjects/inc/exampleobject2.h index c44e08567..c80e8df7a 100644 --- a/flight/OpenPilot/UAVObjects/inc/exampleobject2.h +++ b/flight/OpenPilot/UAVObjects/inc/exampleobject2.h @@ -1,5 +1,13 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup ExampleObject2 ExampleObject2 + * @brief Example object + * + * Autogenerated files and functions for ExampleObject2 Object + + * @{ * * @file exampleobject2.h * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -41,6 +49,11 @@ #define EXAMPLEOBJECT2_NUMBYTES sizeof(ExampleObject2Data) // Object access macros +/** + * @function ExampleObject2Get(dataOut) + * @brief Populate a ExampleObject2Data object + * @param[out] dataOut + */ #define ExampleObject2Get(dataOut) UAVObjGetData(ExampleObject2Handle(), dataOut) #define ExampleObject2Set(dataIn) UAVObjSetData(ExampleObject2Handle(), dataIn) #define ExampleObject2InstGet(instId, dataOut) UAVObjGetInstanceData(ExampleObject2Handle(), instId, dataOut) @@ -54,6 +67,7 @@ #define ExampleObject2InstUpdated(instId) UAVObjUpdated(ExampleObject2Handle(), instId) #define ExampleObject2GetMetadata(dataOut) UAVObjGetMetadata(ExampleObject2Handle(), dataOut) #define ExampleObject2SetMetadata(dataIn) UAVObjSetMetadata(ExampleObject2Handle(), dataIn) +#define ExampleObject2ReadOnly(dataIn) UAVObjReadOnly(ExampleObject2Handle(), dataIn) // Object data typedef struct { @@ -78,3 +92,8 @@ int32_t ExampleObject2Initialize(); UAVObjHandle ExampleObject2Handle(); #endif // EXAMPLEOBJECT2_H + +/** + * @} + * @} + */ \ No newline at end of file diff --git a/flight/OpenPilot/UAVObjects/inc/examplesettings.h b/flight/OpenPilot/UAVObjects/inc/examplesettings.h index 0d4684a63..578376d52 100644 --- a/flight/OpenPilot/UAVObjects/inc/examplesettings.h +++ b/flight/OpenPilot/UAVObjects/inc/examplesettings.h @@ -1,5 +1,13 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup ExampleSettings ExampleSettings + * @brief Example settings object + * + * Autogenerated files and functions for ExampleSettings Object + + * @{ * * @file examplesettings.h * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -41,6 +49,11 @@ #define EXAMPLESETTINGS_NUMBYTES sizeof(ExampleSettingsData) // Object access macros +/** + * @function ExampleSettingsGet(dataOut) + * @brief Populate a ExampleSettingsData object + * @param[out] dataOut + */ #define ExampleSettingsGet(dataOut) UAVObjGetData(ExampleSettingsHandle(), dataOut) #define ExampleSettingsSet(dataIn) UAVObjSetData(ExampleSettingsHandle(), dataIn) #define ExampleSettingsInstGet(instId, dataOut) UAVObjGetInstanceData(ExampleSettingsHandle(), instId, dataOut) @@ -54,6 +67,7 @@ #define ExampleSettingsInstUpdated(instId) UAVObjUpdated(ExampleSettingsHandle(), instId) #define ExampleSettingsGetMetadata(dataOut) UAVObjGetMetadata(ExampleSettingsHandle(), dataOut) #define ExampleSettingsSetMetadata(dataIn) UAVObjSetMetadata(ExampleSettingsHandle(), dataIn) +#define ExampleSettingsReadOnly(dataIn) UAVObjReadOnly(ExampleSettingsHandle(), dataIn) // Object data typedef struct { @@ -76,3 +90,8 @@ int32_t ExampleSettingsInitialize(); UAVObjHandle ExampleSettingsHandle(); #endif // EXAMPLESETTINGS_H + +/** + * @} + * @} + */ \ No newline at end of file diff --git a/flight/OpenPilot/UAVObjects/inc/flightbatterystate.h b/flight/OpenPilot/UAVObjects/inc/flightbatterystate.h index af382637e..e87d70679 100644 --- a/flight/OpenPilot/UAVObjects/inc/flightbatterystate.h +++ b/flight/OpenPilot/UAVObjects/inc/flightbatterystate.h @@ -1,5 +1,13 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup FlightBatteryState FlightBatteryState + * @brief Battery status information. Not currently updated. + * + * Autogenerated files and functions for FlightBatteryState Object + + * @{ * * @file flightbatterystate.h * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -41,6 +49,11 @@ #define FLIGHTBATTERYSTATE_NUMBYTES sizeof(FlightBatteryStateData) // Object access macros +/** + * @function FlightBatteryStateGet(dataOut) + * @brief Populate a FlightBatteryStateData object + * @param[out] dataOut + */ #define FlightBatteryStateGet(dataOut) UAVObjGetData(FlightBatteryStateHandle(), dataOut) #define FlightBatteryStateSet(dataIn) UAVObjSetData(FlightBatteryStateHandle(), dataIn) #define FlightBatteryStateInstGet(instId, dataOut) UAVObjGetInstanceData(FlightBatteryStateHandle(), instId, dataOut) @@ -54,6 +67,7 @@ #define FlightBatteryStateInstUpdated(instId) UAVObjUpdated(FlightBatteryStateHandle(), instId) #define FlightBatteryStateGetMetadata(dataOut) UAVObjGetMetadata(FlightBatteryStateHandle(), dataOut) #define FlightBatteryStateSetMetadata(dataIn) UAVObjSetMetadata(FlightBatteryStateHandle(), dataIn) +#define FlightBatteryStateReadOnly(dataIn) UAVObjReadOnly(FlightBatteryStateHandle(), dataIn) // Object data typedef struct { @@ -74,3 +88,8 @@ int32_t FlightBatteryStateInitialize(); UAVObjHandle FlightBatteryStateHandle(); #endif // FLIGHTBATTERYSTATE_H + +/** + * @} + * @} + */ \ No newline at end of file diff --git a/flight/OpenPilot/UAVObjects/inc/flightsituationactual.h b/flight/OpenPilot/UAVObjects/inc/flightsituationactual.h index f348eca74..387a00669 100644 --- a/flight/OpenPilot/UAVObjects/inc/flightsituationactual.h +++ b/flight/OpenPilot/UAVObjects/inc/flightsituationactual.h @@ -1,5 +1,13 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup FlightSituationActual FlightSituationActual + * @brief Currently unused + * + * Autogenerated files and functions for FlightSituationActual Object + + * @{ * * @file flightsituationactual.h * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -41,6 +49,11 @@ #define FLIGHTSITUATIONACTUAL_NUMBYTES sizeof(FlightSituationActualData) // Object access macros +/** + * @function FlightSituationActualGet(dataOut) + * @brief Populate a FlightSituationActualData object + * @param[out] dataOut + */ #define FlightSituationActualGet(dataOut) UAVObjGetData(FlightSituationActualHandle(), dataOut) #define FlightSituationActualSet(dataIn) UAVObjSetData(FlightSituationActualHandle(), dataIn) #define FlightSituationActualInstGet(instId, dataOut) UAVObjGetInstanceData(FlightSituationActualHandle(), instId, dataOut) @@ -54,6 +67,7 @@ #define FlightSituationActualInstUpdated(instId) UAVObjUpdated(FlightSituationActualHandle(), instId) #define FlightSituationActualGetMetadata(dataOut) UAVObjGetMetadata(FlightSituationActualHandle(), dataOut) #define FlightSituationActualSetMetadata(dataIn) UAVObjSetMetadata(FlightSituationActualHandle(), dataIn) +#define FlightSituationActualReadOnly(dataIn) UAVObjReadOnly(FlightSituationActualHandle(), dataIn) // Object data typedef struct { @@ -86,3 +100,8 @@ int32_t FlightSituationActualInitialize(); UAVObjHandle FlightSituationActualHandle(); #endif // FLIGHTSITUATIONACTUAL_H + +/** + * @} + * @} + */ \ No newline at end of file diff --git a/flight/OpenPilot/UAVObjects/inc/flighttelemetrystats.h b/flight/OpenPilot/UAVObjects/inc/flighttelemetrystats.h index fd7ad2c35..a1ac4854e 100644 --- a/flight/OpenPilot/UAVObjects/inc/flighttelemetrystats.h +++ b/flight/OpenPilot/UAVObjects/inc/flighttelemetrystats.h @@ -1,5 +1,13 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup FlightTelemetryStats FlightTelemetryStats + * @brief Maintains the telemetry statistics from the OpenPilot flight computer. + * + * Autogenerated files and functions for FlightTelemetryStats Object + + * @{ * * @file flighttelemetrystats.h * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -41,6 +49,11 @@ #define FLIGHTTELEMETRYSTATS_NUMBYTES sizeof(FlightTelemetryStatsData) // Object access macros +/** + * @function FlightTelemetryStatsGet(dataOut) + * @brief Populate a FlightTelemetryStatsData object + * @param[out] dataOut + */ #define FlightTelemetryStatsGet(dataOut) UAVObjGetData(FlightTelemetryStatsHandle(), dataOut) #define FlightTelemetryStatsSet(dataIn) UAVObjSetData(FlightTelemetryStatsHandle(), dataIn) #define FlightTelemetryStatsInstGet(instId, dataOut) UAVObjGetInstanceData(FlightTelemetryStatsHandle(), instId, dataOut) @@ -54,6 +67,7 @@ #define FlightTelemetryStatsInstUpdated(instId) UAVObjUpdated(FlightTelemetryStatsHandle(), instId) #define FlightTelemetryStatsGetMetadata(dataOut) UAVObjGetMetadata(FlightTelemetryStatsHandle(), dataOut) #define FlightTelemetryStatsSetMetadata(dataIn) UAVObjSetMetadata(FlightTelemetryStatsHandle(), dataIn) +#define FlightTelemetryStatsReadOnly(dataIn) UAVObjReadOnly(FlightTelemetryStatsHandle(), dataIn) // Object data typedef struct { @@ -82,3 +96,8 @@ int32_t FlightTelemetryStatsInitialize(); UAVObjHandle FlightTelemetryStatsHandle(); #endif // FLIGHTTELEMETRYSTATS_H + +/** + * @} + * @} + */ \ No newline at end of file diff --git a/flight/OpenPilot/UAVObjects/inc/gcstelemetrystats.h b/flight/OpenPilot/UAVObjects/inc/gcstelemetrystats.h index 94e34e0e7..590c4a1f5 100644 --- a/flight/OpenPilot/UAVObjects/inc/gcstelemetrystats.h +++ b/flight/OpenPilot/UAVObjects/inc/gcstelemetrystats.h @@ -1,5 +1,13 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup GCSTelemetryStats GCSTelemetryStats + * @brief The telemetry statistics from the ground computer + * + * Autogenerated files and functions for GCSTelemetryStats Object + + * @{ * * @file gcstelemetrystats.h * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -41,6 +49,11 @@ #define GCSTELEMETRYSTATS_NUMBYTES sizeof(GCSTelemetryStatsData) // Object access macros +/** + * @function GCSTelemetryStatsGet(dataOut) + * @brief Populate a GCSTelemetryStatsData object + * @param[out] dataOut + */ #define GCSTelemetryStatsGet(dataOut) UAVObjGetData(GCSTelemetryStatsHandle(), dataOut) #define GCSTelemetryStatsSet(dataIn) UAVObjSetData(GCSTelemetryStatsHandle(), dataIn) #define GCSTelemetryStatsInstGet(instId, dataOut) UAVObjGetInstanceData(GCSTelemetryStatsHandle(), instId, dataOut) @@ -54,6 +67,7 @@ #define GCSTelemetryStatsInstUpdated(instId) UAVObjUpdated(GCSTelemetryStatsHandle(), instId) #define GCSTelemetryStatsGetMetadata(dataOut) UAVObjGetMetadata(GCSTelemetryStatsHandle(), dataOut) #define GCSTelemetryStatsSetMetadata(dataIn) UAVObjSetMetadata(GCSTelemetryStatsHandle(), dataIn) +#define GCSTelemetryStatsReadOnly(dataIn) UAVObjReadOnly(GCSTelemetryStatsHandle(), dataIn) // Object data typedef struct { @@ -82,3 +96,8 @@ int32_t GCSTelemetryStatsInitialize(); UAVObjHandle GCSTelemetryStatsHandle(); #endif // GCSTELEMETRYSTATS_H + +/** + * @} + * @} + */ \ No newline at end of file diff --git a/flight/OpenPilot/UAVObjects/inc/gpsposition.h b/flight/OpenPilot/UAVObjects/inc/gpsposition.h index 6e9c09e4c..82516fa4f 100644 --- a/flight/OpenPilot/UAVObjects/inc/gpsposition.h +++ b/flight/OpenPilot/UAVObjects/inc/gpsposition.h @@ -1,5 +1,13 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup GPSPosition GPSPosition + * @brief Future object for the raw GPS data from @ref GPSModule. Only should be used by @ref AHRSCommsModule. + * + * Autogenerated files and functions for GPSPosition Object + + * @{ * * @file gpsposition.h * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -41,6 +49,11 @@ #define GPSPOSITION_NUMBYTES sizeof(GPSPositionData) // Object access macros +/** + * @function GPSPositionGet(dataOut) + * @brief Populate a GPSPositionData object + * @param[out] dataOut + */ #define GPSPositionGet(dataOut) UAVObjGetData(GPSPositionHandle(), dataOut) #define GPSPositionSet(dataIn) UAVObjSetData(GPSPositionHandle(), dataIn) #define GPSPositionInstGet(instId, dataOut) UAVObjGetInstanceData(GPSPositionHandle(), instId, dataOut) @@ -54,6 +67,7 @@ #define GPSPositionInstUpdated(instId) UAVObjUpdated(GPSPositionHandle(), instId) #define GPSPositionGetMetadata(dataOut) UAVObjGetMetadata(GPSPositionHandle(), dataOut) #define GPSPositionSetMetadata(dataIn) UAVObjSetMetadata(GPSPositionHandle(), dataIn) +#define GPSPositionReadOnly(dataIn) UAVObjReadOnly(GPSPositionHandle(), dataIn) // Object data typedef struct { @@ -92,3 +106,8 @@ int32_t GPSPositionInitialize(); UAVObjHandle GPSPositionHandle(); #endif // GPSPOSITION_H + +/** + * @} + * @} + */ \ No newline at end of file diff --git a/flight/OpenPilot/UAVObjects/inc/homelocation.h b/flight/OpenPilot/UAVObjects/inc/homelocation.h index d375efe9e..8421eabbb 100644 --- a/flight/OpenPilot/UAVObjects/inc/homelocation.h +++ b/flight/OpenPilot/UAVObjects/inc/homelocation.h @@ -1,5 +1,13 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup HomeLocation HomeLocation + * @brief 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. + * + * Autogenerated files and functions for HomeLocation Object + + * @{ * * @file homelocation.h * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -41,6 +49,11 @@ #define HOMELOCATION_NUMBYTES sizeof(HomeLocationData) // Object access macros +/** + * @function HomeLocationGet(dataOut) + * @brief Populate a HomeLocationData object + * @param[out] dataOut + */ #define HomeLocationGet(dataOut) UAVObjGetData(HomeLocationHandle(), dataOut) #define HomeLocationSet(dataIn) UAVObjSetData(HomeLocationHandle(), dataIn) #define HomeLocationInstGet(instId, dataOut) UAVObjGetInstanceData(HomeLocationHandle(), instId, dataOut) @@ -54,6 +67,7 @@ #define HomeLocationInstUpdated(instId) UAVObjUpdated(HomeLocationHandle(), instId) #define HomeLocationGetMetadata(dataOut) UAVObjGetMetadata(HomeLocationHandle(), dataOut) #define HomeLocationSetMetadata(dataIn) UAVObjSetMetadata(HomeLocationHandle(), dataIn) +#define HomeLocationReadOnly(dataIn) UAVObjReadOnly(HomeLocationHandle(), dataIn) // Object data typedef struct { @@ -90,3 +104,8 @@ int32_t HomeLocationInitialize(); UAVObjHandle HomeLocationHandle(); #endif // HOMELOCATION_H + +/** + * @} + * @} + */ \ No newline at end of file diff --git a/flight/OpenPilot/UAVObjects/inc/manualcontrolcommand.h b/flight/OpenPilot/UAVObjects/inc/manualcontrolcommand.h index 4d3912687..b70c55667 100644 --- a/flight/OpenPilot/UAVObjects/inc/manualcontrolcommand.h +++ b/flight/OpenPilot/UAVObjects/inc/manualcontrolcommand.h @@ -1,5 +1,13 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup ManualControlCommand ManualControlCommand + * @brief The output from the @ref ManualControlModule which descodes the receiver inputs. Overriden by GCS for fly-by-wire control. + * + * Autogenerated files and functions for ManualControlCommand Object + + * @{ * * @file manualcontrolcommand.h * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -41,6 +49,11 @@ #define MANUALCONTROLCOMMAND_NUMBYTES sizeof(ManualControlCommandData) // Object access macros +/** + * @function ManualControlCommandGet(dataOut) + * @brief Populate a ManualControlCommandData object + * @param[out] dataOut + */ #define ManualControlCommandGet(dataOut) UAVObjGetData(ManualControlCommandHandle(), dataOut) #define ManualControlCommandSet(dataIn) UAVObjSetData(ManualControlCommandHandle(), dataIn) #define ManualControlCommandInstGet(instId, dataOut) UAVObjGetInstanceData(ManualControlCommandHandle(), instId, dataOut) @@ -54,6 +67,7 @@ #define ManualControlCommandInstUpdated(instId) UAVObjUpdated(ManualControlCommandHandle(), instId) #define ManualControlCommandGetMetadata(dataOut) UAVObjGetMetadata(ManualControlCommandHandle(), dataOut) #define ManualControlCommandSetMetadata(dataIn) UAVObjSetMetadata(ManualControlCommandHandle(), dataIn) +#define ManualControlCommandReadOnly(dataIn) UAVObjReadOnly(ManualControlCommandHandle(), dataIn) // Object data typedef struct { @@ -88,3 +102,8 @@ int32_t ManualControlCommandInitialize(); UAVObjHandle ManualControlCommandHandle(); #endif // MANUALCONTROLCOMMAND_H + +/** + * @} + * @} + */ \ No newline at end of file diff --git a/flight/OpenPilot/UAVObjects/inc/manualcontrolsettings.h b/flight/OpenPilot/UAVObjects/inc/manualcontrolsettings.h index 8785fba2f..c9467039b 100644 --- a/flight/OpenPilot/UAVObjects/inc/manualcontrolsettings.h +++ b/flight/OpenPilot/UAVObjects/inc/manualcontrolsettings.h @@ -1,5 +1,13 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup ManualControlSettings ManualControlSettings + * @brief Settings to indicate how to decode receiver input by @ref ManualControlModule. + * + * Autogenerated files and functions for ManualControlSettings Object + + * @{ * * @file manualcontrolsettings.h * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -41,6 +49,11 @@ #define MANUALCONTROLSETTINGS_NUMBYTES sizeof(ManualControlSettingsData) // Object access macros +/** + * @function ManualControlSettingsGet(dataOut) + * @brief Populate a ManualControlSettingsData object + * @param[out] dataOut + */ #define ManualControlSettingsGet(dataOut) UAVObjGetData(ManualControlSettingsHandle(), dataOut) #define ManualControlSettingsSet(dataIn) UAVObjSetData(ManualControlSettingsHandle(), dataIn) #define ManualControlSettingsInstGet(instId, dataOut) UAVObjGetInstanceData(ManualControlSettingsHandle(), instId, dataOut) @@ -54,6 +67,7 @@ #define ManualControlSettingsInstUpdated(instId) UAVObjUpdated(ManualControlSettingsHandle(), instId) #define ManualControlSettingsGetMetadata(dataOut) UAVObjGetMetadata(ManualControlSettingsHandle(), dataOut) #define ManualControlSettingsSetMetadata(dataIn) UAVObjSetMetadata(ManualControlSettingsHandle(), dataIn) +#define ManualControlSettingsReadOnly(dataIn) UAVObjReadOnly(ManualControlSettingsHandle(), dataIn) // Object data typedef struct { @@ -104,3 +118,8 @@ int32_t ManualControlSettingsInitialize(); UAVObjHandle ManualControlSettingsHandle(); #endif // MANUALCONTROLSETTINGS_H + +/** + * @} + * @} + */ \ No newline at end of file diff --git a/flight/OpenPilot/UAVObjects/inc/navigationdesired.h b/flight/OpenPilot/UAVObjects/inc/navigationdesired.h index 9ba2f3f46..4eadb6fe6 100644 --- a/flight/OpenPilot/UAVObjects/inc/navigationdesired.h +++ b/flight/OpenPilot/UAVObjects/inc/navigationdesired.h @@ -1,5 +1,13 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup NavigationDesired NavigationDesired + * @brief Currently unused + * + * Autogenerated files and functions for NavigationDesired Object + + * @{ * * @file navigationdesired.h * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -41,6 +49,11 @@ #define NAVIGATIONDESIRED_NUMBYTES sizeof(NavigationDesiredData) // Object access macros +/** + * @function NavigationDesiredGet(dataOut) + * @brief Populate a NavigationDesiredData object + * @param[out] dataOut + */ #define NavigationDesiredGet(dataOut) UAVObjGetData(NavigationDesiredHandle(), dataOut) #define NavigationDesiredSet(dataIn) UAVObjSetData(NavigationDesiredHandle(), dataIn) #define NavigationDesiredInstGet(instId, dataOut) UAVObjGetInstanceData(NavigationDesiredHandle(), instId, dataOut) @@ -54,6 +67,7 @@ #define NavigationDesiredInstUpdated(instId) UAVObjUpdated(NavigationDesiredHandle(), instId) #define NavigationDesiredGetMetadata(dataOut) UAVObjGetMetadata(NavigationDesiredHandle(), dataOut) #define NavigationDesiredSetMetadata(dataIn) UAVObjSetMetadata(NavigationDesiredHandle(), dataIn) +#define NavigationDesiredReadOnly(dataIn) UAVObjReadOnly(NavigationDesiredHandle(), dataIn) // Object data typedef struct { @@ -76,3 +90,8 @@ int32_t NavigationDesiredInitialize(); UAVObjHandle NavigationDesiredHandle(); #endif // NAVIGATIONDESIRED_H + +/** + * @} + * @} + */ \ No newline at end of file diff --git a/flight/OpenPilot/UAVObjects/inc/navigationsettings.h b/flight/OpenPilot/UAVObjects/inc/navigationsettings.h index 6ad6525c1..db7a74c1a 100644 --- a/flight/OpenPilot/UAVObjects/inc/navigationsettings.h +++ b/flight/OpenPilot/UAVObjects/inc/navigationsettings.h @@ -1,5 +1,13 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup NavigationSettings NavigationSettings + * @brief Settings for Navigation. Currently unused. + * + * Autogenerated files and functions for NavigationSettings Object + + * @{ * * @file navigationsettings.h * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -41,6 +49,11 @@ #define NAVIGATIONSETTINGS_NUMBYTES sizeof(NavigationSettingsData) // Object access macros +/** + * @function NavigationSettingsGet(dataOut) + * @brief Populate a NavigationSettingsData object + * @param[out] dataOut + */ #define NavigationSettingsGet(dataOut) UAVObjGetData(NavigationSettingsHandle(), dataOut) #define NavigationSettingsSet(dataIn) UAVObjSetData(NavigationSettingsHandle(), dataIn) #define NavigationSettingsInstGet(instId, dataOut) UAVObjGetInstanceData(NavigationSettingsHandle(), instId, dataOut) @@ -54,6 +67,7 @@ #define NavigationSettingsInstUpdated(instId) UAVObjUpdated(NavigationSettingsHandle(), instId) #define NavigationSettingsGetMetadata(dataOut) UAVObjGetMetadata(NavigationSettingsHandle(), dataOut) #define NavigationSettingsSetMetadata(dataIn) UAVObjSetMetadata(NavigationSettingsHandle(), dataIn) +#define NavigationSettingsReadOnly(dataIn) UAVObjReadOnly(NavigationSettingsHandle(), dataIn) // Object data typedef struct { @@ -84,3 +98,8 @@ int32_t NavigationSettingsInitialize(); UAVObjHandle NavigationSettingsHandle(); #endif // NAVIGATIONSETTINGS_H + +/** + * @} + * @} + */ \ No newline at end of file diff --git a/flight/OpenPilot/UAVObjects/inc/objectpersistence.h b/flight/OpenPilot/UAVObjects/inc/objectpersistence.h index 402494b1a..837a75afe 100644 --- a/flight/OpenPilot/UAVObjects/inc/objectpersistence.h +++ b/flight/OpenPilot/UAVObjects/inc/objectpersistence.h @@ -1,5 +1,13 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup ObjectPersistence ObjectPersistence + * @brief Someone who knows please enter this + * + * Autogenerated files and functions for ObjectPersistence Object + + * @{ * * @file objectpersistence.h * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -41,6 +49,11 @@ #define OBJECTPERSISTENCE_NUMBYTES sizeof(ObjectPersistenceData) // Object access macros +/** + * @function ObjectPersistenceGet(dataOut) + * @brief Populate a ObjectPersistenceData object + * @param[out] dataOut + */ #define ObjectPersistenceGet(dataOut) UAVObjGetData(ObjectPersistenceHandle(), dataOut) #define ObjectPersistenceSet(dataIn) UAVObjSetData(ObjectPersistenceHandle(), dataIn) #define ObjectPersistenceInstGet(instId, dataOut) UAVObjGetInstanceData(ObjectPersistenceHandle(), instId, dataOut) @@ -54,6 +67,7 @@ #define ObjectPersistenceInstUpdated(instId) UAVObjUpdated(ObjectPersistenceHandle(), instId) #define ObjectPersistenceGetMetadata(dataOut) UAVObjGetMetadata(ObjectPersistenceHandle(), dataOut) #define ObjectPersistenceSetMetadata(dataIn) UAVObjSetMetadata(ObjectPersistenceHandle(), dataIn) +#define ObjectPersistenceReadOnly(dataIn) UAVObjReadOnly(ObjectPersistenceHandle(), dataIn) // Object data typedef struct { @@ -80,3 +94,8 @@ int32_t ObjectPersistenceInitialize(); UAVObjHandle ObjectPersistenceHandle(); #endif // OBJECTPERSISTENCE_H + +/** + * @} + * @} + */ \ No newline at end of file diff --git a/flight/OpenPilot/UAVObjects/inc/positionactual.h b/flight/OpenPilot/UAVObjects/inc/positionactual.h index 367316048..259e66179 100644 --- a/flight/OpenPilot/UAVObjects/inc/positionactual.h +++ b/flight/OpenPilot/UAVObjects/inc/positionactual.h @@ -1,5 +1,13 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup PositionActual PositionActual + * @brief Deprecated for GPS position. + * + * Autogenerated files and functions for PositionActual Object + + * @{ * * @file positionactual.h * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -41,6 +49,11 @@ #define POSITIONACTUAL_NUMBYTES sizeof(PositionActualData) // Object access macros +/** + * @function PositionActualGet(dataOut) + * @brief Populate a PositionActualData object + * @param[out] dataOut + */ #define PositionActualGet(dataOut) UAVObjGetData(PositionActualHandle(), dataOut) #define PositionActualSet(dataIn) UAVObjSetData(PositionActualHandle(), dataIn) #define PositionActualInstGet(instId, dataOut) UAVObjGetInstanceData(PositionActualHandle(), instId, dataOut) @@ -54,6 +67,7 @@ #define PositionActualInstUpdated(instId) UAVObjUpdated(PositionActualHandle(), instId) #define PositionActualGetMetadata(dataOut) UAVObjGetMetadata(PositionActualHandle(), dataOut) #define PositionActualSetMetadata(dataIn) UAVObjSetMetadata(PositionActualHandle(), dataIn) +#define PositionActualReadOnly(dataIn) UAVObjReadOnly(PositionActualHandle(), dataIn) // Object data typedef struct { @@ -92,3 +106,8 @@ int32_t PositionActualInitialize(); UAVObjHandle PositionActualHandle(); #endif // POSITIONACTUAL_H + +/** + * @} + * @} + */ \ No newline at end of file diff --git a/flight/OpenPilot/UAVObjects/inc/stabilizationsettings.h b/flight/OpenPilot/UAVObjects/inc/stabilizationsettings.h index cc5a57409..27e35021e 100644 --- a/flight/OpenPilot/UAVObjects/inc/stabilizationsettings.h +++ b/flight/OpenPilot/UAVObjects/inc/stabilizationsettings.h @@ -1,5 +1,13 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup StabilizationSettings StabilizationSettings + * @brief PID settings used by the Stabilization module to combine the @ref AttitudeActual and @ref AttitudeDesired to compute @ref ActuatorDesired + * + * Autogenerated files and functions for StabilizationSettings Object + + * @{ * * @file stabilizationsettings.h * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -41,6 +49,11 @@ #define STABILIZATIONSETTINGS_NUMBYTES sizeof(StabilizationSettingsData) // Object access macros +/** + * @function StabilizationSettingsGet(dataOut) + * @brief Populate a StabilizationSettingsData object + * @param[out] dataOut + */ #define StabilizationSettingsGet(dataOut) UAVObjGetData(StabilizationSettingsHandle(), dataOut) #define StabilizationSettingsSet(dataIn) UAVObjSetData(StabilizationSettingsHandle(), dataIn) #define StabilizationSettingsInstGet(instId, dataOut) UAVObjGetInstanceData(StabilizationSettingsHandle(), instId, dataOut) @@ -54,6 +67,7 @@ #define StabilizationSettingsInstUpdated(instId) UAVObjUpdated(StabilizationSettingsHandle(), instId) #define StabilizationSettingsGetMetadata(dataOut) UAVObjGetMetadata(StabilizationSettingsHandle(), dataOut) #define StabilizationSettingsSetMetadata(dataIn) UAVObjSetMetadata(StabilizationSettingsHandle(), dataIn) +#define StabilizationSettingsReadOnly(dataIn) UAVObjReadOnly(StabilizationSettingsHandle(), dataIn) // Object data typedef struct { @@ -94,3 +108,8 @@ int32_t StabilizationSettingsInitialize(); UAVObjHandle StabilizationSettingsHandle(); #endif // STABILIZATIONSETTINGS_H + +/** + * @} + * @} + */ \ No newline at end of file diff --git a/flight/OpenPilot/UAVObjects/inc/systemalarms.h b/flight/OpenPilot/UAVObjects/inc/systemalarms.h index 2749139ca..d654aa64d 100644 --- a/flight/OpenPilot/UAVObjects/inc/systemalarms.h +++ b/flight/OpenPilot/UAVObjects/inc/systemalarms.h @@ -1,5 +1,13 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup SystemAlarms SystemAlarms + * @brief Alarms from OpenPilot to indicate failure conditions or warnings. Set by various modules. + * + * Autogenerated files and functions for SystemAlarms Object + + * @{ * * @file systemalarms.h * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -41,6 +49,11 @@ #define SYSTEMALARMS_NUMBYTES sizeof(SystemAlarmsData) // Object access macros +/** + * @function SystemAlarmsGet(dataOut) + * @brief Populate a SystemAlarmsData object + * @param[out] dataOut + */ #define SystemAlarmsGet(dataOut) UAVObjGetData(SystemAlarmsHandle(), dataOut) #define SystemAlarmsSet(dataIn) UAVObjSetData(SystemAlarmsHandle(), dataIn) #define SystemAlarmsInstGet(instId, dataOut) UAVObjGetInstanceData(SystemAlarmsHandle(), instId, dataOut) @@ -54,6 +67,7 @@ #define SystemAlarmsInstUpdated(instId) UAVObjUpdated(SystemAlarmsHandle(), instId) #define SystemAlarmsGetMetadata(dataOut) UAVObjGetMetadata(SystemAlarmsHandle(), dataOut) #define SystemAlarmsSetMetadata(dataIn) UAVObjSetMetadata(SystemAlarmsHandle(), dataIn) +#define SystemAlarmsReadOnly(dataIn) UAVObjReadOnly(SystemAlarmsHandle(), dataIn) // Object data typedef struct { @@ -76,3 +90,8 @@ int32_t SystemAlarmsInitialize(); UAVObjHandle SystemAlarmsHandle(); #endif // SYSTEMALARMS_H + +/** + * @} + * @} + */ \ No newline at end of file diff --git a/flight/OpenPilot/UAVObjects/inc/systemsettings.h b/flight/OpenPilot/UAVObjects/inc/systemsettings.h index 9e32dce66..0245daab1 100644 --- a/flight/OpenPilot/UAVObjects/inc/systemsettings.h +++ b/flight/OpenPilot/UAVObjects/inc/systemsettings.h @@ -1,5 +1,13 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup SystemSettings SystemSettings + * @brief Select airframe type. Currently used by @ref ActuatorModule to choose mixing from @ref ActuatorDesired to @ref ActuatorCommand + * + * Autogenerated files and functions for SystemSettings Object + + * @{ * * @file systemsettings.h * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -41,6 +49,11 @@ #define SYSTEMSETTINGS_NUMBYTES sizeof(SystemSettingsData) // Object access macros +/** + * @function SystemSettingsGet(dataOut) + * @brief Populate a SystemSettingsData object + * @param[out] dataOut + */ #define SystemSettingsGet(dataOut) UAVObjGetData(SystemSettingsHandle(), dataOut) #define SystemSettingsSet(dataIn) UAVObjSetData(SystemSettingsHandle(), dataIn) #define SystemSettingsInstGet(instId, dataOut) UAVObjGetInstanceData(SystemSettingsHandle(), instId, dataOut) @@ -54,6 +67,7 @@ #define SystemSettingsInstUpdated(instId) UAVObjUpdated(SystemSettingsHandle(), instId) #define SystemSettingsGetMetadata(dataOut) UAVObjGetMetadata(SystemSettingsHandle(), dataOut) #define SystemSettingsSetMetadata(dataIn) UAVObjSetMetadata(SystemSettingsHandle(), dataIn) +#define SystemSettingsReadOnly(dataIn) UAVObjReadOnly(SystemSettingsHandle(), dataIn) // Object data typedef struct { @@ -72,3 +86,8 @@ int32_t SystemSettingsInitialize(); UAVObjHandle SystemSettingsHandle(); #endif // SYSTEMSETTINGS_H + +/** + * @} + * @} + */ \ No newline at end of file diff --git a/flight/OpenPilot/UAVObjects/inc/systemstats.h b/flight/OpenPilot/UAVObjects/inc/systemstats.h index 127df6361..d4ae4d087 100644 --- a/flight/OpenPilot/UAVObjects/inc/systemstats.h +++ b/flight/OpenPilot/UAVObjects/inc/systemstats.h @@ -1,5 +1,13 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup SystemStats SystemStats + * @brief CPU and memory usage from OpenPilot computer. + * + * Autogenerated files and functions for SystemStats Object + + * @{ * * @file systemstats.h * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -41,6 +49,11 @@ #define SYSTEMSTATS_NUMBYTES sizeof(SystemStatsData) // Object access macros +/** + * @function SystemStatsGet(dataOut) + * @brief Populate a SystemStatsData object + * @param[out] dataOut + */ #define SystemStatsGet(dataOut) UAVObjGetData(SystemStatsHandle(), dataOut) #define SystemStatsSet(dataIn) UAVObjSetData(SystemStatsHandle(), dataIn) #define SystemStatsInstGet(instId, dataOut) UAVObjGetInstanceData(SystemStatsHandle(), instId, dataOut) @@ -54,6 +67,7 @@ #define SystemStatsInstUpdated(instId) UAVObjUpdated(SystemStatsHandle(), instId) #define SystemStatsGetMetadata(dataOut) UAVObjGetMetadata(SystemStatsHandle(), dataOut) #define SystemStatsSetMetadata(dataIn) UAVObjSetMetadata(SystemStatsHandle(), dataIn) +#define SystemStatsReadOnly(dataIn) UAVObjReadOnly(SystemStatsHandle(), dataIn) // Object data typedef struct { @@ -74,3 +88,8 @@ int32_t SystemStatsInitialize(); UAVObjHandle SystemStatsHandle(); #endif // SYSTEMSTATS_H + +/** + * @} + * @} + */ \ No newline at end of file diff --git a/flight/OpenPilot/UAVObjects/inc/telemetrysettings.h b/flight/OpenPilot/UAVObjects/inc/telemetrysettings.h index 648015646..9493f773e 100644 --- a/flight/OpenPilot/UAVObjects/inc/telemetrysettings.h +++ b/flight/OpenPilot/UAVObjects/inc/telemetrysettings.h @@ -1,5 +1,13 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup TelemetrySettings TelemetrySettings + * @brief Select baud rate of telemetry. Warning - this must match your modem. + * + * Autogenerated files and functions for TelemetrySettings Object + + * @{ * * @file telemetrysettings.h * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -41,6 +49,11 @@ #define TELEMETRYSETTINGS_NUMBYTES sizeof(TelemetrySettingsData) // Object access macros +/** + * @function TelemetrySettingsGet(dataOut) + * @brief Populate a TelemetrySettingsData object + * @param[out] dataOut + */ #define TelemetrySettingsGet(dataOut) UAVObjGetData(TelemetrySettingsHandle(), dataOut) #define TelemetrySettingsSet(dataIn) UAVObjSetData(TelemetrySettingsHandle(), dataIn) #define TelemetrySettingsInstGet(instId, dataOut) UAVObjGetInstanceData(TelemetrySettingsHandle(), instId, dataOut) @@ -54,6 +67,7 @@ #define TelemetrySettingsInstUpdated(instId) UAVObjUpdated(TelemetrySettingsHandle(), instId) #define TelemetrySettingsGetMetadata(dataOut) UAVObjGetMetadata(TelemetrySettingsHandle(), dataOut) #define TelemetrySettingsSetMetadata(dataIn) UAVObjSetMetadata(TelemetrySettingsHandle(), dataIn) +#define TelemetrySettingsReadOnly(dataIn) UAVObjReadOnly(TelemetrySettingsHandle(), dataIn) // Object data typedef struct { @@ -72,3 +86,8 @@ int32_t TelemetrySettingsInitialize(); UAVObjHandle TelemetrySettingsHandle(); #endif // TELEMETRYSETTINGS_H + +/** + * @} + * @} + */ \ No newline at end of file diff --git a/flight/OpenPilot/UAVObjects/inc/uavobjectmanager.h b/flight/OpenPilot/UAVObjects/inc/uavobjectmanager.h index 558574f71..b989b92ac 100644 --- a/flight/OpenPilot/UAVObjects/inc/uavobjectmanager.h +++ b/flight/OpenPilot/UAVObjects/inc/uavobjectmanager.h @@ -1,5 +1,11 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup UAV Object Manager + * @brief The core UAV Objects functions, most of which are wrappered by + * autogenerated defines + * @{ * * @file uavobjectmanager.h * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -145,6 +151,7 @@ int32_t UAVObjSetInstanceData(UAVObjHandle obj, uint16_t instId, const void* dat int32_t UAVObjGetInstanceData(UAVObjHandle obj, uint16_t instId, void* dataOut); int32_t UAVObjSetMetadata(UAVObjHandle obj, const UAVObjMetadata* dataIn); int32_t UAVObjGetMetadata(UAVObjHandle obj, UAVObjMetadata* dataOut); +int8_t UAVObjReadOnly(UAVObjHandle obj); int32_t UAVObjConnectQueue(UAVObjHandle obj, xQueueHandle queue, int32_t eventMask); int32_t UAVObjDisconnectQueue(UAVObjHandle obj, xQueueHandle queue); int32_t UAVObjConnectCallback(UAVObjHandle obj, UAVObjEventCallback cb, int32_t eventMask); @@ -156,3 +163,8 @@ void UAVObjInstanceUpdated(UAVObjHandle obj, uint16_t instId); void UAVObjIterate(void (*iterator)(UAVObjHandle obj)); #endif // UAVOBJECTMANAGER_H + +/** + * @} + * @} + */ diff --git a/flight/OpenPilot/UAVObjects/inc/uavobjecttemplate.h b/flight/OpenPilot/UAVObjects/inc/uavobjecttemplate.h index 595fc686c..b16cd996f 100644 --- a/flight/OpenPilot/UAVObjects/inc/uavobjecttemplate.h +++ b/flight/OpenPilot/UAVObjects/inc/uavobjecttemplate.h @@ -1,5 +1,13 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup $(NAME) $(NAME) + * @brief $(DESCRIPTION) + * + * Autogenerated files and functions for $(NAME) Object + + * @{ * * @file $(NAMELC).h * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -41,6 +49,11 @@ #define $(NAMEUC)_NUMBYTES sizeof($(NAME)Data) // Object access macros +/** + * @function $(NAME)Get(dataOut) + * @brief Populate a $(NAME)Data object + * @param[out] dataOut + */ #define $(NAME)Get(dataOut) UAVObjGetData($(NAME)Handle(), dataOut) #define $(NAME)Set(dataIn) UAVObjSetData($(NAME)Handle(), dataIn) #define $(NAME)InstGet(instId, dataOut) UAVObjGetInstanceData($(NAME)Handle(), instId, dataOut) @@ -54,6 +67,7 @@ #define $(NAME)InstUpdated(instId) UAVObjUpdated($(NAME)Handle(), instId) #define $(NAME)GetMetadata(dataOut) UAVObjGetMetadata($(NAME)Handle(), dataOut) #define $(NAME)SetMetadata(dataIn) UAVObjSetMetadata($(NAME)Handle(), dataIn) +#define $(NAME)ReadOnly(dataIn) UAVObjReadOnly($(NAME)Handle(), dataIn) // Object data typedef struct { @@ -68,3 +82,8 @@ int32_t $(NAME)Initialize(); UAVObjHandle $(NAME)Handle(); #endif // $(NAMEUC)_H + +/** + * @} + * @} + */ \ No newline at end of file diff --git a/flight/OpenPilot/UAVObjects/manualcontrolcommand.c b/flight/OpenPilot/UAVObjects/manualcontrolcommand.c index 4e3b7f424..36ac279d1 100644 --- a/flight/OpenPilot/UAVObjects/manualcontrolcommand.c +++ b/flight/OpenPilot/UAVObjects/manualcontrolcommand.c @@ -1,5 +1,12 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup ManualControlCommand ManualControlCommand + * @brief The output from the @ref ManualControlModule which descodes the receiver inputs. Overriden by GCS for fly-by-wire control. + * + * Autogenerated files and functions for ManualControlCommand Object + * @{ * * @file manualcontrolcommand.c * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -98,5 +105,7 @@ UAVObjHandle ManualControlCommandHandle() return handle; } - +/** + * @} + */ diff --git a/flight/OpenPilot/UAVObjects/manualcontrolsettings.c b/flight/OpenPilot/UAVObjects/manualcontrolsettings.c index b56a48bfb..b7964fa3b 100644 --- a/flight/OpenPilot/UAVObjects/manualcontrolsettings.c +++ b/flight/OpenPilot/UAVObjects/manualcontrolsettings.c @@ -1,5 +1,12 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup ManualControlSettings ManualControlSettings + * @brief Settings to indicate how to decode receiver input by @ref ManualControlModule. + * + * Autogenerated files and functions for ManualControlSettings Object + * @{ * * @file manualcontrolsettings.c * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -128,5 +135,7 @@ UAVObjHandle ManualControlSettingsHandle() return handle; } - +/** + * @} + */ diff --git a/flight/OpenPilot/UAVObjects/navigationdesired.c b/flight/OpenPilot/UAVObjects/navigationdesired.c index 46d4b8330..445237db1 100644 --- a/flight/OpenPilot/UAVObjects/navigationdesired.c +++ b/flight/OpenPilot/UAVObjects/navigationdesired.c @@ -1,5 +1,12 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup NavigationDesired NavigationDesired + * @brief Currently unused + * + * Autogenerated files and functions for NavigationDesired Object + * @{ * * @file navigationdesired.c * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -98,5 +105,7 @@ UAVObjHandle NavigationDesiredHandle() return handle; } - +/** + * @} + */ diff --git a/flight/OpenPilot/UAVObjects/navigationsettings.c b/flight/OpenPilot/UAVObjects/navigationsettings.c index c425cca10..c4181af3d 100644 --- a/flight/OpenPilot/UAVObjects/navigationsettings.c +++ b/flight/OpenPilot/UAVObjects/navigationsettings.c @@ -1,5 +1,12 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup NavigationSettings NavigationSettings + * @brief Settings for Navigation. Currently unused. + * + * Autogenerated files and functions for NavigationSettings Object + * @{ * * @file navigationsettings.c * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -106,5 +113,7 @@ UAVObjHandle NavigationSettingsHandle() return handle; } - +/** + * @} + */ diff --git a/flight/OpenPilot/UAVObjects/objectpersistence.c b/flight/OpenPilot/UAVObjects/objectpersistence.c index 30bab9a69..22a805f22 100644 --- a/flight/OpenPilot/UAVObjects/objectpersistence.c +++ b/flight/OpenPilot/UAVObjects/objectpersistence.c @@ -1,5 +1,12 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup ObjectPersistence ObjectPersistence + * @brief Someone who knows please enter this + * + * Autogenerated files and functions for ObjectPersistence Object + * @{ * * @file objectpersistence.c * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -98,5 +105,7 @@ UAVObjHandle ObjectPersistenceHandle() return handle; } - +/** + * @} + */ diff --git a/flight/OpenPilot/UAVObjects/positionactual.c b/flight/OpenPilot/UAVObjects/positionactual.c index f5d991e77..3a293dafc 100644 --- a/flight/OpenPilot/UAVObjects/positionactual.c +++ b/flight/OpenPilot/UAVObjects/positionactual.c @@ -1,5 +1,12 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup PositionActual PositionActual + * @brief Deprecated for GPS position. + * + * Autogenerated files and functions for PositionActual Object + * @{ * * @file positionactual.c * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -98,5 +105,7 @@ UAVObjHandle PositionActualHandle() return handle; } - +/** + * @} + */ diff --git a/flight/OpenPilot/UAVObjects/stabilizationsettings.c b/flight/OpenPilot/UAVObjects/stabilizationsettings.c index 6c753b963..84003806e 100644 --- a/flight/OpenPilot/UAVObjects/stabilizationsettings.c +++ b/flight/OpenPilot/UAVObjects/stabilizationsettings.c @@ -1,5 +1,12 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup StabilizationSettings StabilizationSettings + * @brief PID settings used by the Stabilization module to combine the @ref AttitudeActual and @ref AttitudeDesired to compute @ref ActuatorDesired + * + * Autogenerated files and functions for StabilizationSettings Object + * @{ * * @file stabilizationsettings.c * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -111,5 +118,7 @@ UAVObjHandle StabilizationSettingsHandle() return handle; } - +/** + * @} + */ diff --git a/flight/OpenPilot/UAVObjects/systemalarms.c b/flight/OpenPilot/UAVObjects/systemalarms.c index a83fa32d5..4f56abd51 100644 --- a/flight/OpenPilot/UAVObjects/systemalarms.c +++ b/flight/OpenPilot/UAVObjects/systemalarms.c @@ -1,5 +1,12 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup SystemAlarms SystemAlarms + * @brief Alarms from OpenPilot to indicate failure conditions or warnings. Set by various modules. + * + * Autogenerated files and functions for SystemAlarms Object + * @{ * * @file systemalarms.c * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -98,5 +105,7 @@ UAVObjHandle SystemAlarmsHandle() return handle; } - +/** + * @} + */ diff --git a/flight/OpenPilot/UAVObjects/systemsettings.c b/flight/OpenPilot/UAVObjects/systemsettings.c index 307dbcc9e..60f6082e3 100644 --- a/flight/OpenPilot/UAVObjects/systemsettings.c +++ b/flight/OpenPilot/UAVObjects/systemsettings.c @@ -1,5 +1,12 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup SystemSettings SystemSettings + * @brief Select airframe type. Currently used by @ref ActuatorModule to choose mixing from @ref ActuatorDesired to @ref ActuatorCommand + * + * Autogenerated files and functions for SystemSettings Object + * @{ * * @file systemsettings.c * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -99,5 +106,7 @@ UAVObjHandle SystemSettingsHandle() return handle; } - +/** + * @} + */ diff --git a/flight/OpenPilot/UAVObjects/systemstats.c b/flight/OpenPilot/UAVObjects/systemstats.c index 7c60bcfd3..7a28a2f2a 100644 --- a/flight/OpenPilot/UAVObjects/systemstats.c +++ b/flight/OpenPilot/UAVObjects/systemstats.c @@ -1,5 +1,12 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup SystemStats SystemStats + * @brief CPU and memory usage from OpenPilot computer. + * + * Autogenerated files and functions for SystemStats Object + * @{ * * @file systemstats.c * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -98,5 +105,7 @@ UAVObjHandle SystemStatsHandle() return handle; } - +/** + * @} + */ diff --git a/flight/OpenPilot/UAVObjects/telemetrysettings.c b/flight/OpenPilot/UAVObjects/telemetrysettings.c index 18c7b2131..b936a9987 100644 --- a/flight/OpenPilot/UAVObjects/telemetrysettings.c +++ b/flight/OpenPilot/UAVObjects/telemetrysettings.c @@ -1,5 +1,12 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup TelemetrySettings TelemetrySettings + * @brief Select baud rate of telemetry. Warning - this must match your modem. + * + * Autogenerated files and functions for TelemetrySettings Object + * @{ * * @file telemetrysettings.c * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -99,5 +106,7 @@ UAVObjHandle TelemetrySettingsHandle() return handle; } - +/** + * @} + */ diff --git a/flight/OpenPilot/UAVObjects/uavobjectmanager.c b/flight/OpenPilot/UAVObjects/uavobjectmanager.c index 4b4261381..27c1a64eb 100644 --- a/flight/OpenPilot/UAVObjects/uavobjectmanager.c +++ b/flight/OpenPilot/UAVObjects/uavobjectmanager.c @@ -1,5 +1,12 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup UAV Object Manager + * @brief The core UAV Objects functions, most of which are wrappered by + * autogenerated defines + * @{ + * * * @file uavobjectmanager.h * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -1129,6 +1136,31 @@ int32_t UAVObjGetMetadata(UAVObjHandle obj, UAVObjMetadata* dataOut) return 0; } +/** + * Check if an object is read only + * \param[in] obj The object handle + * \return + * \arg 0 if not read only + * \arg 1 if read only + * \arg -1 if unable to get meta data + */ +int8_t UAVObjReadOnly(UAVObjHandle obj) +{ + ObjectList* objEntry; + UAVObjMetadata* mdata; + + // Cast to object info + objEntry = (ObjectList*)obj; + + // Check access level + if ( !objEntry->isMetaobject ) + { + mdata = (UAVObjMetadata*)(objEntry->linkedObj->instances->data); + return mdata->access == ACCESS_READONLY; + } + return -1; +} + /** * Connect an event queue to the object, if the queue is already connected then the event mask is only updated. * All events matching the event mask will be pushed to the event queue. diff --git a/flight/OpenPilot/UAVObjects/uavobjecttemplate.c b/flight/OpenPilot/UAVObjects/uavobjecttemplate.c index 78f540332..60f48eb6b 100644 --- a/flight/OpenPilot/UAVObjects/uavobjecttemplate.c +++ b/flight/OpenPilot/UAVObjects/uavobjecttemplate.c @@ -1,5 +1,12 @@ /** ****************************************************************************** + * @addtogroup UAVObjects OpenPilot UAVObjects + * @{ + * @addtogroup $(NAME) $(NAME) + * @brief $(DESCRIPTION) + * + * Autogenerated files and functions for $(NAME) Object + * @{ * * @file $(NAMELC).c * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. @@ -98,5 +105,7 @@ UAVObjHandle $(NAME)Handle() return handle; } - +/** + * @} + */ diff --git a/ground/src/libs/uavobjgenerator/uavobjectparser.cpp b/ground/src/libs/uavobjgenerator/uavobjectparser.cpp index 1b6ab6cfa..9003514e5 100644 --- a/ground/src/libs/uavobjgenerator/uavobjectparser.cpp +++ b/ground/src/libs/uavobjgenerator/uavobjectparser.cpp @@ -147,6 +147,7 @@ QString UAVObjectParser::parseXML(QString& xml, QString& filename) bool telGCSFound = false; bool telFlightFound = false; bool logFound = false; + bool descriptionFound = false; while ( !childNode.isNull() ) { // Process element depending on its type @@ -198,6 +199,15 @@ QString UAVObjectParser::parseXML(QString& xml, QString& filename) } logFound = true; } + else if ( childNode.nodeName().compare(QString("description")) == 0 ) + { + QString status = processObjectDescription(childNode, &info->description); + if (!status.isNull()) + { + return status; + } + descriptionFound = true; + } else { return QString("Unknown object element"); @@ -224,6 +234,12 @@ QString UAVObjectParser::parseXML(QString& xml, QString& filename) return QString("Object::logging element is missing"); } + // TODO: Make into error once all objects updated + if ( !descriptionFound ) + { + return QString("Object::description element is missing"); + } + // Calculate ID calculateID(info); @@ -580,6 +596,16 @@ QString UAVObjectParser::processObjectAttributes(QDomNode& node, ObjectInfo* inf return QString(); } +/** + * Process the description field from the XML file + */ +QString UAVObjectParser::processObjectDescription(QDomNode& childNode, QString * description) +{ + description->append(childNode.firstChild().nodeValue()); + return QString(); +} + + /** * Replace all the common tags from the template file with actual object * information. @@ -593,6 +619,8 @@ void UAVObjectParser::replaceCommonTags(QString& out, ObjectInfo* info) out.replace(QString("$(NAME)"), info->name); // Replace $(NAMELC) tag out.replace(QString("$(NAMELC)"), info->name.toLower()); + // Replace $(DESCRIPTION) tag + out.replace(QString("$(DESCRIPTION)"), info->description); // Replace $(NAMEUC) tag out.replace(QString("$(NAMEUC)"), info->name.toUpper()); // Replace $(OBJID) tag diff --git a/ground/src/libs/uavobjgenerator/uavobjectparser.h b/ground/src/libs/uavobjgenerator/uavobjectparser.h index 475449a01..18377ba3a 100644 --- a/ground/src/libs/uavobjgenerator/uavobjectparser.h +++ b/ground/src/libs/uavobjgenerator/uavobjectparser.h @@ -90,7 +90,8 @@ public: int gcsTelemetryUpdatePeriod; /** Update period used by the GCS (only if telemetry mode is PERIODIC) */ UpdateMode loggingUpdateMode; /** Update mode used by the logging module (UpdateMode) */ int loggingUpdatePeriod; /** Update period used by the logging module (only if logging mode is PERIODIC) */ - QList fields; + QList fields; /** The data fields for the object **/ + QString description; /** Description used for Doxygen **/ } ObjectInfo; // Functions @@ -122,6 +123,7 @@ private: QString processObjectAttributes(QDomNode& node, ObjectInfo* info); QString processObjectFields(QDomNode& childNode, ObjectInfo* info); QString processObjectAccess(QDomNode& childNode, ObjectInfo* info); + QString processObjectDescription(QDomNode& childNode, QString * description); QString processObjectMetadata(QDomNode& childNode, UpdateMode* mode, int* period, bool* acked); void calculateID(ObjectInfo* info); quint32 updateHash(quint32 value, quint32 hash); diff --git a/ground/src/shared/uavobjectdefinition/actuatorcommand.xml b/ground/src/shared/uavobjectdefinition/actuatorcommand.xml index 1b74ee8d3..56ff36370 100644 --- a/ground/src/shared/uavobjectdefinition/actuatorcommand.xml +++ b/ground/src/shared/uavobjectdefinition/actuatorcommand.xml @@ -1,9 +1,10 @@ - - - - - - - + + Contains the pulse duration sent to each of the channels. Set by @ref ActuatorModule + + + + + + diff --git a/ground/src/shared/uavobjectdefinition/actuatordesired.xml b/ground/src/shared/uavobjectdefinition/actuatordesired.xml index 181dc8c5f..79b6a5e40 100644 --- a/ground/src/shared/uavobjectdefinition/actuatordesired.xml +++ b/ground/src/shared/uavobjectdefinition/actuatordesired.xml @@ -1,12 +1,13 @@ - - - - - - - - - - + + Desired raw, pitch and yaw actuator settings. Comes from either @ref StabilizationModule or @ref ManualControlModule depending on FlightMode. + + + + + + + + + diff --git a/ground/src/shared/uavobjectdefinition/actuatorsettings.xml b/ground/src/shared/uavobjectdefinition/actuatorsettings.xml index cbc8bafd4..e09571586 100644 --- a/ground/src/shared/uavobjectdefinition/actuatorsettings.xml +++ b/ground/src/shared/uavobjectdefinition/actuatorsettings.xml @@ -1,42 +1,43 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + Settings for the @ref ActuatorModule that controls the channel assignments for the mixer based on AircraftType + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/ground/src/shared/uavobjectdefinition/ahrscalibration.xml b/ground/src/shared/uavobjectdefinition/ahrscalibration.xml index cbe9af266..a743663ce 100644 --- a/ground/src/shared/uavobjectdefinition/ahrscalibration.xml +++ b/ground/src/shared/uavobjectdefinition/ahrscalibration.xml @@ -1,5 +1,6 @@ + Contains the calibration settings for the @ref AHRSCommsModule diff --git a/ground/src/shared/uavobjectdefinition/ahrssettings.xml b/ground/src/shared/uavobjectdefinition/ahrssettings.xml index 01131ec7d..a94a527e1 100644 --- a/ground/src/shared/uavobjectdefinition/ahrssettings.xml +++ b/ground/src/shared/uavobjectdefinition/ahrssettings.xml @@ -1,12 +1,13 @@ - - - - - - - - - - + + Settings for the @ref AHRSCommsModule to control the algorithm and what is updated + + + + + + + + + diff --git a/ground/src/shared/uavobjectdefinition/ahrsstatus.xml b/ground/src/shared/uavobjectdefinition/ahrsstatus.xml index db1425d5d..f435fadab 100644 --- a/ground/src/shared/uavobjectdefinition/ahrsstatus.xml +++ b/ground/src/shared/uavobjectdefinition/ahrsstatus.xml @@ -1,13 +1,14 @@ - - - - - - - - - - - + + Status for the @ref AHRSCommsModule, including communication errors + + + + + + + + + + diff --git a/ground/src/shared/uavobjectdefinition/attitudeactual.xml b/ground/src/shared/uavobjectdefinition/attitudeactual.xml index 748c3dbf1..400e4d5da 100644 --- a/ground/src/shared/uavobjectdefinition/attitudeactual.xml +++ b/ground/src/shared/uavobjectdefinition/attitudeactual.xml @@ -1,15 +1,16 @@ - - - - - - - - - - - - - + + The updated Attitude estimation from @ref AHRSCommsModule. + + + + + + + + + + + + diff --git a/ground/src/shared/uavobjectdefinition/attitudedesired.xml b/ground/src/shared/uavobjectdefinition/attitudedesired.xml index d75103ffe..a664aa90b 100644 --- a/ground/src/shared/uavobjectdefinition/attitudedesired.xml +++ b/ground/src/shared/uavobjectdefinition/attitudedesired.xml @@ -1,12 +1,13 @@ - - - - - - - - - - + + The desired attitude that @ref StabilizationModule will try and achieve if FlightMode is Stabilized. Comes from @ref ManaulControlModule. + + + + + + + + + diff --git a/ground/src/shared/uavobjectdefinition/attituderaw.xml b/ground/src/shared/uavobjectdefinition/attituderaw.xml index 2b94af96f..3e1e5e8f5 100644 --- a/ground/src/shared/uavobjectdefinition/attituderaw.xml +++ b/ground/src/shared/uavobjectdefinition/attituderaw.xml @@ -1,14 +1,15 @@ - - - - - - - - - - - - + + The raw attitude sensor data from @ref AHRSCommsModule. Not always updated. + + + + + + + + + + + diff --git a/ground/src/shared/uavobjectdefinition/baroaltitude.xml b/ground/src/shared/uavobjectdefinition/baroaltitude.xml index b2c0a672f..aeabfc68c 100644 --- a/ground/src/shared/uavobjectdefinition/baroaltitude.xml +++ b/ground/src/shared/uavobjectdefinition/baroaltitude.xml @@ -1,11 +1,12 @@ - - - - - - - - - + + The raw data from the barometric sensor with pressure, temperature and altitude estimate. + + + + + + + + diff --git a/ground/src/shared/uavobjectdefinition/exampleobject1.xml b/ground/src/shared/uavobjectdefinition/exampleobject1.xml index 68f04098a..5d97d8824 100644 --- a/ground/src/shared/uavobjectdefinition/exampleobject1.xml +++ b/ground/src/shared/uavobjectdefinition/exampleobject1.xml @@ -1,16 +1,17 @@ - - - - - - - - - - - - - + + Example object + + + + + + + + + + + + diff --git a/ground/src/shared/uavobjectdefinition/exampleobject2.xml b/ground/src/shared/uavobjectdefinition/exampleobject2.xml index 3b77d1e5f..08236bbfb 100644 --- a/ground/src/shared/uavobjectdefinition/exampleobject2.xml +++ b/ground/src/shared/uavobjectdefinition/exampleobject2.xml @@ -1,12 +1,13 @@ - - - - - - - - + Example object + + + + + + + + diff --git a/ground/src/shared/uavobjectdefinition/examplesettings.xml b/ground/src/shared/uavobjectdefinition/examplesettings.xml index c270fcfa8..2fec671c7 100644 --- a/ground/src/shared/uavobjectdefinition/examplesettings.xml +++ b/ground/src/shared/uavobjectdefinition/examplesettings.xml @@ -1,11 +1,12 @@ - - - - - - - + Example settings object + + + + + + + diff --git a/ground/src/shared/uavobjectdefinition/flightbatterystate.xml b/ground/src/shared/uavobjectdefinition/flightbatterystate.xml index 429eb2d6e..b4e781e00 100644 --- a/ground/src/shared/uavobjectdefinition/flightbatterystate.xml +++ b/ground/src/shared/uavobjectdefinition/flightbatterystate.xml @@ -1,13 +1,12 @@ - - - - - - - - - - - + + Battery status information. Not currently updated. + + + + + + + + diff --git a/ground/src/shared/uavobjectdefinition/flightsituationactual.xml b/ground/src/shared/uavobjectdefinition/flightsituationactual.xml index 17ecb51f7..f1a59919e 100644 --- a/ground/src/shared/uavobjectdefinition/flightsituationactual.xml +++ b/ground/src/shared/uavobjectdefinition/flightsituationactual.xml @@ -1,17 +1,18 @@ - - - - - - - - - - - - - - - + + Currently unused + + + + + + + + + + + + + + diff --git a/ground/src/shared/uavobjectdefinition/flighttelemetrystats.xml b/ground/src/shared/uavobjectdefinition/flighttelemetrystats.xml index 817c064d7..4baa04666 100644 --- a/ground/src/shared/uavobjectdefinition/flighttelemetrystats.xml +++ b/ground/src/shared/uavobjectdefinition/flighttelemetrystats.xml @@ -1,14 +1,15 @@ - - - - - - - - - - - - + + Maintains the telemetry statistics from the OpenPilot flight computer. + + + + + + + + + + + diff --git a/ground/src/shared/uavobjectdefinition/gcstelemetrystats.xml b/ground/src/shared/uavobjectdefinition/gcstelemetrystats.xml index 25caf6fc5..3f9c74b1b 100644 --- a/ground/src/shared/uavobjectdefinition/gcstelemetrystats.xml +++ b/ground/src/shared/uavobjectdefinition/gcstelemetrystats.xml @@ -1,14 +1,15 @@ - - - - - - - - - - - - + + The telemetry statistics from the ground computer + + + + + + + + + + + diff --git a/ground/src/shared/uavobjectdefinition/gpsposition.xml b/ground/src/shared/uavobjectdefinition/gpsposition.xml index bdec35716..db3479594 100644 --- a/ground/src/shared/uavobjectdefinition/gpsposition.xml +++ b/ground/src/shared/uavobjectdefinition/gpsposition.xml @@ -1,19 +1,20 @@ - - - - - - - - - - - - - - - - + + Future object for the raw GPS data from @ref GPSModule. Only should be used by @ref AHRSCommsModule. + + + + + + + + + + + + + + + diff --git a/ground/src/shared/uavobjectdefinition/homelocation.xml b/ground/src/shared/uavobjectdefinition/homelocation.xml index 434da8040..361f2550f 100644 --- a/ground/src/shared/uavobjectdefinition/homelocation.xml +++ b/ground/src/shared/uavobjectdefinition/homelocation.xml @@ -1,15 +1,16 @@ - - - - - - - - - - - - - + + 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. + + + + + + + + + + + + diff --git a/ground/src/shared/uavobjectdefinition/manualcontrolcommand.xml b/ground/src/shared/uavobjectdefinition/manualcontrolcommand.xml index 7f1362f72..03762d890 100644 --- a/ground/src/shared/uavobjectdefinition/manualcontrolcommand.xml +++ b/ground/src/shared/uavobjectdefinition/manualcontrolcommand.xml @@ -1,15 +1,16 @@ - - - - - - - - - - - - - + + The output from the @ref ManualControlModule which descodes the receiver inputs. Overriden by GCS for fly-by-wire control. + + + + + + + + + + + + diff --git a/ground/src/shared/uavobjectdefinition/manualcontrolsettings.xml b/ground/src/shared/uavobjectdefinition/manualcontrolsettings.xml index 9fa4f8978..06bfc8637 100644 --- a/ground/src/shared/uavobjectdefinition/manualcontrolsettings.xml +++ b/ground/src/shared/uavobjectdefinition/manualcontrolsettings.xml @@ -1,17 +1,18 @@ - - - - - - - - - - - - - - + + Settings to indicate how to decode receiver input by @ref ManualControlModule. + + + + + + + + + + + + + diff --git a/ground/src/shared/uavobjectdefinition/navigationdesired.xml b/ground/src/shared/uavobjectdefinition/navigationdesired.xml index 8eb40e3cf..d5eb17b12 100644 --- a/ground/src/shared/uavobjectdefinition/navigationdesired.xml +++ b/ground/src/shared/uavobjectdefinition/navigationdesired.xml @@ -1,12 +1,13 @@ - - - - - - - - - - + + Currently unused + + + + + + + + + diff --git a/ground/src/shared/uavobjectdefinition/navigationsettings.xml b/ground/src/shared/uavobjectdefinition/navigationsettings.xml index 91e829731..48f7ed6b5 100644 --- a/ground/src/shared/uavobjectdefinition/navigationsettings.xml +++ b/ground/src/shared/uavobjectdefinition/navigationsettings.xml @@ -1,16 +1,17 @@ - - - - - - - - - - - - - + + Settings for Navigation. Currently unused. + + + + + + + + + + + + diff --git a/ground/src/shared/uavobjectdefinition/objectpersistence.xml b/ground/src/shared/uavobjectdefinition/objectpersistence.xml index 9462c0e56..4dc04cd1d 100644 --- a/ground/src/shared/uavobjectdefinition/objectpersistence.xml +++ b/ground/src/shared/uavobjectdefinition/objectpersistence.xml @@ -1,12 +1,13 @@ - - - - - - - - - + + Someone who knows please enter this + + + + + + + + diff --git a/ground/src/shared/uavobjectdefinition/positionactual.xml b/ground/src/shared/uavobjectdefinition/positionactual.xml index 5d7dbfdae..3ce112f1a 100644 --- a/ground/src/shared/uavobjectdefinition/positionactual.xml +++ b/ground/src/shared/uavobjectdefinition/positionactual.xml @@ -1,19 +1,20 @@ - - - - - - - - - - - - - - - - + + Deprecated for GPS position. + + + + + + + + + + + + + + + diff --git a/ground/src/shared/uavobjectdefinition/stabilizationsettings.xml b/ground/src/shared/uavobjectdefinition/stabilizationsettings.xml index 46720250e..ae786e045 100644 --- a/ground/src/shared/uavobjectdefinition/stabilizationsettings.xml +++ b/ground/src/shared/uavobjectdefinition/stabilizationsettings.xml @@ -1,21 +1,22 @@ - - - - - - - - - - - - - - - - - - + + PID settings used by the Stabilization module to combine the @ref AttitudeActual and @ref AttitudeDesired to compute @ref ActuatorDesired + + + + + + + + + + + + + + + + + diff --git a/ground/src/shared/uavobjectdefinition/systemalarms.xml b/ground/src/shared/uavobjectdefinition/systemalarms.xml index 7ad00c25e..c280e79ba 100644 --- a/ground/src/shared/uavobjectdefinition/systemalarms.xml +++ b/ground/src/shared/uavobjectdefinition/systemalarms.xml @@ -1,10 +1,11 @@ - - - - - - - + + Alarms from OpenPilot to indicate failure conditions or warnings. Set by various modules. + + + + + + diff --git a/ground/src/shared/uavobjectdefinition/systemsettings.xml b/ground/src/shared/uavobjectdefinition/systemsettings.xml index 4ab6d0f0d..0b2e2c0ec 100644 --- a/ground/src/shared/uavobjectdefinition/systemsettings.xml +++ b/ground/src/shared/uavobjectdefinition/systemsettings.xml @@ -1,9 +1,10 @@ - - - - - - + + Select airframe type. Currently used by @ref ActuatorModule to choose mixing from @ref ActuatorDesired to @ref ActuatorCommand + + + + + diff --git a/ground/src/shared/uavobjectdefinition/systemstats.xml b/ground/src/shared/uavobjectdefinition/systemstats.xml index 1beb49674..bf98f3587 100644 --- a/ground/src/shared/uavobjectdefinition/systemstats.xml +++ b/ground/src/shared/uavobjectdefinition/systemstats.xml @@ -1,11 +1,12 @@ - - - - - - - - + + CPU and memory usage from OpenPilot computer. + + + + + + + diff --git a/ground/src/shared/uavobjectdefinition/telemetrysettings.xml b/ground/src/shared/uavobjectdefinition/telemetrysettings.xml index 6a742ed7b..e27ae2bbd 100644 --- a/ground/src/shared/uavobjectdefinition/telemetrysettings.xml +++ b/ground/src/shared/uavobjectdefinition/telemetrysettings.xml @@ -1,9 +1,10 @@ - - - - - - + + Select baud rate of telemetry. Warning - this must match your modem. + + + + +