> ## 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.

# Sensors documentation

This document explains architecture, integration, development, and validation of sensors on the Qualcomm platform. It covers the Qualcomm® sensing hub (QSH) framework, sensor bring-up, customization, and end-to-end sensor development workflows. It also describes how to test, troubleshoot, and support sensor solutions using Qualcomm-provided tools and references.

### Get started

<CardGroup cols={2}>
  <Card title="Overview" href="./overview">
    Introduces the Qualcomm® SoC architecture, the role of the application processor and application digital signal processor (aDSP), and where Qualcomm® sensing hub (QSH) fits in the Linux sensor stack.
  </Card>

  <Card title="Architecture" href="./architecture">
    Describes the unified event-driven QSH framework, its components, services, platform sensors, utilities, OS abstraction (OSA), and platform abstraction layer (PAL).
  </Card>

  <Card title="Messages" href="./sensor_api_messages">
    The shared communication contract for both client applications and sensor drivers. Covers sensor unique identifier (SUID), nanopb, message types, request options, event fields, and proto file schemas.
  </Card>

  <Card title="Features" href="./supported_features">
    QSH capabilities including OS and hardware independence, island memory, low-power operation, and direct channel APIs.
  </Card>
</CardGroup>

### Develop

<CardGroup cols={2}>
  <Card title="Software for application and low-power processors" href="./software">
    Directory layout for the application processor and aDSP source trees.
  </Card>

  <Card title="QSH client API workflow" href="./qsh_client_apis">
    For application developers to understand the QSH client API session workflow and the `SessionClient` sample application.
  </Card>

  <Card title="Develop sensors" href="./develop_sensors">
    For driver and algorithm authors to understand the sensor and sensor instance lifecycle, QSH services, and stress testing.
  </Card>
</CardGroup>

### API

<CardGroup cols={2}>
  <Card title="Qualcomm® sensing hub APIs" href="./qsh_api_reference">
    Full syntax reference for `getSession`, `open`, `close`, `setCallback`, `sendRequest`, feature APIs, and direct channel APIs.
  </Card>
</CardGroup>

### Test and validate

<CardGroup cols={2}>
  <Card title="Calibrate sensors" href="./calibrate">
    Factory and runtime calibration procedures for accelerometer, gyroscope, magnetometer, proximity, and ambient light sensors.
  </Card>

  <Card title="Verify sensors" href="./verify">
    Use `ssc_sensor_info` to list all QSH-supported sensors and inspect their attributes.
  </Card>

  <Card title="Troubleshoot sensors" href="./test_troubleshoot">
    Diagnose and resolve registry errors, SUID lookup failures, and data stream issues.
  </Card>

  <Card title="Sensor testing tools" href="./test_tools">
    Describes testing tools – `ssc_sensor_info`, `ssc_drva_test`, `see_workhorse`, Qualcomm® Hexagon™ toolchain, and QXDM Professional™ Tool.
  </Card>
</CardGroup>

### Supported platforms

<CardGroup cols={2}>
  <Card title="Qualcomm Dragonwing™ platform" href="./platform">
    Hardware specification and sensor bring-up for the Qualcomm Dragonwing™ RB3 Gen 2 Development Kit. Includes end-to-end bring-up procedures.
  </Card>

  <Card title="Sensors on the platform" href="./platform_sensor_specs">
    Sensor placement and part number table for the Core Kit and Vision Kit.
  </Card>

  <Card title="Simulation platform" href="./simulation">
    Use the sensing hub simulator (SHS) to develop and test sensor algorithms without physical hardware.
  </Card>

  <Card title="Related documents" href="./related_documents">
    External guides including the Sensors Guide Addendum, Linux Build Guide, Yocto Guide, and Development Kit documentation.
  </Card>

  <Card title="Acronyms and terms" href="./acronyms_and_terms">
    Sensors-specific acronyms and definitions used throughout this guide.
  </Card>
</CardGroup>