Interface IBasicStimulation
Basic stimulation operations that upload or select waveforms and manage board configuration. Calls are non-blocking; implementations may enqueue setup steps and return immediately.
Namespace: Wss.CoreModule
Assembly: WSS_Core_Interface.dll
Syntax
public interface IBasicStimulationMethods
Load(WssTarget)
Loads board settings from non-volatile memory. Implementations should pause streaming if needed, perform the load, then resume.
Declaration
void Load(WssTarget wssTarget)Parameters
| Type | Name | Description |
|---|---|---|
| WssTarget | wssTarget | Target device or broadcast. |
LoadWaveform(string, int)
Loads a waveform JSON file (…WF.json), builds it, and enqueues an upload.
Declaration
void LoadWaveform(string fileName, int eventID)Parameters
| Type | Name | Description |
|---|---|---|
| string | fileName | File name or path; “WF.json†suffix is enforced. |
| int | eventID | Event slot to target. |
Request_Configs(int, int, WssTarget)
Requests configuration blocks from the device.
Declaration
void Request_Configs(int command, int id, WssTarget wssTarget)Parameters
| Type | Name | Description |
|---|---|---|
| int | command | Command group identifier. |
| int | id | Sub-id / selector. |
| WssTarget | wssTarget | Target device or broadcast. |
Save(WssTarget)
Saves board settings to non-volatile memory. Implementations should pause streaming if needed, perform the save, then resume.
Declaration
void Save(WssTarget wssTarget)Parameters
| Type | Name | Description |
|---|---|---|
| WssTarget | wssTarget | Target device or broadcast. |
UpdateEventShape(int, int, int, WssTarget)
Sets event shape IDs directly for the given eventID.
Implementations should send setup edits with replies.
Declaration
void UpdateEventShape(int cathodicWaveform, int anodicWaveform, int eventID, WssTarget wssTarget)Parameters
| Type | Name | Description |
|---|---|---|
| int | cathodicWaveform | Shape ID for the standard phase. |
| int | anodicWaveform | Shape ID for the recharge phase. |
| int | eventID | Event slot to modify. |
| WssTarget | wssTarget | Target device or broadcast. |
UpdateIPD(int, int, WssTarget)
Updates inter-phase delay (IPD) for a specific eventID via setup commands (with replies).
If currently Streaming, the core pauses streaming, sends the edit, and resumes when done.
Declaration
void UpdateIPD(int ipd, int eventID, WssTarget wssTarget = WssTarget.Broadcast)Parameters
| Type | Name | Description |
|---|---|---|
| int | ipd | Inter-phase delay in microseconds (clamped internally). |
| int | eventID | Event slot to target. |
| WssTarget | wssTarget | Target device or broadcast. |
UpdateIPD(int, WssTarget)
Updates inter-phase delay (IPD) for events 1–3 via setup commands (with replies). If currently Streaming, the core pauses streaming, sends edits, and resumes when done.
Declaration
void UpdateIPD(int ipd, WssTarget wssTarget = WssTarget.Broadcast)Parameters
| Type | Name | Description |
|---|---|---|
| int | ipd | Inter-phase delay in microseconds (clamped internally). |
| WssTarget | wssTarget | Target device or broadcast. |
UpdateWaveform(int[], int, WssTarget)
Builds a custom waveform from raw points and schedules the upload
for the specified eventID.
Declaration
void UpdateWaveform(int[] waveform, int eventID, WssTarget wssTarget)Parameters
| Type | Name | Description |
|---|---|---|
| int[] | waveform | Concatenated waveform definition. |
| int | eventID | Event slot to target. |
| WssTarget | wssTarget | Target device or broadcast. |
UpdateWaveform(WaveformBuilder, int, WssTarget)
Uploads a prepared waveform and assigns shapes for eventID.
Declaration
void UpdateWaveform(WaveformBuilder waveform, int eventID, WssTarget wssTarget)Parameters
| Type | Name | Description |
|---|---|---|
| WaveformBuilder | waveform | Prepared WaveformBuilder. |
| int | eventID | Event slot to target. |
| WssTarget | wssTarget | Target device or broadcast. |
WaveformSetup(WaveformBuilder, int, WssTarget)
Schedules the upload of custom waveform chunks and points
eventID at the uploaded shapes.
Declaration
void WaveformSetup(WaveformBuilder wave, int eventID, WssTarget wssTarget)Parameters
| Type | Name | Description |
|---|---|---|
| WaveformBuilder | wave | Waveform builder. |
| int | eventID | Event slot to target. |
| WssTarget | wssTarget | Target device or broadcast. |