WagoLibConfigETH.lib CODESYS Library for Device Configuration of ETHERNET Fieldbus Controller. WAGO Software. Library Description. Version 1.0.

(1)

Pos: 2 /Dokumentation allgemein/Einband/Einband Handbuch - Frontseite 2015 - mit DocVariablen und Standardbild für Bibliotheksbeschreibungen @ 15\mod_1370330374073_0.docx @ 121630 @ @ 1

WAGO Software

Library Description

WagoLibConfigETH.lib

CODESYS Library

for Device Configuration of ETHERNET

Fieldbus Controller

(2)

2 WAGO Software WagoLibConfigETH.lib CODESYS Library

Library Description Version 1.0.0

WAGO Kontakttechnik GmbH & Co. KG

Hansastraße 27 D-32423 Minden Phone: +49 (0) 571/8 87 – 0 Fax: +49 (0) 571/8 87 – 1 69 E-Mail: [email protected] Web: http://www.wago.com Technical Support Phone: +49 (0) 571/8 87 – 5 55 Fax: +49 (0) 571/8 87 – 85 55 E-Mail: [email protected]

Every conceivable measure has been taken to ensure the accuracy and completeness of this documentation. However, as errors can never be fully excluded, we always appreciate any information or suggestions for improving the documentation.

E-Mail: [email protected]

We wish to point out that the software and hardware terms as well as the trademarks of companies used and/or mentioned in the present manual are generally protected by trademark or patent.

(3)

WAGO Software Table of Contents 3 WagoLibConfigETH.lib CODESYS Library

Pos : 5 /D okument ati on allgemein/Verzeic hnisse/I nhalts verz eichnis - Ü berschrif t oG und Verzei chnis @ 3\ mod_1219151230875_21. doc x @ 21063 @ @ 1

2.3.6 0006: MAC_Adr2 setting ... 14 2.3.7 0007: MAC_Adr3 setting ... 14 2.3.8 0008: MAC_Adr4 setting ... 14 2.3.9 0009: MAC_Adr5 setting ... 14 2.3.10 0010: Multicast_Enabled setting ... 14 2.3.11 0011: Multicast_Adr1 setting ... 14 2.3.12 0012: Multicast_Adr2 setting ... 15 2.3.13 0013: Multicast_Adr3 setting ... 15 2.3.14 0014: Multicast_Adr4 setting ... 15 2.3.15 0015: Multicast_Adr5 setting ... 15

2.3.16 0016: TCP/UDP ports configuration ... 16

2.3.17 0017: Get/Set IP address for specified ethernet connector ... 17

2.3.18 0018: Get/Set netmask for specified port ... 17

2.3.19 0019: Get/Set default dip switch ip (first 3 octets only) for specified port ... 18

2.3.20 0020: Get/Set gateway IP address ... 18

2.3.21 0021: Get/Set host name (max. 31 characters) ... 19

2.3.22 0022: Get/Set domain name (max. 31 characters) ... 19

2.3.23 0023: Get/Set DNS server IP address for specified entry (max. 2) .... 20

2.3.24 0024: Get/Set SNTP server IP address ... 20

2.3.25 0025: Get/Set SNTP update time interval ... 21

2.3.26 0026: Use non-adaptive bus speed ... 21

List of Tables ... 22

(4)

4 Notes about this Documentation WAGO Software WagoLibConfigETH.lib CODESYS Library

Pos : 7 / Alle Serien (Allgemeine M odul e)/Übersc hrift en für all e Serien/Hi nweis e zur D okument ati on/Hinweise z u dies er D okument ation - Ü berschrif t 1 @ 4\ mod_1237987661750_21. doc x @ 29029 @ 1 @ 1

1 Notes about this Documentation

Pos : 8. 1 / Alle Serien (Allgemeine M odule) /Hinweise z ur Dokumentation/Urhebersc hutz ausf ührlic h @ 4\ mod_1235565145234_21. doc x @ 27691 @ 2 @ 1

1.1 Copyright

This Manual, including all figures and illustrations, is copyright-protected. Any further use of this Manual by third parties that violate pertinent copyright

provisions is prohibited. Reproduction, translation, electronic and phototechnical filing/archiving (e.g., photocopying) as well as any amendments require the written consent of WAGO Kontakttechnik GmbH & Co. KG, Minden, Germany. Non-observance will involve the right to assert damage claims.

(5)

WAGO Software Notes about this Documentation 5 WagoLibConfigETH.lib CODESYS Library

Pos : 8. 3 / Alle Serien (Allgemeine M odule) /Übersc hriften für alle Serien/Hi nweis e z ur D okument ati on/Symbole - Ü berschrif t 2 @ 13\ mod_1351068042408_21.doc x @ 105270 @ 2 @ 1

1.2 Symbols

Pos : 8. 4. 1 / Alle Serien (Allgemeine M odule) /Wic htige Erl äuter ung en/ Sic her hei ts- und s onstige Hi nweise/ G ef ahr/ Gefahr: _Warnung vor Pers onensc häden allgemein_ - Erläut erung @ 13\ mod_1343309450020_21. doc x @ 101029 @ @ 1

Personal Injury!

Indicates a high-risk, imminently hazardous situation which, if not avoided, will result in death or serious injury.

Pos : 8. 4. 2 / Alle Serien (Allgemeine M odule) /Wic htige Erl äuter ung en/ Sic her hei ts- und s onstige Hi nweise/ G ef ahr/ Gefahr: _Warnung vor Pers onensc häden durch el ektrisc hen Str om_ - Erl äuter ung @ 13\mod_1343309694914_21.doc x @ 101030 @ @ 1

Personal Injury Caused by Electric Current!

Indicates a high-risk, imminently hazardous situation which, if not avoided, will result in death or serious injury.

Pos : 8. 4. 3 / Alle Serien (Allgemeine M odule) /Wic htige Erl äuter ung en/ Sic her hei ts- und s onstige Hi nweise/ Warnung/War nung: _War nung vor Personenschäden allgemei n_ - Erl äuter ung @ 13\ mod_1343309877041_21. doc x @ 101035 @ @ 1

Indicates a moderate-risk, potentially hazardous situation which, if not avoided, could result in death or serious injury.

Pos : 8. 4. 4 / Alle Serien (Allgemeine M odule) /Wic htige Erl äuter ung en/ Sic her hei ts- und s onstige Hi nweise/ Vorsicht/Vorsic ht: _Warnung vor Pers onensc häden allgemein_ - Erläut erung @ 13\ mod_1343310028762_21.doc x @ 101038 @ @ 1

Indicates a low-risk, potentially hazardous situation which, if not avoided, may result in minor or moderate injury.

Pos : 8. 4. 5 / Alle Serien (Allgemeine M odule) /Wic htige Erl äuter ung en/ Sic her hei ts- und s onstige Hi nweise/ Ac ht ung/ Ac ht ung: _Warnung vor Sachs chäden allgemei n_ - Erl äuter ung @ 13\mod_1343310134623_21. doc x @ 101041 @ @ 1

Damage to Property!

Indicates a potentially hazardous situation which, if not avoided, may result in damage to property.

Pos : 8. 4. 6 / Alle Serien (Allgemeine M odule) /Wic htige Erl äuter ung en/ Sic her hei ts- und s onstige Hi nweise/ Ac ht ung/ Ac ht ung: _Warnung vor Sachs chäden durc h elektros tatisc he Aufladung _ - Erläuter ung @ 13\ mod_1343310227702_21. doc x @ 101044 @ @ 1

Damage to Property Caused by Electrostatic Discharge (ESD)!

Indicates a potentially hazardous situation which, if not avoided, may result in damage to property.

Pos : 8. 4. 7 / Alle Serien (Allgemeine M odule) /Wic htige Erl äuter ung en/ Sic her hei ts- und s onstige Hi nweise/ Hinweis/Hinweis: _Wic htiger Hi nweis allgemei n_ - Erläut erung @ 13\ mod_1343310326906_21.doc x @ 101047 @ @ 1

Important Note!

Indicates a potential malfunction which, if not avoided, however, will not result in damage to property.

(6)

6 Notes about this Documentation WAGO Software WagoLibConfigETH.lib CODESYS Library

Additional Information:

Refers to additional information which is not an integral part of this documentation (e.g., the Internet).

(7)

WAGO Software Notes about this Documentation 7 WagoLibConfigETH.lib CODESYS Library

Pos : 8. 6 / Alle Serien (Allgemeine M odule) /Hinweise z ur Dokumentation/Z ahl ens yst eme @ 3\mod_1221059454015_21.doc x @ 21711 @ 2 @ 1

1.3 Number Notation

Table 1: Number Notation

Number Code Example Note

Decimal 100 Normal notation

Hexadecimal 0x64 C notation

Binary '100'

'0110.0100'

In quotation marks, nibble separated with dots (.)

Pos : 8. 7 / Alle Serien (Allgemeine M odule) /Hinweise z ur Dokumentation/ Schrif t konventionen @ 3\ mod_1221059521437_21.doc x @ 21714 @ 2 @ 1

1.4 Font Conventions

Table 2: Font Conventions

Font Type Indicates

italic Names of paths and data files are marked in italic-type.

e.g.: C:\Program Files\WAGO Software

Menu Menu items are marked in bold letters.

e.g.: Save

> A greater-than sign between two names means the selection of a

menu item from a menu. e.g.: File > New

Input Designation of input or optional fields are marked in bold letters,

e.g.: Start of measurement range

“Value” Input or selective values are marked in inverted commas.

e.g.: Enter the value “4 mA” under Start of measurement range.

[Button] Pushbuttons in dialog boxes are marked with bold letters in square

brackets. e.g.: [Input]

[Key] Keys are marked with bold letters in square brackets.

e.g.: [F5]

(8)

8 WagoLibConfigETH_01.lib WAGO Software WagoLibConfigETH.lib CODESYS Library

Pos : 10 /Serie 759 ( WAGO-Sof t war e)/ WAGO-I /O-PR O / COD ESYS 2 2 2/Bi bliot heken/WagoLibC onfigETH _01.li b @ 21\ mod_1415193574812_21.doc x @ 167208 @ 1222333333333333333333333333333 @ 1

2 WagoLibConfigETH_01.lib

The library WagoLibConfigETH_01.lib library provides function blocks for accessing the device configuration (e.g., network settings, data and time, ongoing services) of the fieldbus controllers ETHERNET.

(9)

WAGO Software WagoLibConfigETH_01.lib 9 WagoLibConfigETH.lib CODESYS Library

2.1 GetSetConfig

You can use the “GetSetConfig“ function block to configure and parameterize the fieldbus controllers, such as with the WBM or the CBM.

Category Configuration

Name GetSetConfig

Type Function block

Name of library WagoLibConfigETH_01.lib

Required libraries ---

Applicable to 750-88x/xxx-xxx, 750-852

Input parameter

Name Data type Description

EN BOOL The function block starts

processing when the input registers an ascending edge.

SET BOOL 1: modify settings

0: read settings

SAVETOEEPROM: BOOL 1: store in EEPROM

permanently

0: don't store, setting will be lost after reboot FuncCode WORD 1 … 26 InputSize BYTE InBuffer ARRAY[0..255] OF BYTE Output parameter

Name Data type Description

ENO BOOL Indicates whether the function

block has been executed fully.

ErrCode INT

OutputSize BYTE

OutBuffer ARRAY[0..255] OF

(10)

Graphical illustration

Description

- Set other required input parameters if applicable. - Set “EN” to ‘1’ (“ENO” should be ‘0’).

- Execute “GetSetConfig();”.

- As soon as “ENO” goes to ‘1’, command execution has finished. - Check error code “ErrCode”.

- Process output length “OutputSize” and array “OutBuffer”. - Set “EN” to ‘0’, “ENO” should also go to ‘0’ at the same time. Error codes:

0x0000 Command successfully executed, response data valid

0xFFFF Command execution failed

0xFFFE Unknown function code

0xFFFD Wrong input length parameter

0xFFFC Illegal IP range (e.g. Multicast IP addresses must be in the range from

224.0.0.1 to 239.255.255.255)

0xFFFB Value out of valid range (e.g. timezone < -12 or > 14)

0xFFFA Saving to eeprom failed

0xFFF9 Port unsupported

(11)

2.2 FuncCode

With the function code "FuncCode", you select the function to be executed in the next call of the function block "GetSetConfig".

Category Configuration

Name FuncCode

Type Data type Enumeration

Name of library WagoLibConfigETH_01.lib

Applicable to 750-88x/xxx-xxx, 750-852

Structure Enumeration

Element Value Description

WLC_DSTFLAG 1 Daylight_Savings_Enabled setting

WLC_TIMEZONE 2 Timezone setting

WLC_MAC_ENABLED 3 MAC_Filter_Enabled setting

WLC_750_ALLOWED 4 WAGO_750-767_Allowed setting

WLC_MAC1 5 MAC_Adr1 filter setting

WLC_MULTICAST_ENABLED 10 Multicast_Enabled setting

WLC_MULTICAST1 11 Multicast_Adr1 setting

WLC_PORTS 16 TCP/UDP ports configuration

WLC_IPADDRESS 17 Get/Set IP address for specified

ethernet connector

WLC_NETMASK 18 Get/Set netmask for specified port

WLC_DEFAULTDIPSWITCHIP 19 Get/Set default dip switch ip (first 3

octets only) for specified port

WLC_GATEWAY 20 Get/Set gateway IP address

WLC_HOSTNAME 21 Set host name (max. 31 characters)

WLC_DOMAINNAME 22 Set domain name (max. 31

characters)

WLC_DNS 23 Set DNS server IP address for

specified entry (max. 2)

WLC_SNTP_SERVER 24 Set SNTP server IP address

WLC_SNTP_UPDATETIME 25 Set SNTP update time interval

WLC_STATIC_KBUS_SPEED 26 Use non-adaptive bus speed

(12)

Description

2.3 Description of the Function codes

The Function codes are decimal.

2.3.1 0001: Daylight_Savings_Enabled setting

Description

OutputSize (bytes) when reading: 1

InputSize when setting: 1 or 2 (if optional input values are used) Input/Output values:

read from OutBuffer[0] or set in InBuffer[0]:

1: Daylight savings time active

0: daylight savings time not active

Optional input-only values (InputSize = 2): set in InBuffer[1]:

1: perform an immediate SNTP request 0: do not perform an immediate SNTP request Possible error codes:

- WLC_SUCCESS

- WLC_WRONG_INPUT_LENGTH

- WLC_SAVINGFAILED

2.3.2 0002: Timezone setting

Description

OutputSize (bytes) when reading: 2 InputSize when setting: 3

Input/Output values:

read from OutBuffer[0] to [1]) or set in InBuffer[0] to [1]: INT: Time difference from GMT in hours (+14/-12) Input-only values:

set in InBuffer[2]:

1: perform an immediate SNTP request 0: do not perform an immediate SNTP request Possible error codes:

- WLC_SUCCESS

- WLC_VALUE_OUT_OF_RANGE

(13)

2.3.3 0003: MAC_Filter_Enabled setting

Description

Output values (read from OutBuffer[0]), input values (set in InBuffer[0]): 0: MAC filter not active

1: MAC filter active Possible error codes:

- WLC_SUCCESS

- WLC_SAVINGFAILED

2.3.4 0004: WAGO_750-767_Allowed setting

Allowed setting for WAGO devices of series WAGO-I/O-SYSTEM 750 … WAGO-I/O-SYSTEM 767.

Description

Output values (read from OutBuffer[0]), input values (set in InBuffer[0]): 0: don't allow Wago 750/767 devices without having an entry in the address

table

1: always allow access from Wago 750/767 devices Possible error codes:

- WLC_SUCCESS

- WLC_SAVINGFAILED

2.3.5 0005: MAC_Adr1 filter setting

This also applies for the function codes 0006-0009.

Description

Output values (read from OutBuffer[0] to [5]), input values (set in InBuffer[0] to [5]):

MAC address entry with MSB in [0], LSB in [5] Possible error codes:

- WLC_SUCCESS

(14)

2.3.6 0006: MAC_Adr2 setting

See „0005: MAC_Adr2 setting“.

2.3.7 0007: MAC_Adr3 setting

2.3.8 0008: MAC_Adr4 setting

2.3.9 0009: MAC_Adr5 setting

2.3.10 0010: Multicast_Enabled setting

Description

Output values (read from OutBuffer[0]), input values (set in InBuffer[0]): 0: Modbus UDP multicast addresses are not enabled

1: Modbus UDP multicast addresses enabled Possible error codes:

- WLC_SUCCESS

- WLC_SAVINGFAILED

2.3.11 0011: Multicast_Adr1 setting

This also applies for the function codes 0012-0015.

Description

Multicast IP address with MSB in [0], LSB in [3] Possible error codes:

- WLC_SUCCESS

- WLC_SAVINGFAILED

(15)

2.3.12 0012: Multicast_Adr2 setting

See „0011: Multicast_Adr1 setting“.

2.3.13 0013: Multicast_Adr3 setting

2.3.14 0014: Multicast_Adr4 setting

2.3.15 0015: Multicast_Adr5 setting

(16)

2.3.16 0016: TCP/UDP ports configuration

Description

1) Reading current configuration - .SET = 0

- InputSize: 1

- InBuffer[0]: Ethernet port for which the setting is retrieved

- OutBuffer[0]: Ethernet port for which the setting is valid 0: Ethernet port 1

1: Ethernet port 2 (available only on certain devices) - OutputSize (bytes): 3

- OutBuffer[1]: MSB of the 16 bit configuration value - OutBuffer[2]: LSB of the 16 bit configuration value 2) Setting a new configuration

- .SET = 1

- InputSize: 3

- InBuffer[0]: Ethernet port for which the setting is valid

0: Ethernet port 1

1: Ethernet port 2 (available only on certain devices)

- InBuffer[1]: MSB of the 16 bit configuration value

- InBuffer[2]: LSB of the 16 bit configuration value

Returns or takes a WORD denoting the bits enabled on the selected ethernet port The bit positions are as follows:

Bit 0: FTP server

Bit 1: HTTP server

Bit 2: SNMP

Bit 3: (S)NTP

Bit 4: Modbus TCP

Bit 5: Modbus UDP

Bit 6: Ethernet/IP

Bit 7: - RESERVED, DO NOT MODIFY

Bit 8: Use DHCP for IP address acquisition

Bit 9: Use BOOTP for IP address acquisition

If both bit 8 and 9 are set to 0, the controller will be configured for static IP usage. In that case you must also set the IP address using function code 17.

Bit 10: WAGO service tools (port 6626)

Bit 12: Enable web authentication

Bit 13: IO Pro communications port (CoDeSys)

Bit 15: HTTPS

Possible error codes:

- WLC_SUCCESS

- WLC_SAVINGFAILED

(17)

2.3.17 0017: Get/Set IP address for specified ethernet connector

Description

1) Reading current configuration -.SET = 0

- InputSize = 1

- InBuffer[0]: ethernet port number (binary 0 or 1 [where supported by the controller])

- The command will set OutputSize to 4

- OutBuffer[0] to [3]: current IP address setting for specified ethernet port 2) Setting new configuration

- .SET = 1 - InputSize = 5

- InBuffer[0]: ethernet port number

- InBuffer[1] to [4]: new IP address setting for specified ethernet port with MSB in [1] and LSB in [4]

- WLC_SUCCESS

- WLC_SAVINGFAILED

2.3.18 0018: Get/Set netmask for specified port

Description

- InputSize = 1

- InBuffer[0]: ethernet port number - The command will set OutputSize to 4

- OutBuffer[0] to [3]: current netmask setting for specified ethernet port 2) Setting new configuration

-.SET = 1 - InputSize = 5

- InBuffer[1] to [4]: new netmask setting for specified ethernet port with MSB in [1] and LSB in [4]

- WLC_SUCCESS

(18)

2.3.19 0019: Get/Set default dip switch ip (first 3 octets only) for

specified port

Description

- InputSize = 1

- OutBuffer[0] to [3]: current dipswitch IP address setting for specified ethernet port (e.g. 192.168.2.0)

2) Setting new configuration - .SET = 1

- InputSize = 5

- InBuffer[1] to [4]: new IP address setting for specified ethernet port with MSB in [1] and LSB in [4]

The last byte will be autmatically treated as 0. Possible error codes:

- WLC_SUCCESS

- WLC_SAVINGFAILED

2.3.20 0020: Get/Set gateway IP address

Description

- InputSize = 0

- OutBuffer[0] to [3]: current gateway IP address setting 2) Setting new configuration

InBuffer[1] to [4]: new IP address setting for specified ethernet port with MSB in [1] and LSB in [4]

- WLC_SUCCESS

(19)

2.3.21 0021: Get/Set host name (max. 31 characters)

Description

- InputSize = 0

- The command will set OutputSize to the length of the returned string - OutBuffer[0] to [n-1]: current host name

- InputSize = length of the host name string (n=max. 31 characters) - InBuffer[0] to InBuffer[n-1]: host name string

- WLC_SUCCESS

- WLC_WRONG_INPUT_ LENGTH

if string is longer than 31 characters

- WLC_SAVINGFAILED

2.3.22 0022: Get/Set domain name (max. 31 characters)

Description

- InputSize = 0

- The command will set OutputSize to the length of the returned string - OutBuffer[0] to [n-1]: current domain name

- InputSize = length of the domain name string (n=max. 31 characters) - InBuffer[0] to InBuffer[n-1]: domain name string

- WLC_SUCCESS

if string is longer than 31 characters

(20)

2.3.23 0023: Get/Set DNS server IP address for specified entry

(max. 2)

Description

- InputSize = 1

- InBuffer[0]: DNS server address entry - The command will set OutputSize to 4

- OutBuffer[0] to [3]: current IP address setting for specified DNS server entry

- InputSize = 5

- InBuffer[0]: DNS server entry number

- InBuffer[1] to [4]: new IP address setting for specified DNS server entry with MSB in [1] and LSB in [4]

- WLC_SUCCESS

- WLC_SAVINGFAILED

- WLC_VALUE_OUT_OF_RANGE

2.3.24 0024: Get/Set SNTP server IP address

Description

- InputSize = 1

- InBuffer[0]: server entry number, must be 0 - The command will set OutputSize to 4

- OutBuffer[0] to [3]: current IP address setting 2) Setting new configuration

- InBuffer[0]: server entry number, must be 0

- InBuffer[1] to [4]: new SNTP server IP address setting with MSB in [1] and LSB in [4]

- WLC_SUCCESS

- WLC_SAVINGFAILED

(21)

2.3.25 0025: Get/Set SNTP update time interval

Description

UINT: SNTP update interval in seconds (0-65535) Possible error codes:

- WLC_SUCCESS

- WLC_SAVINGFAILED

2.3.26 0026: Use non-adaptive bus speed

Description

Output values (read from OutBuffer[0]), input values (set in InBuffer[0]): 0: Bus speed is dynamic

1: Bus speed is static Possible error codes:

- WLC_SUCCESS

- WLC_SAVINGFAILED

(22)

22 List of Tables WAGO Software WagoLibConfigETH.lib CODESYS Library

Pos : 12 /D okument ation allgemei n/ Verz eic hniss e/ Tabell enverz eichnis - Übersc hrift oG und Verz eichnis @ 3\ mod_1219222958703_21. doc x @ 21084 @ @ 1

List of Tables

Table 1: Number Notation ... 7 Table 1: Font Conventions ... 7

(23)

WAGO Software 23 WagoLibConfigETH.lib CODESYS Library

(24)

Pos : 14 /D okument ation allgemei n/ Einband/ Einband H andbuc h - R üc kseit e 2015 @ 9\ mod_1285229376516_21. doc x @ 64944 @ @ 1

WAGO Kontakttechnik GmbH & Co. KG Postfach 2880 • D-32385 Minden Hansastraße 27 • D-32423 Minden Phone: 05 71/8 87 – 0 Fax: 05 71/8 87 – 1 69 E-Mail: [email protected] Internet: http://www.wago.com

=== Ende der List e f ür T ext mar ke Ei nband_hint en ===