WriteSlaveAlias

Writes an alias address into an EtherCAT slave.

Syntax

KsCommandStatus WriteSlaveAlias(
     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: the alias address to use. See the AliasAddress in the SlaveStatus structure.

Return value

Returns the KsCommandStatus structure.

Remarks

Some EtherCAT slaves don't accept alias address being modified. If the master writes a value that is not acceptable to the slave, the slave may display an error and refuse to start.

Usable EtherCAT states

ecatInit, ecatPreOP, ecatSafeOP, ecatOP

Example

const WORD newAlias = 5;
WaitForCommand(3, TRUE, WriteSlaveAlias(0, newAlias));

Requirements

See also

ReadSlaveAlias