Class WssStimulationCoreOptions

Holds startup and default stimulation settings for WssStimulationCore.

Inheritance

object

WssStimulationCoreOptions

Namespace: Wss.CoreModule

Assembly: WSS_Core_Interface.dll

Syntax

public sealed class WssStimulationCoreOptions

Remarks

These values affect configuration loading, setup retry behavior, and the default schedule/event values used during the core's initial device setup. Packet spacing is intentionally not exposed here because it remains a fixed hardware/radio constraint in the core implementation. The core constructor requires a non-empty ConfigPath and validates that MaxSetupTries is at least 1.

Properties

ConfigPath

Gets or sets the core configuration file path. Directory paths resolve to stimConfig.json in that directory.

Declaration

public string ConfigPath { get; set; }

Property Value

Type	Description
string

DefaultAmp

Gets or sets the default amplitude used during initial setup, in mA. The default is 1.0.

Declaration

public float DefaultAmp { get; set; }

Property Value

Type	Description
float

DefaultIpd

Gets or sets the default inter-phase delay used during initial setup, in microseconds. The default is 50.

Declaration

public int DefaultIpd { get; set; }

Property Value

Type	Description
int

DefaultIpi

Gets or sets the default inter-pulse interval used during initial setup, in milliseconds. The default is 10.

Declaration

public int DefaultIpi { get; set; }

Property Value

Type	Description
int

DefaultRatio

Gets or sets the default event ratio used during initial setup. The default is 8.

Declaration

public int DefaultRatio { get; set; }

Property Value

Type	Description
int

DefaultSync

Gets or sets the default sync group used during initial setup. The default is 170.

Declaration

public int DefaultSync { get; set; }

Property Value

Type	Description
int

MaxSetupTries

Gets or sets the maximum number of setup retries before the core enters the Error state. This must be at least 1. The default is 5.

Declaration

public int MaxSetupTries { get; set; }

Property Value

Type	Description
int