IApi.AoeReadCommand method

Reads data 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<byte[]> AoeReadCommand(
       int SlaveId,
       int Port,
       int IndexGroup,
       int IndexOffset,
       int Length
)

Function AoeReadCommand(
       SlaveId As Integer,
       Port As Integer,
       IndexGroup As Integer,
       IndexOffset As Integer,
       Length As Integer
) As KsCommandStatus(Of Byte())

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.

IndexGroup

Type: int

The index group of the object to read.

IndexOffset

Type: int

The offset of the object in the group.

Length

Type: int

The length in byte of the value to read.

Return value

Type: KsCommandStatus<byte[]>

Returns a state of a method and a byte array.

Usable EtherCAT states

ecatPreOP, ecatSafeOP, ecatOP

Examples

N/A