> For the complete documentation index, see [llms.txt](https://docs.theseus.us/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.theseus.us/cyclops/autopilot-integration/ardupilot/mission-planner-plugin.md).

# Mission Planner plugin

The Cyclops Mission Planner plugin adds some Vozilla functions to Mission Planner on Windows. With it you can set up, check and fly a UAV with Cyclops without the Vozilla app.

| You are...                                                    | You use                                                                  | Page                                                                                                                   |
| ------------------------------------------------------------- | ------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------- |
| An operator getting ready to fly, and flying                  | **DATA > Cyclops** tab and the **Cyclops** map menu (right click)        | [Flight Data](https://docs.theseus.us/cyclops/autopilot-integration/ardupilot/mission-planner-plugin/flight-data.md)   |
| An operator planning a mission                                | **PLAN >** **Cyclops** (right click) > **Check Mission with Cyclops...** | [Flight Plan](https://docs.theseus.us/cyclops/autopilot-integration/ardupilot/mission-planner-plugin/flight-plan.md)   |
| An integrator validating an aircraft after installing Cyclops | **SETUP > Optional Hardware > Cyclops**                                  | [Ground check](https://docs.theseus.us/cyclops/autopilot-integration/ardupilot/mission-planner-plugin/ground-check.md) |

## What the plugin adds

* **DATA > Cyclops tab:** shows Cyclops' state, position and map area, lists pre-arm checks, and holds the operator controls: set home, start the GPS spoof, enable or disable Cyclops, recording, lockdown and relocalize.
* **PLAN > Cyclops** (right click): checks a mission plan against the Cyclops map and its map quality before you fly, and can suggest optimizations for best performance. This tool is designed for waypoint missions.
* **SETUP > Optional Hardware > Cyclops:** runs the guided Cyclops ground check, confirms the aircraft is set up correctly for Cyclops.

A typical sequence:

1. The integrator installs Cyclops and runs the [ground check](https://docs.theseus.us/cyclops/autopilot-integration/ardupilot/mission-planner-plugin/ground-check.md) once per aircraft, and again after any change to its setup.
2. The operator plans a mission and [checks it with Cyclops](https://docs.theseus.us/cyclops/autopilot-integration/ardupilot/mission-planner-plugin/flight-plan.md).
3. In the field, the operator sets the Cyclops home position, starts the spoof, reads the [pre-arm checks](https://docs.theseus.us/cyclops/autopilot-integration/ardupilot/mission-planner-plugin/flight-data.md#pre-arm-checks) and verifies home.
4. The operator arms, flies, and monitors the **Cyclops** tab.

{% hint style="warning" %}
The Cyclops pre-arm checks in Mission Planner only warn. They never stop you from arming. Read them before every flight.
{% endhint %}

{% hint style="info" %}
This release is a beta. The ground check limits are provisional and may change as Theseus collects field data. Route error predictions in meters are switched off until the Cyclops route model has been validated on flight data.
{% endhint %}

## Requirements

* Mission Planner for Windows, connected to the aircraft over MAVLink (USB, telemetry radio or network). The plugin talks to Cyclops through that link only; you never connect to the Cyclops computer directly.
* Permission to write to the Mission Planner installation folder. With the default installation in `C:\Program Files (x86)\Mission Planner`, that means a Windows administrator account.
* A Cyclops computer running software that supports the plugin. Mission Planner tells you when the software is too old and needs an update (see [Version messages](#version-messages)).
* For the mission plan check: a Theseus account (the one you use in Vozilla), and an internet connection the first time you load a map. After that, planning works offline.

## Install

Download the plugin:

{% file src="/files/LFCzD9xRTh5l7YwzzGTY" %}

{% stepper %}
{% step %}

### Copy the files

Close Mission Planner. Unzip the download and copy **both** `Theseus.Cyclops.MissionPlanner.dll` and `Theseus.Cyclops.Core.dll` into the `plugins` folder of your Mission Planner installation (the folder that contains `MissionPlanner.exe`, by default `C:\Program Files (x86)\Mission Planner`). Both files must be in the same folder. If Windows asks for administrator permission, approve it.
{% endstep %}

{% step %}

### Unblock the files

Windows blocks DLLs downloaded from the internet or received by email, and Mission Planner cannot load a blocked DLL. Right-click each DLL (or the zip, before unzipping), choose **Properties**, tick **Unblock** at the bottom of the **General** tab if it is there, and click **OK**.
{% endstep %}

{% step %}

### Check that it works

Start Mission Planner and connect to the aircraft. Check that:

* **DATA** has a **Cyclops** tab, at the end of the tabs under the HUD;
* right-clicking the DATA map shows a **Cyclops** menu at the top;
* **SETUP > Optional Hardware** has a **Cyclops** entry. On Mission Planner versions without an Optional Hardware group, **Cyclops** appears directly in the Setup list.

If none of these appears, see [Troubleshooting](#troubleshooting).
{% endstep %}
{% endstepper %}

To update the plugin, close Mission Planner and replace **both** DLLs, then unblock them again if needed. To remove it, close Mission Planner and delete both DLLs from `plugins`. Your Theseus sign-in and downloaded map data stay in the `cyclops` folder of Mission Planner's user data folder until you delete it; use **Sign out** on the PLAN screen first if you want the sign-in removed.

## Version messages

Mission Planner checks the Cyclops software as soon as it connects. If the versions do not work together, it shows a short line on the DATA HUD and the full message in the **Messages** tab, once per connection. The same message appears on the Cyclops SETUP menu. Mission Planner keeps checking every 10 seconds, so the message clears on its own after the aircraft is updated.

| Message                                                                                              | What to do                                                                                                                                    |
| ---------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `Waiting for Cyclops...`                                                                             | Mission Planner is still asking the aircraft. Wait a few seconds.                                                                             |
| `No Cyclops on this connection.`                                                                     | Mission Planner hears no Cyclops computer. Check that it is powered and connected to the flight controller. This is not a version problem.    |
| `Update the Cyclops plugin for Mission Planner: ...`                                                 | The aircraft has newer Cyclops software than this plugin understands. Install the plugin version that matches the aircraft's Cyclops release. |
| `Update the Cyclops software on the aircraft (theseus-edge-api ...): ...`                            | The aircraft's Cyclops software is older than the plugin needs. Update Cyclops on the aircraft.                                               |
| `The Cyclops software on this aircraft is too old for the ground check: update theseus-edge-api ...` | Cyclops is present but its software predates the plugin. Update Cyclops on the aircraft.                                                      |
| `This Cyclops software does not send operator status. Update Cyclops.` (Cyclops tab)                 | The software runs the ground check but not the operator tab. Update Cyclops on the aircraft.                                                  |

## Troubleshooting

| Problem                                                                         | Fix                                                                                                                                                                                 |
| ------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| No **Cyclops** tab or menu                                                      | Check that both DLLs are in the `plugins` folder next to `MissionPlanner.exe` (not in a sub-folder), that both are unblocked, and that Mission Planner was restarted after copying. |
| The tab or menu appeared once but not after an update                           | Only one DLL was updated. Replace both.                                                                                                                                             |
| "The Cyclops plugin is not running. Restart Mission Planner." on the Setup page | The plugin did not start correctly. Restart Mission Planner. If it persists, reinstall both DLLs.                                                                                   |

## Support

Contact <support@theseus.us>. When reporting a ground check problem, include the [ground check report](https://docs.theseus.us/cyclops/autopilot-integration/ardupilot/mission-planner-plugin/ground-check.md#reports).
