Reference#

CLI Reference#

parasect#

Main CLI entry point.

parasect [OPTIONS] COMMAND [ARGS]...

Options

--debug#

Generate log file.

--version#

Show the version and exit.

build#

Build command.

parasect build [OPTIONS]

Options

-o, --output_folder <output_folder>#

Specify the output folder.

-c, --configuration <config>#

Specify a single Meal to build.

-f, --format <format>#

Select autopilot format. Read the documentation of Formats for more information.

Options:

csv | px4 | px4afv1 | px4afv2 | apm | apj

-i, --input_folder <input_folder>#

Specify the folder from which to read configurations and parameters.

-d, --default_parameters <default_parameters>#

Specify the default parameters file to apply to all Meals.

compare#

Compare command.

parasect compare [OPTIONS] FILE_1 FILE_2

Options

-i, --input_folder <input_folder>#

The directory where the Meals Menu is created, containing at least the calibration and operator staple dishes. Necessary when the nocal and noop options are set.

-s, --suppress-calibration#

Don’t compare calibration parameters.

-u, --suppress-operator-defined#

Don’t compare operator-selectable parameters.

-c, --component <component>#

Compare the parameters of a specific component. Refers to MAVLink-type Component IDs.

Arguments

FILE_1#

Required argument

FILE_2#

Required argument

API Reference#

Parasect package.

class parasect.Formats(value)#

Supported output formats.

apj = 'apj'#

File compatible with Ardupilot’s apj tool.

apm = 'apm'#

Ardupilot-compatible file.

csv = 'csv'#

Simple parameter name, value .csv file.

px4 = 'px4'#

QGroundControl-style parameter file.

px4afv1 = 'px4afv1'#

Legacy PX4 airframe file, prior to version 1.11.

px4afv2 = 'px4afv2'#

New PX4 airframe file, version 1.11 and later.

parasect.build(meal_ordered, format, input_folder, default_params, output_folder=None, sitl=False)#

Build parameter sets.

Parameters:

  • meal_ordered (str | None) – Specify which meal should be built. All meals specified in the menu will be built if left None.

  • format (Formats) – The autopilot format to export as.

  • input_folder (str | None) – The directory where the Meals Menu is created.

  • default_params (str | None) – If set, this file will provide the full parameters set for all the Meals.

  • output_folder (str | None) – The directory where the meals will be exported.

  • sitl (bool) – Filter for Meals marked as “sitl”. None: Disregard this meal keyword. True: Only build “sitl” meals. False: Don’t build “sitl” meals.

Raises:

ValueError – If meal_ordered is None (hence all the meals will be exported) but no output_folder is specified.

Return type:

None

parasect.compare(file_1, file_2, input_folder, nocal, noop, component)#

Compare two parameter files.

Parameters:

  • file_1 (str) – The path to the first parameter file to compare.

  • file_2 (str) – The path to the second parameter file to compare.

  • input_folder (str | None) – Necessary when the nocal and noop options are set. The directory where the Meals Menu is created, containing at least the calibration and operator staple dishes.

  • nocal (bool) – Don’t compare the calibration parameters.

  • noop (bool) – Don’t compare the operator parameters.

  • component (int | None) – Compare the parameters of a specific component. Refers to MAVLink-type Component IDs.

Returns:

A string with the comparison table contents.

Return type:

str