HIDDevice: receiveFeatureReport() method

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

Note: This feature is available in Web Workers, except for Shared Web Workers.

The receiveFeatureReport() method of the HIDDevice interface receives a feature report from the HID device. Feature reports are a way for HID devices and applications to exchange non-standardized HID data.

The reportId for each of the report formats that this device supports can be retrieved from HIDDevice.collections.

Syntax

js
receiveFeatureReport(reportId)

Parameters

reportId

An 8-bit report ID. If the HID device does not use report IDs, send 0.

Return value

A Promise which resolves with a DataView object containing the feature report.

Exceptions

NotAllowedError DOMException

Thrown if receiving the report fails for any reason.

Examples

In the following example a report is received from a device using a reportId of 1.

js
const dataView = await device.receiveFeatureReport(1);

Specifications

Specification
WebHID API
# dom-hiddevice-receivefeaturereport

Browser compatibility

BCD tables only load in the browser