W3cubDocs

/Web APIs

HIDDevice: receiveFeatureReport() method

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.

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

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
receiveFeatureReport 89 89 No No 75 No No No No No No No

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/HIDDevice/receiveFeatureReport