Api.AoeWriteControlCommand method

Sends a command to the device through ADS over EtherCAT (AoE).

Namespace: IntervalZero.KINGSTAR.Local.Api

Assembly: IntervalZero.KINGSTAR.Local.Api (in IntervalZero.KINGSTAR.Local.dll) Version: 4.4.0.0

Syntax

C#VB

public KsCommandStatus AoeWriteControlCommand(
       int SlaveId,
       int Port,
       ushort AoeState,
       ushort DeviceState,
       byte[] Value
)

Public Function AoeWriteControlCommand(
       SlaveId As Integer,
       Port As Integer,
       AoeState As UShort,
       DeviceState As UShort,
       Value As Byte()
) As KsCommandStatus

Parameters

SlaveId

Type: int

The slave index. This index value is automatically assigned by the KINGSTAR master when the EtherCAT network starts, based on the physical connection order. The first device connected directly to the master is assigned Index 0, followed by Index 1, Index 2, and so on. These indexes remain consistent within the slave array even if devices are added, removed, or reconnected. Please refer to the use cases in HotConnect, Repair, and Restart for more details.

Port

Type: int

The EtherCAT slave port.

AoeState

Type: ushort

The AoE state in which the command runs.

DeviceState

Type: ushort

The device state in which the command runs. The state varies between devices.

Value

Type: byte[]

The value to run the command.

Return value

Type: KsCommandStatus

Returns the KsCommandStatus class.

Usable EtherCAT states

ecatPreOP, ecatSafeOP, ecatOP

Examples

N/A