Class CreateEventRequest
Describes an event to create on the WSS device.
Inheritance
Namespace: Wss.CoreModule
Assembly: WSS_Core_Interface.dll
Syntax
public sealed class CreateEventRequest
Remarks
This request supports the same payload shapes as the previous overload set: basic event, event with explicit shape IDs, event with amplitude and pulse-width data, or event with both shape and amplitude data. StandardShapeId and RechargeShapeId must be supplied together. StandardAmplitudes and RechargeAmplitudes must be supplied together. PulseWidths is required when amplitude arrays are supplied, and amplitude arrays are required when PulseWidths is supplied.
Properties
ContactConfigId
Gets or sets the contact configuration ID (0..255).
Declaration
public int ContactConfigId { get; set; }
Property Value
| Type | Description |
|---|---|
| int |
DelayMs
Gets or sets the delay from schedule start, in milliseconds.
Declaration
public int DelayMs { get; set; }
Property Value
| Type | Description |
|---|---|
| int |
EventId
Gets or sets the event ID (0..255).
Declaration
public int EventId { get; set; }
Property Value
| Type | Description |
|---|---|
| int |
PulseWidths
Gets or sets the optional pulse-width payload. This is required when amplitude arrays are supplied.
Declaration
public EventPulseWidths PulseWidths { get; set; }
Property Value
| Type | Description |
|---|---|
| EventPulseWidths |
RechargeAmplitudes
Gets or sets the optional four-element amplitude array for the recharge phase. Must be supplied together with StandardAmplitudes and PulseWidths.
Declaration
public int[] RechargeAmplitudes { get; set; }
Property Value
| Type | Description |
|---|---|
| int[] |
RechargeShapeId
Gets or sets the optional recharge-phase shape ID. Must be supplied together with StandardShapeId.
Declaration
public int? RechargeShapeId { get; set; }
Property Value
| Type | Description |
|---|---|
| int? |
StandardAmplitudes
Gets or sets the optional four-element amplitude array for the standard phase. Must be supplied together with RechargeAmplitudes and PulseWidths.
Declaration
public int[] StandardAmplitudes { get; set; }
Property Value
| Type | Description |
|---|---|
| int[] |
StandardShapeId
Gets or sets the optional standard-phase shape ID. Must be supplied together with RechargeShapeId.
Declaration
public int? StandardShapeId { get; set; }
Property Value
| Type | Description |
|---|---|
| int? |