Mirror/inav
1
0
Fork 0
mirror of https://github.com/iNavFlight/inav.git synced 2025-07-14 11:59:56 +03:00
Code Issues Wiki Activity

[docs] update serial_printf doc (#9780)

Browse source
This commit is contained in:
Jonathan Hudson 2024-03-08 17:47:48 +00:00 • committed by GitHub
parent 1d82aca917
commit e4b95efd2b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 14 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

19
docs/development/serial_printf_debugging.md
View file

@ -98,10 +98,13 @@ LOG_BUF_DEBUG(TEMPERATURE, &tstruct, sizeof(tstruct));
Log messages are transmitted through the `FUNCTION_LOG` serial port as MSP messages (`MSP_DEBUGMSG`). It is possible to use any serial terminal to display these messages, however it is advisable to use an application that understands `MSP_DEBUGMSG` in order to maintain readability (in a raw serial terminal the MSP message envelope may result in the display of strange characters). `MSP_DEBUGMSG` aware applications include: Log messages are transmitted through the `FUNCTION_LOG` serial port as MSP messages (`MSP_DEBUGMSG`). It is possible to use any serial terminal to display these messages, however it is advisable to use an application that understands `MSP_DEBUGMSG` in order to maintain readability (in a raw serial terminal the MSP message envelope may result in the display of strange characters). `MSP_DEBUGMSG` aware applications include:
* [msp-tool](https://github.com/fiam/msp-tool)
* [mwp](https://github.com/stronnag/mwptools)
* [dbg-tool](https://codeberg.org/stronnag/dbg-tool) * [dbg-tool](https://codeberg.org/stronnag/dbg-tool)
* [INAV Configurator](https://github.com/iNavFlight/inav-configurator) * [INAV Configurator](https://github.com/iNavFlight/inav-configurator)
* [mwp](https://github.com/stronnag/mwptools)
In addtion:
* [msp-tool](https://github.com/fiam/msp-tool) is obsolete and has limited OS support.
For example, with the final lines of `src/main/fc/fc_init.c` set to: For example, with the final lines of `src/main/fc/fc_init.c` set to:
@ -121,10 +124,16 @@ set log_topics = 4294967295
The output will be formatted as follows: The output will be formatted as follows:
``` ```
# msp-tool # dbg-tool
[DEBUG] [ 3.967] Init is complete [dbg-tool] 12:46:49.909079 DBG: [ 3.967] Init is complete
# mwp (stderr log file) # mwp (stderr log file)
2020-02-02T19:09:02+0000 DEBUG:[ 3.968] Init is complete 2020-02-02T19:09:02+0000 DEBUG:[ 3.968] Init is complete
# msp-tool
[DEBUG] [ 3.967] Init is complete
``` ```
The numeric value in square brackets is the FC uptime in seconds. For the Configurator, debug messages are shown in the developer console log.
Note: The numeric value in square brackets is the FC uptime in seconds.