From c1d5f0441c0109a82f6cdeebad5d818fa6eb1fb2 Mon Sep 17 00:00:00 2001 From: Rishabh Date: Thu, 23 Apr 2020 14:45:16 +0530 Subject: [PATCH] Sub: LogMessage Documentation --- ArduSub/Log.cpp | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/ArduSub/Log.cpp b/ArduSub/Log.cpp index 5fb78ec788..01758de082 100644 --- a/ArduSub/Log.cpp +++ b/ArduSub/Log.cpp @@ -257,6 +257,14 @@ void Sub::Log_Write_GuidedTarget(uint8_t target_type, const Vector3f& pos_target // @Field: DCRt: desired climb rate // @Field: CRt: climb rate +// @LoggerMessage: MOTB +// @Description: Battery information +// @Field: TimeUS: Time since system startup +// @Field: LiftMax: Maximum motor compensation gain +// @Field: BatVolt: Ratio betwen detected battery voltage and maximum battery voltage +// @Field: BatRes: Estimated battery resistance +// @Field: ThLimit: Throttle limit set due to battery current limitations + // @LoggerMessage: D16 // @Description: Generic 16-bit-signed-integer storage // @Field: TimeUS: Time since system startup @@ -287,6 +295,17 @@ void Sub::Log_Write_GuidedTarget(uint8_t target_type, const Vector3f& pos_target // @Field: Id: Data type identifier // @Field: Value: Value +// @LoggerMessage: GUID +// @Description: Guided mode target information +// @Field: TimeUS: Time since system startup +// @Field: Type: Type of guided mode +// @Field: pX: Target position, X-Axis +// @Field: pY: Target position, Y-Axis +// @Field: pZ: Target position, Z-Axis +// @Field: vX: Target velocity, X-Axis +// @Field: vY: Target velocity, Y-Axis +// @Field: vZ: Target velocity, Z-Axis + // type and unit information can be found in // libraries/AP_Logger/Logstructure.h; search for "log_Units" for // units and "Format characters" for field type information