Skip to content

Commit

Permalink
DOCS: update documentation a bit
Browse files Browse the repository at this point in the history
  • Loading branch information
amilcarlucas committed Jan 19, 2025
1 parent f627dd5 commit aa17a42
Show file tree
Hide file tree
Showing 7 changed files with 37 additions and 33 deletions.
8 changes: 1 addition & 7 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,13 +82,7 @@ ardupilot_methodic_configurator

## MacOS Installation

Install [git](https://git-scm.com/) and [python](https://www.python.org/downloads/). Then execute the command lines:

```bash
git clone https://github.com/ArduPilot/MethodicConfigurator.git
cd MethodicConfigurator
./install_macos.sh
```
Follow the linux installation instructions above.

## Install *Mission Planner* software on a PC or Mac

Expand Down
12 changes: 6 additions & 6 deletions TUNING_GUIDE_ArduCopter.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,9 @@ Your vehicle will be different as your application will have different requireme

To configure and operate your vehicle you need at least these software:

- [Install ArduPilot Methodic Configurator](README.md#install-ardupilot-methodic-configurator-software-on-a-pc-or-mac)
- [Install Mission Planner](README.md#3-install-mission-planner-software-on-a-pc-or-mac)
- [Install ArduPilot](README.md#4-install-ardupilot-firmware-on-the-flight-controller)
- [Install ArduPilot Methodic Configurator](INSTALL.md)
- [Install Mission Planner](INSTALL.md#install-mission-planner-software-on-a-pc-or-mac)
- [Install ArduPilot](INSTALL.md#install-ardupilot-firmware-on-the-flight-controller)

Use Mission Planner to flash the latest stable [ArduCopter](https://firmware.ardupilot.org/Copter/stable/), [ArduPlane](https://firmware.ardupilot.org/Plane/stable/), [ArduRover](https://firmware.ardupilot.org/Rover/stable/), [ArduSub](https://firmware.ardupilot.org/Sub/stable/) or [ArduBlimp](https://firmware.ardupilot.org/Blimp/latest/) firmware for your flight controller.

Expand All @@ -108,7 +108,7 @@ The table bellow summarizes the software used in this guide. Download and instal
|:----|:----|:----|
| [Mission Planner](https://firmware.ardupilot.org/Tools/MissionPlanner/MissionPlanner-latest.msi) | latest beta | Ground control station (PC software) used for configuring and operating the vehicle |
| [ArduPilot Methodic Configurator](https://github.com/ArduPilot/MethodicConfigurator) | latest | A clear ArduPilot configuration sequence |
| [ArduCopter](https://firmware.ardupilot.org/Copter/stable/) | 4.4.4 or 4.5.5 | Flight controller firmware |
| [ArduCopter](https://firmware.ardupilot.org/Copter/stable/) | 4.4.4 or 4.5.7 | Flight controller firmware |
| [BLHeliSuite32](https://www.mediafire.com/file/fj1p9qlbzo5bl5g/BLHeliSuite32_32.9.0.6.zip/file) | 32.9.06 | PC software to flash and configure ESCs with BLHeli_32 ARM firmware |
| [BLHeli_32 ARM](https://github.com/bitdump/BLHeli/tree/master/BLHeli_32%20ARM) | 32.8 | ESC firmware with Bidir Dshot support |
| [EdgeTx companion](https://edgetx.org/getedgetx/) | 2.9.2 | PC software for configuring and updating EdgeTX based RC transmitters |
Expand All @@ -132,7 +132,7 @@ The table bellow summarizes the software used in this guide. Download and instal
The ArduPilot Methodic Configurator needs to know which components you used/plan to use and how you connected/plan to connect them to the flight controller (autopilot).
It uses this information to automatically pre-select configuration settings relevant to your specific vehicle.

So, [start the ArduPilot Methodic Configurator and input select a vehicle that resembles yours](README.md#use-the-ardupilot-methodic-configurator-software-for-the-first-time) and input vehicle components and component connections information into the ArduPilot Methodic Configurator *component editor window*:
So, [start the ArduPilot Methodic Configurator and select a vehicle that resembles yours](USECASES.md#use-the-ardupilot-methodic-configurator-software-for-the-first-time) and input vehicle components and component connections information into the ArduPilot Methodic Configurator *component editor window*:

1. Close Mission Planner, if it is open on the PC.
1. Connect the flight controller to the PC via a USB cable and wait 7 seconds.
Expand All @@ -157,7 +157,7 @@ That is harder to do once the autopilot is assembled inside the vehicle, hence i

## 4.1 Setup IMU temperature calibration

1. [Start the software](README.md#6-configure-the-vehicles-parameters-in-a-traceable-way)
1. [Start the software](USECASES.md#use-the-ardupilot-methodic-configurator-software-for-the-first-time) if not already running.
1. On *ArduPilot Methodic Configurator* select `02_imu_temperature_calibration_setup.param` on the *Current intermediate parameter file:* Combobox if not already selected.
1. Read the *Forum Blog:* and *Wiki:* documentation by pressing on the blue URL links.
1. Edit the `02_imu_temperature_calibration_setup.param` parameters' `New Value` and `Change Reason` using the *ArduPilot Methodic Configurator* parameter editor and press `Upload selected params to FC, and advance to next file`.
Expand Down
12 changes: 6 additions & 6 deletions TUNING_GUIDE_ArduPlane.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,9 @@ Your vehicle will be different as your application will have different requireme

To configure and operate your vehicle you need at least these software:

- [Install ArduPilot Methodic Configurator](README.md#install-ardupilot-methodic-configurator-software-on-a-pc-or-mac)
- [Install Mission Planner](README.md#3-install-mission-planner-software-on-a-pc-or-mac)
- [Install ArduPilot](README.md#4-install-ardupilot-firmware-on-the-flight-controller)
- [Install ArduPilot Methodic Configurator](INSTALL.md)
- [Install Mission Planner](INSTALL.md#install-mission-planner-software-on-a-pc-or-mac)
- [Install ArduPilot](INSTALL.md#install-ardupilot-firmware-on-the-flight-controller)

Use Mission Planner to flash the latest stable [ArduCopter](https://firmware.ardupilot.org/Copter/stable/), [ArduPlane](https://firmware.ardupilot.org/Plane/stable/), [ArduRover](https://firmware.ardupilot.org/Rover/stable/), [ArduSub](https://firmware.ardupilot.org/Sub/stable/) or [ArduBlimp](https://firmware.ardupilot.org/Blimp/latest/) firmware for your flight controller.

Expand All @@ -108,7 +108,7 @@ The table bellow summarizes the software used in this guide. Download and instal
|:----|:----|:----|
| [Mission Planner](https://firmware.ardupilot.org/Tools/MissionPlanner/MissionPlanner-latest.msi) | latest beta | Ground control station (PC software) used for configuring and operating the vehicle |
| [ArduPilot Methodic Configurator](https://github.com/ArduPilot/MethodicConfigurator) | latest | A clear ArduPilot configuration sequence |
| [ArduCopter](https://firmware.ardupilot.org/Copter/stable/) | 4.4.4 or 4.5.5 | Flight controller firmware |
| [ArduCopter](https://firmware.ardupilot.org/Copter/stable/) | 4.4.4 or 4.5.7 | Flight controller firmware |
| [BLHeliSuite32](https://www.mediafire.com/file/fj1p9qlbzo5bl5g/BLHeliSuite32_32.9.0.6.zip/file) | 32.9.06 | PC software to flash and configure ESCs with BLHeli_32 ARM firmware |
| [BLHeli_32 ARM](https://github.com/bitdump/BLHeli/tree/master/BLHeli_32%20ARM) | 32.8 | ESC firmware with Bidir Dshot support |
| [EdgeTx companion](https://edgetx.org/getedgetx/) | 2.9.2 | PC software for configuring and updating EdgeTX based RC transmitters |
Expand All @@ -132,7 +132,7 @@ The table bellow summarizes the software used in this guide. Download and instal
The ArduPilot Methodic Configurator needs to know which components you used/plan to use and how you connected/plan to connect them to the flight controller (autopilot).
It uses this information to automatically pre-select configuration settings relevant to your specific vehicle.

So, [start the ArduPilot Methodic Configurator and input select a vehicle that resembles yours](README.md#use-the-ardupilot-methodic-configurator-software-for-the-first-time) and input vehicle components and component connections information into the ArduPilot Methodic Configurator *component editor window*:
So, [start the ArduPilot Methodic Configurator and select a vehicle that resembles yours](USECASES.md#use-the-ardupilot-methodic-configurator-software-for-the-first-time) and input vehicle components and component connections information into the ArduPilot Methodic Configurator *component editor window*:

1. Close Mission Planner, if it is open on the PC.
1. Connect the flight controller to the PC via a USB cable and wait 7 seconds.
Expand All @@ -157,7 +157,7 @@ That is harder to do once the autopilot is assembled inside the vehicle, hence i

## 4.1 Setup IMU temperature calibration

1. [Start the software](README.md#6-configure-the-vehicles-parameters-in-a-traceable-way)
1. [Start the software](USECASES.md#use-the-ardupilot-methodic-configurator-software-for-the-first-time) if not already running.
1. On *ArduPilot Methodic Configurator* select `02_imu_temperature_calibration_setup.param` on the *Current intermediate parameter file:* Combobox if not already selected.
1. Read the *Forum Blog:* and *Wiki:* documentation by pressing on the blue URL links.
1. Edit the `02_imu_temperature_calibration_setup.param` parameters' `New Value` and `Change Reason` using the *ArduPilot Methodic Configurator* parameter editor and press `Upload selected params to FC, and advance to next file`.
Expand Down
12 changes: 6 additions & 6 deletions TUNING_GUIDE_Heli.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,9 +93,9 @@ Your vehicle will be different as your application will have different requireme

To configure and operate your vehicle you need at least these software:

- [Install ArduPilot Methodic Configurator](README.md#install-ardupilot-methodic-configurator-software-on-a-pc-or-mac)
- [Install Mission Planner](README.md#3-install-mission-planner-software-on-a-pc-or-mac)
- [Install ArduPilot](README.md#4-install-ardupilot-firmware-on-the-flight-controller)
- [Install ArduPilot Methodic Configurator](INSTALL.md)
- [Install Mission Planner](INSTALL.md#install-mission-planner-software-on-a-pc-or-mac)
- [Install ArduPilot](INSTALL.md#install-ardupilot-firmware-on-the-flight-controller)

Use Mission Planner to flash the latest stable [ArduCopter](https://firmware.ardupilot.org/Copter/stable/), [ArduPlane](https://firmware.ardupilot.org/Plane/stable/), [ArduRover](https://firmware.ardupilot.org/Rover/stable/), [ArduSub](https://firmware.ardupilot.org/Sub/stable/) or [ArduBlimp](https://firmware.ardupilot.org/Blimp/latest/) firmware for your flight controller.

Expand All @@ -107,7 +107,7 @@ The table bellow summarizes the software used in this guide. Download and instal
|:----|:----|:----|
| [Mission Planner](https://firmware.ardupilot.org/Tools/MissionPlanner/MissionPlanner-latest.msi) | latest beta | Ground control station (PC software) used for configuring and operating the vehicle |
| [ArduPilot Methodic Configurator](https://github.com/ArduPilot/MethodicConfigurator) | latest | A clear ArduPilot configuration sequence |
| [ArduCopter](https://firmware.ardupilot.org/Copter/stable/) | 4.4.4 or 4.5.5 | Flight controller firmware |
| [ArduCopter](https://firmware.ardupilot.org/Copter/stable/) | 4.4.4 or 4.5.7 | Flight controller firmware |
| [BLHeliSuite32](https://www.mediafire.com/file/fj1p9qlbzo5bl5g/BLHeliSuite32_32.9.0.6.zip/file) | 32.9.06 | PC software to flash and configure ESCs with BLHeli_32 ARM firmware |
| [BLHeli_32 ARM](https://github.com/bitdump/BLHeli/tree/master/BLHeli_32%20ARM) | 32.8 | ESC firmware with Bidir Dshot support |
| [EdgeTx companion](https://edgetx.org/getedgetx/) | 2.9.2 | PC software for configuring and updating EdgeTX based RC transmitters |
Expand All @@ -131,7 +131,7 @@ The table bellow summarizes the software used in this guide. Download and instal
The ArduPilot Methodic Configurator needs to know which components you used/plan to use and how you connected/plan to connect them to the flight controller (autopilot).
It uses this information to automatically pre-select configuration settings relevant to your specific vehicle.

So, [start the ArduPilot Methodic Configurator and input select a vehicle that resembles yours](README.md#use-the-ardupilot-methodic-configurator-software-for-the-first-time) and input vehicle components and component connections information into the ArduPilot Methodic Configurator *component editor window*:
So, [start the ArduPilot Methodic Configurator and select a vehicle that resembles yours](USECASES.md#use-the-ardupilot-methodic-configurator-software-for-the-first-time) and input vehicle components and component connections information into the ArduPilot Methodic Configurator *component editor window*:

1. Close Mission Planner, if it is open on the PC.
1. Connect the flight controller to the PC via a USB cable and wait 7 seconds.
Expand All @@ -156,7 +156,7 @@ That is harder to do once the autopilot is assembled inside the vehicle, hence i

## 4.1 Setup IMU temperature calibration

1. [Start the software](README.md#6-configure-the-vehicles-parameters-in-a-traceable-way)
1. [Start the software](USECASES.md#use-the-ardupilot-methodic-configurator-software-for-the-first-time) if not already running.
1. On *ArduPilot Methodic Configurator* select `02_imu_temperature_calibration_setup.param` on the *Current intermediate parameter file:* Combobox if not already selected.
1. Read the *Forum Blog:* and *Wiki:* documentation by pressing on the blue URL links.
1. Edit the `02_imu_temperature_calibration_setup.param` parameters' `New Value` and `Change Reason` using the *ArduPilot Methodic Configurator* parameter editor and press `Upload selected params to FC, and advance to next file`.
Expand Down
12 changes: 6 additions & 6 deletions TUNING_GUIDE_Rover.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,9 @@ Your vehicle will be different as your application will have different requireme

To configure and operate your vehicle you need at least these software:

- [Install ArduPilot Methodic Configurator](README.md#install-ardupilot-methodic-configurator-software-on-a-pc-or-mac)
- [Install Mission Planner](README.md#3-install-mission-planner-software-on-a-pc-or-mac)
- [Install ArduPilot](README.md#4-install-ardupilot-firmware-on-the-flight-controller)
- [Install ArduPilot Methodic Configurator](INSTALL.md)
- [Install Mission Planner](INSTALL.md#install-mission-planner-software-on-a-pc-or-mac)
- [Install ArduPilot](INSTALL.md#install-ardupilot-firmware-on-the-flight-controller)

Use Mission Planner to flash the latest stable [ArduCopter](https://firmware.ardupilot.org/Copter/stable/), [ArduPlane](https://firmware.ardupilot.org/Plane/stable/), [ArduRover](https://firmware.ardupilot.org/Rover/stable/), [ArduSub](https://firmware.ardupilot.org/Sub/stable/) or [ArduBlimp](https://firmware.ardupilot.org/Blimp/latest/) firmware for your flight controller.

Expand All @@ -108,7 +108,7 @@ The table bellow summarizes the software used in this guide. Download and instal
|:----|:----|:----|
| [Mission Planner](https://firmware.ardupilot.org/Tools/MissionPlanner/MissionPlanner-latest.msi) | latest beta | Ground control station (PC software) used for configuring and operating the vehicle |
| [ArduPilot Methodic Configurator](https://github.com/ArduPilot/MethodicConfigurator) | latest | A clear ArduPilot configuration sequence |
| [ArduCopter](https://firmware.ardupilot.org/Copter/stable/) | 4.4.4 or 4.5.5 | Flight controller firmware |
| [ArduCopter](https://firmware.ardupilot.org/Copter/stable/) | 4.4.4 or 4.5.7 | Flight controller firmware |
| [BLHeliSuite32](https://www.mediafire.com/file/fj1p9qlbzo5bl5g/BLHeliSuite32_32.9.0.6.zip/file) | 32.9.06 | PC software to flash and configure ESCs with BLHeli_32 ARM firmware |
| [BLHeli_32 ARM](https://github.com/bitdump/BLHeli/tree/master/BLHeli_32%20ARM) | 32.8 | ESC firmware with Bidir Dshot support |
| [EdgeTx companion](https://edgetx.org/getedgetx/) | 2.9.2 | PC software for configuring and updating EdgeTX based RC transmitters |
Expand All @@ -132,7 +132,7 @@ The table bellow summarizes the software used in this guide. Download and instal
The ArduPilot Methodic Configurator needs to know which components you used/plan to use and how you connected/plan to connect them to the flight controller (autopilot).
It uses this information to automatically pre-select configuration settings relevant to your specific vehicle.

So, [start the ArduPilot Methodic Configurator and input select a vehicle that resembles yours](README.md#use-the-ardupilot-methodic-configurator-software-for-the-first-time) and input vehicle components and component connections information into the ArduPilot Methodic Configurator *component editor window*:
So, [start the ArduPilot Methodic Configurator and select a vehicle that resembles yours](USECASES.md#use-the-ardupilot-methodic-configurator-software-for-the-first-time) and input vehicle components and component connections information into the ArduPilot Methodic Configurator *component editor window*:

1. Close Mission Planner, if it is open on the PC.
1. Connect the flight controller to the PC via a USB cable and wait 7 seconds.
Expand All @@ -157,7 +157,7 @@ That is harder to do once the autopilot is assembled inside the vehicle, hence i

## 4.1 Setup IMU temperature calibration

1. [Start the software](README.md#6-configure-the-vehicles-parameters-in-a-traceable-way)
1. [Start the software](USECASES.md#use-the-ardupilot-methodic-configurator-software-for-the-first-time) if not already running.
1. On *ArduPilot Methodic Configurator* select `02_imu_temperature_calibration_setup.param` on the *Current intermediate parameter file:* Combobox if not already selected.
1. Read the *Forum Blog:* and *Wiki:* documentation by pressing on the blue URL links.
1. Edit the `02_imu_temperature_calibration_setup.param` parameters' `New Value` and `Change Reason` using the *ArduPilot Methodic Configurator* parameter editor and press `Upload selected params to FC, and advance to next file`.
Expand Down
2 changes: 0 additions & 2 deletions install_linux.sh
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,6 @@ git config --local sequence.editor "code --wait"
# install pre-commit git hooks
pre-commit install

# setuptools has a bug and refuses to install these files, so do it manually
cp ardupilot_methodic_configurator/vehicle_templates ~/.local/lib/python3.12/site-packages/ardupilot_methodic_configurator/

echo "Installation complete."
echo ""
Expand Down
12 changes: 12 additions & 0 deletions install_macos.sh
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,23 @@ python3 -m venv .venv
source .venv/bin/activate

# Uninstall serial and pyserial to avoid conflicts
echo "Uninstalling serial and pyserial..."
python3 -m pip uninstall -y serial pyserial

# Install the project dependencies
echo "Installing project dependencies..."
python3 -m pip install -e .[dev]

# configure git local repository settings
git config --local pull.rebase true
git config --local push.autoSetupRemote
git config --local init.defaultbranch master
git config --local sequence.editor "code --wait"

# install pre-commit git hooks
pre-commit install


echo "Installation complete."
echo ""
echo "You can run the ArduPilot methodic configurator GUI by executing:"
Expand Down

0 comments on commit aa17a42

Please sign in to comment.