Class StimulationOptions

Configuration record for StimulationController.

Inheritance

object

StimulationOptions

Namespace: HFI.Wss

Assembly: HFI_WSS_Csharp_Implementation.dll

Syntax

public sealed class StimulationOptions

Properties

BleAutoSelect

When true, the BLE transport scans for compatible devices and auto-selects the best candidate.

Declaration

public bool BleAutoSelect { get; init; }

Property Value

Type	Description
bool

BleDeviceId

Explicit BLE device identifier to connect to when auto-selection is disabled.

Declaration

public string? BleDeviceId { get; init; }

Property Value

Type	Description
string

BleDeviceName

Exact BLE device name to connect to when auto-selection is disabled.

Declaration

public string? BleDeviceName { get; init; }

Property Value

Type	Description
string

ConfigPath

Directory that holds the JSON configs used by the WSS stack.

Declaration

public string ConfigPath { get; init; }

Property Value

Type	Description
string

MaxSetupTries

Maximum number of setup retries before failing initialization.

Declaration

public int MaxSetupTries { get; init; }

Property Value

Type	Description
int

SerialPort

Optional serial device name (e.g., "COM3" or "/dev/ttyUSB0"). Uses auto-detect when null.

Declaration

public string? SerialPort { get; init; }

Property Value

Type	Description
string

Remarks

Only used when Transport is Serial.

TickIntervalMs

Delay in milliseconds between background tick invocations.

Declaration

public int TickIntervalMs { get; init; }

Property Value

Type	Description
int

Transport

Selects the transport implementation used for stimulation.

Declaration

public StimulationTransportKind Transport { get; init; }

Property Value

Type	Description
StimulationTransportKind

Methods

CreateDefault()

Creates default options using a Config directory under the current working directory.

Declaration

public static StimulationOptions CreateDefault()

Returns

Type	Description
StimulationOptions