ardupilot/libraries/AP_Logger
Peter Barker f337d011e7 AP_Logger: make LogEvent an enum class, split off LogDataID
We were mixing the enumeration values across different messages, which
isn't great
2019-11-05 08:19:26 +08:00
..
examples AP_Logger: examples: var_info is now in GCS_MAVLINK_Parameters 2019-08-14 18:25:43 +10:00
AP_Logger.cpp AP_Logger: make LogEvent an enum class, split off LogDataID 2019-11-05 08:19:26 +08:00
AP_Logger.h AP_Logger: make LogEvent an enum class, split off LogDataID 2019-11-05 08:19:26 +08:00
AP_Logger_Backend.cpp AP_Logger: const-struct many structures, use temp for navekf object 2019-08-06 11:45:04 +10:00
AP_Logger_Backend.h AP_Logger: Support new ModeReason 2019-10-25 08:48:22 +08:00
AP_Logger_Block.cpp AP_Logger: fix logging on 256Mbit flash chips 2019-10-05 16:25:22 +10:00
AP_Logger_Block.h AP_Logger: fix logging on 256Mbit flash chips 2019-10-05 16:25:22 +10:00
AP_Logger_DataFlash.cpp AP_Logger: fix logging on 256Mbit flash chips 2019-10-05 16:25:22 +10:00
AP_Logger_DataFlash.h AP_Logger: fix logging on 256Mbit flash chips 2019-10-05 16:25:22 +10:00
AP_Logger_File.cpp AP_Logger: fixed LOG_FILE_DSRMROT with delayed log stop 2019-10-03 07:17:16 +10:00
AP_Logger_File.h AP_Logger: fixed LOG_FILE_DSRMROT with delayed log stop 2019-10-03 07:17:16 +10:00
AP_Logger_MAVLink.cpp AP_Logger: fixed use of old irqsave() API 2019-09-21 15:36:47 +10:00
AP_Logger_MAVLink.h AP_Logger: pass mavlink_message_t by const reference 2019-07-16 20:51:42 +10:00
AP_Logger_MAVLinkLogTransfer.cpp AP_Logger: pass mavlink_message_t by const reference 2019-07-16 20:51:42 +10:00
AP_Logger_SITL.cpp AP_logger: rename dataflash to logger and refactor the filename logger.bin 2019-03-28 16:40:58 +11:00
AP_Logger_SITL.h AP_logger: rename dataflash to logger and refactor the filename logger.bin 2019-03-28 16:40:58 +11:00
LogFile.cpp AC_Logger: adjust for proximity status namespace change 2019-10-31 11:58:15 +08:00
LogStructure.h AP_Logger: Log GPS yaw accuracy 2019-10-15 11:06:11 +11:00
LoggerMessageWriter.cpp AP_Logger: tidy MessageWriter stages using enum class 2019-10-05 16:37:43 +10:00
LoggerMessageWriter.h AP_Logger: tidy MessageWriter stages using enum class 2019-10-05 16:37:43 +10:00
README.md AP_Logger: add a README.md to help locating units/mults/fieldtypes 2019-06-04 19:00:11 +10:00

README.md

Logger Notes

Format Types

The format type specifies the amount of storage required for the entry and how the content should be interpreted.

Char C Type
a int16_t[32]
b int8_t
B uint8_t
h int16_t
H uint16_t
i int32_t
I uint32_t
f float
d double
n char[4]
N char[16]
Z char[64]
L int32_t latitude/longitude (so -35.1332423 becomes -351332423)
M uint8_t flight mode
q int64_t
Q uint64_t

Legacy field types - do not use. These have been replaced by using the base C type and an appropriate multiplier column entry.

Char CType+Mult
c int16_t * 100
C uint16_t * 100
e int32_t * 100
E uint32_t * 100

Units

All units here should be base units This does mean battery capacity is here as "amp*second" Please keep the names consistent with Tools/autotest/param_metadata/param.py:33

Char Unit Abbrev. Description
'-' "" no units e.g. Pi
'?' "UNKNOWN" Units which haven't been worked out yet....
'A' "A" Ampere
'd' "deg" of the angular variety
'b' "B" bytes
'k' "deg/s" degrees per second. Degrees are NOT SI
'D' "deglatitude" degrees of latitude
'e' "deg/s/s" degrees per second per second. Degrees are NOT SI
'E' "rad/s" radians per second
'G' "Gauss" Gauss is not an SI unit
'h' "degheading" 0.? to 359.?
'i' "A.s" Ampere second
'J' "W.s" Joule (Watt second)
'l' "l" litres
'L' "rad/s/s" radians per second per second
'm' "m" metres
'n' "m/s" metres per second
'N' "N" Newton
'o' "m/s/s" metres per second per second
'O' "degC" degrees Celsius. Not SI
'%' "%" percent
'S' "satellites" number of satellites
's' "s" seconds
'q' "rpm" rounds per minute. Not SI
'r' "rad" radians
'U' "deglongitude" degrees of longitude
'u' "ppm" pulses per minute
'v' "V" Volt
'P' "Pa" Pascal
'w' "Ohm" Ohm
'Y' "us" pulse width modulation in microseconds
'z' "Hz" Hertz
'#' "instance" (e.g.)Sensor instance number

Multipliers

This multiplier information applies to the raw value present in the log. Any adjustment implied by the format field (e.g. the "centi" in "centidegrees" is IGNORED for the purposes of scaling. Essentially "format" simply tells you the C-type, and format-type h (int16_t) is equivalent to format-type c (int16_t*100) tl;dr a GCS shouldn't/mustn't infer any scaling from the unit name

Char Multiplier
'-' 0
'?' 1
'2' 1e2
'1' 1e1
'0' 1e0
'A' 1e-1
'B' 1e-2
'C' 1e-3
'D' 1e-4
'E' 1e-5
'F' 1e-6
'G' 1e-7
'!' 3.6
'/' 3600