ReadSlaveEEprom

Reads a double word from a slave's EEPROM.

Syntax

KsCommandStatus ReadSlaveEEprom(
     int SlaveId,
     int Offset,
     DWORD* Data
);

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.

Offset: the offset in the EEPROM space.

Data: pointer to the data read to be stored.

Return value

Returns the KsCommandStatus structure.

Usable EtherCAT states

ecatInit, ecatPreOP, ecatSafeOP, ecatOP

Example

Copy
DWORD dataEEPROM = 0;
WaitForCommand(3, TRUE, ReadSlaveEEprom(0, 0X1C, &dataEEPROM)); // 0x1C Mailbox Protocol

Requirements

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

See also

WriteSlaveEEprom