Протокол HID трекера головы

Протокол HID (Hed Tracker Human Interface Device), доступный для устройств под управлением Android 13 и выше, позволяет подключать устройство отслеживания положения головы к устройству Android через USB или Bluetooth и предоставлять доступ к фреймворку Android и приложениям через фреймворк датчиков . Этот протокол используется для управления эффектом аудиовиртуализатора (3D-аудио). На этой странице используются термины устройство и хост в их Bluetooth-смысле, где устройство означает устройство отслеживания положения головы, а хост означает хост Android.

Производители устройств должны настроить свои устройства Android для поддержки протокола HID трекера головы. Для получения более подробной информации о настройке см. файл README для динамических датчиков .

Эта страница предполагает знакомство со следующими ресурсами:

Структура верхнего уровня

Платформа Android идентифицирует устройство отслеживания положения головы как HID-устройство.

Полный пример допустимого дескриптора HID см. в Приложении 1: Пример дескриптора HID .

На верхнем уровне устройство отслеживания положения головы представляет собой коллекцию приложений со страницей Sensors ( 0x20 ) и Other: Custom использование ( 0xE1 ). Внутри этой коллекции есть несколько полей данных ( входы ) и свойств ( функции ).

Свойства и поля данных

В этом разделе описываются свойства и поля данных в коллекции приложений устройства слежения за положением головы.

Свойство: Описание датчика ( 0x0308 )

Свойство Описание датчика ( 0x0308 ) представляет собой строковое свойство ASCII (8-битное), доступное только для чтения, которое должно содержать следующие значения:

Версия трекера головы 1.0:

#AndroidHeadTracker#1.0

Head Tracker версии 2.0 (доступно в Android 15 и выше), которая включает поддержку LE-аудио:

#AndroidHeadTracker#2.0#x

x — целое число ( 1 , 2 , 3 ), указывающее на транспортную поддержку:

  • 1: ACL
  • 2: ИСО
  • 3: ACL + ISO

Нулевой терминатор не предполагается, что означает, что общий размер этого свойства составляет 23 8-битных символа для версии 1.0.

Это свойство служит дискриминатором, позволяющим избежать столкновений с другими пользовательскими датчиками.

Свойство: Постоянный уникальный идентификатор ( 0x0302 )

Свойство Persistent Unique ID ( 0x0302 ) — это массив из 16 элементов, по 8 бит каждый (всего 128 бит). Нулевой терминатор не ожидается. Это свойство необязательно.

Это свойство позволяет устройствам отслеживания положения головы, интегрированным в аудиоустройства, ссылаться на аудиоустройство, к которому они подключены. Поддерживаются следующие схемы.

Автономный хед-трекер

Если свойство Persistent Unique ID ( 0x0302 ) не существует или установлено на все нули, это означает, что устройство отслеживания положения головы не подключено постоянно к аудиоустройству и может использоваться отдельно, например, позволяя пользователю вручную связать устройство отслеживания положения головы с отдельным аудиоустройством.

Ссылка с использованием MAC-адреса Bluetooth

Октет 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
Ценить 0 0 0 0 0 0 0 0 Б Т Bluetooth-MAC-адрес

В этой схеме первые 8 октетов должны быть 0 , октеты 8 и 9 должны содержать значения ASCII B и T соответственно, а следующие 6 октетов интерпретируются как MAC-адрес Bluetooth, предполагая, что устройство отслеживания положения головы применяется к любому аудиоустройству, имеющему этот MAC-адрес. Этот адрес должен быть адресом идентификации, даже если устройство использует случайный MAC-адрес для установления соединений. Двухрежимные устройства, подключающиеся через Bluetooth classic (формат HID v1.0) и Bluetooth LE (формат HID v2.0), должны предоставлять два дескриптора HID с одинаковым адресом идентификации. Двухрежимные устройства с разделенными левым и правым устройствами должны предоставлять Bluetooth LE HID с использованием первичного двухрежимного устройства вместо вторичного устройства только с LE.

Ссылка с использованием UUID

Всякий раз, когда установлен старший бит (MSB) октета 8 ( ≥0x80 ), поле интерпретируется как UUID, как указано в RFC-4122 . Соответствующее аудиоустройство предоставляет тот же UUID, который зарегистрирован в фреймворке Android, через неопределенный механизм, который специфичен для типа используемого транспорта.

Свойство: Отчетное состояние ( 0x0316 )

Свойство Reporting State ( 0x0316 ) является свойством чтения/записи, имеющим стандартную семантику, определенную в спецификации HID. Хост использует это свойство, чтобы указать устройству, о каких событиях сообщать. Используются только значения No Events ( 0x0840 ) и All Events ( 0x0841 ).

Начальное значение этого поля должно быть «Нет событий», и оно никогда не должно изменяться устройством, только хостом.

Свойство: Состояние питания ( 0x0319 )

Свойство Power State ( 0x0319 ) является свойством чтения/записи, которое имеет стандартную семантику, определенную в спецификации HID. Хост использует это свойство, чтобы указать устройству, в каком состоянии питания оно должно находиться. Используются только значения Full Power ( 0x0851 ) и Power Off ( 0x0855 ).

Начальное значение этого поля определяется устройством и никогда не должно изменяться устройством, только хостом.

Свойство: Интервал отчета ( 0x030E )

Свойство Report Interval ( 0x030E ) является свойством чтения/записи, имеющим стандартную семантику, определенную в спецификации HID. Хост использует это свойство, чтобы указать устройству, как часто следует сообщать показания своих данных. Единицами являются секунды. Допустимый диапазон для этого значения определяется устройством и описывается с помощью механизма Physical Min/Max. Должна поддерживаться частота отчетов не менее 50 Гц, а рекомендуемая максимальная частота отчетов составляет 100 Гц. Следовательно, минимальный интервал отчетов должен быть меньше или равен 20 мс и рекомендуется быть больше или равен 10 мс.

Свойство: Зарезервированный поставщиком LE Transport ( 0xF410 )

Свойство Vendor-reserved LE Transport ( 0xF410 ) является свойством чтения/записи, имеющим стандартную семантику, определенную в спецификации HID. Хост использует это свойство для указания выбранного транспорта (ACL или ISO). Используются только значения ACL ( 0xF800 ) и ISO ( 0xF801 ), и оба должны быть включены в логическую коллекцию.

Это свойство настраивается до включения питания или состояния отчетности.

Поле данных: Пользовательское значение 1 ( 0x0544 )

Поле Custom Value 1 ( 0x0544 ) — это поле ввода, используемое для предоставления фактической информации о слежении за головой. Это массив из 3 элементов, интерпретируемый в соответствии с обычными правилами HID для физических значений, как указано в разделе 6.2.2.7 спецификации HID. Допустимый диапазон для каждого элемента — [-π, π] рад. Единицами всегда являются радианы.

Элементы интерпретируются как: [rx, ry, rz] , так что [rx, ry, rz] является вектором вращения , представляющим преобразование из опорной системы в головную систему. Величина должна быть в диапазоне [0..π].

Система отсчета произвольна, но она обычно фиксирована и должна быть правосторонней. Небольшое отклонение допустимо. Оси головки:

  • X от левого уха к правому
  • Y от затылка к носу (сзади вперед)
  • Z от шеи до макушки головы

Поле данных: Пользовательское значение 2 ( 0x0545 )

Поле Custom Value 2 ( 0x0545 ) — это поле ввода, используемое для предоставления фактической информации о слежении за головой. Это массив из 3 элементов с фиксированной точкой, интерпретируемый в соответствии с обычными правилами HID для физических значений. Единицы измерения всегда радианы/секунда.

Элементы интерпретируются как: [vx, vy, vz] , где [vx, vy, vz]вектор вращения , представляющий угловую скорость головной рамы (относительно самой себя).

Поле данных: Пользовательское значение 3 ( 0x0546 )

Поле Custom Value 3 ( 0x0546 ) — это поле ввода, используемое для отслеживания разрывов в системе отсчета. Это скалярное целое число размером 8 бит. Оно должно увеличиваться (с переносом) устройством каждый раз при изменении системы отсчета, например, если алгоритм фильтра ориентации, используемый для определения ориентации, сбросил свое состояние. Это значение интерпретируется в соответствии с обычными правилами HID для физических значений. Однако физическое значение и единицы измерения не имеют значения. Единственной информацией, относящейся к хосту, является измененное значение. Чтобы избежать числовых проблем, связанных с потерей точности при преобразовании из логических единиц в физические, рекомендуется установить значения для физического минимума, физического максимума и показателя единицы равными нулю для этого поля.

Структура отчета

Группировка свойств в отчеты (путем назначения идентификаторов отчетов) является гибкой. Для эффективности мы рекомендуем отделить свойства только для чтения от свойств для чтения/записи.

Для полей данных поля «Пользовательское значение 1», «2» и «3» должны находиться в одном отчете и только в одном отчете для данного устройства (коллекции приложений).

Отправить отчеты о входных данных

Устройство должно периодически и асинхронно (через сообщения HID INPUT) отправлять отчеты о входных данных при соблюдении всех следующих условий:

  • Свойство Power State установлено на Full Power.
  • Свойство «Состояние отчета» установлено на «Все события».
  • Свойство «Интервал отчетности» не равно нулю.

Свойство Reporting Interval определяет, как часто отправлять отчеты. Если какое-либо из условий выше не выполняется, устройство не должно отправлять никаких отчетов.

Прямая и обратная совместимость

Протокол HID трекера головы использует схему управления версиями, которая позволяет обновлять данные, одновременно обеспечивая взаимодействие между хостом и устройством, использующим разные версии протокола. Версии протокола идентифицируются двумя числами, основной и второстепенной, которые имеют различную семантику, как описано в следующих разделах.

Версии, поддерживаемые устройством, можно определить, изучив его свойство «Описание датчика» ( 0x0308 ).

Совместимость с младшими версиями

Изменения в младшей версии обратно совместимы с более ранними младшими версиями, основанными на той же старшей версии. При обновлениях младшей версии хост игнорирует дополнительные поля данных и свойства. Например, устройство, использующее протокол версии 1.6, совместимо с хостом, поддерживающим протокол версии 1.x, включая версию 1.5.

Совместимость с основными версиями

Несовместимые с предыдущей версией изменения разрешены для изменений основных версий. Для поддержки нескольких основных версий для взаимодействия со старыми и новыми хостами устройства могут указывать несколько коллекций приложений в своих дескрипторах отчетов. Например:

const unsigned char ReportDescriptor[] = {
    HID_USAGE_PAGE_SENSOR,
    HID_USAGE_SENSOR_TYPE_OTHER_CUSTOM,

    HID_COLLECTION(HID_APPLICATION),
        // Feature report 2 (read-only).
        HID_REPORT_ID(2),

        // Magic value: "#AndroidHeadTracker#1.5"
        HID_USAGE_SENSOR_PROPERTY_SENSOR_DESCRIPTION,
        HID_LOGICAL_MIN_8(0),
        HID_LOGICAL_MAX_8(0xFF),
        HID_REPORT_SIZE(8),
        HID_REPORT_COUNT(23),
        HID_FEATURE(HID_CONST_VAR_ABS),

      ...

    HID_END_COLLECTION,

    HID_COLLECTION(HID_APPLICATION),
        // Feature report 12 (read-only).
        HID_REPORT_ID(12),

        // Magic value: "#AndroidHeadTracker#2.4"
        HID_USAGE_SENSOR_PROPERTY_SENSOR_DESCRIPTION,
        HID_LOGICAL_MIN_8(0),
        HID_LOGICAL_MAX_8(0xFF),
        HID_REPORT_SIZE(8),
        HID_REPORT_COUNT(23),
        HID_FEATURE(HID_CONST_VAR_ABS),

      ...

    HID_END_COLLECTION,
};

В этом случае хост может перечислить все различные коллекции приложений, рекламируемые устройством, проверив их свойство Sensor Description, чтобы определить версии протоколов, которые они реализуют, а затем выбрать последнюю версию протокола, поддерживаемую хостом. При выборе хост работает с единственным протоколом, который был выбран на весь срок действия подключения устройства.

Приложение: Пример дескриптора HID

Следующий пример иллюстрирует типичный допустимый дескриптор HID. Он использует широко используемые макросы C, представленные в разделе Использование датчиков HID (раздел 4.1).

const unsigned char ReportDescriptor[] = {
    HID_USAGE_PAGE_SENSOR,
    HID_USAGE_SENSOR_TYPE_OTHER_CUSTOM,
    HID_COLLECTION(HID_APPLICATION),
        // Feature report 2 (read-only).
        HID_REPORT_ID(2),

        // Magic value: "#AndroidHeadTracker#1.0"
        HID_USAGE_SENSOR_PROPERTY_SENSOR_DESCRIPTION,
        HID_LOGICAL_MIN_8(0),
        HID_LOGICAL_MAX_8(0xFF),
        HID_REPORT_SIZE(8),
        HID_REPORT_COUNT(23),
        HID_FEATURE(HID_CONST_VAR_ABS),

        // UUID.
        HID_USAGE_SENSOR_PROPERTY_PERSISTENT_UNIQUE_ID,
        HID_LOGICAL_MIN_8(0),
        HID_LOGICAL_MAX_8(0xFF),
        HID_REPORT_SIZE(8),
        HID_REPORT_COUNT(16),
        HID_FEATURE(HID_CONST_VAR_ABS),

        // Feature report 1 (read/write).
        HID_REPORT_ID(1),

        // 1-bit on/off reporting state.
        HID_USAGE_SENSOR_PROPERTY_REPORTING_STATE,
        HID_LOGICAL_MIN_8(0),
        HID_LOGICAL_MAX_8(1),
        HID_REPORT_SIZE(1),
        HID_REPORT_COUNT(1),
        HID_COLLECTION(HID_LOGICAL),
            HID_USAGE_SENSOR_PROPERTY_REPORTING_STATE_NO_EVENTS,
            HID_USAGE_SENSOR_PROPERTY_REPORTING_STATE_ALL_EVENTS,
            HID_FEATURE(HID_DATA_ARR_ABS),
        HID_END_COLLECTION,

        // 1-bit on/off power state.
        HID_USAGE_SENSOR_PROPERTY_POWER_STATE,
        HID_LOGICAL_MIN_8(0),
        HID_LOGICAL_MAX_8(1),
        HID_REPORT_SIZE(1),
        HID_REPORT_COUNT(1),
        HID_COLLECTION(HID_LOGICAL),
            HID_USAGE_SENSOR_PROPERTY_POWER_STATE_D4_POWER_OFF,
            HID_USAGE_SENSOR_PROPERTY_POWER_STATE_D0_FULL_POWER,
            HID_FEATURE(HID_DATA_ARR_ABS),
        HID_END_COLLECTION,

        // 6-bit reporting interval, with values [0x00..0x3F] corresponding to [10ms..100ms].
        HID_USAGE_SENSOR_PROPERTY_REPORT_INTERVAL,
        HID_LOGICAL_MIN_8(0x00),
        HID_LOGICAL_MAX_8(0x3F),
        HID_PHYSICAL_MIN_8(10),
        HID_PHYSICAL_MAX_8(100),
        HID_REPORT_SIZE(6),
        HID_REPORT_COUNT(1),
        HID_USAGE_SENSOR_UNITS_SECOND,
        HID_UNIT_EXPONENT(0xD),  // 10^-3
        HID_FEATURE(HID_DATA_VAR_ABS),

        // Input report 1

        // Orientation as rotation vector (scaled to [-pi..pi] rad).
        HID_USAGE_SENSOR_DATA_CUSTOM_VALUE_1,
        HID_LOGICAL_MIN_16(0x01, 0x80), // LOGICAL_MINIMUM (-32767)
        HID_LOGICAL_MAX_16(0xFF, 0x7F), // LOGICAL_MAXIMUM (32767)
        HID_PHYSICAL_MIN_32(0x60, 0x4F, 0x46, 0xED),  // -314159265
        HID_PHYSICAL_MAX_32(0xA1, 0xB0, 0xB9, 0x12),  // 314159265
        HID_UNIT_EXPONENT(0x08),  // 10^-8
        HID_REPORT_SIZE(16),
        HID_REPORT_COUNT(3),
        HID_INPUT(HID_DATA_VAR_ABS),

        // Angular velocity as rotation vector (scaled to [-32..32] rad/sec).
        HID_USAGE_SENSOR_DATA_CUSTOM_VALUE_2,
        HID_LOGICAL_MIN_16(0x01, 0x80), // LOGICAL_MINIMUM (-32767)
        HID_LOGICAL_MAX_16(0xFF, 0x7F), // LOGICAL_MAXIMUM (32767)
        HID_PHYSICAL_MIN_8(0xE0),
        HID_PHYSICAL_MAX_8(0x20),
        HID_UNIT_EXPONENT(0x00),  // 10^0
        HID_REPORT_SIZE(16),
        HID_REPORT_COUNT(3),
        HID_INPUT(HID_DATA_VAR_ABS),

        // Reference frame reset counter.
        HID_USAGE_SENSOR_DATA_CUSTOM_VALUE_3,
        HID_LOGICAL_MIN_16(0x00, 0x00), // LOGICAL_MINIMUM (0)
        HID_LOGICAL_MAX_16(0xFF, 0x00), // LOGICAL_MAXIMUM (255)
        HID_PHYSICAL_MIN_8(0x00),
        HID_PHYSICAL_MAX_8(0x00),
        HID_UNIT_EXPONENT(0x00),  // 10^0
        HID_REPORT_SIZE(8),
        HID_REPORT_COUNT(1),
        HID_INPUT(HID_DATA_VAR_ABS),

    HID_END_COLLECTION,
};

Приложение 2: Пример дескриптора HID версии 2.0

В следующем примере показан дескриптор HID версии 2.0 для устройства, поддерживающего только транспорт Bluetooth LE ACL.

const unsigned char ReportDescriptor[] = {
    HID_USAGE_PAGE_SENSOR,
    HID_USAGE_SENSOR_TYPE_OTHER_CUSTOM,
    HID_COLLECTION(HID_APPLICATION),
        // Feature report 2 (read-only).
        HID_REPORT_ID(2),

        // Magic value: "#AndroidHeadTracker#2.0#1"
        HID_USAGE_SENSOR_PROPERTY_SENSOR_DESCRIPTION,
        HID_LOGICAL_MIN_8(0),
        HID_LOGICAL_MAX_8(0xFF),
        HID_REPORT_SIZE(8),
        HID_REPORT_COUNT(25),
        HID_FEATURE(HID_CONST_VAR_ABS),

        // UUID.
        HID_USAGE_SENSOR_PROPERTY_PERSISTENT_UNIQUE_ID,
        HID_LOGICAL_MIN_8(0),
        HID_LOGICAL_MAX_8(0xFF),
        HID_REPORT_SIZE(8),
        HID_REPORT_COUNT(16),
        HID_FEATURE(HID_CONST_VAR_ABS),

        // Feature report 1 (read/write).
        HID_REPORT_ID(1),

        // 1-bit on/off reporting state.
        HID_USAGE_SENSOR_PROPERTY_REPORTING_STATE,
        HID_LOGICAL_MIN_8(0),
        HID_LOGICAL_MAX_8(1),
        HID_REPORT_SIZE(1),
        HID_REPORT_COUNT(1),
        HID_COLLECTION(HID_LOGICAL),
            HID_USAGE_SENSOR_PROPERTY_REPORTING_STATE_NO_EVENTS,
            HID_USAGE_SENSOR_PROPERTY_REPORTING_STATE_ALL_EVENTS,
            HID_FEATURE(HID_DATA_ARR_ABS),
        HID_END_COLLECTION,

        // 1-bit on/off power state.
        HID_USAGE_SENSOR_PROPERTY_POWER_STATE,
        HID_LOGICAL_MIN_8(0),
        HID_LOGICAL_MAX_8(1),
        HID_REPORT_SIZE(1),
        HID_REPORT_COUNT(1),
        HID_COLLECTION(HID_LOGICAL),
            HID_USAGE_SENSOR_PROPERTY_POWER_STATE_D4_POWER_OFF,
            HID_USAGE_SENSOR_PROPERTY_POWER_STATE_D0_FULL_POWER,
            HID_FEATURE(HID_DATA_ARR_ABS),
        HID_END_COLLECTION,

        // 6-bit reporting interval, with values [0x00..0x3F] corresponding to [10ms..100ms].
        HID_USAGE_SENSOR_PROPERTY_REPORT_INTERVAL,
        HID_LOGICAL_MIN_8(0x00),
        HID_LOGICAL_MAX_8(0x3F),
        HID_PHYSICAL_MIN_8(10),
        HID_PHYSICAL_MAX_8(100),
        HID_REPORT_SIZE(6),
        HID_REPORT_COUNT(1),
        HID_USAGE_SENSOR_UNITS_SECOND,
        HID_UNIT_EXPONENT(0xD),  // 10^-3
        HID_FEATURE(HID_DATA_VAR_ABS),

        // 1-bit transport selection
        HID_USAGE_SENSOR_PROPERTY_VENDOR_LE_TRANSPORT,
        HID_LOGICAL_MIN_8(0),
        HID_LOGICAL_MAX_8(1),
        HID_REPORT_SIZE(1),
        HID_REPORT_COUNT(1),
        HID_COLLECTION(HID_LOGICAL),
            HID_USAGE_SENSOR_PROPERTY_VENDOR_LE_TRANSPORT_ACL,
            HID_USAGE_SENSOR_PROPERTY_VENDOR_LE_TRANSPORT_ISO,
            HID_FEATURE(HID_DATA_ARR_ABS),
        HID_END_COLLECTION,

        // Input report 1

        // Orientation as rotation vector (scaled to [-pi..pi] rad).
        HID_USAGE_SENSOR_DATA_CUSTOM_VALUE_1,
        HID_LOGICAL_MIN_16(0x01, 0x80), // LOGICAL_MINIMUM (-32767)
        HID_LOGICAL_MAX_16(0xFF, 0x7F), // LOGICAL_MAXIMUM (32767)
        HID_PHYSICAL_MIN_32(0x60, 0x4F, 0x46, 0xED),  // -314159265
        HID_PHYSICAL_MAX_32(0xA1, 0xB0, 0xB9, 0x12),  // 314159265
        HID_UNIT_EXPONENT(0x08),  // 10^-8
        HID_REPORT_SIZE(16),
        HID_REPORT_COUNT(3),
        HID_INPUT(HID_DATA_VAR_ABS),

        // Angular velocity as rotation vector (scaled to [-32..32] rad/sec).
        HID_USAGE_SENSOR_DATA_CUSTOM_VALUE_2,
        HID_LOGICAL_MIN_16(0x01, 0x80), // LOGICAL_MINIMUM (-32767)
        HID_LOGICAL_MAX_16(0xFF, 0x7F), // LOGICAL_MAXIMUM (32767)
        HID_PHYSICAL_MIN_8(0xE0),
        HID_PHYSICAL_MAX_8(0x20),
        HID_UNIT_EXPONENT(0x00),  // 10^0
        HID_REPORT_SIZE(16),
        HID_REPORT_COUNT(3),
        HID_INPUT(HID_DATA_VAR_ABS),

        // Reference frame reset counter.
        HID_USAGE_SENSOR_DATA_CUSTOM_VALUE_3,
        HID_LOGICAL_MIN_16(0x00, 0x00), // LOGICAL_MINIMUM (0)
        HID_LOGICAL_MAX_16(0xFF, 0x00), // LOGICAL_MAXIMUM (255)
        HID_PHYSICAL_MIN_8(0x00),
        HID_PHYSICAL_MAX_8(0x00),
        HID_UNIT_EXPONENT(0x00),  // 10^0
        HID_REPORT_SIZE(8),
        HID_REPORT_COUNT(1),
        HID_INPUT(HID_DATA_VAR_ABS),

    HID_END_COLLECTION,
};