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

Transcription

1 Pos: 2 /Dokumentation allgemein/einband/einband Handbuch - Frontseite mit DocVariablen und Standardbild für @ 1 Pos: 3 /Alle Serien (Allgemeine Module)/Hinweise zur Dokumentation/Impressum für Standardhandbücher - allg. Angaben, Anschriften, Telefonnummern und @ 1 WAGO Software WagoLibConfigETH.lib CODESYS Library for Device Configuration of ETHERNET Fieldbus Controller

2 === Ende der Liste für T extmar ke Ei nband_vorne === 2 WAGO Software 2015 by WAGO Kontakttechnik GmbH & Co. KG All rights reserved. WAGO Kontakttechnik GmbH & Co. KG Hansastraße 27 D Minden Phone: +49 (0) 571/ Fax: +49 (0) 571/ Web: info@wago.com Technical Support Phone: +49 (0) 571/ Fax: +49 (0) 571/ support@wago.com 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. documentation@wago.com 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 === Ende der Liste für T extmar ke Verzeic hnis_vor ne === WAGO Software Table of Contents 3 Pos : 5 /D okumentati on allgemein/verzeic hnisse/inhalts verz eichnis - Ü berschrift og und Verzei @ 1 Table of Contents 1 Notes about this Documentation Copyright Symbols Number Notation Font Conventions WagoLibConfigETH_01.lib GetSetConfig FuncCode of the Function codes : Daylight_Savings_Enabled setting : Timezone setting : MAC_Filter_Enabled setting : WAGO_ _Allowed setting : MAC_Adr1 filter setting : MAC_Adr2 setting : MAC_Adr3 setting : MAC_Adr4 setting : MAC_Adr5 setting : Multicast_Enabled setting : Multicast_Adr1 setting : Multicast_Adr2 setting : Multicast_Adr3 setting : Multicast_Adr4 setting : Multicast_Adr5 setting : TCP/UDP ports configuration : Get/Set IP address for specified ethernet connector : Get/Set netmask for specified port : Get/Set default dip switch ip (first 3 octets only) for specified port : Get/Set gateway IP address : Get/Set host name (max. 31 characters) : Get/Set domain name (max. 31 characters) : Get/Set DNS server IP address for specified entry (max. 2) : Get/Set SNTP server IP address : Get/Set SNTP update time interval : Use non-adaptive bus speed List of Tables... 22

4 Pos : 8.2 /D okumentati on allgemein/gliederungsel emente/---seitenwec @ 1 4 Notes about this Documentation WAGO Software Pos : 7 /Alle Serien (Allgemeine M odul e)/übersc hriften für all e Serien/Hi nweis e zur D okumentati on/hinweise z u dies er D okumentation - Ü berschrift Notes about this Documentation Pos : 8.1 /Alle Serien (Allgemeine M odule) /Hinweise z ur Dokumentation/Urhebersc hutz ausführlic 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 Pos : /Alle Serien (Allgemeine M odule) /Wic htige Erl äuter ung en/sic her hei ts- und s onstige Hi nweise/gefahr/gefahr: _Warnung vor Pers onensc häden allgemein_ - @ 1 Pos : /Alle Serien (Allgemeine M odule) /Wic htige Erl äuter ung en/sic her hei ts- und s onstige Hi nweise/gefahr/gefahr: _Warnung vor Pers onensc häden durch el ektrisc hen Str om_ - Erl äuter @ 1 Pos : /Alle Serien (Allgemeine M odule) /Wic htige Erl äuter ung en/sic her hei ts- und sonstige Hinweise/Warnung/Warnung: _Warnung vor Personenschäden allgemein_ - Erl äuter @ 1 Pos : /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_ - @ 1 Pos : /Alle Serien (Allgemeine M odule) /Wic htige Erl äuter ung en/sic her hei ts- und s onstige Hi nweise/ac htung/ac htung: _Warnung vor Sachs chäden allgemei n_ - Erl äuter @ 1 Pos : /Alle Serien (Allgemeine M odule) /Wic htige Erl äuter ung en/sic her hei ts- und s onstige Hi nweise/ac htung/ac htung: _Warnung vor Sachs chäden durc h elektros tatisc he Aufladung _ - Erläuter @ 1 Pos : /Alle Serien (Allgemeine M odule) /Wic htige Erl äuter ung en/sic her hei ts- und sonstige Hi nweise/hinweis/hinweis: _Wichtiger Hi nweis allgemei n_ - @ 1 Pos : /Alle Serien (Allgemeine M odule) /Wic htige Erl äuter ung en/sic her hei ts- und s onstige Hi nweise/infor mati on/infor mati on: _Weitere Infor mati on allgemein_ - @ 1 WAGO Software Notes about this Documentation 5 Pos : 8.3 /Alle Serien (Allgemeine M odule) /Übersc hriften für alle Serien/Hi nweis e z ur D okumentati on/symbole - Ü berschrift Symbols Personal Injury! Indicates a high-risk, imminently hazardous situation which, if not avoided, will result in death or serious injury. Personal Injury Caused by Electric Current! Indicates a high-risk, imminently hazardous situation which, if not avoided, will result in death or serious injury. Personal Injury! Indicates a moderate-risk, potentially hazardous situation which, if not avoided, could result in death or serious injury. Personal Injury! Indicates a low-risk, potentially hazardous situation which, if not avoided, may result in minor or moderate injury. Damage to Property! Indicates a potentially hazardous situation which, if not avoided, may result in damage to property. Damage to Property Caused by Electrostatic Discharge (ESD)! Indicates a potentially hazardous situation which, if not avoided, may result in damage to property. Important Note! Indicates a potential malfunction which, if not avoided, however, will not result in damage to property.

6 Pos : 8.5 /D okumentati on allgemein/gliederungsel emente/---seitenwec @ 1 6 Notes about this Documentation WAGO Software Additional Information: Refers to additional information which is not an integral part of this documentation (e.g., the Internet).

7 Pos: 9 /Dokumentation allgemein/gliederungselemente/---seitenwec 3\mod_ _0.doc WAGO Software Notes about this Documentation 7 Pos : 8.6 /Alle Serien (Allgemeine M odule) /Hinweise z ur Dokumentation/Z ahl ens Number Notation Table 1: Number Notation Number Code Example Note Decimal 100 Normal notation Hexadecimal 0x64 C notation Binary '100' ' ' In quotation marks, nibble separated with dots (.) Pos : 8.7 /Alle Serien (Allgemeine Module)/Hinweise zur 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 Pos : 10 /Serie 759 ( WAGO-Softwar e)/wago-i/o-pr O / COD ESYS 2 2 2/Bi bliotheken/wagolibc onfigeth _01.li 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 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 x/xxx-xxx, Input parameter Name Data type 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 ENO BOOL Indicates whether the function block has been executed fully. ErrCode INT OutputSize BYTE OutBuffer ARRAY[0..255] OF BYTE

10 10 WagoLibConfigETH_01.lib WAGO Software Graphical illustration - 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 to ) 0xFFFB Value out of valid range (e.g. timezone < -12 or > 14) 0xFFFA Saving to eeprom failed 0xFFF9 Port unsupported 0xFFF8 Illegal netmask

11 WAGO Software WagoLibConfigETH_01.lib 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 x/xxx-xxx, Structure Enumeration Element Value 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_ _Allowed setting WLC_MAC1 5 MAC_Adr1 filter setting WLC_MAC2 6 MAC_Adr2 filter setting WLC_MAC3 7 MAC_Adr3 filter setting WLC_MAC4 8 MAC_Adr4 filter setting WLC_MAC5 9 MAC_Adr5 filter setting WLC_MULTICAST_ENABLED 10 Multicast_Enabled setting WLC_MULTICAST1 11 Multicast_Adr1 setting WLC_MULTICAST2 12 Multicast_Adr2 setting WLC_MULTICAST3 13 Multicast_Adr3 setting WLC_MULTICAST4 14 Multicast_Adr4 setting WLC_MULTICAST5 15 Multicast_Adr5 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 Variable declaration

12 12 WagoLibConfigETH_01.lib WAGO Software 2.3 of the Function codes The Function codes are decimal : Daylight_Savings_Enabled setting 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 - WLC_WRONG_INPUT_LENGTH : Timezone setting 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 - WLC_VALUE_OUT_OF_RANGE

13 WAGO Software WagoLibConfigETH_01.lib : MAC_Filter_Enabled setting OutputSize (bytes) when reading: 1 InputSize when setting: 1 Output values (read from OutBuffer[0]), input values (set in InBuffer[0]): 0: MAC filter not active 1: MAC filter active - WLC_WRONG_INPUT_LENGTH : WAGO_ _Allowed setting Allowed setting for WAGO devices of series WAGO-I/O-SYSTEM 750 WAGO-I/O-SYSTEM 767. OutputSize (bytes) when reading: 1 InputSize when setting: 1 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 - WLC_WRONG_INPUT_LENGTH : MAC_Adr1 filter setting This also applies for the function codes OutputSize (bytes) when reading: 6 InputSize when setting: 6 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] - WLC_WRONG_INPUT_LENGTH

14 14 WagoLibConfigETH_01.lib WAGO Software : MAC_Adr2 setting See 0005: MAC_Adr2 setting : MAC_Adr3 setting See 0005: MAC_Adr2 setting : MAC_Adr4 setting See 0005: MAC_Adr2 setting : MAC_Adr5 setting See 0005: MAC_Adr2 setting : Multicast_Enabled setting OutputSize (bytes) when reading: 1 InputSize when setting: 1 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 - WLC_WRONG_INPUT_LENGTH : Multicast_Adr1 setting This also applies for the function codes OutputSize (bytes) when reading: 4 InputSize when setting: 4 Output values (read from OutBuffer[0] to [3]), input values (set in InBuffer[0] to [3]): Multicast IP address with MSB in [0], LSB in [3] - WLC_WRONG_INPUT_LENGTH - WLC_ILLEGAL_IP_RANGE

15 WAGO Software WagoLibConfigETH_01.lib : Multicast_Adr2 setting See 0011: Multicast_Adr1 setting : Multicast_Adr3 setting See 0011: Multicast_Adr1 setting : Multicast_Adr4 setting See 0011: Multicast_Adr1 setting : Multicast_Adr5 setting See 0011: Multicast_Adr1 setting.

16 16 WagoLibConfigETH_01.lib WAGO Software : TCP/UDP ports configuration 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 11: - RESERVED, DO NOT MODIFY Bit 12: Enable web authentication Bit 13: IO Pro communications port (CoDeSys) Bit 14: - RESERVED, DO NOT MODIFY Bit 15: HTTPS - WLC_WRONG_INPUT_LENGTH - WLC_PORT_UNSUPPORTED

17 WAGO Software WagoLibConfigETH_01.lib : Get/Set IP address for specified ethernet connector 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_WRONG_INPUT_LENGTH : Get/Set netmask for specified port 1) Reading current configuration -.SET = 0 - 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[0]: ethernet port number - InBuffer[1] to [4]: new netmask setting for specified ethernet port with MSB in [1] and LSB in [4] - WLC_WRONG_INPUT_LENGTH

18 18 WagoLibConfigETH_01.lib WAGO Software : Get/Set default dip switch ip (first 3 octets only) for specified port 1) Reading current configuration -.SET = 0 - InputSize = 1 - InBuffer[0]: ethernet port number - The command will set OutputSize to 4 - OutBuffer[0] to [3]: current dipswitch IP address setting for specified ethernet port (e.g ) 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] The last byte will be autmatically treated as 0. - WLC_WRONG_INPUT_LENGTH : Get/Set gateway IP address 1) Reading current configuration -.SET = 0 - InputSize = 0 - InBuffer[0]: ethernet port number - The command will set OutputSize to 4 - OutBuffer[0] to [3]: current gateway IP address setting 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_WRONG_INPUT_LENGTH

19 WAGO Software WagoLibConfigETH_01.lib : Get/Set host name (max. 31 characters) 1) Reading current configuration -.SET = 0 - InputSize = 0 - The command will set OutputSize to the length of the returned string - OutBuffer[0] to [n-1]: current host name 2) Setting new configuration -.SET = 1 - InputSize = length of the host name string (n=max. 31 characters) - InBuffer[0] to InBuffer[n-1]: host name string - WLC_WRONG_INPUT_ LENGTH if string is longer than 31 characters : Get/Set domain name (max. 31 characters) 1) Reading current configuration -.SET = 0 - InputSize = 0 - The command will set OutputSize to the length of the returned string - OutBuffer[0] to [n-1]: current domain name 2) Setting new configuration -.SET = 1 - InputSize = length of the domain name string (n=max. 31 characters) - InBuffer[0] to InBuffer[n-1]: domain name string - WLC_WRONG_INPUT_ LENGTH if string is longer than 31 characters

20 20 WagoLibConfigETH_01.lib WAGO Software : Get/Set DNS server IP address for specified entry (max. 2) 1) Reading current configuration -.SET = 0 - 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 2) Setting new configuration -.SET = 1 - 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_WRONG_INPUT_ LENGTH - WLC_VALUE_OUT_OF_RANGE : Get/Set SNTP server IP address 1) Reading current configuration -.SET = 0 - 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 -.SET = 1 - InputSize = 5 - 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_WRONG_INPUT_ LENGTH - WLC_VALUE_OUT_OF_RANGE

21 === Ende der Liste für T extmar ke Inhalt_mitte === WAGO Software WagoLibConfigETH_01.lib : Get/Set SNTP update time interval OutputSize (bytes) when reading: 2 InputSize when setting: 2 Output values (read from OutBuffer[0] to [1]), input values (set in InBuffer[0] to [1]): UINT: SNTP update interval in seconds ( ) - WLC_WRONG_INPUT_ LENGTH : Use non-adaptive bus speed OutputSize (bytes) when reading: 1 InputSize when setting: 1 Output values (read from OutBuffer[0]), input values (set in InBuffer[0]): 0: Bus speed is dynamic 1: Bus speed is static - WLC_WRONG_INPUT_ LENGTH

22 === Ende der Liste für T extmar ke Verzeic hnis_hi nten === 22 List of Tables WAGO Software Pos : 12 /D okumentation allgemei n/verz eic hniss e/tabell enverz eichnis - Übersc hrift og und Verz @ 1 List of Tables Table 1: Number Notation... 7 Table 1: Font Conventions... 7

23 WAGO Software 23

24 Pos : 14 /D okumentation allgemei n/einband/einband H andbuc h - R üc kseite @ 1 === Ende der Liste für T extmar ke Ei nband_hinten === WAGO Kontakttechnik GmbH & Co. KG Postfach 2880 D Minden Hansastraße 27 D Minden Phone: 05 71/ Fax: 05 71/ info@wago.com Internet: