From 7f0e722a3381eed4ea978a6d5c97fbbee32f25d0 Mon Sep 17 00:00:00 2001
From: Peter Barker <pbarker@barker.dropbear.id.au>
Date: Wed, 25 Mar 2020 23:33:03 +1100
Subject: [PATCH] AP_Logger: add onboard LogMessage documentation

---
 libraries/AP_Logger/LogStructure.h | 49 ++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)

diff --git a/libraries/AP_Logger/LogStructure.h b/libraries/AP_Logger/LogStructure.h
index f0bb7e7f16..58aaf525e3 100644
--- a/libraries/AP_Logger/LogStructure.h
+++ b/libraries/AP_Logger/LogStructure.h
@@ -1362,6 +1362,13 @@ struct PACKED log_Arm_Disarm {
 // @Field: Format: character string defining the C-storage-type of the fields in this message
 // @Field: Columns: the labels of the message being defined
 
+// @LoggerMessage: FMTU
+// @Description: Message defining units and multipliers used for fields of other messages
+// @Field: TimeUS: microseconds since system startup
+// @Field: FmtType: numeric reference to associated FMT message
+// @Field: UnitIds: each character refers to a UNIT message.  The unit at an offset corresponds to the field at the same offset in FMT.Format
+// @Field: MultIds: each character refers to a MULT message.  The multiplier at an offset corresponds to the field at the same offset in FMT.Format
+
 // @LoggerMessage: GPS
 // @Description: Information received from GNSS systems attached to the autopilot
 // @Field: TimeUS: microseconds since system startup
@@ -1401,6 +1408,12 @@ struct PACKED log_Arm_Disarm {
 // @Field: ModeNum: alias for Mode
 // @Field: Rsn: reason for entering this mode; enumeration value
 
+// @LoggerMessage: MULT
+// @Description: Message mapping from single character to numeric multiplier
+// @Field: TimeUS: microseconds since system startup
+// @Field: Id: character referenced by FMTU
+// @Field: Mult: numeric multiplier
+
 // @LoggerMessage: PIDR,PIDP,PIDY,PIDA,PIDS
 // @Description: Proportional/Integral/Derivative gain values for Roll/Pitch/Yaw/Z/Steering
 // @Field: TimeUS: microseconds since system startup
@@ -1466,6 +1479,42 @@ struct PACKED log_Arm_Disarm {
 // @Field: C13: channel 13 output
 // @Field: C14: channel 14 output
 
+// @LoggerMessage: SRTL
+// @Description: SmartRTL statistics
+// @Field: TimeUS: microseconds since system startup
+// @Field: Active: true if SmartRTL could be used right now
+// @Field: NumPts: number of points currently in use
+// @Field: MaxPts: maximum number of points that could be used
+// @Field: Action: most recent internal action taken by SRTL library
+// @Field: N: point associated with most recent action (North component)
+// @Field: E: point associated with most recent action (East component)
+// @Field: D: point associated with most recent action (Down component)
+
+// @LoggerMessage: UBX1
+// @Description: uBlox-specific GPS information (part 1)
+// @Field: TimeUS: microseconds since system startup
+// @Field: Instance: GPS instance number
+// @Field: noisePerMS: noise level as measured by GPS
+// @Field: jamInd: jamming indicator; higher is more likely jammed
+// @Field: aPower: antenna power indicator; 2 is don't know
+// @Field: agcCnt: automatic gain control monitor
+// @Field: config: bitmask for messages which haven't been seen
+
+// @LoggerMessage: UBX2
+// @Description: uBlox-specific GPS information (part 2)
+// @Field: TimeUS: microseconds since system startup
+// @Field: Instance: GPS instance number
+// @Field: ofsI: imbalance of I part of complex signal
+// @Field: magI: magnitude of I part of complex signal
+// @Field: ofsQ: imbalance of Q part of complex signal
+// @Field: magQ: magnitude of Q part of complex signal
+
+// @LoggerMessage: UNIT
+// @Description: Message mapping from single character to SI unit
+// @Field: TimeUS: microseconds since system startup
+// @Field: Id: character referenced by FMTU
+// @Field: Label: Unit - SI where available
+
 // @LoggerMessage: VIBE
 // @Description: Processed (acceleration) vibration information
 // @Field: TimeUS: microseconds since system startup