ReadSlaveAlias

Reads the alias address from an EtherCAT slave.

Syntax

KsCommandStatus ReadSlaveAlias(
     int SlaveId,
     WORD* Alias
);

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.

Alias: pointer to the value to receive the alias address. See the AliasAddress in the SlaveStatus structure.

Return value

Returns the KsCommandStatus structure.

Usable EtherCAT states

ecatInit, ecatPreOP, ecatSafeOP, ecatOP

Example

WORD slaveAlias = 0;
WaitForCommand(3, TRUE, ReadSlaveAlias(0, &slaveAlias));

Requirements

See also

WriteSlaveAlias