File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 20.04.2021, 15:57:27 companyName string 3S-Smart Software Solutions GmbH libraryFile CmpTls_Itfs.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile CmpTls_Itfs.clean.json version version 2.0.0.0 ProjectInformation IsInterfaceLibrary bool True Released True SourceLibrary False LastModificationDateTime date 20.04.2021, 15:57:27 LibraryCategories library-category-list System|SysLibs Author string CODESYS Development GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 DefaultNamespace Description See: Description DocFormat reStructuredText Project CmpTls_Itfs Title CmpTls Interfaces Version version 3.5.17.0

Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. SysTypes2 Interfaces ¶ Library Identification ¶ Name: SysTypes2 Interfaces Version: newest Company: System Namespace: SysTypes Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTypes2 Interfaces, * (System)

CmpTraceMgr Library Documentation ¶ Company System Title CmpTraceMgr Version 3.5.17.0 Categories System|SysLibs Author 3S - Smart Software Solutions GmbH Placeholder CmpTraceMgr Description 1 ¶ This library provides access to the runtime system component CmpTraceMgr. The trace manager handles trace packets, that are defined from: the Trace editor in CoDeSys, a runtime system component, or an IEC program. A trace packet is the container for trace variables, which are called records. A trace packet is is always identified by its name, which must be unique. A trace record contains the trace of a single variable, including the buffer used to store the time-stamped samples. This is a typical sequence of function calls a client of CmpTraceMgr will use: TraceMgrPacketCreate TraceMgrRecordAdd TraceMgrPacketComplete TraceMgrPacketStart TraceMgrPacketStop TraceMgrPacketRestart / TraceMgrPacketStart / TraceMgrPacketDelete Contents: ¶ ComponentId (GVL) EventParameter EVTPARAM_CmpTraceMgr_Packet (Struct) EVTPARAM_CmpTraceMgr_Record (Struct) EventIDs (GVL) GlobalConstants (GVL) Structs AddressArea (Struct) Monitoring2ByteCode (Struct) Monitoring2ByteCodeUnion (Union) MonitoringService (Struct) PropertyLocation (Struct) SymVarAccess (Struct) SystemParameter (Struct) TraceAddress (Union) TracePacketConfiguration (Struct) TraceRecordConfiguration (Struct) TraceRecordEntry (Struct) TraceState (Struct) TraceTrigger (Struct) TraceVarInfo (Union) TraceVariable (Struct) TraceVariableAddress (Struct) TriggerState (Struct) TriggerValue (Union) TypeClass3 (Alias) TRACE_PACKET_FLAGS (GVL) TRACE_PACKET_STATE (GVL) TRACE_RECORD_GRAPH_TYPES (GVL) TRACE_TRIGGER_EDGE (GVL) TRACE_TRIGGER_FLAGS (GVL) TRACE_TRIGGER_STATE (GVL) TRACE_VAR_ADDRESS_FLAGS (GVL) TraceMgrGetConfigFromFile (Function) TraceMgrGetConfigFromFileRelease (Function) TraceMgrPacketCheckTrigger (Function) TraceMgrPacketClose (Function) TraceMgrPacketComplete (Function) TraceMgrPacketCreate (Function) TraceMgrPacketDelete (Function) TraceMgrPacketDisable (Function) TraceMgrPacketDisableTrigger (Function) TraceMgrPacketEnable (Function) TraceMgrPacketEnableTrigger (Function) TraceMgrPacketGetAbsoluteStartTime (Function) TraceMgrPacketGetChangeTimestamp (Function) TraceMgrPacketGetConfig (Function) TraceMgrPacketGetFirst (Function) TraceMgrPacketGetNext (Function) TraceMgrPacketGetStartTime (Function) TraceMgrPacketGetState (Function) TraceMgrPacketOpen (Function) TraceMgrPacketReadBegin (Function) TraceMgrPacketReadEnd (Function) TraceMgrPacketReadFirst (Function) TraceMgrPacketReadFirst2 (Function) TraceMgrPacketReadNext (Function) TraceMgrPacketReadNext2 (Function) TraceMgrPacketResetTrigger (Function) TraceMgrPacketRestart (Function) TraceMgrPacketRestore (Function) TraceMgrPacketStart (Function) TraceMgrPacketStop (Function) TraceMgrPacketStore (Function) TraceMgrRecordAdd (Function) TraceMgrRecordGetConfig (Function) TraceMgrRecordGetFirst (Function) TraceMgrRecordGetNext (Function) TraceMgrRecordRemove (Function) TraceMgrRecordUpdate (Function) TraceMgrRecordUpdate2 (Function) TraceMgrRecordUpdate3 (Function) TraceMgrRecordUpdate4 (Function) TraceMgrRecordUpdate5 (Function) Indices and tables ¶ 1 Based on CmpTraceMgr.library, last modified 20.04.2021, 15:57:46. LibDoc 4.4.0.0-b.27 The content file CmpTraceMgr.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 20.04.2021, 15:57:46.

SupervisorOperationDead (FUN) ¶ FUNCTION SupervisorOperationDead : RTS_IEC_RESULT Signals a desperate situation of an operation in order to prevent the retriggering of the hardware watchdog. After this call, the operation is marked immediate as failed! InOut: Scope Name Type Comment Return SupervisorOperationDead RTS_IEC_RESULT Error code Error code: ERR_OK: Dead state was successfully signalled ERR_NOTINITIALIZED: The operation memory is not initialized ERR_INVALID_HANDLE: The handle to the operation is invalid ERR_PARAMETER: The handle to the operation is invalid ERR_NO_CHANGE: Supervision is disabled for the operation Input hOperation RTS_IEC_HANDLE Handle to the operation

SupervisorOperationDisable (FUN) ¶ FUNCTION SupervisorOperationDisable : RTS_IEC_RESULT Disables supervision for this operation. This operation will never be supervised, until the next SupervisorOperationEnable() call! InOut: Scope Name Type Comment Return SupervisorOperationDisable RTS_IEC_RESULT Error code Error code: ERR_OK: Supervision was successfully disabled ERR_NOTINITIALIZED: The operation memory is not initialized ERR_INVALID_HANDLE: The handle to the operation is invalid ERR_PARAMETER: The handle to the operation is invalid ERR_NO_CHANGE: The operation is already disabled Input hOperation RTS_IEC_HANDLE Handle to the operation

SupervisorOperationEnable (FUN) ¶ FUNCTION SupervisorOperationEnable : RTS_IEC_RESULT Enables supervision for this operation: Sets timestamp to current time and alive flag InOut: Scope Name Type Comment Return SupervisorOperationEnable RTS_IEC_RESULT Error code Error code: ERR_OK: Supervision was successfully enabled ERR_NOTINITIALIZED: The operation memory is not initialized ERR_INVALID_HANDLE: The handle to the operation is invalid ERR_PARAMETER: The handle to the operation is invalid ERR_NO_CHANGE: The operation is already supervised ERR_NOT_SUPPORTED”>SysTimeGetUs is not supported Input hOperation RTS_IEC_HANDLE Handle to the operation

SupervisorOperationGetEntry (FUN) ¶ FUNCTION SupervisorOperationGetEntry : POINTER TO SupervisorEntry Returns the SupervisorEntry of a given operation handle Error code: ERR_OK: The SupervisorEntry was successfully retrieved ERR_INVALID_HANDLE: The handle to the operation is invalid ERR_PARAMETER: The handle to the operation is invalid InOut: Scope Name Type Comment Return SupervisorOperationGetEntry POINTER TO SupervisorEntry Pointer to SupervisorEntry of the given operation handle or NULL in case of an error Input hOperation RTS_IEC_HANDLE Handle to the operation pResult POINTER TO RTS_IEC_RESULT Pointer to error code

SupervisorOperationGetFirst (FUN) ¶ FUNCTION SupervisorOperationGetFirst : RTS_IEC_HANDLE Iteration interface to get the first registered operation Error code: ERR_OK: The first operation was successfully retrieved ERR_NOTINITIALIZED: The operation memory is not initialized ERR_NO_OBJECT: There are no registered operations InOut: Scope Name Type Comment Return SupervisorOperationGetFirst RTS_IEC_HANDLE Handle to the first operation or RTS_INVALID_HANDLE in case of an error Input pResult POINTER TO RTS_IEC_RESULT Pointer to error code

SupervisorOperationGetNext (FUN) ¶ FUNCTION SupervisorOperationGetNext : RTS_IEC_HANDLE Iteration interface to get the next registered operation. Must be started with SupervisorOperationGetFirst() Error code: ERR_OK: The next operation was successfully retrieved ERR_NOTINITIALIZED: The operation memory is not initialized ERR_END_OF_OBJECT: There are no registered operations left InOut: Scope Name Type Comment Return SupervisorOperationGetNext RTS_IEC_HANDLE Handle to the first operation or RTS_INVALID_HANDLE in case of an error Input hPrevOperation RTS_IEC_HANDLE Handle to the previous operation retrieved via SupervisorOperationGetFirst() or subsequent calls of SupervisorOperationGetNext() pResult POINTER TO RTS_IEC_RESULT Pointer to error code

SupervisorOperationGetState2 (FUN) ¶ FUNCTION SupervisorOperationGetState2 : RTS_IEC_RESULT Retrieves the supervisor state for all supervised operations! Here you can check with one call how many operations failed. InOut: Scope Name Type Comment Return SupervisorOperationGetState2 RTS_IEC_RESULT Error code Error code: ERR_OK: The SupervisorState was successfully retrieved ERR_NOTINITIALIZED: The operation memory is not initialized ERR_PARAMETER: The pointer to the SupervisorState is invalid ERR_NOT_SUPPORTED”>SysTimeGetUs is not supported Input pSupervisorState POINTER TO SupervisorState Pointer to the SupervisorState, will be filled with the corresponding information. The caller has to hold the buffer.