WAGO Software CODESYS Library WagoLibDiagnosticIDs.lib for accessing the internal diagnostics protocol

(1)

Pos : 2 /D okument ati on allgemein/Ei nband/Ei nband H andbuch - Dec kbl at t mit St andardbild für Bibli ot heken @ 15\mod_1370330374073_0. doc x @ 121630 @ @ 1

Library Description

WAGO Software

CODESYS Library

WagoLibDiagnosticIDs.lib

for accessing the internal diagnostics protocol

(2)

2 WAGO Software WagoLibDiagnosticIDs.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 WagoLibDiagnosticIDs.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

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 WagoLibDiagnosticIDs.lib CODESYS Library

Pos : 8. 3 / Alle Serien (Allgemeine M odule) /Übersc hriften für alle Serien/Hi nweis zur Dokumentation/Symbole - Übersc hrift 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 WagoLibDiagnosticIDs.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 WagoLibDiagnosticIDs.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:\Programme\WAGO-I/O-CHECK

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 WagoLibDiagnosticIDs.lib WAGO Software WagoLibDiagnosticIDs.lib CODESYS Library

Pos : 10 /Serie 759 ( WAGO-Sof t war e)/ WAGO-I /O-PR O / COD ESYS/Bi bliotheken/ WagoLi bDiagnostic IDs.li b @ 14\ mod_1358253682277_21.doc x @ 108710 @ 122 @ 1

2 WagoLibDiagnosticIDs.lib

This library is used to take part in an internal diagnostics protocol via an IEC-61131 application.

You can define your own IDs and provide your own texts for this. You can also transmit your own diagnostics IDs.

Diagnostics generated in this manner are saved in the system log and displayed in text form, for example, in the WBM.

(9)

WAGO Software WagoLibDiagnosticIDs.lib 9 WagoLibDiagnosticIDs.lib CODESYS Library

2.1 DIAGNOSTIC_SEND_ID

The DIAGNOSTIC_SEND_ID function is used to transmit diagnostics messages to the system log.

Category System logging

Name DIAGNOSTIC_SEND_ID

Type Function

Name of library WagoLibDiagnosticIDs.lib

Required libraries ---

Applicable to 750-82xx

Input parameter

Name Data type Description

uiID UINT ID to be sent

bSavePersistent BOOL Method of saving

bSet BOOL Setting/Resetting of diagnostics

iParam1 INT Additional parameter

iParam2 INT Additional parameter

Output parameter

DIAGNOSTIC_SEND_ ID

BOOL ID, with parameters, to be

transmitted

(10)

10 WagoLibDiagnosticIDs.lib WAGO Software WagoLibDiagnosticIDs.lib CODESYS Library

Description

Here, the ID to be transmitted is transferred with additional parameters.

bSavePersistent: If TRUE is transferred here, the diagnostics report is saved in the flash memory and can also be called up after a device restart.

If FALSE is transferred, the diagnostics report is saved to the RAM, meaning it will no longer be available in the log after a device restart.

bSet: It may be useful to know whether some diagnostics reports remain available, or are permanently lost. If TRUE is indicated here, the diagnostics reports are marked as being present in the log. If FALSE is indicated, a diagnostics reports that will no longer be available is marked.

iParam1 and iParam2: Here, you can attach additional values as INT values to the diagnostics reports.

(11)

WAGO Software WagoLibDiagnosticIDs.lib 11 WagoLibDiagnosticIDs.lib CODESYS Library

2.2 DIAGNOSTIC_SET_TEXT_FOR_ID

The DIAGNOSTIC_SET_TEXT_FOR_ID function is used to define texts for diagnostics IDs.

Category Diagnostics definition

Name DIAGNOSTIC_SET_TEXT_FOR_ID

Type Function

Name of library WagoLibDiagnosticIDs.lib

Required libraries ---

Applicable to 750-82xx

Input parameter

uiID UINT ID to be sent

stText STRING(80) String to be used

Output parameter

DIAGNOS TIC_SET_ TEXT_FOR _ID UINT Diagnostics ID Graphical illustration Description

The diagnostics reports are saved as IDs in the system log and replaced by the texts defined here when read out.

The additional parameters can be incorporated into the text. To do this, enter "$1" for the first and "$2" for the second parameter.

In CODESYS, "$" is a special character and must therefore be written as "$$", e.g.,

"Malfunction - system down. $$1 parts were not finished!"

This sentence would be displayed in the WBM under "Diagnostics" as follows: "Malfunction - system down. 123 parts were not finished!"

(12)

12 List of Tables WAGO Software WagoLibDiagnosticIDs.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 2: Font conventions ... 7

(13)

WAGO Software 13 WagoLibDiagnosticIDs.lib CODESYS Library

(14)

Pos : 14 /D okument ation allgemei n/ Einband/ Einband H andbuc h - R üc kseit e @ 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: +49/5 71/8 87 – 0 Fax: +49/5 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 ===