Описание
Используйте API chrome.hid для взаимодействия с подключенными HID-устройствами. Этот API предоставляет доступ к операциям HID из контекста приложения. Используя этот API, приложения могут выступать в качестве драйверов для аппаратных устройств. Ошибки, генерируемые этим API, сообщаются путем установки runtime.lastError и выполнения обычного вызова функции. В этом случае обычные параметры вызова будут неопределены.
Разрешения
hid Типы
DeviceFilter
Характеристики
- продуктИдентификатор
число необязательно
Идентификатор продукта устройства проверяется только в том случае, если совпадает идентификатор производителя.
- использование
число необязательно
Идентификатор использования HID, проверяется только в том случае, если страница использования HID совпадает.
- страница использования
число необязательно
Идентификатор страницы использования HID.
- vendorId
число необязательно
Идентификатор производителя устройства.
GetDevicesOptions
Характеристики
- фильтры
DeviceFilter [] необязательный
В результате будет возвращено устройство, соответствующее любому заданному фильтру. Пустой список фильтров вернет все устройства, для которых приложение имеет разрешение.
- продуктИдентификатор
число необязательно
УстаревшийЭквивалентно установке параметра
DeviceFilter.productId. - vendorId
число необязательно
УстаревшийЭквивалентно установке параметра
DeviceFilter.vendorId.
HidCollectionInfo
Характеристики
- reportIds
число[]
Сообщите идентификаторы, принадлежащие коллекции и ее дочерним элементам.
- использование
число
Идентификатор использования, заданный на странице.
- страница использования
число
Идентификатор страницы использования HID.
HidConnectInfo
Характеристики
- connectionId
число
Непрозрачный идентификатор, используемый для идентификации этого соединения во всех остальных функциях.
HidDeviceInfo
Характеристики
- коллекции
Основные данные из описаний отчетов этого устройства.
- идентификатор устройства
число
Идентификатор непрозрачного устройства.
- maxFeatureReportSize
число
Максимальный размер отчета по функциям в коллекции верхнего уровня.
- maxInputReportSize
число
Максимальный размер входного отчета для коллекции верхнего уровня.
- maxOutputReportSize
число
Максимальный размер выходного отчета для коллекции верхнего уровня.
- продуктИдентификатор
число
Идентификатор продукта.
- продуктName
нить
Chrome 46+Если имеется, устройство считывает название продукта.
- отчетОписание
ArrayBuffer
Необработанный дескриптор отчета об устройстве (недоступен в Windows).
- серийный номер
нить
Chrome 46+Серийный номер, считанный с устройства, если таковой имеется.
- vendorId
число
Идентификатор поставщика.
Методы
connect()
chrome.hid.connect(
deviceId: number,
callback?: function,
): Promise<HidConnectInfo>
Установите соединение с устройством HID для обмена данными.
Параметры
- идентификатор устройства
число
HidDeviceInfo.deviceIdидентификатор устройства, которое нужно открыть. - перезвонить
функция необязательна
Параметр
callbackвыглядит следующим образом:(connection: HidConnectInfo) => void
- связь
Возвраты
Promise <HidConnectInfo>
Chrome 117+Поддержка промисов доступна только для Manifest V3 и более поздних версий; для других платформ необходимо использовать колбэки.
disconnect()
chrome.hid.disconnect(
connectionId: number,
callback?: function,
): Promise<void>
Отключитесь от устройства. Выполнение операций на устройстве после вызова этой функции безопасно, но не имеет никакого эффекта.
Параметры
- connectionId
число
Идентификатор
connectionIdвозвращаемый функциейconnect. - перезвонить
функция необязательна
Параметр
callbackвыглядит следующим образом:() => void
Возвраты
Обещание<пустота>
Chrome 117+Поддержка промисов доступна только для Manifest V3 и более поздних версий; для других платформ необходимо использовать колбэки.
getDevices()
chrome.hid.getDevices(
options: GetDevicesOptions,
callback?: function,
): Promise<HidDeviceInfo[]>
Перечислите подключенные HID-устройства.
Параметры
- параметры
Свойства, которые следует искать на целевых устройствах.
- перезвонить
функция необязательна
Параметр
callbackвыглядит следующим образом:(devices: HidDeviceInfo[]) => void
- устройства
Возвраты
Promise< HidDeviceInfo []>
Chrome 117+Поддержка промисов доступна только для Manifest V3 и более поздних версий; для других платформ необходимо использовать колбэки.
receive()
chrome.hid.receive(
connectionId: number,
callback: function,
): void
Получите следующий отчет о вводе данных от устройства.
Параметры
- connectionId
число
Идентификатор
connectionIdвозвращаемый функциейconnect. - перезвонить
функция
Параметр
callbackвыглядит следующим образом:(reportId: number, data: ArrayBuffer) => void
- reportId
число
Идентификатор отчета или
0, если такового нет. - данные
ArrayBuffer
Данные отчета и префикс идентификатора отчета (если он присутствует) удаляются.
receiveFeatureReport()
chrome.hid.receiveFeatureReport(
connectionId: number,
reportId: number,
callback?: function,
): Promise<ArrayBuffer>
Запросите отчет о работе устройства.
Параметры
- connectionId
число
Идентификатор
connectionIdвозвращаемый функциейconnect. - reportId
число
Идентификатор отчета или
0, если идентификатора нет. - перезвонить
функция необязательна
Параметр
callbackвыглядит следующим образом:(data: ArrayBuffer) => void
- данные
ArrayBuffer
Данные отчета, включая префикс идентификатора отчета, если таковой отправляется устройством.
Возвраты
Promise<ArrayBuffer>
Chrome 117+Поддержка промисов доступна только для Manifest V3 и более поздних версий; для других платформ необходимо использовать колбэки.
send()
chrome.hid.send(
connectionId: number,
reportId: number,
data: ArrayBuffer,
callback?: function,
): Promise<void>
Отправьте отчет о результатах на устройство.
Примечание: Не включайте префикс идентификатора отчета в data . Он будет добавлен при необходимости.
Параметры
- connectionId
число
Идентификатор
connectionIdвозвращаемый функциейconnect. - reportId
число
Идентификатор отчета для использования или
0, если такового нет. - данные
ArrayBuffer
Данные отчета.
- перезвонить
функция необязательна
Параметр
callbackвыглядит следующим образом:() => void
Возвраты
Обещание<пустота>
Chrome 117+Поддержка промисов доступна только для Manifest V3 и более поздних версий; для других платформ необходимо использовать колбэки.
sendFeatureReport()
chrome.hid.sendFeatureReport(
connectionId: number,
reportId: number,
data: ArrayBuffer,
callback?: function,
): Promise<void>
Отправьте отчет о работе устройства.
Примечание: Не включайте префикс идентификатора отчета в data . Он будет добавлен при необходимости.
Параметры
- connectionId
число
Идентификатор
connectionIdвозвращаемый функциейconnect. - reportId
число
Идентификатор отчета для использования или
0, если такового нет. - данные
ArrayBuffer
Данные отчета.
- перезвонить
функция необязательна
Параметр
callbackвыглядит следующим образом:() => void
Возвраты
Обещание<пустота>
Chrome 117+Поддержка промисов доступна только для Manifest V3 и более поздних версий; для других платформ необходимо использовать колбэки.
События
onDeviceAdded
chrome.hid.onDeviceAdded.addListener(
callback: function,
)
Событие генерируется при добавлении устройства в систему. События передаются только приложениям и расширениям, имеющим разрешение на доступ к устройству. Разрешение могло быть предоставлено во время установки или когда пользователь принял необязательное разрешение (см. permissions.request ).
Параметры
- перезвонить
функция
Параметр
callbackвыглядит следующим образом:(device: HidDeviceInfo) => void
- устройство
onDeviceRemoved
chrome.hid.onDeviceRemoved.addListener(
callback: function,
)
Событие генерируется при удалении устройства из системы. См. onDeviceAdded чтобы узнать, какие события доставляются.
Параметры
- перезвонить
функция
Параметр
callbackвыглядит следующим образом:(deviceId: number) => void
- идентификатор устройства
число
Описание
Используйте API chrome.hid для взаимодействия с подключенными HID-устройствами. Этот API предоставляет доступ к операциям HID из контекста приложения. Используя этот API, приложения могут выступать в качестве драйверов для аппаратных устройств. Ошибки, генерируемые этим API, сообщаются путем установки runtime.lastError и выполнения обычного вызова функции. В этом случае обычные параметры вызова будут неопределены.
Разрешения
hid Типы
DeviceFilter
Характеристики
- продуктИдентификатор
число необязательно
Идентификатор продукта устройства проверяется только в том случае, если совпадает идентификатор производителя.
- использование
число необязательно
Идентификатор использования HID, проверяется только в том случае, если страница использования HID совпадает.
- страница использования
число необязательно
Идентификатор страницы использования HID.
- vendorId
число необязательно
Идентификатор производителя устройства.
GetDevicesOptions
Характеристики
- фильтры
DeviceFilter [] необязательный
В результате будет возвращено устройство, соответствующее любому заданному фильтру. Пустой список фильтров вернет все устройства, для которых приложение имеет разрешение.
- продуктИдентификатор
число необязательно
УстаревшийЭквивалентно установке параметра
DeviceFilter.productId. - vendorId
число необязательно
УстаревшийЭквивалентно установке параметра
DeviceFilter.vendorId.
HidCollectionInfo
Характеристики
- reportIds
число[]
Сообщите идентификаторы, принадлежащие коллекции и ее дочерним элементам.
- использование
число
Идентификатор использования, заданный на странице.
- страница использования
число
Идентификатор страницы использования HID.
HidConnectInfo
Характеристики
- connectionId
число
Непрозрачный идентификатор, используемый для идентификации этого соединения во всех остальных функциях.
HidDeviceInfo
Характеристики
- коллекции
Основные данные из описаний отчетов этого устройства.
- идентификатор устройства
число
Идентификатор непрозрачного устройства.
- maxFeatureReportSize
число
Максимальный размер отчета по функциям в коллекции верхнего уровня.
- maxInputReportSize
число
Максимальный размер входного отчета для коллекции верхнего уровня.
- maxOutputReportSize
число
Максимальный размер выходного отчета для коллекции верхнего уровня.
- продуктИдентификатор
число
Идентификатор продукта.
- продуктName
нить
Chrome 46+Если имеется, устройство считывает название продукта.
- отчетОписание
ArrayBuffer
Необработанный дескриптор отчета об устройстве (недоступен в Windows).
- серийный номер
нить
Chrome 46+Серийный номер, считанный с устройства, если таковой имеется.
- vendorId
число
Идентификатор поставщика.
Методы
connect()
chrome.hid.connect(
deviceId: number,
callback?: function,
): Promise<HidConnectInfo>
Установите соединение с устройством HID для обмена данными.
Параметры
- идентификатор устройства
число
HidDeviceInfo.deviceIdидентификатор устройства, которое нужно открыть. - перезвонить
функция необязательна
Параметр
callbackвыглядит следующим образом:(connection: HidConnectInfo) => void
- связь
Возвраты
Promise <HidConnectInfo>
Chrome 117+Поддержка промисов доступна только для Manifest V3 и более поздних версий; для других платформ необходимо использовать колбэки.
disconnect()
chrome.hid.disconnect(
connectionId: number,
callback?: function,
): Promise<void>
Отключитесь от устройства. Выполнение операций на устройстве после вызова этой функции безопасно, но не имеет никакого эффекта.
Параметры
- connectionId
число
Идентификатор
connectionIdвозвращаемый функциейconnect. - перезвонить
функция необязательна
Параметр
callbackвыглядит следующим образом:() => void
Возвраты
Обещание<пустота>
Chrome 117+Поддержка промисов доступна только для Manifest V3 и более поздних версий; для других платформ необходимо использовать колбэки.
getDevices()
chrome.hid.getDevices(
options: GetDevicesOptions,
callback?: function,
): Promise<HidDeviceInfo[]>
Перечислите подключенные HID-устройства.
Параметры
- параметры
Свойства, которые следует искать на целевых устройствах.
- перезвонить
функция необязательна
Параметр
callbackвыглядит следующим образом:(devices: HidDeviceInfo[]) => void
- устройства
Возвраты
Promise< HidDeviceInfo []>
Chrome 117+Поддержка промисов доступна только для Manifest V3 и более поздних версий; для других платформ необходимо использовать колбэки.
receive()
chrome.hid.receive(
connectionId: number,
callback: function,
): void
Получите следующий отчет о вводе данных от устройства.
Параметры
- connectionId
число
Идентификатор
connectionIdвозвращаемый функциейconnect. - перезвонить
функция
Параметр
callbackвыглядит следующим образом:(reportId: number, data: ArrayBuffer) => void
- reportId
число
Идентификатор отчета или
0, если такового нет. - данные
ArrayBuffer
Данные отчета и префикс идентификатора отчета (если он присутствует) удаляются.
receiveFeatureReport()
chrome.hid.receiveFeatureReport(
connectionId: number,
reportId: number,
callback?: function,
): Promise<ArrayBuffer>
Запросите отчет о работе устройства.
Параметры
- connectionId
число
Идентификатор
connectionIdвозвращаемый функциейconnect. - reportId
число
Идентификатор отчета или
0, если идентификатора нет. - перезвонить
функция необязательна
Параметр
callbackвыглядит следующим образом:(data: ArrayBuffer) => void
- данные
ArrayBuffer
Данные отчета, включая префикс идентификатора отчета, если таковой отправляется устройством.
Возвраты
Promise<ArrayBuffer>
Chrome 117+Поддержка промисов доступна только для Manifest V3 и более поздних версий; для других платформ необходимо использовать колбэки.
send()
chrome.hid.send(
connectionId: number,
reportId: number,
data: ArrayBuffer,
callback?: function,
): Promise<void>
Отправьте отчет о результатах на устройство.
Примечание: Не включайте префикс идентификатора отчета в data . Он будет добавлен при необходимости.
Параметры
- connectionId
число
Идентификатор
connectionIdвозвращаемый функциейconnect. - reportId
число
Идентификатор отчета для использования или
0, если такового нет. - данные
ArrayBuffer
Данные отчета.
- перезвонить
функция необязательна
Параметр
callbackвыглядит следующим образом:() => void
Возвраты
Обещание<пустота>
Chrome 117+Поддержка промисов доступна только для Manifest V3 и более поздних версий; для других платформ необходимо использовать колбэки.
sendFeatureReport()
chrome.hid.sendFeatureReport(
connectionId: number,
reportId: number,
data: ArrayBuffer,
callback?: function,
): Promise<void>
Отправьте отчет о работе устройства.
Примечание: Не включайте префикс идентификатора отчета в data . Он будет добавлен при необходимости.
Параметры
- connectionId
число
Идентификатор
connectionIdвозвращаемый функциейconnect. - reportId
число
Идентификатор отчета для использования или
0, если такового нет. - данные
ArrayBuffer
Данные отчета.
- перезвонить
функция необязательна
Параметр
callbackвыглядит следующим образом:() => void
Возвраты
Обещание<пустота>
Chrome 117+Поддержка промисов доступна только для Manifest V3 и более поздних версий; для других платформ необходимо использовать колбэки.
События
onDeviceAdded
chrome.hid.onDeviceAdded.addListener(
callback: function,
)
Событие генерируется при добавлении устройства в систему. События передаются только приложениям и расширениям, имеющим разрешение на доступ к устройству. Разрешение могло быть предоставлено во время установки или когда пользователь принял необязательное разрешение (см. permissions.request ).
Параметры
- перезвонить
функция
Параметр
callbackвыглядит следующим образом:(device: HidDeviceInfo) => void
- устройство
onDeviceRemoved
chrome.hid.onDeviceRemoved.addListener(
callback: function,
)
Событие генерируется при удалении устройства из системы. См. onDeviceAdded чтобы узнать, какие события доставляются.
Параметры
- перезвонить
функция
Параметр
callbackвыглядит следующим образом:(deviceId: number) => void
- идентификатор устройства
число
Описание
Используйте API chrome.hid для взаимодействия с подключенными HID-устройствами. Этот API предоставляет доступ к операциям HID из контекста приложения. Используя этот API, приложения могут выступать в качестве драйверов для аппаратных устройств. Ошибки, генерируемые этим API, сообщаются путем установки runtime.lastError и выполнения обычного вызова функции. В этом случае обычные параметры вызова будут неопределены.
Разрешения
hid Типы
DeviceFilter
Характеристики
- продуктИдентификатор
число необязательно
Идентификатор продукта устройства проверяется только в том случае, если совпадает идентификатор производителя.
- использование
число необязательно
Идентификатор использования HID, проверяется только в том случае, если страница использования HID совпадает.
- страница использования
число необязательно
Идентификатор страницы использования HID.
- vendorId
число необязательно
Идентификатор производителя устройства.
GetDevicesOptions
Характеристики
- фильтры
DeviceFilter [] необязательный
В результате будет возвращено устройство, соответствующее любому заданному фильтру. Пустой список фильтров вернет все устройства, для которых приложение имеет разрешение.
- продуктИдентификатор
число необязательно
УстаревшийЭквивалентно установке параметра
DeviceFilter.productId. - vendorId
число необязательно
УстаревшийЭквивалентно установке параметра
DeviceFilter.vendorId.
HidCollectionInfo
Характеристики
- reportIds
число[]
Сообщите идентификаторы, принадлежащие коллекции и ее дочерним элементам.
- использование
число
Идентификатор использования, заданный на странице.
- страница использования
число
Идентификатор страницы использования HID.
HidConnectInfo
Характеристики
- connectionId
число
Непрозрачный идентификатор, используемый для идентификации этого соединения во всех остальных функциях.
HidDeviceInfo
Характеристики
- коллекции
Основные данные из описаний отчетов этого устройства.
- идентификатор устройства
число
Идентификатор непрозрачного устройства.
- maxFeatureReportSize
число
Максимальный размер отчета по функциям в коллекции верхнего уровня.
- maxInputReportSize
число
Максимальный размер входного отчета для коллекции верхнего уровня.
- maxOutputReportSize
число
Максимальный размер выходного отчета для коллекции верхнего уровня.
- продуктИдентификатор
число
Идентификатор продукта.
- продуктName
нить
Chrome 46+Если имеется, устройство считывает название продукта.
- отчетОписание
ArrayBuffer
Необработанный дескриптор отчета об устройстве (недоступен в Windows).
- серийный номер
нить
Chrome 46+Серийный номер, считанный с устройства, если таковой имеется.
- vendorId
число
Идентификатор поставщика.
Методы
connect()
chrome.hid.connect(
deviceId: number,
callback?: function,
): Promise<HidConnectInfo>
Установите соединение с устройством HID для обмена данными.
Параметры
- идентификатор устройства
число
HidDeviceInfo.deviceIdидентификатор устройства, которое нужно открыть. - перезвонить
функция необязательна
Параметр
callbackвыглядит следующим образом:(connection: HidConnectInfo) => void
- связь
Возвраты
Promise <HidConnectInfo>
Chrome 117+Поддержка промисов доступна только для Manifest V3 и более поздних версий; для других платформ необходимо использовать колбэки.
disconnect()
chrome.hid.disconnect(
connectionId: number,
callback?: function,
): Promise<void>
Отключитесь от устройства. Выполнение операций на устройстве после вызова этой функции безопасно, но не имеет никакого эффекта.
Параметры
- connectionId
число
Идентификатор
connectionIdвозвращаемый функциейconnect. - перезвонить
функция необязательна
Параметр
callbackвыглядит следующим образом:() => void
Возвраты
Обещание<пустота>
Chrome 117+Поддержка промисов доступна только для Manifest V3 и более поздних версий; для других платформ необходимо использовать колбэки.
getDevices()
chrome.hid.getDevices(
options: GetDevicesOptions,
callback?: function,
): Promise<HidDeviceInfo[]>
Перечислите подключенные HID-устройства.
Параметры
- параметры
Свойства, которые следует искать на целевых устройствах.
- перезвонить
функция необязательна
Параметр
callbackвыглядит следующим образом:(devices: HidDeviceInfo[]) => void
- устройства
Возвраты
Promise< HidDeviceInfo []>
Chrome 117+Поддержка промисов доступна только для Manifest V3 и более поздних версий; для других платформ необходимо использовать колбэки.
receive()
chrome.hid.receive(
connectionId: number,
callback: function,
): void
Получите следующий отчет о вводе данных от устройства.
Параметры
- connectionId
число
Идентификатор
connectionIdвозвращаемый функциейconnect. - перезвонить
функция
Параметр
callbackвыглядит следующим образом:(reportId: number, data: ArrayBuffer) => void
- reportId
число
Идентификатор отчета или
0, если такового нет. - данные
ArrayBuffer
Данные отчета и префикс идентификатора отчета (если он присутствует) удаляются.
receiveFeatureReport()
chrome.hid.receiveFeatureReport(
connectionId: number,
reportId: number,
callback?: function,
): Promise<ArrayBuffer>
Запросите отчет о работе устройства.
Параметры
- connectionId
число
Идентификатор
connectionIdвозвращаемый функциейconnect. - reportId
число
Идентификатор отчета или
0, если идентификатора нет. - перезвонить
функция необязательна
Параметр
callbackвыглядит следующим образом:(data: ArrayBuffer) => void
- данные
ArrayBuffer
Данные отчета, включая префикс идентификатора отчета, если таковой отправляется устройством.
Возвраты
Promise<ArrayBuffer>
Chrome 117+Поддержка промисов доступна только для Manifest V3 и более поздних версий; для других платформ необходимо использовать колбэки.
send()
chrome.hid.send(
connectionId: number,
reportId: number,
data: ArrayBuffer,
callback?: function,
): Promise<void>
Отправьте отчет о результатах на устройство.
Примечание: Не включайте префикс идентификатора отчета в data . Он будет добавлен при необходимости.
Параметры
- connectionId
число
Идентификатор
connectionIdвозвращаемый функциейconnect. - reportId
число
Идентификатор отчета для использования или
0, если такового нет. - данные
ArrayBuffer
Данные отчета.
- перезвонить
функция необязательна
Параметр
callbackвыглядит следующим образом:() => void
Возвраты
Обещание<пустота>
Chrome 117+Поддержка промисов доступна только для Manifest V3 и более поздних версий; для других платформ необходимо использовать колбэки.
sendFeatureReport()
chrome.hid.sendFeatureReport(
connectionId: number,
reportId: number,
data: ArrayBuffer,
callback?: function,
): Promise<void>
Отправьте отчет о работе устройства.
Примечание: Не включайте префикс идентификатора отчета в data . Он будет добавлен при необходимости.
Параметры
- connectionId
число
Идентификатор
connectionIdвозвращаемый функциейconnect. - reportId
число
Идентификатор отчета для использования или
0, если такового нет. - данные
ArrayBuffer
Данные отчета.
- перезвонить
функция необязательна
Параметр
callbackвыглядит следующим образом:() => void
Возвраты
Обещание<пустота>
Chrome 117+Поддержка промисов доступна только для Manifest V3 и более поздних версий; для других платформ необходимо использовать колбэки.
События
onDeviceAdded
chrome.hid.onDeviceAdded.addListener(
callback: function,
)
Событие генерируется при добавлении устройства в систему. События передаются только приложениям и расширениям, имеющим разрешение на доступ к устройству. Разрешение могло быть предоставлено во время установки или когда пользователь принял необязательное разрешение (см. permissions.request ).
Параметры
- перезвонить
функция
Параметр
callbackвыглядит следующим образом:(device: HidDeviceInfo) => void
- устройство
onDeviceRemoved
chrome.hid.onDeviceRemoved.addListener(
callback: function,
)
Событие генерируется при удалении устройства из системы. См. onDeviceAdded чтобы узнать, какие события доставляются.
Параметры
- перезвонить
функция
Параметр
callbackвыглядит следующим образом:(deviceId: number) => void
- идентификатор устройства
число