IApi.AoeWriteControlCommand method

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

Namespace: IntervalZero.KINGSTAR.Base.Api

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

Syntax

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

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

Parameters

SlaveId

Type: int

The index of a slave array. When EtherCAT is started, this index has the same value as the SlaveId, which corresponds to the position of the slave in the network. Please note that after EtherCAT is started in the Operational (Op) state, any addition or removal of slaves from the network will change the position of the slaves in the network (SlaveId). Nevertheless, the index of the slave will remain the same. Newly added devices will be added in the back of the slave array. For all slaves after the change, the index and SlaveId will no longer match. This behavior is only available for physical devices; simulated devices are inapplicable. Please refer to the use cases in EnableHotConnect 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