Qt Board Support Package (QBSP) provides needed components for using Qt on an embedded device. QBSPs are installed using Qt Online Installer, either from online content or from a separately downloaded .qbsp file. QBSPs are available to commercial users.

You can download QBSP files either from the Qt Customer Portal or directly from your development board's hardware vendor. Note that the support for the QBSP might be provided by the hardware vendor.

A QBSP file contains a cross-compilation toolchain that gets integrated into Qt Creator, and a device image that you can use to boot your device using Boot to Qt Software Stack. To setup a development environment from the QBSP file, you need to install the QBSP on your host platform and then, install the Boot to Qt device image on your target device. You must also configure the device kit in Qt Creator.

1. Installing QBSP on Host Platform

You can use the Qt Online Installer to install a downloaded QBSP file:

1. Launch the Qt Online Installer.
2. Follow the instructions until you are in the Select components page.
3. Click on Browse QBSP files (1) and select the QBSP file.

After this, the content of the QBSP file is available in the component selection tree.

Select the components you are interested in and finalize the installation.

If you have an existing Qt installation, you can use Qt Maintenance Tool to install a downloaded QBSP file:

1. Open Qt Maintenance Tool (MaintenanceTool.exe), located in Qt installation directory.
2. Select Add or Remove Components.
3. Click on Browse QBSP files and select the QBSP file.

After this, the content of the QBSP is available in the component selection tree. Select the ones you are interested in and finalize the installation.

Alternatively, you can use the command line option --install-compressed-repository to instruct MaintenanceTool to use a specific QBSP file:

./MaintenanceTool --install-compressed-repository <Path-to-QBSP-file>

README File with Hardware-Specific Instructions

If you install a QBSP file that contains a pre-built Boot to Qt for your target hardware, you will find a README file under <Qt installation path/Qt version/Boot2Qt/<target>/images/. The README file may contain the hardware-specific installation instructions that you should carefully follow.

2. Installing Boot to Qt on Target Device

You can use Flashing Wizard to flash the image to your target device.

Devices usually support booting from an SD card. Some devices also provide a way to flash the image directly to internal eMMC memory.

Flash the image with Flashing Wizard to an SD card:

1. Connect your SD card reader to the development host. Make sure that the SD card size is at least 8 GB.
2. Launch Qt Creator.
3. Select Tools > Flash Boot to Qt Device, and follow the instructions in Flashing Wizard.

Flash the image with Flashing Wizard to internal eMMC memory:

1. Use the RS-232 or USB cable to access the serial terminal on the target device.
2. Power on your device and press any key to stop the autoboot.
3. Run the following command in U-Boot:

   ums 0 mmc 0

4. Connect your device to the development host using USB On-The-Go (OTG).
5. Use Flashing Wizard to flash the image to the device:
   • Launch Qt Creator.
   • Select Tools > Flash Boot to Qt Device, and follow the instructions in Flashing Wizard.
6. Press Ctrl+C in the U-Boot console and run the reset command.

3. Configuring a Device Kit in Qt Creator

You must set up the development tools in Qt Creator for your device. That is, you must configure your target device to be used for each build and run kit.

Connecting to Host Supporting USB On-The-Go

Connect your device to the development host using USB On-The-Go (OTG) and launch Qt Creator. In Qt Creator:

1. Select Edit > Preferences > Kits.
2. Select one of the predefined kits starting with Boot to Qt... that matches the type of your device.
3. Select the correct device in the Device field.
4. Select OK.

You are now ready to start developing with Qt for your device.

Connecting to Host Not Supporting USB On-The-Go

In case your device does not support USB OTG connection to host machine, you must connect the device to the network via an Ethernet cable and launch Qt Creator. In Qt Creator:

1. Select Edit > Preferences > Devices > Add.
2. Select Boot2Qt Device > Start Wizard.
3. Enter the device name and network address (IPv4). You can check the device address in the Launcher Settings when the device is running the Boot to Qt demo.
4. Select Finish.

You also have to configure the correct device to be used for each build and run kit:

1. Select Edit > Preferences > Kits.
2. Select one of the predefined kits starting with Boot to Qt... that matches the type of your device.
3. Select the correct device in the Device field.
4. Select OK.

You are now ready to start developing with Qt for your device.

4. Powering on with Boot to Qt Demo Launcher

After you have successfully flashed your device with Boot to Qt Software Stack, Boot to Qt Demo Launcher automatically appears on the screen when you power on the device.

For detailed information about how to deploy Qt projects to the device, see Tutorial: Deploying Your First Project with Boot to Qt.