MAVExplorer: Add logmessage download and help commands, using meta-data from autotest web site #1337
Conversation
|
On Wed, 13 Mar 2024, Simon Hancock wrote:
In that case should probably use a subfolder for param XMLs too (separate PR).
Indeed.
|
shancock884
force-pushed
the
logmessage-help
branch
2 times, most recently
from
a3c44be to
1b07864
Compare
MAVProxy/tools/MAVExplorer.py
Outdated
| '''show log message information''' | ||
| mlog = mestate.mlog | ||
| usage = "Usage: logmessage <help|download>" | ||
| if len(args) > 0: |
There was a problem hiding this comment.
| if len(args) > 0: | |
| if len(args) <= 0: | |
| print(usage) | |
| return | |
... save indenting / context complication
.... logmessage list to show fields which are understood, perhaps? Or are in the intersection of what help can provide and what's in the log? ("future enhancement" :-) )
There was a problem hiding this comment.
logmessage list is probably a quick enough thing for me to add now.
The tab completion gives only the messages that exist in the log file, but you can actually ask for help on any message in the XML for the current vehicle type.
MAVProxy/tools/MAVExplorer.py
Outdated
| mlog.metadata.print_help(args[1]) | ||
| return | ||
| if args[0] == 'download': | ||
| # download XML files for log messages |
There was a problem hiding this comment.
Length-wise, this is on the border of making a new separate cmd_logmessage_download a good idea.
There was a problem hiding this comment.
Now that download is now implemented on pymavlink side, this code is shorter, so I maybe length is now OK to keep here?
Use DFMetaData.download to download XML files to .pymavlink/LogMessages Use DFMetaData.print_help to print logmessage help Apply suggestions, and perform flake8 check on new code Co-authored-by: Peter Barker <pb-gh@barker.dropbear.id.au>
shancock884
force-pushed
the
logmessage-help
branch
from
8b150e6 to
e2003e2
Compare
| # Skip XML files in the LogMessages subfolder | ||
| if os.path.basename(dirname) == "LogMessages": | ||
| continue |
There was a problem hiding this comment.
Don't need this bit any more.
The aim of this PR is to start making use of the LogMessage xml files in MAVExplorer.
This PR adds the commands "logmessage download" and "logmessage help " to MAVExplorer.
The download command will download all LogMessage XMLs to the user's .mavproxy folder.
The help command calls mlog.metadata.print_help(msg) method on the new DFMetaData class (links to PR ArduPilot/pymavlink#929).
The DFMetaData class is implemented in DFReader.py file, within pymavlink, so that other tools, such as mavlogdump can access the meta data on a loaded DF file without a dependency on MAVProxy. For example, to provide the enum strings and bitmask information when doing "mavlogdump --verbose".
Any call to mlog.metadata is protected with hasattr(mlog,'metadata') in case mlog is a TLOG or if the the pymavlink in use is older, and does not yet have the attribute.
I also updated load_graphs function to avoid XML warnings when it tries to load *.xml from .mavproxy folder.
An example of the output is as follows: