Class WheelApi

WebHID-based API for communicating with the wheel controller.

Example

import { WheelApi } from "@shubham0x13/ffbeast-wheel-webhid-api";

const wheel = new WheelApi();

wheel.on("stateReceived", (state) => {
  console.log("Position:", state.position);
});

await wheel.connect();

// ... later

await wheel.disconnect();
wheel.destroy();

Hierarchy

EventEmitter<WheelEvents>
- WheelApi

Constructors

constructor

new WheelApi(): WheelApi
Returns WheelApi
Overrides EventEmitter<WheelEvents>.constructor
- Defined in src/wheel-api.ts:126

Properties

`Static`prefixed

prefixed: string | boolean

Accessors

firmwareReleaseType

get firmwareReleaseType(): number | null
Current firmware release type.

Returns number | null
Release type number, or null if not connected.
- Defined in src/wheel-api.ts:95

firmwareVersion

get firmwareVersion(): string | null
Current firmware version string.

Returns string | null
Version string (e.g., "1.2.3"), or null if not connected.
- Defined in src/wheel-api.ts:106

isConnected

get isConnected(): boolean
Device connection status.

Returns boolean
true if connected and opened.
- Defined in src/wheel-api.ts:118

lastState

get lastState(): Readonly<DeviceState> | null
Last received device state.

Returns Readonly<DeviceState> | null
Device state, or null if no state received yet.
- Defined in src/wheel-api.ts:62

positionDegrees

get positionDegrees(): number | null
Current wheel position in degrees.

Returns number | null
Position in degrees, or null if not connected.
- Defined in src/wheel-api.ts:70

torqueNormalized

get torqueNormalized(): number | null
Current torque normalized to [-100, 100] range.

Returns number | null
Normalized torque, or null if not connected.
- Defined in src/wheel-api.ts:84

Methods

addListener

addListener<T extends keyof WheelEvents>(
    event: T,
    fn: (
        ...args: ArgumentMap<WheelEvents>[Extract<T, keyof WheelEvents>],
    ) => void,
    context?: any,
): this
Type Parameters
- T extends keyof WheelEvents
Parameters
- event: T
- fn: (...args: ArgumentMap<WheelEvents>[Extract<T, keyof WheelEvents>]) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45

connect

connect(): Promise<boolean>
Opens the browser's device picker to connect to a wheel.

Returns Promise<boolean>
true if connection was successful.
- Defined in src/wheel-api.ts:149

destroy

destroy(): Promise<void>
Cleans up all resources and event listeners. Must be called when the API instance is no longer needed.

Returns Promise<void>
- Defined in src/wheel-api.ts:207

disconnect

disconnect(): Promise<void>
Disconnects from the current device.

Returns Promise<void>
- Defined in src/wheel-api.ts:183

emit

emit<T extends keyof WheelEvents>(
event: T,
...args: ArgumentMap<WheelEvents>[Extract<T, keyof WheelEvents>],
): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends keyof WheelEvents
Parameters
- event: T
- ...args: ArgumentMap<WheelEvents>[Extract<T, keyof WheelEvents>]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): (keyof WheelEvents)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (keyof WheelEvents)[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15

listenerCount

listenerCount(event: keyof WheelEvents): number
Return the number of listeners listening to a given event.
Parameters
- event: keyof WheelEvents
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T extends keyof WheelEvents>(
    event: T,
): (
    (
        ...args: ArgumentMap<WheelEvents>[Extract<T, keyof WheelEvents>],
    ) => void
)[]
Return the listeners registered for a given event.
Type Parameters
- T extends keyof WheelEvents
Parameters
- event: T
Returns ((...args: ArgumentMap<WheelEvents>[Extract<T, keyof WheelEvents>]) => void)[]
Inherited from EventEmitter.listeners
- Defined in node_modules/eventemitter3/index.d.ts:20

off

off<T extends keyof WheelEvents>(
    event: T,
    fn?: (
        ...args: ArgumentMap<WheelEvents>[Extract<T, keyof WheelEvents>],
    ) => void,
    context?: any,
    once?: boolean,
): this
Type Parameters
- T extends keyof WheelEvents
Parameters
- event: T
- Optionalfn: (...args: ArgumentMap<WheelEvents>[Extract<T, keyof WheelEvents>]) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.off
- Defined in node_modules/eventemitter3/index.d.ts:69

on

on<T extends keyof WheelEvents>(
    event: T,
    fn: (
        ...args: ArgumentMap<WheelEvents>[Extract<T, keyof WheelEvents>],
    ) => void,
    context?: any,
): this
Add a listener for a given event.
Type Parameters
- T extends keyof WheelEvents
Parameters
- event: T
- fn: (...args: ArgumentMap<WheelEvents>[Extract<T, keyof WheelEvents>]) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.on
- Defined in node_modules/eventemitter3/index.d.ts:40

once

once<T extends keyof WheelEvents>(
    event: T,
    fn: (
        ...args: ArgumentMap<WheelEvents>[Extract<T, keyof WheelEvents>],
    ) => void,
    context?: any,
): this
Add a one-time listener for a given event.
Type Parameters
- T extends keyof WheelEvents
Parameters
- event: T
- fn: (...args: ArgumentMap<WheelEvents>[Extract<T, keyof WheelEvents>]) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.once
- Defined in node_modules/eventemitter3/index.d.ts:54

readAdcExtensionSettings

readAdcExtensionSettings(): Promise<AdcSettings>
Reads the current ADC extension settings from the device.

Returns Promise<AdcSettings>
ADC settings object.
- Defined in src/wheel-api.ts:287

readAllSettings

readAllSettings(): Promise<DeviceSettings>
Reads all settings from the device sequentially.

Returns Promise<DeviceSettings>
Object containing all settings groups.
- Defined in src/wheel-api.ts:327

readEffectSettings

readEffectSettings(): Promise<EffectSettings>
Reads the current effect settings from the device.

Returns Promise<EffectSettings>
Effect settings object.
- Defined in src/wheel-api.ts:218

readFirmwareLicense

readFirmwareLicense(): Promise<FirmwareLicense>
Reads the firmware license information from the device.

Returns Promise<FirmwareLicense>
Firmware license object.
- Defined in src/wheel-api.ts:306

readGpioExtensionSettings

readGpioExtensionSettings(): Promise<GpioSettings>
Reads the current GPIO extension settings from the device.

Returns Promise<GpioSettings>
GPIO settings object.
- Defined in src/wheel-api.ts:268

readHardwareSettings

readHardwareSettings(): Promise<HardwareSettings>
Reads the current hardware settings from the device.

Returns Promise<HardwareSettings>
Hardware settings object.
- Defined in src/wheel-api.ts:241

rebootController

rebootController(): Promise<void>
Reboots the controller without saving settings.

Returns Promise<void>
- Defined in src/wheel-api.ts:482

removeAllListeners

removeAllListeners(event?: keyof WheelEvents): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: keyof WheelEvents
Returns this
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T extends keyof WheelEvents>(
    event: T,
    fn?: (
        ...args: ArgumentMap<WheelEvents>[Extract<T, keyof WheelEvents>],
    ) => void,
    context?: any,
    once?: boolean,
): this
Remove the listeners of a given event.
Type Parameters
- T extends keyof WheelEvents
Parameters
- event: T
- Optionalfn: (...args: ArgumentMap<WheelEvents>[Extract<T, keyof WheelEvents>]) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63

resetWheelCenter

resetWheelCenter(): Promise<void>
Sets the current wheel position as center.

Returns Promise<void>
- Defined in src/wheel-api.ts:496

saveAndReboot

saveAndReboot(): Promise<void>
Saves current settings to flash and reboots the controller.

Returns Promise<void>
- Defined in src/wheel-api.ts:475

sendDirectControl

sendDirectControl(control: DirectControl): Promise<void>
Sends direct force feedback control to the device.
Parameters
- control: DirectControl
  Force feedback control values.
Returns Promise<void>
- Defined in src/wheel-api.ts:398

sendFirmwareActivation

sendFirmwareActivation(license: string): Promise<boolean>
Sends the firmware activation license key to the device. Expected format: "XXXXXXXX-XXXXXXXX-XXXXXXXX" (Hex strings)
Parameters
- license: string
  The license key string.
Returns Promise<boolean>
true if the format was valid and sent, false otherwise.
- Defined in src/wheel-api.ts:425

sendSetting

sendSetting(field: SettingField, index: number, value: number): Promise<void>
Writes a single setting value to the device.
Parameters
- field: SettingField
  The setting field to write.
- index: number
  Sub-index for array-based settings.
- value: number
  The value to write.
Returns Promise<void>
- Defined in src/wheel-api.ts:347

switchToDfu

switchToDfu(): Promise<void>
Switches the device to DFU mode for firmware updates.

Returns Promise<void>
- Defined in src/wheel-api.ts:489

tryAutoConnect

tryAutoConnect(): Promise<boolean>
Attempts to reconnect to a previously authorized device.

Returns Promise<boolean>
true if a device was found and connected.
- Defined in src/wheel-api.ts:171

`Static`isSupported

isSupported(): boolean
Checks if WebHID is supported in the current browser.

Returns boolean
true if supported (Chrome/Edge/Opera).
- Defined in src/wheel-api.ts:141

Class WheelApi

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns WheelApi

Properties

Staticprefixed

Accessors

firmwareReleaseType

Returns number | null

firmwareVersion

Returns string | null

isConnected

Returns boolean

lastState

Returns Readonly<DeviceState> | null

positionDegrees

Returns number | null

torqueNormalized

Returns number | null

Methods

addListener

Type Parameters

Parameters

Returns this

connect

Returns Promise<boolean>

destroy

Returns Promise<void>

disconnect

Returns Promise<void>

emit

Type Parameters

Parameters

Returns boolean

eventNames

Returns (keyof WheelEvents)[]

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns ((...args: ArgumentMap<WheelEvents>[Extract<T, keyof WheelEvents>]) => void)[]

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

readAdcExtensionSettings

Returns Promise<AdcSettings>

readAllSettings

Returns Promise<DeviceSettings>

readEffectSettings

Returns Promise<EffectSettings>

readFirmwareLicense

Returns Promise<FirmwareLicense>

readGpioExtensionSettings

Returns Promise<GpioSettings>

readHardwareSettings

Returns Promise<HardwareSettings>

rebootController

Returns Promise<void>

removeAllListeners

Parameters

Returns this

removeListener

`Static`prefixed

`Static`isSupported