Skip to content

Custom Mavlink Action

Both the Fly View and Joysticks support the ability execute arbitrary mavlink commands to the active vehicle. In the Fly View these will show up in the Toolstrip Action list. With Joysticks you can assign then to button presses.

Custom Actions File

The custom actions available are defined in a JSON file. The format of that file is as follows:

    "version":    1,
    "fileType":   "CustomActions",
    "label":        "First Command",
    "description":  "This is the first command",
    "mavCmd":       10,
    "compId":       100,
    "param1":       1,
    "param2":       2,
    "label":        "Second Command",
    "description":  "This is the second command",
    "mavCmd":       20,


  • actions (required) - An array of json objects, one for each command
  • label (required) - The user visible short description for the command. This is used as the button text for the Fly View - Actions command list. For Joysticks, this is the command you select from the dropdown. For Joysticks, make sure your name doesn't conflict with the built in names.
  • description (required) - This is a longer description of the command used in the Fly View - Action list. This is not used by joysticks.
  • mavCmd (required) - The command id of the mavlink command you want to send.
  • compId (options) - The component id for where you want to send the command to. If not specified MAV_COMP_ID_AUTOPILOT1 is used.
  • param1 thru param7 (optional) - The parameters for the command. Parameters which are not specified will default to 0.0

Custom action files should be located in the CustomActions directory of the QGC save location. For example on Linux that would be ~/Documents/QGroundControl/CustomActions or ~/Documents/QGroundControl Daily/CustomActions. The Fly View and Joysticks each have there own custom actions files:

  • Fly View - FlyViewCustomActions.json
  • Joystick - JoystickCustomActions.json

When you start up QGC it will load these files if they exist and make the commands available for use.