Skip to content

USBDevice.md

Latest commit

 

History

History
61 lines (49 loc) · 2.91 KB

USBDevice.md

File metadata and controls

61 lines (49 loc) · 2.91 KB
Raw

USBDevice

Namespace: SpawnDev.SpawnJS.JSObjects.USB
Inheritance: SpawnJSObject -> USBDevice
MDN Reference: USBDevice - MDN

Represents a USB device. Provides access to device metadata and methods for communication including control transfers, bulk transfers, and isochronous transfers.

Constructors

Signature Description
USBDevice(SpawnJSObjectReference _ref) Deserialization constructor.

Properties

Property Type Description
VendorId int The USB vendor ID.
ProductId int The USB product ID.
ProductName string? Human-readable product name.
ManufacturerName string? Human-readable manufacturer name.
SerialNumber string? Serial number string.
Configuration USBConfiguration? The currently selected configuration.
Configurations USBConfiguration[] All available configurations.
Opened bool Whether the device is currently opened.

Methods

Method Return Type Description
Open() Task Opens the device for communication.
Close() Task Closes the device.
SelectConfiguration(int configurationValue) Task Selects a USB configuration.
ClaimInterface(int interfaceNumber) Task Claims exclusive access to an interface.
ReleaseInterface(int interfaceNumber) Task Releases a claimed interface.
SelectAlternateInterface(int interfaceNumber, int alternateSetting) Task Selects an alternate interface setting.
ControlTransferIn(USBControlTransferParameters setup, int length) Task<USBInTransferResult> Performs a control transfer (device to host).
ControlTransferOut(USBControlTransferParameters setup) Task<USBOutTransferResult> Performs a control transfer (host to device).
ControlTransferOut(USBControlTransferParameters setup, BufferSource data) Task<USBOutTransferResult> Control transfer with data.
TransferIn(int endpointNumber, int length) Task<USBInTransferResult> Bulk/interrupt transfer in.
TransferOut(int endpointNumber, BufferSource data) Task<USBOutTransferResult> Bulk/interrupt transfer out.
IsochronousTransferIn(int endpointNumber, int[] packetLengths) Task<USBIsochronousInTransferResult> Isochronous transfer in.
IsochronousTransferOut(int endpointNumber, BufferSource data, int[] packetLengths) Task<USBIsochronousOutTransferResult> Isochronous transfer out.
Reset() Task Resets the device.

Example

using var device = await usb.RequestDevice(options);
await device.Open();
await device.SelectConfiguration(1);
await device.ClaimInterface(0);

// Control transfer
var result = await device.ControlTransferIn(
    new USBControlTransferParameters { /* ... */ }, 64);

await device.ReleaseInterface(0);
await device.Close();