IApi.AoeWriteCommand method

Writes 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 AoeWriteCommand(
       int SlaveId,
       int Port,
       int IndexGroup,
       int IndexOffset,
       byte[] Value
)

Function AoeWriteCommand(
       SlaveId As Integer,
       Port As Integer,
       IndexGroup As Integer,
       IndexOffset As Integer,
       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.

IndexGroup

Type: int

The index group of the object to write.

IndexOffset

Type: int

The offset of the object in the group.

Value

Type: byte[]

The buffer containing the value to write.

Return value

Type: KsCommandStatus

Returns a state of a method.

Usable EtherCAT states

ecatPreOP, ecatSafeOP, ecatOP

Examples

N/A