EoeSetSlaveEoeIp

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

Syntax

KsCommandStatus EoeSetSlaveEoeIp(
     int SlaveId,
     unsigned long long Mac,
     DWORD Ip,
     DWORD Subnet,
     DWORD Gateway,
     DWORD Dns,
     char* DnsName
);

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.

Mac: the MAC address of the slave.

Ip: the IP address of the slave.

Subnet: the subnet of the slave.

Gateway: the gateway of the slave.

Dns: the DNS of the slave.

DnsName: the DNS name of the slave.

Return value

If the function succeeds, it returns errNoError, otherwise an error code. For more information about the error code, see the KsError list.

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, so the DWORD value is the 4 bytes of the addresses.

Usable EtherCAT states

ecatPreOP, ecatSafeOP, ecatOP

Example

Command = WaitForCommand(
              5,
              false,
              EoeSetSlaveEoeIp(
                  0,                 //SlaveID
                  0x093A284FC23C,    //Mac
                  3232261123,        //IP 192.168.100.3
                  4294967040,        //Subnet, 255.255.255.0
                  0,                 //Gateway
                  0,                 //DNS
                  ""                 //DNSName
              )
          );

Requirements

See also

Ethernet over EtherCAT