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 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: 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