Api.EoeSetSlaveEoeIp method

Configures an EtherCAT slave's Ethernet over EtherCAT (EoE) network settings. For more information about EoE, see Ethernet over EtherCAT.

Namespace: IntervalZero.KINGSTAR.Local.Api

Assembly: IntervalZero.KINGSTAR.Local.Api (in IntervalZero.KINGSTAR.Local.dll) Version: 4.4.0.0

Syntax

C#VB

public KsCommandStatus EoeSetSlaveEoeIp(
       int SlaveId,
       byte[] Mac,
       byte[] Ip,
       byte[] Subnet,
       byte[] Gateway,
       byte[] Dns,
       string DnsName
)

Public Function EoeSetSlaveEoeIp(
       SlaveId As Integer,
       Mac As Byte(),
       Ip As Byte(),
       Subnet As Byte(),
       Gateway As Byte(),
       Dns As Byte(),
       DnsNAme As String
) As KsCommandStatus

Parameters

SlaveId

Type: int

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.

Mac

Type: byte[]

The MAC address of the slave.

Type: byte[]

The IP address of the slave.

Subnet

Type: byte[]

The subnet of the slave.

Gateway

Type: byte[]

The gateway of the slave.

Dns

Type: byte[]

The DNS of the slave.

DnsName

Type: string

The DNS name of the slave.

Return value

Type: KsCommandStatus

Returns the KsCommandStatus class.

Remarks

If the EtherCAT slave supports EoE, and in RTX64 Control Panel, under Network and interfaces, in Manage interfaces, Device is set to RTX64 Virtual Network Interface. In Advanced NAL properties > TCP/IP Stack properties, Filter Name is set to KSeoe.rtdll, the slave will automatically get an IP address when it is started.
The IP, subnet, gateway, and DNS are usually represented as "1.2.3.4". Each of the four values is in the 0–255 range and can be stored in a byte.
For more details about EoE configuration in KINGSTAR, please refer to Ethernet over EtherCAT.

Usable EtherCAT states

ecatPreOP, ecatSafeOP, ecatOP

Examples

N/A