Commit Graph
5 Commits
Author SHA1 Message Date
Peter Barker 0a62cb443d Tools: use pathlib.Path for reading entire files 2026-03-30 10:35:51 +11:00
Peter Barker bc1aa19b28 Tools: avoid errors for catching bare exception 2026-03-23 08:14:01 +11:00
Peter Barker 09964a4ebe Tools: correct Python import lines for ruff correctness 2026-03-14 20:08:01 +11:00
Peter Barker 23513e3f9a Tools: use /usr/bin/env to find python3
going directly to /usr/bin/python3 means we don't use the venv python
2024-10-02 18:10:34 +10:00
Dr.-Ing. Amilcar do Carmo Lucas b6b4c972f9 Tools: Script to fetch online ArduPilot parameter documentation (if not cached) and
add it to the specified file or to all *.param and *.parm files in the specified directory.

1. Checks if a local cache of the XML file exists in the target directory or on the directory of the target file:
 - If it does, the script loads the file content.
 - If it doesn't, the script sends a GET request to the URL to fetch the XML data for the requested vehicle type.
2. Parses the XML data and creates a dictionary of parameter documentation.
3. DELETES all comments that start at the beginning of a line
4. Adds the parameter documentation to the target file or to all *.param,*.parm files in the target directory.

Supports AP_Periph, AntennaTracker, ArduCopter, ArduPlane, ArduSub, Blimp, Heli, Rover and SITL vehicle types
Supports both Mission Planner and MAVProxy file formats
Supports sorting the parameters
Has unit tests with 88% coverage

AP_FLAKE8_CLEAN

Author: Amilcar do Carmo Lucas, IAV GmbH

# Conflicts:
#	.github/workflows/test_unit_tests.yml
2024-02-22 08:31:57 +11:00