Skip to content

Commit

Permalink
FEATURE: Explain more use cases
Browse files Browse the repository at this point in the history
  • Loading branch information
amilcarlucas committed Jul 12, 2024
1 parent 4d4d234 commit c89fbd7
Show file tree
Hide file tree
Showing 8 changed files with 76 additions and 0 deletions.
2 changes: 2 additions & 0 deletions QUICKSTART.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,3 +98,5 @@ double-click and step inside the directory that you want to use, not just select
1. Proceed as explained in [section 5](#5-configure-the-vehicles-parameters-in-a-traceable-way)

Congratulations your flight controller is now fully configured in the safest and fastest way publicly known.

There is also [documentation on other use cases](USECASES.md).
71 changes: 71 additions & 0 deletions USECASES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Ardupilot Methodic Configurator use cases

The software is meant to guide you a in sequence of procedural steps to configure and tune your vehicle in a safe and time-efficient way.

Hence the two main use cases are:

1. [Create a vehicle configuration based on a pre-existing template](QUICKSTART.md#4-use-the-ardupilot-methodic-configurator-software-for-the-first-time)
1. [Edit existing vehicle configuration files to configure and tune a vehicle](QUICKSTART.md#6-use-the-ardupilot-methodic-configurator-software-after-having-created-a-vehicle-from-template)

But there are other use cases as well:

1. [Create a vehicle configuration based on a correctly configured vehicle](#create-a-vehicle-configuration-based-on-a-correctly-configured-vehicle)
1. [Review and or edit configuration files without having the vehicle FC](#review-and-or-edit-configuration-files-without-having-the-vehicle-fc)
1. [Use the correct default values](#use-the-correct-default-values)

## Create a vehicle configuration based on a correctly configured vehicle

1. Connect the flight controller to the computer using a USB cable.
1. Wait at least 7 seconds.
1. Open the *ArduPilot Methodic Configurator* software.
1. The software should now automatically detect and connect to your flight controller.
![AMC FC info and parameter download](images/App_screenshot_FC_info_and_param_download.png)
1. Select the vehicle template that better resembles your vehicle.
![AMC template selection1](images/App_screenshot_Vehicle_directory_vehicle_params0.png)
![AMC template selection2](images/App_screenshot_Vehicle_overview.png)
1. **select the `Use parameter values from connected FC, not from template files` checkbox**
![AMC template selection1](images/App_screenshot_Vehicle_directory_vehicle_params1.png)
1. Give a name to your vehicle.
![AMC new vehicle name](images/App_screenshot_Vehicle_directory_vehicle_params2.png)
1. Press *Create vehicle configuration from template*.
![AMC new vehicle create](images/App_screenshot_Vehicle_directory_vehicle_params3.png)
1. Edit all the components of your vehicle to match your own in the *Vehicle Component Editor* window.
![AMC component editor](images/App_screenshot_Component_Editor.png)
1. Press *Save data and start configuration*.
1. The application will validate your input.
If issues are found the problematic fields' background will be marked in red color.
Correct those entries and press the `Save data and start configuration` button again.
1. You should now see the *Parameter file editor and uploader* window.
![AMC parameter file editor and uploader](images/App_screenshot2.png)
1. Follow the procedure to [configure the vehicle parameters](QUICKSTART.md#5-configure-the-vehicles-parameters-in-a-traceable-way)

If something is not clear, read the [ArduPilot Methodic Configurator user manual](USERMANUAL.md)

## Review and or edit configuration files without having the vehicle FC

1. Open the *ArduPilot Methodic Configurator* software.
1. Select `Skip FC connection, just edit .param files on disk` button .
![AMC no connection](images/App_screenshot_FC_connection_no_connection.png)
1. Open the vehicle configuration directory that you want to edit or review.
![AMC open vehicle configuration](images/App_screenshot_Vehicle_directory4.png)
**double-click and step inside the directory that you want to use, not just select it**
1. Edit all the components of your vehicle to match your own in the *Vehicle Component Editor* window.
![AMC component editor](images/App_screenshot_Component_Editor.png)
1. Press *Save data and start configuration*.
1. The application will validate your input.
If issues are found the problematic fields' background will be marked in red color.
Correct those entries and press the `Save data and start configuration` button again.
1. You should now see the *Parameter file editor and uploader* window.
![AMC parameter file editor and uploader](images/App_screenshot2.png) the `Upload selected params to FC, and advance to next param file` button will be grayed out because there is no FC connected.
1. Follow the procedure to [configure the vehicle parameters](QUICKSTART.md#5-configure-the-vehicles-parameters-in-a-traceable-way)

If something is not clear, read the [ArduPilot Methodic Configurator user manual](USERMANUAL.md)

# Use the correct default values

To get the correct default values for your board you need to do:

```bash
cd VehicleConfigurarationDirectory
extract_param_defaults bin_log_file.bin > 00_default.param
```
3 changes: 3 additions & 0 deletions USERMANUAL.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ Amilcar Lucas's - ArduPilot Methodic Configurator is a Python tool designed to s
It provides a graphical user interface (GUI) for managing, editing and visualizing drone parameter files, as well as uploading parameters to the vehicle.
It automates the tasks described in the [How to methodically tune (almost) any multicopter using ArduCopter forum Blog post](https://discuss.ardupilot.org/t/how-to-methodically-tune-almost-any-multicopter-using-arducopter-4-4-x/110842/1)

This user manual gives a general overview of the Software functionality.
There are also [quick start instructions](QUICKSTART.md) and [specific use case instructions](USECASES.md).

## Usage

Before starting the application on your PC you should connect a flight controller to the PC and wait at least seven seconds.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c89fbd7

Please sign in to comment.