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

Transcription

1 Pos : 3 /Alle Serien (Allgemeine M odul e)/hinweise z ur Dokumentation/Impres sum für Standardhandbüc her - allg. Angaben, Ansc hriften, Tel efonnummer n und -Adres @ 1 Pos: Library 2 /Dokumentation allgemein/einband/einband Handbuch - Dec kbl att mit Standardbild für Bibli @ 1 Description WAGO Software CODESYS Library WagoLibDiagnosticIDs.lib for accessing the internal diagnostics protocol

2 === Ende der Liste für T extmar ke Ei nband_vorne === 2 WAGO Software 2014 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 WagoLibDiagnosticIDs.lib DIAGNOSTIC_SEND_ID DIAGNOSTIC_SET_TEXT_FOR_ID List of Tables... 12

4 Pos : 8.2 /D okumentati on allgemein/gliederungsel emente/---seitenwec 3\mod_ _0.doc Notes about this Documentation WAGO Software Pos : 7 /Alle Serien (Allgemeine M odul e)/übersc hriften für all e Serien/Hi nweis z ur Dokumentation/Hinweis e z ur D okumentation - Ü bersc hrift 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 ektrischen Strom_ - 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 zur Dokumentation/Symbole - Übersc hrift 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 @ 1 WAGO Software Notes about this Documentation 7 Pos : 8.6 /Alle Serien (Allgemeine Module)/Hinweise zur 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 M odule) /Hinweise z ur 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 Pos : 10 /Serie 759 ( WAGO-Softwar e)/wago-i/o-pr O / COD ESYS/Bi bliotheken/wagoli bdiagnostic IDs.li WagoLibDiagnosticIDs.lib This library is used to take part in an internal diagnostics protocol via an IEC 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 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 xx 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 Name Data type Description DIAGNOSTIC_SEND_ BOOL ID, with parameters, to be ID transmitted Graphical illustration

10 10 WagoLibDiagnosticIDs.lib WAGO Software 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 === Ende der Liste für T extmar ke Inhalt_mitte === WAGO Software WagoLibDiagnosticIDs.lib 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 xx Input parameter Name Data type Description uiid UINT ID to be sent sttext STRING(80) String to be used Output parameter Name Data type Description 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 === Ende der Liste für T extmar ke Verzeic hnis_hi nten === 12 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 2: Font conventions... 7

13 WAGO Software 13

14 Pos : 14 /D okumentation allgemei n/einband/einband H andbuc h - R üc @ 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: +49/5 71/ Fax: +49/5 71/ info@wago.com Internet: