Beckhoff TE1000 TwinCAT 3 EventLogger Manual PDF (EN)

Table of contents

Table of contents Table of contents 1 Foreword.................................................................................................................................................... 7 1.1 Notes on the documentation ............................................................................................................. 7 1.2 For your safety .................................................................................................................................. 8 1.3 Notes on information security............................................................................................................

9 2 Overview .................................................................................................................................................. 10 3 System requirements.............................................................................................................................. 11 4 Limitations ............................................................................................................................................... 12 5 Technical introduction............................................................................................................................

13 5.1 Event class...................................................................................................................................... 16 5.2 Event ............................................................................................................................................... 19 5.3 Managing events with Excel............................................................................................................ 21 5.4 Code generation of the event definition ..........................................................................................

23 5.5 Internationalization/translations....................................................................................................... 24 5.6 Target system ................................................................................................................................. 26 5.7 Engineering ..................................................................................................................................... 28 5.8 Arguments.......................................................................................................................................

30 5.9 Handling sources ............................................................................................................................ 32 5.10 Internationalization of sources ........................................................................................................ 33 5.11 JSON attributes............................................................................................................................... 34 5.12 Query filter.......................................................................................................................................

35 5.12.1 Return values................................................................................................................... 36 5.13 Remote access to the EventLogger via PLC .................................................................................. 36 5.14 Importing resource files................................................................................................................... 37 6 PLC API ....................................................................................................................................................

38 6.1 Functions and function blocks......................................................................................................... 38 6.1.1 Asynchronous text requests............................................................................................. 38 6.1.2 EventEntry conversion ..................................................................................................... 62 6.1.3 Filter ................................................................................................................................. 65 6.1.4 RemoteEventLogger ........................................................................................................

70 6.1.5 FB_ListenerBase2............................................................................................................ 83 6.1.6 FB_TcAlarm ..................................................................................................................... 88 6.1.7 FB_TcArguments ............................................................................................................. 94 6.1.8 FB_TcEvent ..................................................................................................................... 96 6.1.9 FB_TcEventBase .............................................................................................................

98 6.1.10 FB_TcEventLogger ........................................................................................................ 104 6.1.11 FB_TcMessage.............................................................................................................. 115 6.1.12 FB_TcSourceInfo ........................................................................................................... 119 6.2 Interfaces ...................................................................................................................................... 121 6.2.1 I_TcArguments...............................................................................................................

121 6.2.2 I_TcEventBase............................................................................................................... 131 6.2.3 I_TcMessage.................................................................................................................. 136 6.2.4 I_TcSourceInfo............................................................................................................... 137 6.3 Data types ..................................................................................................................................... 137 TE1000 3 Version: 1.11.5

Стр. 3

Table of contents

Table of contents 6.3.1 TcEventEntry.................................................................................................................. 137 6.3.2 TcEventSeverity............................................................................................................. 138 6.3.3 TcEventConfirmationState ............................................................................................. 138 6.4 Global lists.....................................................................................................................................

139 6.4.1 Global_Constants........................................................................................................... 139 6.4.2 GVL................................................................................................................................ 139 6.4.3 Parameter list................................................................................................................. 139 6.4.4 Global_Version...............................................................................................................

140 7 C++ API .................................................................................................................................................. 141 7.1 Interfaces ...................................................................................................................................... 141 7.1.1 ITcEvent......................................................................................................................... 141 7.1.2 ITcMessage....................................................................................................................

144 7.1.3 ITcAlarm......................................................................................................................... 145 7.1.4 ITcEventLogger.............................................................................................................. 148 7.2 Data types ..................................................................................................................................... 155 7.2.1 TcEventEntry.................................................................................................................. 155 7.2.2 TcEventSeverity.............................................................................................................

156 7.2.3 TcEventConfirmationState ............................................................................................. 156 8 User mode API....................................................................................................................................... 157 8.1 Classes ......................................................................................................................................... 157 8.1.1 TcEventLogger...............................................................................................................

157 8.1.2 TcArguments.................................................................................................................. 162 8.1.3 TcSourceInfo.................................................................................................................. 164 8.2 Interfaces ...................................................................................................................................... 166 8.2.1 _ITcEventLoggerEvents................................................................................................. 166 8.2.2 ITcAlarm3.......................................................................................................................

167 8.2.3 ITcArgumentEntry .......................................................................................................... 173 8.2.4 ITcCauseRemedy .......................................................................................................... 177 8.2.5 ITcDetail......................................................................................................................... 177 8.2.6 ITcEvent......................................................................................................................... 178 8.2.7 ITcEventLogger2............................................................................................................

182 8.2.8 ITcLoggedEvent4........................................................................................................... 184 8.2.9 ITcMessage3.................................................................................................................. 190 8.3 Data types ..................................................................................................................................... 195 8.3.1 ConfirmationStateEnum................................................................................................. 195 8.3.2 EventTypeEnum.............................................................................................................

195 8.3.3 SeverityLevelEnum ........................................................................................................ 196 8.3.4 TcEventArgumentTypeEnum......................................................................................... 196 8.3.5 TcSourceInfoTypeEnum ................................................................................................ 196 9 Example ................................................................................................................................................. 198 9.1 PLC ...............................................................................................................................................

198 9.1.1 Tutorial ........................................................................................................................... 198 9.1.2 Example ResultMessage ............................................................................................... 201 9.1.3 Example Listener ........................................................................................................... 201 9.1.4 Example filter ................................................................................................................. 202 TE1000 4 Version: 1.11.5

Стр. 4

Table of contents

Table of contents 9.1.5 Sample Resource Import ............................................................................................... 202 9.2 C++ ............................................................................................................................................... 203 9.2.1 Tutorial ........................................................................................................................... 203 9.2.2 Example: Start-Stop.......................................................................................................

208 9.3 User mode API.............................................................................................................................. 209 9.2.3 Example Listener ........................................................................................................... 208 10 Appendix................................................................................................................................................ 210 10.1 Third-party components ................................................................................................................

210 10.2 ADS Return Codes........................................................................................................................ 210 TE1000 5 Version: 1.11.5

Стр. 5

Table of contents

Table of contents TE1000 6 Version: 1.11.5

Стр. 6