The Qualcomm® Intelligent Robotics(QIR) SDK is a collection of components that enable you to develop robotic features on Qualcomm platforms. This SDK is applicable to the Qualcomm Linux releases.
The QIR SDK provides the following:
- Reference code in Robot Operating System (ROS) packages to develop robotic applications.
- E2E(end-to-end) scenario samples to evaluate robotic platforms.
- Integrated cross-compile toolchain, which includes common build tools, such as aarch64-oe-linux-gcc, make, cmake, and ROS core.
- Tools and scripts to speed up the development.
- Provide some basic ROS nodes to help you build your ros application, such as qrb_ros_camera, qrb_ros_nn_inference, etc.
This will guide you through developing your first sample application. It explains how to:
- Flash the prebuilt Qualcomm linux image and configure the environment.
- Run sample applications.
- Develop sample applications using the prebuilt image and QIR SDK.
- Generate customized images and QIR SDK.
- Provide a Gazebo simulation environment for testing and debugging robotic applications.
| Branches/Tag | Description |
|---|---|
| main branch | Primary development branch. Base your contributions here and submit pull requests against it. |
| wrynose branch | LTS branch based on Yocto Project 6.0, used by Qualcomm Linux 2.x. |
| release tag | Stable release snapshot, see the tags page. |
| All stable branches up until styhead | Stable branches based on previous Yocto Project LTS releases. |
QIR SDK is a multi-component project. This guide walks you through building an image that includes meta-qcom and ros-core content, which can then be flashed to one of the supported devices below.
| Hardware | Quick Start Guide | Access |
|---|---|---|
| Qualcomm Dragonwing IQ-9075 Evaluation Kit | Quick Start Guide | Public |
| Qualcomm Dragonwing IQ-8275 Evaluation Kit | Quick Start Guide | Public |
-
Please refer to the Yocto Project Reference Manual to set up your Yocto Project build environment.
-
Please follow the instructions below for a KAS-based build. The KAS tool offers an easy way to setup bitbake based projects. For more details, visit the KAS documentation. Install kas tool:
sudo pip3 install kas
-
Clone meta-qcom-robotics-sdk layer
git clone https://github.com/qualcomm-linux/meta-qcom-robotics-sdk -b <Supported Branches/Tag>
-
Supported kas configurations
MACHINE configuration DISTRO configuration TARGET image recipe iq-8275-evkiq-9075-evk
qcom-robotics-distroqcom-robotics-distro-catchall
qcom-robotics-imageqcom-robotics-proprietary-image
-
Build Command(Example):<MACHINE: iq-9075-evk, DISTRO: qcom-robotics-distro>
-
To build the robotics image based on open-source components, use the
qcom-robotics-imagetarget:kas build meta-qcom-robotics-sdk/ci/iq-9075-evk.yml:meta-qcom-robotics-sdk/ci/qcom-robotics-distro.yml:meta-qcom-robotics-sdk/ci/qcom-robotics-image.yml
-
To build the robotics image with features in the Qualcomm proprietary components, use the
qcom-robotics-proprietary-imagetarget:kas build meta-qcom-robotics-sdk/ci/iq-9075-evk.yml:meta-qcom-robotics-sdk/ci/qcom-robotics-distro.yml:meta-qcom-robotics-sdk/ci/qcom-robotics-proprietary-image.yml
For more details, please refer to the Qualcomm Linux Documentation — Build with GitHub Actions.
- Please refer to the Qualcomm Linux Documentation — Flash the Robotics Image.
Prebuilt artifacts are available from the Qualcomm Linux Documentation — Download Prebuilt Packages.
How to develop new features/fixes for the software. Maybe different than "usage". Also provide details on how to contribute via a CONTRIBUTING.md.
How to contact maintainers. E.g. GitHub Issues, GitHub Discussions could be indicated for many cases. However, a mail list or list of Maintainer e-mails could be shared for other types of discussions.
- Report an Issue on GitHub
meta-qcom-robotics-sdk is licensed under the BSD-3-clause License. See LICENSE.txt for the full license text.