AoeReadWriteCommand

Reads and writes data through ADS over EtherCAT (AoE) at the same time.

Syntax

KsCommandStatus AoeReadWriteCommand(
     int SlaveId,
     int Port,
     int IndexGroup,
     int IndexOffset,
     BYTE* ReadValue,
     int ReadLength,
     BYTE* WriteValue,
     int WriteLength
);

Parameters

SlaveId: 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: the EtherCAT slave port.

IndexGroup: the index group of the object to read and write.

IndexOffset: the offset of the object in the group.

ReadValue: pointer to the value to be read.

ReadLength: the length in byte of the value to read.

WriteValue: pointer to the buffer containing the value to be written.

WriteLength: the length in byte of the value to write.

Return value

Returns the KsCommandStatus structure.

Usable EtherCAT states

ecatPreOP, ecatSafeOP, ecatOP

Example

Copy

BYTE valueRead = 0;
BYTE valueWrite = 1;
AoeReadWriteCommand(1, 0x1070, 0x6060, 0, &valueRead, 1, &valueWrite, 1);

Requirements

	RT	Win32
Minimum supported version	4.0	4.0
Header	ksapi.h	ksapi.h
Library	KsApi_Rtss.lib	KsApi.lib