ardupilot/Tools/scripts
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
..
CAN treewide: fix shebangs - /bin/bash -> /usr/bin/env bash 2024-02-13 11:36:23 +11:00
build_sizes Tools: added linux boards to build sizes web page 2024-01-19 11:41:02 +11:00
build_tests Tools: disable networking in ccache test 2023-11-17 10:54:24 -08:00
signing
sitl-on-hardware Tools: Update sitl-on-hardware README.md to match new file paths. 2024-01-13 13:55:25 -08:00
__init__.py Tools: Extracts parameter default values from an ArduPilot .bin file. 2024-02-21 18:24:16 +11:00
annotate_params.py Tools: Script to fetch online ArduPilot parameter documentation (if not cached) and 2024-02-22 08:31:57 +11:00
apj_tool.py Tools: extend error message when not finding defaults 2024-01-17 18:28:48 +11:00
battery_fit.py Tools: added battery fitting script 2023-08-10 07:43:25 +10:00
bin2hex.py Tools: enforce python3 on Tools 2023-05-18 07:54:10 +10:00
board_list.py Tools: remove HerePro 2024-02-15 13:42:14 +11:00
build-jsbsim.sh treewide: fix shebangs - /bin/bash -> /usr/bin/env bash 2024-02-13 11:36:23 +11:00
build_all.sh treewide: fix shebangs - /bin/bash -> /usr/bin/env bash 2024-02-13 11:36:23 +11:00
build_appveyor.sh treewide: fix shebangs - /bin/bash -> /usr/bin/env bash 2024-02-13 11:36:23 +11:00
build_autotest.sh treewide: fix shebangs - /bin/bash -> /usr/bin/env bash 2024-02-13 11:36:23 +11:00
build_binaries.py Tools: add bin file when building binaries for Here4FC 2024-01-13 23:03:52 +11:00
build_binaries_history.py
build_bootloaders.py Tools: added --periph-only option to build_bootloaders.py 2023-09-06 11:21:51 +10:00
build_ci.sh Tools: remove HerePro 2024-02-15 13:42:14 +11:00
build_docs.sh treewide: fix shebangs - /bin/bash -> /usr/bin/env bash 2024-02-13 11:36:23 +11:00
build_examples.py
build_examples.sh treewide: fix shebangs - /bin/bash -> /usr/bin/env bash 2024-02-13 11:36:23 +11:00
build_iofirmware.py scripts: build f103 variants of iofirmware 2023-08-15 06:53:48 +10:00
build_log_message_documentation.sh Autotest: Generate LogMessages.xml for Sub 2024-02-21 21:05:22 +11:00
build_options.py Tools: build_options.py: include fixed-yaw and in-flight learning options 2024-02-06 11:11:27 +11:00
build_parameters.sh treewide: fix shebangs - /bin/bash -> /usr/bin/env bash 2024-02-13 11:36:23 +11:00
build_peripherals.py Tools: added build_peripherals.py 2023-09-01 13:04:59 +10:00
check_firmware_version.py
configure-ci.sh treewide: fix shebangs - /bin/bash -> /usr/bin/env bash 2024-02-13 11:36:23 +11:00
configure_all.py Tools: Test for membership should be `not in` 2023-09-02 13:27:25 +10:00
convert_param_scale.py Tools: added convert_param_scale.py 2024-01-23 15:00:30 +11:00
convert_plane_PID.py
cygwin_build.sh Tools: added -e to cygwin build 2024-02-16 18:59:32 +11:00
decode_ICSR.py Tools: Scripts: decode_ICSR: use decoder_m4_pendsvset function 2024-01-01 11:31:40 +11:00
decode_devid.py Tools: Scripts: Decode devid: add ICM45686 2023-11-30 14:26:26 -08:00
decode_watchdog.py
du32_change.py Tools: move RC bits in mavlink to common code 2024-02-10 11:46:44 +11:00
dumpcore.sh
dumpstack.sh
esp32_get_idf.sh treewide: fix shebangs - /bin/bash -> /usr/bin/env bash 2024-02-13 11:36:23 +11:00
extract_features.py Tools: build_options.py: include fixed-yaw and in-flight learning options 2024-02-06 11:11:27 +11:00
extract_param_defaults.py Tools: Extracts parameter default values from an ArduPilot .bin file. 2024-02-21 18:24:16 +11:00
filter_size_compare_branches_csv.py Tools: filter empty columns out of size_compare result 2023-10-27 17:41:30 +11:00
firmware_version_decoder.py Tools: add can-zero board 2023-12-05 07:41:06 -06:00
fix_libraries_includes.sh treewide: fix shebangs - /bin/bash -> /usr/bin/env bash 2024-02-13 11:36:23 +11:00
format.sh treewide: fix shebangs - /bin/bash -> /usr/bin/env bash 2024-02-13 11:36:23 +11:00
frame_sizes.py
gen_stable.py Tools: support new stable release of 4.3.x 2023-08-29 11:11:55 +10:00
generate_manifest.py Tools: support beta-4.3 tags for doing new beta releases 2023-05-23 20:26:42 +10:00
imu_uart_decode.py Tools: added IMU decoder script 2023-11-30 07:05:02 +11:00
logic_decode_channels.py
macos_remote_upload.sh treewide: fix shebangs - /bin/bash -> /usr/bin/env bash 2024-02-13 11:36:23 +11:00
make_abin.sh Tools: fixed build of CPUInfo and other tools 2023-04-10 16:48:50 +10:00
make_apj.py Tools: enforce python3 on Tools 2023-05-18 07:54:10 +10:00
make_intel_hex.py Tools: enforce python3 on Tools 2023-05-18 07:54:10 +10:00
mavlink_parse.py Tools: scripts: create mavlink_parse.py 2023-05-05 09:43:54 +02:00
param_unpack.py Tools: Test for membership should be `not in` 2023-09-02 13:27:25 +10:00
playback_log_fg.py
powr_change.py
pretty_diff_size.py
rcda_decode.py
run_astyle.py Tools: Add MicroStrain7 support 2023-12-05 11:09:22 +11:00
run_coverage.py Tools: rename sim_periph_gps to sim_gps_universal, recreate sim_periph_gps 2024-01-16 12:16:35 +11:00
run_flake8.py Tools: don't check all files if no files-to-check supplied 2024-01-03 11:46:05 +11:00
run_luacheck.sh treewide: fix shebangs - /bin/bash -> /usr/bin/env bash 2024-02-13 11:36:23 +11:00
runcoptertest.py
runfliptest.py
runplanetest.py
sensor_status_change.py Tools: add sensor_status_change.py 2023-08-10 08:04:01 +10:00
size_compare_branches.py Tools: size_compare_branches.py: correct pruning of threads 2024-02-01 14:27:36 +11:00
solution_status_change.py Tools: tidy solution_status_change.py 2023-06-15 19:25:12 +10:00
ssbl_uploader.sh
tempcal_IMU.py Tools: Test for membership should be `not in` 2023-09-02 13:27:25 +10:00
tfminiplus.py
unpack_mp.sh treewide: fix shebangs - /bin/bash -> /usr/bin/env bash 2024-02-13 11:36:23 +11:00
uploader.py Tools: uploader.py: set write_timeout 2024-01-09 01:32:16 -08:00