A lifeline for ArduPilot craft.
Project description
Parachute
Parachute is a swiss army knife for ArduPilot settings. It helps you quickly and easily back up all your parameters to a file (and restore them). It also lets you get/set them, filter them, diff them, restore them or convert them to parameter files compatible with Mission Planner/QGroundControl.
Installation
Installing Parachute is simple. You can use pipx
(recommended):
$ pipx install parachute
Or pip
(less recommended):
$ pip install parachute
You can also download pre-built binaries for Windows and Linux from the artifacts page.
Usage
Parachute is called like so:
$ parachute backup <craft name>
For example:
$ parachute backup Mini-Drak
To restore:
$ parachute restore backup.chute
Conversion
You can also convert a Parachute file to a file compatible with Mission Planner or QGroundControl:
$ parachute convert qgc Mini-Drak_2021-03-02_02-29.chute Mini-Drak.params
Filtering
You can filter parameters based on a regular expression:
$ parachute filter "serial[123]_" Mini-Drak_2021-03-02_02-29.chute filtered.chute
Since all parameter names are uppercase, the regex is case-insensitive, for convenience.
You can also filter when converting:
$ parachute convert --filter=yaw mp Mini-Drak_2021-03-02_02-29.chute -
Comparing
You can compare parameters in a backup with parameters on the craft:
$ parachute compare backup.chute
Getting/setting
You can get and set parameters:
$ parachute get BATT_AMP_OFFSET BATT_AMP_PERVLT
$ parachute set BATT_AMP_OFFSET=-0.0135 BATT_AMP_PERVLT=63.8826
Shell completions
Parachute includes shell completion for AP parameters for various shells. After you've
enabled completions, you can get parameter completion for the get
and set
commands.
For example, try typing parachute get acr<TAB>
.
The way to enable it depends on your shell:
fish
Save the completion script to ~/.config/fish/completions/parachute.fish:
_PARACHUTE_COMPLETE=fish_source parachute > ~/.config/fish/completions/parachute.fish
bash
Save the completion script somewhere.
_PARACHUTE_COMPLETE=bash_source parachute > ~/.parachute-complete.bash
Source the file in ~/.bashrc.
. ~/.parachute-complete.bash
zsh
Save the completion script somewhere.
_PARACHUTE_COMPLETE=zsh_source parachute > ~/.parachute-complete.zsh
Source the file in ~/.zshrc.
. ~/.parachute-complete.zsh
Changelog
v0.3.9 (2021-11-02)
Fixes
- Show the correct parameter name when diffing. [Stavros Korokithakis]
v0.3.8 (2021-10-29)
Features
-
Colorize tables. [Stavros Korokithakis]
-
Make table Markdown-compatible. [Stavros Korokithakis]
Fixes
- Fix inverted
compare
display. [Stavros Korokithakis]
v0.3.7 (2021-10-23)
Features
-
Include parameter completions. [Stavros Korokithakis]
-
Add
--baud-rate
cli option` [Stavros Korokithakis]
Fixes
-
Display accurate names when diffing. [Stavros Korokithakis]
-
Fix port detection on Windows. [Stavros Korokithakis]
v0.3.6 (2021-08-29)
Features
- Attempt socket autodetection. [Stavros Korokithakis]
Fixes
- Make messages more consistent. [Stavros Korokithakis]
v0.3.5 (2021-05-24)
Features
- Show old and new parameter values when setting. [Stavros Korokithakis]
v0.3.4 (2021-05-04)
Features
-
Add --only-backup and --only-craft options to "compare" [Stavros Korokithakis]
-
Add version command line parameter. [Stavros Korokithakis]
-
Allow the "compare" command to compare two backups. [Stavros Korokithakis]
v0.3.2 (2021-03-15)
Fixes
-
Make MP files actually compatible with MP. [Stavros Korokithakis]
-
Add timeout on parameter fetching. [Stavros Korokithakis]
v0.3.1 (2021-03-15)
Fixes
- Add more forbidden parameters. [Stavros Korokithakis]
v0.3.0 (2021-03-14)
Features
-
Add "reset-to-defaults" option. [Stavros Korokithakis]
-
Add "reboot" option. [Stavros Korokithakis]
Fixes
-
Fix table display. [Stavros Korokithakis]
-
Print prettier tables. [Stavros Korokithakis]
v0.2.2 (2021-03-06)
Features
- Add the "show" command. [Stavros Korokithakis]
Fixes
-
Fix leftover characters in counts. [Stavros Korokithakis]
-
Improve the display of the "get" command. [Stavros Korokithakis]
v0.2.1 (2021-03-04)
Fixes
- Don't print duplicate parameters when comparing. [Stavros Korokithakis]
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file parachute-0.3.9.tar.gz
.
File metadata
- Download URL: parachute-0.3.9.tar.gz
- Upload date:
- Size: 35.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 10ea41c492e4e097aeb79fbaed3d02190de7d57b91f3fdcac021361d454c0427 |
|
MD5 | 39c293c7798080c2018b4aab774232ce |
|
BLAKE2b-256 | 0978d8eb44cbac062824f68d338795389f70f26cfae85d69e9648b5af4815384 |
File details
Details for the file parachute-0.3.9-py3-none-any.whl
.
File metadata
- Download URL: parachute-0.3.9-py3-none-any.whl
- Upload date:
- Size: 33.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | cf93d652a33aaacc6dd8daebcc1eeb5125ad34e480e524104d85af60364f6718 |
|
MD5 | 0b4c97627184d074c60611f8a7fa9814 |
|
BLAKE2b-256 | 7b1a2b292dc2e1560ba817e745a1d74eeeebaa94be222c6c40b294e2f48d3367 |