> ## Documentation Index
> Fetch the complete documentation index at: https://dragonwingdocs.qualcomm.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Qualcomm Intelligent Robotics SDK documentation

The Qualcomm<sup>®</sup> Intelligent Robotics (QIR) SDK provides the robotics samples and tools for you to develop applications on the development kits supporting the Qualcomm Linux software.

## QIR SDK introduction

<Columns cols={2}>
  <Card title="Overview" icon="book" href="./qir-sdk-overview">
    Provides an overview of what the QIR SDK offers and the Qualcomm Dragonwing<sup>TM</sup> hardware platforms it supports.
  </Card>

  <Card title="QIR SDK software architecture" icon="boxes" href="./qir-software-architecture">
    Shows a visual representation of the QIR SDK software components, functionalities, and tools.
  </Card>
</Columns>

## Get started with QIR SDK

The [Get started](./get-started-with-qir-sdk) allows you to try out the prebuilt image of the QIR SDK.

<Columns cols={2}>
  <Card title="Download the prebuilt package" icon="download" href="./download-the-prebuilt-packages">
    Download robotics prebuilt package.
  </Card>

  <Card title="Flash the robotics image" icon="hard-drive" href="./flash-the-robotics-image">
    Flash the robotics image to get the development kits ready for running sample applications.
  </Card>

  <Card title="Set up the environment for sample applications" icon="wrench" href="./set-up-env-for-sample-app">
    Complete necessary settings to ensure sample applications can run on the development kits.
  </Card>

  <Card title="Run the demo application" icon="play-circle" href="./run-demo-application">
    Run a demo application to verify the QIR SDK installation.
  </Card>
</Columns>

## Run QIR SDK sample applications

Run the sample applications on supported development kits. For details, see [QIR SDK sample applications](./qir-sdk-sample-applications).

<Columns cols={3}>
  <Card title="Run robotics sample applications" icon="robot" href="./run-robotics-sample-applications">
    Run robotics sample applications, such as autonomous/ moving robot (AMR) 2D lidar SLAM.
  </Card>

  <Card title="Run platform sample applications" icon="terminal" href="./run-platform-sample-applications">
    Run platform sample applications, such as getting system monitor information.
  </Card>
</Columns>

## Develop applications using the QIR SDK

<Columns cols={2}>
  <Card title="Understand the file structure" icon="folder-tree" href="./develop-applications-using-the-qir-sdk#qir-sdk-file-structure">
    Understand the file structure and toolchain included in QIR SDK.
  </Card>

  <Card title="QIR SDK API list" icon="clipboard-list" href="./explore-the-available-apis">
    Check all the APIs provided by the QIR SDK.
  </Card>

  <Card title="Develop a sample ROS2 application" icon="file-code" href="./develop-a-sample-ros-2-application">
    Use the QIR SDK to develop a ROS 2 sample application.
  </Card>
</Columns>

## Build and customize

The following workflows are optional only when you need to customize the QIR SDK. Ensure that you understand the procedures before building the QIR SDK or upgrading the artifacts.

<Columns cols={1}>
  <Card title="Build the QIR SDK" icon="hammer" href="./build-the-qir-sdk">
    Build the QIR SDK only when you really need to, using these workflows:

    * [GitHub workflow](./build-with-git-hub-workflow)
    * [Qualcomm Software Center (QSC) launcher](./build-with-qsc-launcher)
    * [QSC-CLI](./build-with-qsc-cli)
    * [Robotics eSDK](./build-the-robotics-image-with-the-prebuilt-robotics-esdk)
  </Card>

  <Card title="Upgrade QIR SDK artifacts" icon="refresh" href="./upgrade-qir-sdk-artifact">
    Upgrade the QIR SDK artifact without rebuilding the entire QIR SDK.
  </Card>

  <Card title="Troubleshoot" icon="shield" href="./troubleshoot">
    Learn methods to troubleshoot general issues.
  </Card>
</Columns>

## Migration from Qualcomm Linux 1.0 to 2.0

<Columns cols={2}>
  <Card title="Migration overview" icon="clipboard-list" href="./migration-overview">
    Summarizes key changes in QIR SDK, including layer consolidation and image composition updates.
  </Card>

  <Card title="Robotics OpenEmbedded layer changes" icon="file-text" href="./migration-robotics-oe-layer-changes">
    Describes the consolidation of multiple robotics layers into a single layer in Qualcomm Linux 2.0.
  </Card>

  <Card title="Robotics image composition changes" icon="folders" href="./migration-image-composition">
    Describes the transition from the `base`/`custom` build variant model to separate image recipes.
  </Card>
</Columns>