SlaveStatus

Name	Type	Meaning
Name[64]	CHAR	The name of a device.
VendorId	DWORD	The vendor ID of a device, given by the EtherCAT Technology Group to the manufacturer of the EtherCAT device.
ProductCode	DWORD	The product code of a device.
RevisionNumber	DWORD	The revision number of a device.
SerialNumber	DWORD	The serial number of a device.
SlaveId	int	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.
SlotId	int	For IO-Link devices, a slot is an IO-Link port of an IO-Link master that can be connected to an EtherCAT network. SlotId is the ID of a slot where a module (IO-Link slave) is connected. For CAN devices, it is the CAN ID. For non-modular devices, the values are -1.
PhysAddress	USHORT	PhysAddress is the physical address of a device, used by the EtherCAT master to access the device. It is configured by the master during startup. Values are 1001 + slave index.
AliasAddress	USHORT	AliasAddress (or station alias) is used to identify multiple identical devices with the same Vendor ID and Product code. It is a software defined value, stored in the device's EEPROM, and can be written using tools or by the EtherCAT master (WriteSlaveAlias). You can set up AliasAddress for devices in specific roles, such as X, Y, and Z axes. When the AliasAddress is changed, the device must be power cycled for the change to take effect. IMPORTANT: The alias address is intended to be a software defined value, but some devices map it to a hardware DIP switch, which corresponds to the ExplicitId. In such cases, the value should never be changed in software, as it may trigger a device error. Please check your device's user manual for the station alias information before using it. NOTE: If a device supports both AliasAddress and ExplicitId, you can use the ExplicitId without configuring the AliasAddress.
ExplicitId	USHORT	ExplicitId is a preconfigured address used to differentiate same-model devices (drives or I/O modules) on the same network. It must be set before adding the device to the network, either via a rotary DIP switch on the device, or the configuration tool bundled with the device. NOTE: Some devices store the ExplicitId in the EEPROM. Please refer to the device’s ESI file for details on retrieving the ExplicitId.
State	EthercatState	The EtherCAT state of a device.
RequestedState	EthercatState	Reads the EtherCAT state from the latest RequestState function call.
InputLength	int	The length of the input data read from a device.
OutputLength	int	The length of the output data sent to a device.
CycleTime	int	The cycle time for a slave. If the slaves on the EtherCAT network can't catch up the cycle time of the master, KINGSTAR auto-configuration will slow down the cycle time based on their capabilities.
VariableIndexOffset	WORD	If you are using multi-axis servo drives and you want to read the data from one of the axes, you can use this parameter to retrieve the offset value of the SDO object addresses of that axis. For example, the actual position of the first axis is at #x6064. If the second axis is at #x6864, the offset value of the second axis is #x800. This parameter can be used only on axes.

Name[64]

CHAR

The name of a device.

VendorId

DWORD

The vendor ID of a device, given by the EtherCAT Technology Group to the manufacturer of the EtherCAT device.

ProductCode

DWORD

The product code of a device.

RevisionNumber

DWORD

The revision number of a device.

SerialNumber

DWORD

The serial number of a device.

SlaveId

int

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.

SlotId

int

For IO-Link devices, a slot is an IO-Link port of an IO-Link master that can be connected to an EtherCAT network. SlotId is the ID of a slot where a module (IO-Link slave) is connected. For CAN devices, it is the CAN ID.

For non-modular devices, the values are -1.

PhysAddress

USHORT

PhysAddress is the physical address of a device, used by the EtherCAT master to access the device. It is configured by the master during startup. Values are 1001 + slave index.

AliasAddress

USHORT

AliasAddress (or station alias) is used to identify multiple identical devices with the same Vendor ID and Product code. It is a software defined value, stored in the device's EEPROM, and can be written using tools or by the EtherCAT master (WriteSlaveAlias). You can set up AliasAddress for devices in specific roles, such as X, Y, and Z axes. When the AliasAddress is changed, the device must be power cycled for the change to take effect.

IMPORTANT: The alias address is intended to be a software defined value, but some devices map it to a hardware DIP switch, which corresponds to the ExplicitId. In such cases, the value should never be changed in software, as it may trigger a device error. Please check your device's user manual for the station alias information before using it.

NOTE: If a device supports both AliasAddress and ExplicitId, you can use the ExplicitId without configuring the AliasAddress.

ExplicitId

USHORT

ExplicitId is a preconfigured address used to differentiate same-model devices (drives or I/O modules) on the same network. It must be set before adding the device to the network, either via a rotary DIP switch on the device, or the configuration tool bundled with the device.

NOTE: Some devices store the ExplicitId in the EEPROM. Please refer to the device’s ESI file for details on retrieving the ExplicitId.

State

EthercatState

The EtherCAT state of a device.

RequestedState

EthercatState

Reads the EtherCAT state from the latest RequestState function call.

InputLength

int

The length of the input data read from a device.

OutputLength

int

The length of the output data sent to a device.

CycleTime

int

The cycle time for a slave. If the slaves on the EtherCAT network can't catch up the cycle time of the master, KINGSTAR auto-configuration will slow down the cycle time based on their capabilities.

VariableIndexOffset

WORD

If you are using multi-axis servo drives and you want to read the data from one of the axes, you can use this parameter to retrieve the offset value of the SDO object addresses of that axis. For example, the actual position of the first axis is at #x6064. If the second axis is at #x6864, the offset value of the second axis is #x800. This parameter can be used only on axes.