Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Edited ACD API.

...

Set the Vendor ID of this EtherNet/IP stack instance. The vendor ID is assigned by the ODVA.

Default Value: 1114

goal_eipCfgVendorIdSet parameters

Parameter

Description

uint16_t vendorId

Vendor ID

Table: goal_eipCfgVendorIdSet parameters

Code Block
languagec
res = goal_eipCfgVendorIdSet(1114);

goal_eipCfgDeviceTypeSet

Set the Device Type of this EtherNet/IP stack instance. Valid values are defined by the CIP specification.

Default Value: 0x2B

goal_eipCfgDeviceTypeSet parameters

Parameter

Description

uint16_t deviceType

Device Type

Table: goal_eipCfgDeviceTypeSet parameters

Code Block
languagec
res = goal_eipCfgDeviceTypeSet(0x2B);

goal_eipCfgProductCodeSet

Set the Product Code of this EtherNet/IP stack instance. This value is defined by the device vendor.

Default Value: 1goal_eipCfgProductCodeSet parameters

Parameter

Description

uint16_t productCode

Product Code

Table: goal_eipCfgProductCodeSet parameters

Code Block
languagec
res = goal_eipCfgProductCodeSet(0xABCD);

goal_eipCfgRevisionSet

Set the Revision of the EtherNet/IP stack instance. The revision consists of a major and a minor number. It represents changes in the firmware that affect the device’s behaviour.

Default Value: 1.1

goal_eipCfgRevisionSet parameters

Parameter

Description

uint8_t revMajor

major revision number

uint8_t revMinor

minor revision number

Table: goal_eipCfgRevisionSet parameters

Code Block
languagec
res = goal_eipCfgRevisionSet(1, 3);

goal_eipCfgSerialNumSet

Set the Serial Number of the EtherNet/IP stack instance. This number is assigned by the vendor and should be unique for each device.

Default Value: 1

goal_eipCfgSerialNumSet parameters

Parameter

Description

uint32_t serial

SErial Number

...

Serial Number

Table: res = goal_eipCfgRevisionSet(1, 3);

Code Block
languagec
res = goal_eipCfgSerialNumSet(12345678);

goal_eipCfgProductNameSet

...

Default Value: “EtherNet/IP Adapter”goal_eipCfgProductNameSet parameters

Parameter

Description

const char *strName

Product Name

Table: goal_eipCfgProductNameSet parameters

Code Block
languagec
res = goal_eipCfgProductNameSet("EtherNet/IP Adapter");

goal_eipCfgDomainNameSet

Set the default Domain Name of the EtherNet/IP stack instance. This name is used as the device’s domain name if no valid configuration was found. Its maximum length is 48 characters.

Default Value:port.de

goal_eipCfgDomainNameSet parameters

Parameter

Description

const char *strName

default Domain Name

Table: goal_eipCfgDomainNameSet parameters

Code Block
languagec
res = goal_eipCfgDomainNameSet("example.org");

goal_eipCfgHostNameSet

Set the default Host Name of the EtherNet/IP stack instance. This name is used as the device’s host name if no valid configuration was found. Its maximum length is 64 characters.

Default Value: “eipdevice”

goal_eipCfgHostNameSet parameters

Parameter

Description

const char *strName

default Host Name

Table: goal_eipCfgHostNameSet parameters

Code Block
languagec
res = goal_eipCfgHostNameSet("example_device");

goal_eipCfgNumExplicitConSet

Set the maximum number of explicit Connections the device can handle at once.

Default Value: 6goal_eipCfgNumExplicitConSet parameters

Parameter

Description

uint16_t num

number of explicit connections

Table: goal_eipCfgNumExplicitConSet parameters

Code Block
languagec
res = goal_eipCfgNumExplicitConSet(10);

goal_

...

eipCfgNumImplicitConSet

Set the maximum number of implicit Connections the device can handle at once.

Default Value: 6goal_eipCfgNumImplicitConSetImpl parameters

Parameter

Description

uint16_t num

number of implicit connections

Table: goal_eipCfgNumImplicitConSet parameters

Code Block
languagec
res = goal_

...

eipCfgNumImplicitConSet(10);

goal_eipCfgEthLinkCountersOn

Enable support for Ethernet Link attributes 4, 5, 12 and 13. THe The hardware must support the appropriate counters.

Default Value: GOAL_TRUE

goal_eipCfgEthLinkCountersOn parameters

Parameter

Description

GOAL_BOOL_T enable

enable or disable feature

Table: goal_eipCfgEthLinkCountersOn parameters

Code Block
languagec
res = goal_eipCfgEthLinkCountersOn(GOAL_TRUE);

goal_eipCfgEthLinkControlOn

Enable support for Ethernet Link attribute 6. The hardware must support forced link speeds and duplex modes.

Default Value: GOAL_TRUE

goal_eipCfgEthLinkControlOn parameters

Parameter

Description

GOAL_BOOL_T enable

enable or disable feature

Table: goal_eipCfgEthLinkControlOn parameters

Code Block
languagec
res = goal_eipCfgEthLinkControlOn(GOAL_TRUE);

goal_eipCfgChangeEthAfterResetOn

A change of Ethernet link speeds or duplex modes requires a reset of the device. The hardware must support forced link speeds and duplex modes.

Default Value: GOAL_FALSE

goal_eipCfgChangeEthAfterResetOn parameters

Parameter

Description

GOAL_BOOL_T enable

enable or disable feature

Table: goal_eipCfgChangeEthAfterResetOn parameters

Code Block
languagec
res = goal_eipCfgChangeEthAfterResetOn(GOAL_FALSE);

goal_eipCfgChangeIpAfterResetOn

A change of the IP address requires a reset of the device.

Default Value: GOAL_FALSEgoal_eipCfgChangeIpAfterResetOn parameters

Parameter

Description

GOAL_BOOL_T enable

enable or disable feature

Table: goal_eipCfgChangeIpAfterResetOn parameters

Code Block
languagec
res = goal_eipCfgChangeIpAfterResetOn(GOAL_FALSE);

goal_eipCfgNumSessionsSet

Set the number of Encapsulation sessions the device can handle at once.

Default Value: 20goal_eipCfgNumSessionsSet parameters

Parameter

Description

uint16_t num

number of sessions

Table: goal_eipCfgNumSessionsSet parameters

Code Block
languagec
res = goal_eipCfgNumSessionsSet(10);

goal_eipCfgTickSet

Set the number of milliseconds of one tick. The stack uses a tick as the smallest unit of time.

Default Value: 10

goal_eipCfgTickSet parameters

...

Parameter

...

Description

...

uint32_t ticks

...

size of 1 tick in ms

res = goal_eipCfgTickSet(10);

...

Info

This function is deprecated and has no effect. It is kept for compatibility with older versions.

goal_eipCfgO2TRunIdleHeaderOn

Default Value: GOAL_TRUE

Enable the Run/Idle Header for consumed (Originator-to-Target) cyclic data.

goal_eipCfgO2TRunIdleHeaderOn parameters

Parameter

Description

GOAL_BOOL_T enable

enable or disable feature

Table: goal_eipCfgO2TRunIdleHeaderOn parameters

Code Block
languagec
res = goal_eipCfgO2TRunIdleHeaderOn(GOAL_TRUE);

goal_eipCfgT2ORunIdleHeaderOn

Enable the Run/Idle Header for produced (Target-to-Originator) cyclic data.

Default Value: GOAL_FALSE

goal_eipCfgT2ORunIdleHeaderOn parameters

Parameter

Description

GOAL_BOOL_T enable

enable or disable feature

Table: goal_eipCfgT2ORunIdleHeaderOn parameters

Code Block
languagec
res = goal_eipCfgT2ORunIdleHeaderOn(GOAL_FALSE);

goal_eipCfgQoSOn

Enable support of the QoS object.

Default Value: GOAL_TRUE

goal_eipCfgQoSOn parameters

Parameter

Description

GOAL_BOOL_T enable

enable or disable feature

Table: goal_eipCfgQoSOn parameters

Code Block
languagec
res = goal_eipCfgQoSOn(GOAL_TRUE);

goal_eipCfgNumDelayedEncapMsgSet

Set the number of Encapsulation messages that can be delayed at the same time.

Default Value: 2

goal_eipCfgNumDelayedEncapMsgSet parameters

Parameter

Description

uint16_t num

number of messages

Table: goal_eipCfgNumDelayedEncapMsgSet parameters

Code Block
languagec
res = goal__eipCfgNumDelayedEncapMsgSet(2);

goal_eipCfgDhcpOn

Enable the DHCP client if it is supported by the platform.

Default Value: GOAL_FALSEgoal_eipCfgDhcpOn parameters

Parameter

Description

GOAL_BOOL_T enable

enable or disable feature

Table: goal_eipCfgDhcpOn parameters

Code Block
languagec
res = goal_eipCfgDhcpOn(GOAL_TRUE);

goal_eipCfgDlrOn

Enable support of the DLR object. THis This feature requires the DLR stack and support of the hardware.

Default Value: GOAL_FALSE

Parameter

Description

GOAL_BOOL_T enable

enable or disable feature

Table: goal_eipCfgDlrOn parameters

Code Block
languagec
res = goal_eipCfgDlrOn(GOAL_TRUE);

goal_eipCfgAcdOn

Enable support for Address Conflict Detection (ACD).

Default Value: GOAL_FALSE

Parameter

Description

GOAL_BOOL_T enable

enable or disable feature

Table: goal_eipCfgAcdOn

Code Block
languagec
res = goal_

...

eipCfgAcdOn(GOAL_TRUE);

goal_eipCfgAcdConflictFallbackIp

Configure Fallback IP Configuration, if Address Conflict Detection (ACD) detects an address conflict. The device will apply the configured IP, if it’s configured as device with static IP. If attribute 3 of the TCP/IP Class is set to DHCP, the device will start the DHCP process after a fixed timeout.

  • Transit into error state and do nothing: pass ipAddress, subnetMask and gateway = 0,

  • Set fallback IP configuration: pass valid IP configuration.

Parameter

Description

uint32_t ipAddress

fallback IP address

uint32_t subnetMask

fallback subnet mask

uint32_t gateway

fallback gateway address

Table: goal_eipCfgAcdConflictBehavior

Code Block
languagec
uint32_t ipAddress = GOAL_NET_IPV4(192, 168, 0, 100);
uint32_t subnetMask = GOAL_NET_IPV4(255, 255, 255, 0);
uint32_t gateway = GOAL_NET_IPV4(192, 168, 0, 1);

res = goal_eipCfgAcdConflictFallbackIp(ipAddress, subnetMask, gateway);