#!/usr/bin/env python3

"""
Framework to start a simulated vehicle and connect it to MAVProxy.

Peter Barker, April 2016
based on sim_vehicle.sh by Andrew Tridgell, October 2011

AP_FLAKE8_CLEAN

"""

import atexit
import binascii
import datetime
import errno
import math
import optparse
import os
import os.path
import re
import shlex
import signal
import subprocess
import sys
import tempfile
import textwrap
import time

from pysim import util
from pysim import vehicleinfo

# List of open terminal windows for macosx
windowID = []

autotest_dir = os.path.dirname(os.path.realpath(__file__))
root_dir = os.path.realpath(os.path.join(autotest_dir, '../..'))

try:
    from pymavlink import mavextra
except ImportError:
    sys.path.append(os.path.join(root_dir, "modules/mavlink"))
    from pymavlink import mavextra

os.environ["SIM_VEHICLE_SESSION"] = binascii.hexlify(os.urandom(8)).decode()


class CompatError(Exception):
    """A custom exception class to hold state if we encounter the parse
    error we are looking for"""
    def __init__(self, error, opts, rargs):
        Exception.__init__(self, error)
        self.opts = opts
        self.rargs = rargs


class CompatOptionParser(optparse.OptionParser):
    """An option parser which emulates the behaviour of the old
    sim_vehicle.sh; if passed -C, the first argument not understood starts
    a list of arguments that are passed straight to mavproxy
    """

    class CustomFormatter(optparse.IndentedHelpFormatter):
        def __init__(self, *args, **kwargs):
            optparse.IndentedHelpFormatter.__init__(self, *args, **kwargs)

        # taken and modified from from optparse.py's format_option
        def format_option_preserve_nl(self, option):
            # The help for each option consists of two parts:
            #   * the opt strings and metavars
            #     eg. ("-x", or "-fFILENAME, --file=FILENAME")
            #   * the user-supplied help string
            #     eg. ("turn on expert mode", "read data from FILENAME")
            #
            # If possible, we write both of these on the same line:
            #   -x      turn on expert mode
            #
            # But if the opt string list is too long, we put the help
            # string on a second line, indented to the same column it would
            # start in if it fit on the first line.
            #   -fFILENAME, --file=FILENAME
            #           read data from FILENAME
            result = []
            opts = self.option_strings[option]
            opt_width = self.help_position - self.current_indent - 2
            if len(opts) > opt_width:
                opts = "%*s%s\n" % (self.current_indent, "", opts)
            else:                       # start help on same line as opts
                opts = "%*s%-*s  " % (self.current_indent, "", opt_width, opts)
            result.append(opts)
            if option.help:
                help_text = self.expand_default(option)
                tw = textwrap.TextWrapper(replace_whitespace=False,
                                          initial_indent="",
                                          subsequent_indent="    ",
                                          width=self.help_width)

                for line in help_text.split("\n"):
                    help_lines = tw.wrap(line)
                    for wline in help_lines:
                        result.extend(["%*s%s\n" % (self.help_position,
                                                    "",
                                                    wline)])
            elif opts[-1] != "\n":
                result.append("\n")
            return "".join(result)

        def format_option(self, option):
            if str(option).find('frame') != -1:
                return self.format_option_preserve_nl(option)
            return optparse.IndentedHelpFormatter.format_option(self, option)

    def __init__(self, *args, **kwargs):
        formatter = CompatOptionParser.CustomFormatter()
        optparse.OptionParser.__init__(self,
                                       *args,
                                       formatter=formatter,
                                       **kwargs)

    def error(self, error):
        """Override default error handler called by
        optparse.OptionParser.parse_args when a parse error occurs;
        raise a detailed exception which can be caught
        """
        if error.find("no such option") != -1:
            raise CompatError(error, self.values, self.rargs)

        optparse.OptionParser.error(self, error)

    def parse_args(self, args=None, values=None):
        '''Wrap parse_args so we can catch the exception raised upon
        discovering the known parameter parsing error
        '''

        try:
            opts, args = optparse.OptionParser.parse_args(self)
        except CompatError as e:
            if not e.opts.sim_vehicle_sh_compatible:
                print(e)
                print("Perhaps you want --sim_vehicle_sh_compatible (-C)?")
                sys.exit(1)
            if e.opts.mavproxy_args:
                print("--mavproxy-args not permitted in compat mode")
                sys.exit(1)

            args = []
            opts = e.opts
            mavproxy_args = [str(e)[16:]]  # this trims "no such option" off
            mavproxy_args.extend(e.rargs)
            opts.ensure_value("mavproxy_args", " ".join(mavproxy_args))

        return opts, args


def cygwin_pidof(proc_name):
    """ Thanks to kata198 for this:
    https://github.com/kata198/cygwin-ps-misc/blob/master/pidof
    """
    pipe = subprocess.Popen("ps -ea | grep " + proc_name,
                            shell=True,
                            stdout=subprocess.PIPE)
    output_lines = pipe.stdout.read().decode('utf-8').replace("\r", "").split("\n")
    ret = pipe.wait()
    pids = []
    if ret != 0:
        # No results
        return []
    for line in output_lines:
        if not line:
            continue
        line_split = [item for item in line.split(' ') if item]
        cmd = line_split[-1].split('/')[-1]
        if cmd == proc_name:
            try:
                pid = int(line_split[0].strip())
            except ValueError:
                pid = int(line_split[1].strip())
            if pid not in pids:
                pids.append(pid)
    return pids


def under_cygwin():
    """Return if Cygwin binary exist"""
    return os.path.exists("/usr/bin/cygstart")


def under_macos():
    return sys.platform == 'darwin'


def under_vagrant():
    return os.path.isdir("/vagrant")


def under_wsl2():
    import platform
    return 'microsoft-standard-WSL2' in platform.release()


def wsl2_host_ip():
    if not under_wsl2() or cmd_opts.no_wsl2_network:
        return None

    pipe = subprocess.Popen("ip route show default | awk '{print $3}'",
                            shell=True,
                            stdout=subprocess.PIPE)
    output_lines = pipe.stdout.read().decode('utf-8').strip(' \r\n')
    ret = pipe.wait()

    if ret != 0:
        # Command exited with an error. The output it generated probably isn't what we're expecting
        return None

    if not output_lines:
        # No output detected, maybe there's no nameserver or WSL2 has some abnormal firewalls/network settings?
        return None

    return str(output_lines)


def kill_tasks_cygwin(victims):
    """Shell out to ps -ea to find processes to kill"""
    for victim in list(victims):
        pids = cygwin_pidof(victim)
#        progress("pids for (%s): %s" %
#                 (victim,",".join([ str(p) for p in pids])))
        for apid in pids:
            os.kill(apid, signal.SIGKILL)


def kill_tasks_macos():
    for window in windowID:
        cmd = ("osascript -e \'tell application \"Terminal\" to close "
               "(window(get index of window id %s))\'" % window)
        os.system(cmd)


def kill_tasks_psutil(victims):
    """Use the psutil module to kill tasks by name.  Sadly, this module is
    not available on Windows, but when it is we should be able to *just*
    use this routine"""
    import psutil
    for proc in psutil.process_iter():
        pdict = proc.as_dict(attrs=['environ', 'status'])
        if pdict['status'] == psutil.STATUS_ZOMBIE:
            continue
        if pdict['environ'] is not None:
            if pdict['environ'].get('SIM_VEHICLE_SESSION') == os.environ['SIM_VEHICLE_SESSION']:
                proc.kill()


def kill_tasks_pkill(victims):
    """Shell out to pkill(1) to kill processed by name"""
    for victim in victims:  # pkill takes a single pattern, so iterate
        cmd = ["pkill", victim[:15]]  # pkill matches only first 15 characters
        run_cmd_blocking("pkill", cmd, quiet=True)


def kill_tasks():
    """Clean up stray processes by name.  This is a shotgun approach"""
    progress("Killing tasks")

    if cmd_opts.coverage:
        import psutil
        for proc in psutil.process_iter(['pid', 'name', 'environ']):
            if proc.name() not in ["arducopter", "ardurover", "arduplane", "ardusub", "antennatracker"]:
                # only kill vehicle that way
                continue
            if os.environ['SIM_VEHICLE_SESSION'] not in proc.environ().get('SIM_VEHICLE_SESSION'):
                # only kill vehicle launched with sim_vehicle.py that way
                continue
            proc.terminate()
            progress("Waiting SITL to exit cleanly and write coverage .gcda")
            try:
                proc.wait(timeout=30)
                progress("Done")
            except psutil.TimeoutExpired:
                progress("SITL doesn't want to exit cleaning, killing ...")
                proc.kill()

    try:
        victim_names = {
            'JSBSim',
            'lt-JSBSim',
            'ArduPlane.elf',
            'ArduCopter.elf',
            'ArduSub.elf',
            'Rover.elf',
            'AntennaTracker.elf',
            'JSBSIm.exe',
            'MAVProxy.exe',
            'runsim.py',
            'AntennaTracker.elf',
            'scrimmage',
            'ardurover',
            'arduplane',
            'arducopter'
        }
        for vehicle in vinfo.options:
            for frame in vinfo.options[vehicle]["frames"]:
                frame_info = vinfo.options[vehicle]["frames"][frame]
                if "waf_target" not in frame_info:
                    continue
                exe_name = os.path.basename(frame_info["waf_target"])
                victim_names.add(exe_name)

        if under_cygwin():
            return kill_tasks_cygwin(victim_names)
        if under_macos() and os.environ.get('DISPLAY'):
            # use special macos kill routine if Display is on
            return kill_tasks_macos()

        try:
            kill_tasks_psutil(victim_names)
        except ImportError:
            kill_tasks_pkill(victim_names)
    except Exception as e:  # noqa: BLE001
        progress("kill_tasks failed: {}".format(str(e)))


def progress(text):
    """Display sim_vehicle progress text"""
    print("SIM_VEHICLE: " + text)


def wait_unlimited():
    """Wait until signal received"""
    while True:
        time.sleep(600)


vinfo = vehicleinfo.VehicleInfo()


def run_gui(cmd_opts):
    try:
        import wx
    except ImportError:
        progress("Error: wxPython could not be imported. GUI cannot start.")
        sys.exit(1)

    app = wx.App(False)
    config = wx.Config("ArduPilotSITL")

    locations = []
    default_location = "CMAC"
    loc_file = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'locations.txt')

    if os.path.exists(loc_file):
        with open(loc_file, 'r') as f:
            for line in f:
                line = line.strip()
                if line and not line.startswith('#'):
                    parts = line.split('=')
                    if len(parts) > 0:
                        locations.append(parts[0].strip())

    locations.sort()
    if default_location not in locations:
        locations.insert(0, default_location)

    target_location = cmd_opts.location or config.Read("last_location", default_location)

    default_vehicle = cmd_opts.vehicle
    if default_vehicle and default_vehicle in vinfo.options:
        available_vehicles = [default_vehicle]
        if default_vehicle == 'ArduCopter' and 'Helicopter' in vinfo.options:
            available_vehicles.append('Helicopter')
    else:
        available_vehicles = list(vinfo.options.keys())

    frame = wx.Frame(None, title="ArduPilot SITL Launcher")
    panel = wx.Panel(frame)
    vbox = wx.BoxSizer(wx.VERTICAL)

    vbox.Add(wx.StaticText(panel, label="Select Vehicle:"), flag=wx.LEFT | wx.TOP, border=10)
    vehicle_combo = wx.ComboBox(panel, choices=available_vehicles, style=wx.CB_READONLY)
    if available_vehicles:
        if len(available_vehicles) == 1:
            vehicle_combo.SetSelection(0)
        else:
            saved_vehicle = config.Read("last_vehicle", "")
            if saved_vehicle and saved_vehicle in available_vehicles:
                vehicle_combo.SetStringSelection(saved_vehicle)
            else:
                vehicle_combo.SetSelection(0)

    vbox.Add(vehicle_combo, flag=wx.EXPAND | wx.LEFT | wx.RIGHT | wx.TOP, border=10)

    vbox.Add(wx.StaticText(panel, label="Starting Location (-L):"), flag=wx.LEFT | wx.TOP, border=10)
    location_combo = wx.ComboBox(panel, choices=locations, style=wx.CB_DROPDOWN)
    location_combo.AutoComplete(locations)

    if target_location in locations:
        location_combo.SetSelection(locations.index(target_location))
    else:
        location_combo.SetValue(target_location)

    vbox.Add(location_combo, flag=wx.EXPAND | wx.LEFT | wx.RIGHT | wx.TOP, border=10)

    vbox.Add(wx.StaticText(panel, label="Aircraft Scenario (--aircraft):"), flag=wx.LEFT | wx.TOP, border=10)
    history_str = config.Read("aircraft_history", "")
    aircraft_history = [h for h in history_str.split(',') if h]

    aircraft_combo = wx.ComboBox(panel, choices=aircraft_history, style=wx.CB_DROPDOWN)
    aircraft_combo.AutoComplete(aircraft_history)
    if cmd_opts.aircraft:
        aircraft_combo.SetValue(cmd_opts.aircraft)
    elif aircraft_history:
        aircraft_combo.SetValue(aircraft_history[0])

    vbox.Add(aircraft_combo, flag=wx.EXPAND | wx.LEFT | wx.RIGHT | wx.TOP, border=10)

    options_sizer = wx.BoxSizer(wx.VERTICAL)

    chk_mavproxy = wx.CheckBox(panel, label="Enable MAVProxy")
    mavproxy_default = config.ReadBool("no_mavproxy", False)
    should_enable = not cmd_opts.no_mavproxy and (cmd_opts.map or cmd_opts.console or not mavproxy_default)
    chk_mavproxy.SetValue(should_enable)

    chk_map = wx.CheckBox(panel, label="Enable MAVProxy map")
    chk_map.SetValue(cmd_opts.map or config.ReadBool("map", True))

    chk_console = wx.CheckBox(panel, label="Enable MAVProxy console")
    chk_console.SetValue(cmd_opts.console or config.ReadBool("console", True))

    chk_osd = wx.CheckBox(panel, label="Enable OSD")
    chk_osd.SetValue(getattr(cmd_opts, 'OSD', False) or config.ReadBool("osd", False))

    chk_wipe = wx.CheckBox(panel, label="Reset to Default Parameters (-w)")
    chk_wipe.SetValue(cmd_opts.wipe_eeprom or config.ReadBool("wipe", False))

    def on_mavproxy(event):
        enabled = chk_mavproxy.GetValue()
        chk_map.Enable(enabled)
        chk_console.Enable(enabled)
        if not enabled:
            chk_map.SetValue(False)
            chk_console.SetValue(False)
        if event:
            event.Skip()

    chk_mavproxy.Bind(wx.EVT_CHECKBOX, on_mavproxy)
    on_mavproxy(None)

    options_sizer.Add(chk_mavproxy, flag=wx.ALL, border=5)
    options_sizer.Add(chk_map, flag=wx.LEFT, border=25)
    options_sizer.Add(chk_console, flag=wx.LEFT, border=25)
    options_sizer.Add(chk_osd, flag=wx.ALL, border=5)
    options_sizer.Add(wx.StaticLine(panel), flag=wx.EXPAND | wx.TOP | wx.BOTTOM, border=10)
    options_sizer.Add(chk_wipe, flag=wx.ALL, border=5)

    vbox.Add(options_sizer, flag=wx.LEFT | wx.RIGHT | wx.TOP | wx.EXPAND, border=10)

    is_cancelled = True

    def on_launch(event):
        nonlocal is_cancelled
        is_cancelled = False

        config.WriteBool("console", chk_console.GetValue())
        config.WriteBool("map", chk_map.GetValue())
        config.WriteBool("osd", chk_osd.GetValue())
        config.WriteBool("no_mavproxy", not chk_mavproxy.GetValue())
        config.WriteBool("wipe", chk_wipe.GetValue())
        config.Write("last_location", location_combo.GetValue())
        config.Write("last_vehicle", vehicle_combo.GetStringSelection())

        new_aircraft = aircraft_combo.GetValue().strip()
        if new_aircraft:
            if new_aircraft in aircraft_history:
                aircraft_history.remove(new_aircraft)
            aircraft_history.insert(0, new_aircraft)
            config.Write("aircraft_history", ",".join(aircraft_history[:10]))

        config.Flush()

        if available_vehicles:
            cmd_opts.vehicle = vehicle_combo.GetStringSelection()

        selected_loc = location_combo.GetValue()
        if selected_loc:
            cmd_opts.location = selected_loc

        if new_aircraft:
            cmd_opts.aircraft = new_aircraft

        cmd_opts.wipe_eeprom = chk_wipe.GetValue()
        cmd_opts.console = chk_console.GetValue()
        cmd_opts.map = chk_map.GetValue()
        cmd_opts.OSD = chk_osd.GetValue()
        cmd_opts.no_mavproxy = not chk_mavproxy.GetValue()

        frame.Close()

    btn_launch = wx.Button(panel, label="Launch SITL")
    btn_launch.Bind(wx.EVT_BUTTON, on_launch)
    vbox.Add(btn_launch, flag=wx.EXPAND | wx.ALL, border=15)

    panel.SetSizer(vbox)
    vbox.Fit(frame)

    frame.Centre()
    frame.Show()
    app.MainLoop()

    return not is_cancelled


def do_build(opts, frame_options):
    """Build sitl using waf"""
    progress("WAF build")

    old_dir = os.getcwd()
    os.chdir(root_dir)

    waf_light = os.path.join(root_dir, "modules/waf/waf-light")

    configure_target = frame_options.get('configure_target', 'sitl')

    cmd_configure = [waf_light, "configure", "--board", configure_target]
    if opts.debug:
        cmd_configure.append("--debug")

    if opts.coverage:
        cmd_configure.append("--coverage")

    if opts.enable_onvif and 'antennatracker' in frame_options["waf_target"]:
        cmd_configure.append("--enable-onvif")

    if opts.OSD:
        cmd_configure.append("--enable-sfml")
        cmd_configure.append("--sitl-osd")

    if opts.OSDMSP:
        cmd_configure.append("--osd")

    if opts.rgbled:
        cmd_configure.append("--enable-sfml")
        cmd_configure.append("--sitl-rgbled")

    if opts.tonealarm:
        cmd_configure.append("--enable-sfml-audio")

    if opts.math_check_indexes:
        cmd_configure.append("--enable-math-check-indexes")

    if opts.enable_ekf2:
        cmd_configure.append("--enable-EKF2")

    if opts.disable_ekf3:
        cmd_configure.append("--disable-EKF3")

    if opts.postype_single:
        cmd_configure.append("--postype-single")

    if opts.ekf_double:
        cmd_configure.append("--ekf-double")

    if opts.ekf_single:
        cmd_configure.append("--ekf-single")

    if opts.force_32bit:
        cmd_configure.append("--force-32bit")

    if opts.ubsan:
        cmd_configure.append("--ubsan")

    if opts.ubsan_abort:
        cmd_configure.append("--ubsan-abort")

    if opts.num_aux_imus:
        cmd_configure.append("--num-aux-imus=%s" % opts.num_aux_imus)

    for nv in opts.define:
        cmd_configure.append("--define=%s" % nv)

    if opts.enable_DDS:
        cmd_configure.append("--enable-DDS")

    if opts.disable_networking:
        cmd_configure.append("--disable-networking")

    if opts.enable_ppp:
        cmd_configure.append("--enable-PPP")

    if opts.enable_networking_tests:
        cmd_configure.append("--enable-networking-tests")

    pieces = [shlex.split(x) for x in opts.waf_configure_args]
    for piece in pieces:
        cmd_configure.extend(piece)

    if not cmd_opts.no_configure:
        run_cmd_blocking("Configure waf", cmd_configure, check=True)

    if opts.clean:
        run_cmd_blocking("Building clean", [waf_light, "clean"])

    print(frame_options)
    cmd_build = [waf_light, "build", "--target", frame_options["waf_target"]]
    if opts.jobs is not None:
        cmd_build += ['-j', str(opts.jobs)]
    pieces = [shlex.split(x) for x in opts.waf_build_args]
    for piece in pieces:
        cmd_build.extend(piece)

    _, sts = run_cmd_blocking("Building", cmd_build)

    if sts != 0:  # build failed
        if opts.rebuild_on_failure:
            progress("Build failed; cleaning and rebuilding")
            run_cmd_blocking("Building clean", [waf_light, "clean"])

            _, sts = run_cmd_blocking("Building", cmd_build)
            if sts != 0:
                progress("Build failed")
                sys.exit(1)
        else:
            progress("Build failed")
            sys.exit(1)

    os.chdir(old_dir)


def do_build_parameters(vehicle):
    # build succeeded
    # now build parameters
    progress("Building fresh parameter descriptions")
    param_parse_path = os.path.join(
        autotest_dir, "param_metadata/param_parse.py")
    cmd_param_build = ["python", param_parse_path, '--vehicle', vehicle]

    _, sts = run_cmd_blocking("Building fresh params", cmd_param_build)
    if sts != 0:
        progress("Parameter build failed")
        sys.exit(1)


def get_user_locations_path():
    '''The user locations.txt file is located by default in
    $XDG_CONFIG_DIR/ardupilot/locations.txt. If $XDG_CONFIG_DIR is
    not defined, we look in $HOME/.config/ardupilot/locations.txt.  If
    $HOME is not defined, we look in ./.config/ardupilot/locations.txt.'''

    config_dir = os.environ.get(
        'XDG_CONFIG_DIR',
        os.path.join(os.environ.get('HOME', '.'), '.config'))

    user_locations_path = os.path.join(
        config_dir, 'ardupilot', 'locations.txt')

    return user_locations_path


def find_offsets(instances, file_path):
    offsets = {}
    swarminit_filepath = os.path.join(autotest_dir, "swarminit.txt")
    comment_regex = re.compile(r"\s*#.*")
    for path in [file_path, swarminit_filepath]:
        if os.path.isfile(path):
            with open(path, 'r') as fd:
                for line in fd:
                    line = re.sub(comment_regex, "", line)
                    line = line.rstrip("\n")
                    if len(line) == 0:
                        continue
                    (instance, offset) = line.split("=")
                    instance = (int)(instance)
                    if (instance not in offsets) and (instance in instances):
                        offsets[instance] = [(float)(x) for x in offset.split(",")]
                        continue
                    if len(offsets) == len(instances):
                        return offsets
        if len(offsets) == len(instances):
            return offsets
    for instance in instances:
        if instance not in offsets:
            offsets[instance] = [90.0, 20.0 * instance, 0.0, None]
    return offsets


def find_geocoder_location(locname):
    '''find a location using geocoder and SRTM'''
    try:
        import geocoder
    except ImportError:
        print("geocoder not installed")
        return None
    # Step 1: Attempt the lookup
    try:
        j = geocoder.osm(locname)
    except Exception as e:  # noqa: BLE001
        # Handle network/blocked errors (like 403)
        err_msg = str(e)
        if '403' in err_msg:
            print(f"geocoder access denied (HTTP 403) for '{locname}'")
        else:
            print(f"geocoder error: {err_msg}")
        return None
    # Step 2: Validate the response object (Handles status_code 403 if no exception was raised)
    status_code = getattr(j, 'status_code', None)
    if status_code == 403:
        print(f"geocoder access denied (HTTP 403) for '{locname}'")
        return None

    if j is None or not hasattr(j, 'lat') or j.lat is None:
        print(f"geocoder failed to find '{locname}'")
        return None
    # Step 3: Success logic
    lat, lon = j.lat, j.lng

    from MAVProxy.modules.mavproxy_map import srtm
    downloader = srtm.SRTMDownloader()
    downloader.loadFileList()
    start = time.time()
    alt = None
    while time.time() - start < 5:
        tile = downloader.getTile(int(math.floor(lat)), int(math.floor(lon)))
        if tile:
            alt = tile.getAltitudeFromLatLon(lat, lon)
            break
    if alt is None:
        print(f"timed out getting altitude for '{locname}'")
        return None
    return [lat, lon, alt, 0.0]


def find_location_by_name(locname):
    """Search locations.txt for locname, return GPS coords"""
    locations_userpath = os.environ.get('ARDUPILOT_LOCATIONS',
                                        get_user_locations_path())
    locations_filepath = os.path.join(autotest_dir, "locations.txt")
    comment_regex = re.compile(r"\s*#.*")
    for path in [locations_userpath, locations_filepath]:
        if not os.path.isfile(path):
            continue
        with open(path, 'r') as fd:
            for line in fd:
                line = re.sub(comment_regex, "", line)
                line = line.rstrip("\n")
                if len(line) == 0:
                    continue
                (name, loc) = line.split("=")
                if name == locname:
                    return [(float)(x) for x in loc.split(",")]

    # fallback to geocoder if available
    loc = find_geocoder_location(locname)
    if loc is None:
        sys.exit(1)
    return loc


def find_spawns(loc, offsets):
    lat, lon, alt, heading = loc
    spawns = {}
    for k in offsets:
        (x, y, z, head) = offsets[k]
        if head is None:
            head = heading
        g = mavextra.gps_offset(lat, lon, x, y)
        spawns[k] = ",".join([str(g[0]), str(g[1]), str(alt+z), str(head)])
    return spawns


def progress_cmd(what, cmd):
    """Print cmd in a way a user could cut-and-paste to get the same effect"""
    progress(what)
    shell_text = "%s" % (" ".join(['"%s"' % x for x in cmd]))
    progress(shell_text)


def run_cmd_blocking(what, cmd, quiet=False, check=False, **kw):
    if not quiet:
        progress_cmd(what, cmd)

    try:
        p = subprocess.Popen(cmd, **kw)
        ret = os.waitpid(p.pid, 0)
    except Exception as e:  # noqa: BLE001
        print("[%s] An exception has occurred with command: '%s'" % (what, (' ').join(cmd)))
        print(e)
        sys.exit(1)

    _, sts = ret
    if check and sts != 0:
        progress("(%s) exited with code %d" % (what, sts,))
        sys.exit(1)
    return ret


def run_in_terminal_window(name, cmd, **kw):

    """Execute the run_in_terminal_window.sh command for cmd"""
    runme = [os.path.join(autotest_dir, "run_in_terminal_window.sh"), name]
    runme.extend(cmd)
    progress_cmd("Run " + name, runme)

    if under_macos() and os.environ.get('DISPLAY'):
        # on MacOS record the window IDs so we can close them later
        out = subprocess.Popen(runme, stdout=subprocess.PIPE, **kw).communicate()[0]
        out = out.decode('utf-8')
        p = re.compile('tab 1 of window id (.*)')

        tstart = time.time()
        while time.time() - tstart < 5:
            tabs = p.findall(out)

            if len(tabs) > 0:
                break

            time.sleep(0.1)
        # sleep for extra 2 seconds for application to start
        time.sleep(2)
        if len(tabs) > 0:
            windowID.append(tabs[0])
        else:
            progress("Cannot find %s process terminal" % name)
    else:
        subprocess.Popen(runme, **kw)


tracker_serial0 = None  # blemish


def start_antenna_tracker(opts):
    """Compile and run the AntennaTracker, add tracker to mavproxy"""

    global tracker_serial0
    progress("Preparing antenna tracker")
    tracker_home = find_location_by_name(opts.tracker_location)
    vehicledir = os.path.join(autotest_dir, "../../" + "AntennaTracker")
    options = vinfo.options["AntennaTracker"]
    tracker_default_frame = options["default_frame"]
    tracker_frame_options = options["frames"][tracker_default_frame]
    do_build(opts, tracker_frame_options)
    tracker_instance = 1
    oldpwd = os.getcwd()
    os.chdir(vehicledir)
    tracker_serial0 = "tcp:127.0.0.1:" + str(5760 + 10 * tracker_instance)
    binary_basedir = "build/sitl"
    exe = os.path.join(root_dir,
                       binary_basedir,
                       "bin/antennatracker")
    run_in_terminal_window("AntennaTracker",
                           ["nice",
                            exe,
                            "-I" + str(tracker_instance),
                            "--model=tracker",
                            "--home=" + ",".join([str(x) for x in tracker_home])])
    os.chdir(oldpwd)


def start_CAN_Periph(opts, frame_info):
    """Compile and run the sitl_periph"""

    progress("Preparing sitl_periph_universal")
    options = vinfo.options["sitl_periph_universal"]['frames']['universal']
    defaults_path = frame_info.get('periph_params_filename', None)
    if defaults_path is None:
        defaults_path = options.get('default_params_filename', None)

    if not isinstance(defaults_path, list):
        defaults_path = [defaults_path]

    # add in path and make a comma separated list
    defaults_path = ','.join([util.relcurdir(os.path.join(autotest_dir, p)) for p in defaults_path])

    if not cmd_opts.no_rebuild:
        do_build(opts, options)
    exe = os.path.join(root_dir, 'build/sitl_periph_universal', 'bin/AP_Periph')
    cmd = ["nice"]
    cmd_name = "sitl_periph_universal"
    if opts.valgrind:
        cmd_name += " (valgrind)"
        cmd.append("valgrind")
        # adding this option allows valgrind to cope with the overload
        # of operator new
        cmd.append("--soname-synonyms=somalloc=nouserintercepts")
        cmd.append("--track-origins=yes")
    if opts.gdb or opts.gdb_stopped:
        cmd_name += " (gdb)"
        cmd.append("gdb")
        gdb_commands_file = tempfile.NamedTemporaryFile(mode='w', delete=False)
        atexit.register(os.unlink, gdb_commands_file.name)
        gdb_commands_file.write("set pagination off\n")
        if not opts.gdb_stopped:
            gdb_commands_file.write("r\n")
        gdb_commands_file.close()
        cmd.extend(["-x", gdb_commands_file.name])
        cmd.append("--args")
    cmd.append(exe)
    if defaults_path is not None:
        cmd.append("--defaults")
        cmd.append(defaults_path)
    run_in_terminal_window(cmd_name, cmd)


def start_vehicle(binary, opts, stuff, spawns=None):
    """Run the ArduPilot binary"""

    cmd_name = opts.vehicle
    cmd = []
    if opts.valgrind:
        cmd_name += " (valgrind)"
        cmd.append("valgrind")
        # adding this option allows valgrind to cope with the overload
        # of operator new
        cmd.append("--soname-synonyms=somalloc=nouserintercepts")
        cmd.append("--track-origins=yes")
    if opts.callgrind:
        cmd_name += " (callgrind)"
        cmd.append("valgrind")
        cmd.append("--tool=callgrind")
    if opts.gdb or opts.gdb_stopped:
        cmd_name += " (gdb)"
        cmd.append("gdb")
        gdb_commands_file = tempfile.NamedTemporaryFile(mode='w', delete=False)
        atexit.register(os.unlink, gdb_commands_file.name)

        for breakpoint in opts.breakpoint:
            gdb_commands_file.write("b %s\n" % (breakpoint,))
        if opts.disable_breakpoints:
            gdb_commands_file.write("disable\n")
        gdb_commands_file.write("set pagination off\n")
        if not opts.gdb_stopped:
            gdb_commands_file.write("r\n")
        gdb_commands_file.close()
        cmd.extend(["-x", gdb_commands_file.name])
        cmd.append("--args")
    elif opts.lldb or opts.lldb_stopped:
        cmd_name += " (lldb)"
        cmd.append("lldb")
        lldb_commands_file = tempfile.NamedTemporaryFile(mode='w', delete=False)
        atexit.register(os.unlink, lldb_commands_file.name)

        for breakpoint in opts.breakpoint:
            lldb_commands_file.write("b %s\n" % (breakpoint,))
        if not opts.lldb_stopped:
            lldb_commands_file.write("process launch\n")
        lldb_commands_file.close()
        cmd.extend(["-s", lldb_commands_file.name])
        cmd.append("--")
    if opts.strace:
        cmd_name += " (strace)"
        cmd.append("strace")
        strace_options = ['-o', binary + '.strace', '-s', '8000', '-ttt']
        cmd.extend(strace_options)

    cmd.append(binary)
    if opts.wipe_eeprom:
        cmd.append("-w")
    cmd.extend(["--model", stuff["model"]])
    cmd.extend(["--speedup", str(opts.speedup)])
    if opts.sysid is not None:
        cmd.extend(["--sysid", str(opts.sysid)])
    if opts.slave is not None:
        cmd.extend(["--slave", str(opts.slave)])
    if opts.enable_fgview:
        cmd.extend(["--enable-fgview"])
    if opts.sitl_instance_args:
        # this could be a lot better:
        cmd.extend(opts.sitl_instance_args)
    if opts.mavlink_gimbal:
        cmd.append("--gimbal")
    # the SITL binary resolves the per-frame default parameter files
    # from its embedded vehicleinfo.json keyed by --model, so we no
    # longer pass --defaults here. Use --add-param-file or --param to
    # layer extra parameters on top of the embedded defaults.
    path = None
    if opts.flash_storage:
        cmd.append("--set-storage-flash-enabled 1")
        cmd.append("--set-storage-posix-enabled 0")
    elif opts.fram_storage:
        cmd.append("--set-storage-fram-enabled 1")
        cmd.append("--set-storage-posix-enabled 0")
    if opts.add_param_file:
        for file in opts.add_param_file:
            if not os.path.isfile(file):
                print("The parameter file (%s) does not exist" %
                      (file,))
                sys.exit(1)

            if path is not None:
                path += "," + str(file)
            else:
                path = str(file)

            progress("Adding parameters from (%s)" % (str(file),))
    if opts.param:
        param_file = tempfile.NamedTemporaryFile(mode='w', delete=False)
        atexit.register(os.unlink, param_file.name)
        param_dir = os.path.join(param_file.name)
        single_params = []
        for p in opts.param:
            single_params.extend(p.split(','))
        for sp in single_params:
            sp.replace("=", " ")
            sp = sp.strip()
            param_file.write(f"{sp}\n")
        if path is not None:
            path += "," + str(param_dir)
        else:
            path = str(param_dir)

    if opts.OSDMSP:
        osd_paths = [
            os.path.join(root_dir, "libraries/AP_MSP/Tools/osdtest.parm"),
            os.path.join(autotest_dir, "default_params/msposd.parm"),
        ]
        if path is not None:
            path += "," + ",".join(osd_paths)
        else:
            path = ",".join(osd_paths)
        subprocess.Popen([os.path.join(root_dir, "libraries/AP_MSP/Tools/msposd.py")])

    if path is not None and len(path) > 0:
        cmd.extend(["--defaults", path])

    if cmd_opts.start_time is not None:
        # Parse start_time into a double precision number specifying seconds since 1900.
        try:
            start_time_UTC = time.mktime(datetime.datetime.strptime(cmd_opts.start_time, '%Y-%m-%d-%H:%M').timetuple())
        except ValueError:
            print("Incorrect start time format - require YYYY-MM-DD-HH:MM (given %s)" % cmd_opts.start_time)
            sys.exit(1)

        cmd.append("--start-time=%d" % start_time_UTC)

    cmd.append("--sim-address=%s" % cmd_opts.sim_address)

    old_dir = os.getcwd()
    for i, i_dir in zip(instances, instance_dir):
        c = ["-I" + str(i)]
        if spawns is not None:
            c.extend(["--home", spawns[i]])
        if opts.mcast:
            c.extend(["--serial0", "mcast:"])
        elif opts.udp:
            c.extend(["--serial0", "udpclient:127.0.0.1:" + str(5760+i*10)])
        if opts.auto_sysid:
            if opts.sysid is not None:
                raise ValueError("Can't use auto-sysid and sysid together")
            sysid = i + 1
            # Take 0-based logging into account
            if sysid < 1 or sysid > 255:
                raise ValueError("Invalid system id %d" % sysid)
            c.extend(["--sysid", str(sysid)])

        os.chdir(i_dir)
        run_in_terminal_window(cmd_name, cmd + c)
    os.chdir(old_dir)


def start_mavproxy(opts, stuff):
    """Run mavproxy"""
    # FIXME: would be nice to e.g. "mavproxy.mavproxy(....).run"
    # rather than shelling out

    extra_cmd = ""
    cmd = []
    if under_cygwin():
        cmd.append("/usr/bin/cygstart")
        cmd.append("-w")
        cmd.append("mavproxy.exe")
    else:
        cmd.append("mavproxy.py")

    if opts.valgrind:
        cmd.extend(['--retries', '10'])
    else:
        cmd.extend(['--retries', '5'])

    if opts.mcast:
        cmd.extend(["--master", "mcast:"])

    # returns a valid IP of the host windows computer if we're WSL2.
    # This is run before the loop so it only runs once
    wsl2_host_ip_str = wsl2_host_ip()

    for i in instances:
        if not opts.no_extra_ports:
            ports = [14550 + 10 * i]
            for port in ports:
                if under_vagrant():
                    # We're running inside of a vagrant guest; forward our
                    # mavlink out to the containing host OS
                    cmd.extend(["--out", "10.0.2.2:" + str(port)])
                elif wsl2_host_ip_str:
                    # We're running WSL2; forward our
                    # mavlink out to the containing host Windows OS
                    cmd.extend(["--out", str(wsl2_host_ip_str) + ":" + str(port)])
                else:
                    cmd.extend(["--out", "127.0.0.1:" + str(port)])

        if not opts.mcast:
            if opts.udp:
                cmd.extend(["--master", ":" + str(5760 + 10 * i)])
            else:
                cmd.extend(["--master", "tcp:127.0.0.1:" + str(5760 + 10 * i)])
        if stuff["sitl-port"] and not opts.no_rcin:
            cmd.extend(["--sitl", "127.0.0.1:" + str(5501 + 10 * i)])

    if opts.tracker:
        cmd.extend(["--load-module", "tracker"])
        # tracker_serial0 is set when we start the tracker...
        extra_cmd += ("module load map;"
                      "tracker set port %s; "
                      "tracker start; "
                      "tracker arm;" % (tracker_serial0,))

    if opts.mavlink_gimbal:
        cmd.extend(["--load-module", "gimbal"])

    if "extra_mavlink_cmds" in stuff:
        extra_cmd += " " + stuff["extra_mavlink_cmds"]

    # Parsing the arguments to pass to mavproxy, split args on space
    # and "=" signs and ignore those signs within quotation marks
    if opts.mavproxy_args:
        # It would be great if this could be done with regex
        mavargs = opts.mavproxy_args.split(" ")
        # Find the arguments with '=' in them and split them up
        for i, x in enumerate(mavargs):
            if '=' in x:
                mavargs[i] = x.split('=')[0]
                mavargs.insert(i+1, x.split('=')[1])
        # Use this flag to tell if parsing character in between a pair
        # of quotation marks
        inString = False
        beginStringIndex = []
        endStringIndex = []
        # Iterate through the arguments, looking for the arguments
        # that begin with a quotation mark and the ones that end with
        # a quotation mark
        for i, x in enumerate(mavargs):
            if not inString and x[0] == "\"":
                beginStringIndex.append(i)
                mavargs[i] = x[1:]
                inString = True
            elif inString and x[-1] == "\"":
                endStringIndex.append(i)
                inString = False
                mavargs[i] = x[:-1]
        # Replace the list items with one string to be passed into mavproxy
        for begin, end in zip(beginStringIndex, endStringIndex):
            replacement = " ".join(mavargs[begin:end+1])
            mavargs[begin] = replacement
            mavargs = mavargs[0:begin+1] + mavargs[end+1:]
        cmd.extend(mavargs)

    # compatibility pass-through parameters (for those that don't want
    # to use -C :-)
    for out in opts.out:
        cmd.extend(['--out', out])
    if opts.map:
        cmd.append('--map')
    if opts.console:
        cmd.append('--console')
    if opts.aircraft is not None:
        cmd.extend(['--aircraft', opts.aircraft])
    if opts.moddebug:
        cmd.append('--moddebug=%u' % opts.moddebug)
    if opts.mavcesium:
        cmd.extend(["--load-module", "cesium"])

    if opts.fresh_params:
        # these were built earlier:
        path = os.path.join(os.getcwd(), "apm.pdef.xml")
        cmd.extend(['--load-module', 'param:{"xml-filepath":"%s"}' % path])

    if len(extra_cmd):
        cmd.extend(['--cmd', extra_cmd])

    # add Tools/mavproxy_modules to PYTHONPATH in autotest so we can
    # find random MAVProxy helper modules like sitl_calibration
    local_mp_modules_dir = os.path.abspath(
        os.path.join(__file__, '..', '..', 'mavproxy_modules'))
    env = dict(os.environ)
    old = env.get('PYTHONPATH', None)
    env['PYTHONPATH'] = local_mp_modules_dir
    if old is not None:
        env['PYTHONPATH'] += os.path.pathsep + old

    run_cmd_blocking("Run MavProxy", cmd, env=env)
    progress("MAVProxy exited")

    if opts.gdb:
        # in the case that MAVProxy exits (as opposed to being
        # killed), restart it if we are running under GDB.  This
        # allows ArduPilot to stop (eg. via a very early panic call)
        # and have you debugging session not be killed.
        while True:
            progress("Running under GDB; restarting MAVProxy")
            run_cmd_blocking("Run MavProxy", cmd, env=env)
            progress("MAVProxy exited; sleeping 10")
            time.sleep(10)


vehicle_options_string = '|'.join(vinfo.options.keys())


def generate_frame_help():
    ret = ""
    for vehicle in vinfo.options:
        frame_options = sorted(vinfo.options[vehicle]["frames"].keys())
        frame_options_string = '|'.join(frame_options)
        ret += "%s: %s\n" % (vehicle, frame_options_string)
    return ret


# map from some vehicle aliases back to directory names.  APMrover2
# was the old name / directory name for Rover.
vehicle_map = {
    "APMrover2": "Rover",
    "Copter": "ArduCopter",
    "Plane": "ArduPlane",
    "Sub": "ArduSub",
    "Blimp" : "Blimp",
    "Rover": "Rover",
}
# add lower-case equivalents too
for k in list(vehicle_map.keys()):
    vehicle_map[k.lower()] = vehicle_map[k]

# define and run parser
parser = CompatOptionParser(
    "sim_vehicle.py",
    epilog=""
    "eeprom.bin in the starting directory contains the parameters for your "
    "simulated vehicle. Always start from the same directory. It is "
    "recommended that you start in the main vehicle directory for the vehicle "
    "you are simulating, for example, start in the ArduPlane directory to "
    "simulate ArduPlane")

vehicle_choices = list(vinfo.options.keys())

# add vehicle aliases to argument parser options:
for c in vehicle_map.keys():
    vehicle_choices.append(c)

parser.add_option("-v", "--vehicle",
                  type='choice',
                  default=None,
                  help="vehicle type (%s)" % vehicle_options_string,
                  choices=vehicle_choices)
parser.add_option("-f", "--frame", type='string', default=None, help="""set vehicle frame type

%s""" % (generate_frame_help()))

parser.add_option("--vehicle-binary",
                  default=None,
                  help="vehicle binary path")

parser.add_option("-C", "--sim_vehicle_sh_compatible",
                  action='store_true',
                  default=False,
                  help="be compatible with the way sim_vehicle.sh works; "
                  "make this the first option")

parser.add_option("-P", "--param",
                  default=None,
                  action='append',
                  help="set some param with the format PARAM=VALUE; "
                       "layered on top of the per-frame defaults the "
                       "binary loads from its embedded vehicleinfo.json")

parser.add_option("--gui",
                  action='store_true',
                  default=False,
                  help="start GUI launcher")

group_build = optparse.OptionGroup(parser, "Build options")
group_build.add_option("-N", "--no-rebuild",
                       action='store_true',
                       default=False,
                       help="don't rebuild before starting ardupilot")
group_build.add_option("--no-configure",
                       action='store_true',
                       default=False,
                       help="don't run waf configure before building")
group_build.add_option("-D", "--debug",
                       action='store_true',
                       default=False,
                       help="build with debugging")
group_build.add_option("-c", "--clean",
                       action='store_true',
                       default=False,
                       help="do a make clean before building")
group_build.add_option("-j", "--jobs",
                       default=None,
                       type='int',
                       help="number of processors to use during build "
                       "(default for waf : number of processor, for make : 1)")
group_build.add_option("-b", "--build-target",
                       default=None,
                       type='string',
                       help="override SITL build target")
group_build.add_option("--enable-math-check-indexes",
                       default=False,
                       action="store_true",
                       dest="math_check_indexes",
                       help="enable checking of math indexes")
group_build.add_option("", "--force-32bit",
                       default=False,
                       action='store_true',
                       dest="force_32bit",
                       help="compile sitl using 32-bit")
group_build.add_option("", "--configure-define",
                       default=[],
                       action='append',
                       dest="define",
                       help="create a preprocessor define")
group_build.add_option("", "--rebuild-on-failure",
                       dest="rebuild_on_failure",
                       action='store_true',
                       default=False,
                       help="if build fails, do not clean and rebuild")
group_build.add_option("", "--waf-configure-arg",
                       action="append",
                       dest="waf_configure_args",
                       type="string",
                       default=[],
                       help="extra arguments to pass to waf in configure step")
group_build.add_option("", "--waf-build-arg",
                       action="append",
                       dest="waf_build_args",
                       type="string",
                       default=[],
                       help="extra arguments to pass to waf in its build step")
group_build.add_option("", "--coverage",
                       action='store_true',
                       default=False,
                       help="use coverage build")
group_build.add_option("", "--ubsan",
                       default=False,
                       action='store_true',
                       dest="ubsan",
                       help="compile sitl with undefined behaviour sanitiser")
group_build.add_option("", "--ubsan-abort",
                       default=False,
                       action='store_true',
                       dest="ubsan_abort",
                       help="compile sitl with undefined behaviour sanitiser and abort on error")
group_build.add_option("--num-aux-imus",
                       dest="num_aux_imus",
                       default=0,
                       type='int',
                       help='number of auxiliary IMUs to simulate')
parser.add_option_group(group_build)

group_sim = optparse.OptionGroup(parser, "Simulation options")
group_sim.add_option("-I", "--instance",
                     default=0,
                     type='int',
                     help="instance of simulator")
group_sim.add_option("-n", "--count",
                     type='int',
                     default=1,
                     help="vehicle count; if this is specified, -I is used as a base-value")
group_sim.add_option("-i", "--instances",
                     default=None,
                     type='string',
                     help="a space delimited list of instances to spawn; if specified, overrides -I and -n.")
group_sim.add_option("-V", "--valgrind",
                     action='store_true',
                     default=False,
                     help="enable valgrind for memory access checking (slow!)")
group_sim.add_option("", "--callgrind",
                     action='store_true',
                     default=False,
                     help="enable valgrind for performance analysis (slow!!)")
group_sim.add_option("-T", "--tracker",
                     action='store_true',
                     default=False,
                     help="start an antenna tracker instance")
group_sim.add_option("", "--enable-onvif",
                     action="store_true",
                     help="enable onvif camera control sim using AntennaTracker")
group_sim.add_option("", "--can-peripherals",
                     action='store_true',
                     default=False,
                     help="start a DroneCAN peripheral instance")
group_sim.add_option("-A", "--sitl-instance-args",
                     type='string',
                     default=[],
                     action="append",
                     help="pass arguments to SITL instance")
group_sim.add_option("-G", "--gdb",
                     action='store_true',
                     default=False,
                     help="use gdb for debugging ardupilot")
group_sim.add_option("-g", "--gdb-stopped",
                     action='store_true',
                     default=False,
                     help="use gdb for debugging ardupilot (no auto-start)")
group_sim.add_option("--lldb",
                     action='store_true',
                     default=False,
                     help="use lldb for debugging ardupilot")
group_sim.add_option("--lldb-stopped",
                     action='store_true',
                     default=False,
                     help="use ldb for debugging ardupilot (no auto-start)")
group_sim.add_option("-d", "--delay-start",
                     default=0,
                     type='float',
                     help="delay start of mavproxy by this number of seconds")
group_sim.add_option("-B", "--breakpoint",
                     type='string',
                     action="append",
                     default=[],
                     help="add a breakpoint at given location in debugger")
group_sim.add_option("--disable-breakpoints",
                     default=False,
                     action='store_true',
                     help="disable all breakpoints before starting")
group_sim.add_option("-M", "--mavlink-gimbal",
                     action='store_true',
                     default=False,
                     help="enable MAVLink gimbal")
group_sim.add_option("-L", "--location", type='string',
                     default=None,
                     help="use start location from "
                     "Tools/autotest/locations.txt")
group_sim.add_option("-l", "--custom-location",
                     type='string',
                     default=None,
                     help="set custom start location (lat,lon,alt,heading)")
group_sim.add_option("-S", "--speedup",
                     default=1,
                     type='int',
                     help="set simulation speedup (1 for wall clock time)")
group_sim.add_option("-t", "--tracker-location",
                     default='CMAC_PILOTSBOX',
                     type='string',
                     help="set antenna tracker start location")
group_sim.add_option("-w", "--wipe-eeprom",
                     action='store_true',
                     default=False, help="wipe EEPROM and reload parameters")
group_sim.add_option("-m", "--mavproxy-args",
                     default=None,
                     type='string',
                     help="additional arguments to pass to mavproxy.py")
group_sim.add_option("", "--scrimmage-args",
                     default=None,
                     type='string',
                     help="arguments used to populate SCRIMMAGE mission (comma-separated). "
                     "Currently visual_model, motion_model, and terrain are supported. "
                     "Usage: [instance=]argument=value...")
group_sim.add_option("", "--strace",
                     action='store_true',
                     default=False,
                     help="strace the ArduPilot binary")
group_sim.add_option("", "--model",
                     type='string',
                     default=None,
                     help="Override simulation model to use")
group_sim.add_option("", "--use-dir",
                     type='string',
                     default=None,
                     help="Store SITL state and output in named directory")
group_sim.add_option("", "--no-mavproxy",
                     action='store_true',
                     default=False,
                     help="Don't launch MAVProxy")
group_sim.add_option("", "--fresh-params",
                     action='store_true',
                     dest='fresh_params',
                     default=False,
                     help="Generate and use local parameter help XML")
group_sim.add_option("", "--mcast",
                     action="store_true",
                     default=False,
                     help="Use multicasting at default 239.255.145.50:14550")
group_sim.add_option("", "--udp",
                     action="store_true",
                     default=False,
                     help="Use UDP on 127.0.0.1:5760")
group_sim.add_option("", "--osd",
                     action='store_true',
                     dest='OSD',
                     default=False,
                     help="Enable SITL OSD")
group_sim.add_option("", "--osdmsp",
                     action='store_true',
                     dest='OSDMSP',
                     default=False,
                     help="Enable SITL OSD using MSP")
group_sim.add_option("", "--tonealarm",
                     action='store_true',
                     dest='tonealarm',
                     default=False,
                     help="Enable SITL ToneAlarm")
group_sim.add_option("", "--rgbled",
                     action='store_true',
                     dest='rgbled',
                     default=False,
                     help="Enable SITL RGBLed")
group_sim.add_option("", "--add-param-file",
                     type='string',
                     action="append",
                     default=None,
                     help="Add a parameters file to use; layered on "
                     "top of the per-frame defaults the binary loads "
                     "from its embedded vehicleinfo.json")
group_sim.add_option("", "--no-extra-ports",
                     action='store_true',
                     dest='no_extra_ports',
                     default=False,
                     help="Disable setup of UDP 14550 and 14551 output")
group_sim.add_option("", "--no-wsl2-network",
                     action='store_true',
                     dest='no_wsl2_network',
                     default=False,
                     help="Disable setup of WSL2 network for output")
group_sim.add_option("-Z", "--swarm",
                     type='string',
                     default=None,
                     help="Specify path of swarminit.txt for shifting spawn location")
group_sim.add_option("", "--auto-offset-line",
                     type="string",
                     default=None,
                     help="Argument of form  BEARING,DISTANCE.  When running multiple instances, form a line along bearing with an interval of DISTANCE",  # NOQA
                     )
group_sim.add_option("--flash-storage",
                     action='store_true',
                     help="use flash storage emulation")
group_sim.add_option("--fram-storage",
                     action='store_true',
                     help="use fram storage emulation")
group_sim.add_option("--enable-ekf2",
                     action='store_true',
                     help="disable EKF2 in build")
group_sim.add_option("--disable-ekf3",
                     action='store_true',
                     help="disable EKF3 in build")
group_sim.add_option("", "--start-time",
                     default=None,
                     type='string',
                     help="specify simulation start time in format YYYY-MM-DD-HH:MM in your local time zone")
group_sim.add_option("", "--sysid",
                     type='int',
                     default=None,
                     help="Set MAV_SYSID")
group_sim.add_option("--postype-single",
                     action='store_true',
                     help="force single precision postype_t")
group_sim.add_option("--ekf-double",
                     action='store_true',
                     help="use double precision in EKF")
group_sim.add_option("--ekf-single",
                     action='store_true',
                     help="use single precision in EKF")
group_sim.add_option("", "--slave",
                     type='int',
                     default=0,
                     help="Set the number of JSON slave")
group_sim.add_option("", "--auto-sysid",
                     default=False,
                     action='store_true',
                     help="Set MAV_SYSID based upon instance number")
group_sim.add_option("", "--sim-address",
                     type=str,
                     default="127.0.0.1",
                     help="IP address of the simulator. Defaults to localhost")
group_sim.add_option("--enable-DDS", action='store_true',
                     help="Enable the dds client to connect with ROS2/DDS")
group_sim.add_option("--disable-networking", action='store_true',
                     help="Disable networking APIs")
group_sim.add_option("--enable-ppp", action='store_true',
                     help="Enable PPP networking")
group_sim.add_option("--enable-networking-tests", action='store_true',
                     help="Enable networking tests")
group_sim.add_option("--enable-fgview", action='store_true',
                     help="Enable FlightGear output")

parser.add_option_group(group_sim)


# special-cased parameters for mavproxy, because some people's fingers
# have long memories, and they don't want to use -C :-)
group = optparse.OptionGroup(parser,
                             "Compatibility MAVProxy options "
                             "(consider using --mavproxy-args instead)")
group.add_option("", "--out",
                 default=[],
                 type='string',
                 action="append",
                 help="create an additional mavlink output")
group.add_option("", "--map",
                 default=False,
                 action='store_true',
                 help="load map module on startup")
group.add_option("", "--mavcesium",
                 default=False,
                 action='store_true',
                 help="load MAVCesium module on startup")

group.add_option("", "--console",
                 default=False,
                 action='store_true',
                 help="load console module on startup")
group.add_option("", "--aircraft",
                 default=None,
                 help="store state and logs in named directory")
group.add_option("", "--moddebug",
                 default=0,
                 type=int,
                 help="mavproxy module debug")
group.add_option("", "--no-rcin",
                 action='store_true',
                 help="disable mavproxy rcin")
parser.add_option_group(group)

group_completion = optparse.OptionGroup(parser, "Completion helpers")
group_completion.add_option("", "--list-vehicle",
                            action='store_true',
                            help="List the vehicles")
group_completion.add_option("", "--list-frame",
                            type='string',
                            default=None,
                            help="List the vehicle frames")
parser.add_option_group(group_completion)

cmd_opts, cmd_args = parser.parse_args()

cwd = os.getcwd()
vehicle_dir_name = os.path.basename(cwd)
in_vehicle_dir = vehicle_dir_name in vinfo.options

if len(sys.argv) == 1 and not in_vehicle_dir:
    cmd_opts.gui = True

if cmd_opts.gui:
    if cmd_opts.vehicle is None:
        cwd = os.getcwd()
        while cwd:
            bname = os.path.basename(cwd)
            if not bname:
                break
            if bname in vinfo.options:
                cmd_opts.vehicle = bname
                break
            cwd = os.path.dirname(cwd)

    launch_continued = run_gui(cmd_opts)

    if not launch_continued:
        progress("Launch cancelled by user.")
        sys.exit(0)

    if cmd_opts.vehicle == 'Helicopter':
        cmd_opts.vehicle = 'ArduCopter'
        cmd_opts.frame = 'heli'

if cmd_opts.list_vehicle:
    print(' '.join(vinfo.options.keys()))
    sys.exit(1)
if cmd_opts.list_frame:
    frame_options = sorted(vinfo.options[cmd_opts.list_frame]["frames"].keys())
    frame_options_string = ' '.join(frame_options)
    print(frame_options_string)
    sys.exit(1)

# clean up processes at exit:
atexit.register(kill_tasks)

progress("Start")

if cmd_opts.sim_vehicle_sh_compatible and cmd_opts.jobs is None:
    cmd_opts.jobs = 1

# validate parameters
if cmd_opts.valgrind and (cmd_opts.gdb or cmd_opts.gdb_stopped or cmd_opts.lldb or cmd_opts.lldb_stopped):
    print("May not use valgrind with gdb or lldb")
    sys.exit(1)

if cmd_opts.valgrind and cmd_opts.callgrind:
    print("May not use valgrind with callgrind")
    sys.exit(1)

if cmd_opts.strace and (cmd_opts.gdb or cmd_opts.gdb_stopped or cmd_opts.lldb or cmd_opts.lldb_stopped):
    print("May not use strace with gdb or lldb")
    sys.exit(1)

if (cmd_opts.gdb or cmd_opts.gdb_stopped) and (cmd_opts.lldb or cmd_opts.lldb_stopped):
    print("May not use lldb with gdb")
    sys.exit(1)

if cmd_opts.instance < 0:
    print("May not specify a negative instance ID")
    sys.exit(1)

if cmd_opts.count < 1:
    print("May not specify a count less than 1")
    sys.exit(1)

if cmd_opts.strace and cmd_opts.valgrind:
    print("valgrind and strace almost certainly not a good idea")

if cmd_opts.strace and cmd_opts.callgrind:
    print("callgrind and strace almost certainly not a good idea")

if cmd_opts.sysid and cmd_opts.auto_sysid:
    print("Cannot use auto-sysid together with sysid")
    sys.exit(1)

# magically determine vehicle type (if required):
if cmd_opts.vehicle is None:
    cwd = os.getcwd()
    cmd_opts.vehicle = os.path.basename(cwd)

if cmd_opts.vehicle not in vinfo.options:
    # try in parent directories, useful for having config in subdirectories
    cwd = os.getcwd()
    while cwd:
        bname = os.path.basename(cwd)
        if not bname:
            break
        if bname in vinfo.options:
            cmd_opts.vehicle = bname
            break
        cwd = os.path.dirname(cwd)

if cmd_opts.vehicle in vehicle_map:
    cmd_opts.vehicle = vehicle_map[cmd_opts.vehicle]
elif cmd_opts.vehicle.lower() in vehicle_map:
    cmd_opts.vehicle = vehicle_map[cmd_opts.vehicle.lower()]

# try to validate vehicle
if cmd_opts.vehicle not in vinfo.options:
    progress('''
** Is (%s) really your vehicle type?
Perhaps you could try -v %s
You could also try changing directory to e.g. the ArduCopter subdirectory
''' % (cmd_opts.vehicle, vehicle_options_string))
    sys.exit(1)

# determine frame options (e.g. build type might be "sitl")
if cmd_opts.frame is None:
    cmd_opts.frame = vinfo.options[cmd_opts.vehicle]["default_frame"]

frame_infos = vinfo.options_for_frame(cmd_opts.frame,
                                      cmd_opts.vehicle,
                                      cmd_opts)

vehicle_dir = os.path.realpath(os.path.join(root_dir, cmd_opts.vehicle))
if not os.path.exists(vehicle_dir):
    print("vehicle directory (%s) does not exist" % (vehicle_dir,))
    sys.exit(1)

if cmd_opts.instances is not None:
    instances = set()
    for i in cmd_opts.instances.split(' '):
        i = (int)(i)
        if i < 0:
            print("May not specify a negative instance ID")
            sys.exit(1)
        instances.add(i)
    instances = sorted(instances) # to list
else:
    instances = range(cmd_opts.instance, cmd_opts.instance + cmd_opts.count)

if cmd_opts.instance == 0:
    kill_tasks()

if cmd_opts.tracker:
    start_antenna_tracker(cmd_opts)

if cmd_opts.can_peripherals or frame_infos.get('periph_params_filename', None) is not None:
    start_CAN_Periph(cmd_opts, frame_infos)

if cmd_opts.custom_location:
    location = [(float)(x) for x in cmd_opts.custom_location.split(",")]
    progress("Starting up at %s" % (location,))
elif cmd_opts.location is not None:
    location = find_location_by_name(cmd_opts.location)
    progress("Starting up at %s (%s)" % (location, cmd_opts.location))
else:
    progress("Starting up at SITL location")
    location = None
if cmd_opts.swarm is not None:
    offsets = find_offsets(instances, cmd_opts.swarm)
elif cmd_opts.auto_offset_line is not None:
    if location is None:
        raise ValueError("location needed for auto-offset-line")
    (bearing, metres) = cmd_opts.auto_offset_line.split(",")
    bearing = float(bearing)
    metres = float(metres)
    dist = 0
    offsets = {}
    for x in instances:
        offsets[x] = [dist*math.sin(math.radians(bearing)), dist*math.cos(math.radians(bearing)), 0, 0]
        dist += metres
else:
    offsets = {x: [0.0, 0.0, 0.0, None] for x in instances}
if location is not None:
    spawns = find_spawns(location, offsets)
else:
    spawns = None

if cmd_opts.use_dir is not None:
    base_dir = os.path.realpath(cmd_opts.use_dir)
    try:
        os.makedirs(base_dir)
    except OSError as exception:
        if exception.errno != errno.EEXIST:
            raise
    os.chdir(base_dir)
else:
    base_dir = os.getcwd()
instance_dir = []
if len(instances) == 1:
    instance_dir.append(base_dir)
else:
    for i in instances:
        i_dir = os.path.join(base_dir, str(i))
        try:
            os.makedirs(i_dir)
        except OSError as exception:
            if exception.errno != errno.EEXIST:
                raise
        finally:
            instance_dir.append(i_dir)

if True:
    if not cmd_opts.no_rebuild:  # i.e. we should rebuild
        do_build(cmd_opts, frame_infos)

    if cmd_opts.fresh_params:
        do_build_parameters(cmd_opts.vehicle)

    if cmd_opts.vehicle_binary is not None:
        vehicle_binary = cmd_opts.vehicle_binary
    else:
        binary_basedir = "build/sitl"
        vehicle_binary = os.path.join(root_dir,
                                      binary_basedir,
                                      frame_infos["waf_target"])

    if not os.path.exists(vehicle_binary):
        print("Vehicle binary (%s) does not exist" % (vehicle_binary,))
        sys.exit(1)

    start_vehicle(vehicle_binary,
                  cmd_opts,
                  frame_infos,
                  spawns=spawns)


if cmd_opts.delay_start:
    progress("Sleeping for %f seconds" % (cmd_opts.delay_start,))
    time.sleep(float(cmd_opts.delay_start))

tmp = None
if cmd_opts.frame in ['scrimmage-plane', 'scrimmage-copter']:
    from tempfile import mkstemp

    # import only here so as to avoid jinja dependency in whole script
    from jinja2 import Environment
    from jinja2 import FileSystemLoader
    entities = []
    config = {}
    config['plane'] = cmd_opts.vehicle == 'ArduPlane'
    if location is not None:
        config['lat'] = location[0]
        config['lon'] = location[1]
        config['alt'] = location[2]
    entities = {}
    for i in instances:
        (x, y, z, heading) = offsets[i]
        entities[i] = {
            'x': x, 'y': y, 'z': z, 'heading': heading,
            'to_ardupilot_port': 9003 + i * 10,
            'from_ardupilot_port': 9002 + i * 10,
            'to_ardupilot_ip': '127.0.0.1'
        }
    if cmd_opts.scrimmage_args is not None:
        scrimmage_args = cmd_opts.scrimmage_args.split(',')
        global_opts = ['terrain']
        instance_opts = ['motion_model', 'visual_model']
        for arg in scrimmage_args:
            arg = arg.split('=', 2)
            if len(arg) == 2:
                k, v = arg
                if k in global_opts:
                    config[k] = v
                elif k in instance_opts:
                    for i in entities:
                        # explicit instance args take precedence; don't overwrite
                        if k not in entities[i]:
                            entities[i][k] = v
            elif len(arg) == 3:
                i, k, v = arg
                try:
                    i = int(i)
                except ValueError:
                    continue
                if i in entities and k in instance_opts:
                    entities[i][k] = v
    config['entities'] = list(entities.values())
    env = Environment(loader=FileSystemLoader(os.path.join(autotest_dir, 'template')))
    mission = env.get_template('scrimmage.xml.j2').render(**config)
    tmp = mkstemp()
    atexit.register(os.remove, tmp[1])

    with os.fdopen(tmp[0], 'w') as fd:
        fd.write(mission)
    run_in_terminal_window('SCRIMMAGE', ['scrimmage', tmp[1]])


if cmd_opts.delay_start:
    progress("Sleeping for %f seconds" % (cmd_opts.delay_start,))
    time.sleep(float(cmd_opts.delay_start))

try:
    if cmd_opts.no_mavproxy:
        time.sleep(3)  # output our message after run_in_terminal_window.sh's
        progress("Waiting for SITL to exit")
        wait_unlimited()
    else:
        start_mavproxy(cmd_opts, frame_infos)
except KeyboardInterrupt:
    progress("Keyboard Interrupt received ...")

sys.exit(0)
