SupervisorState (STRUCT) ¶ TYPE SupervisorState : STRUCT InOut: Name Type Comment nNumOfOperations UDINT Number of registered operations that are supervised/enabled nNumOfFailedOperations UDINT Number of failed operations. 0=All operations alive nNumOfRegisteredOperations UDINT Number of all registered operations
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 20.04.2021, 15:56:21 companyName string 3S-Smart Software Solutions GmbH libraryFile CmpSupervisor.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile CmpSupervisor.clean.json version version 2.0.0.0 ProjectInformation Released bool True LastModificationDateTime date 20.04.2021, 15:56:21 LibraryCategories library-category-list System|SysLibs Author string 3S - Smart Software Solutions GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 Patch 2 Description See: Description DocFormat reStructuredText Placeholder CmpSupervisor Project CmpSupervisor Title CmpSupervisor Version version 3.5.17.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. CmpEventMgr ¶ Library Identification ¶ Placeholder: CmpEventMgr Default Resolution: CmpEventMgr, * (System) Namespace: CmpEventMgr Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpEventMgr 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)
CmpTargetVisu Library Documentation ¶ Company System Title CmpTargetVisu Version 3.5.19.0 Categories System|SysLibs Author 3S-Smart Software Solutions GmbH Placeholder CmpTargetVisu Description 1 ¶ This library provides access to some functionality that is exported by the targetvisualization component Contents: ¶ Constants (GVL) EventIds (GVL) EventParameter EVTPARAM_Application (Struct) TargetVisuCyclic (Function) TargetVisuFindById (Function) TargetVisuNotify (Function) Indices and tables ¶ 1 Based on CmpTargetVisu.library, last modified 02.03.2023, 11:02:30. LibDoc 4.4.0.0-b.27 The content file CmpTargetVisu.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 02.03.2023, 11:02:32.
Constants (GVL) ¶ Attributes: qualified_only InOut: Scope Name Type Initial Comment Constant NOTIFY_TAG_PAINTDATA_AVAILABLE DWORD 1 This tag can be sent to a targetvisualization instance to signal that new information is available that can be drawn from now on. This tag does not use the parameters at the moment.
EventIds (GVL) ¶ InOut: Scope Name Type Initial Comment Constant CMPID_CmpTargetVisu DWORD 16#52 ComponentID to specify for EventOpen EVTPARAMID_CmpTargetVisu_WindowCreated WORD 16#1 IDs for the event parameter structures EVTVERSION_CmpTargetVisu_WindowCreated WORD 16#1 EVTPARAMID_CmpTargetVisu_WindowDestroyed WORD 16#1 EVTVERSION_CmpTargetVisu_WindowDestroyed WORD 16#1 EVTPARAMID_CmpTargetVisu_WindowFirstPaint WORD 16#1 EVTVERSION_CmpTargetVisu_WindowFirstPaint WORD 16#1 EVT_WindowCreated DWORD (SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#3) <category>Events</category> <description>Event is sent when the target visu window is created</description> <param name=”pEventParam” type=”IN”>EVTPARAM_Application</param> EVT_WindowDestroyed DWORD (SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#4) <category>Events</category> <description>Event is sent when the target visu window is destroyed</description> <param name=”pEventParam” type=”IN”>EVTPARAM_Application</param> EVT_WindowFirstPaint DWORD (SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#5) <category>Events</category> <description>Event is sent when the target visu was painted the first time</description> <param name=”pEventParam” type=”IN”>EVTPARAM_Application</param>
EventParameter ¶ EVTPARAM_Application (Struct)
RCVREC_MODE (ENUM) ¶ TYPE RCVREC_MODE : Attributes: qualified_only InOut: Name Initial Comment CHECK 0 If the Field Device interface has received a process data record, only the outputs NEW, SLOT, INDEX and RLEN are set. Multiple calls of this function block with MODE=0 returns the outputs for the same request. RECEIVE 1 If the Field Device interface has received a process data record, the function block outputs are updated and the data record is transferred to the RECORD parameter. RECEIVE_BY_SLOT 2 If the Field Device interface has received a process data record for the slot or subslot the num-bers of which are given in input F_ID, the function block outputs are updated and the data re-cord is transferred to the RECORD parameter. POS_RESPONSE 3 The service is responded positively. NEG_RESPONSE 4 After checking the request to receive a process data record, this function block refuses to accept this record and sends a negative response to the Host Controller. The error reason is given with the inputs CODE1 and CODE2.
SALARM (FB) ¶ FUNCTION_BLOCK SALARM A Field Device can generate alarms to its associated Host Controller to inform it e.g. about certain process events or other events to state there are some limitations of the capabilities of the Field Device for diagnostic reasons. The Host application may use the RALARM function block to receive these alarms. The ID parameter identifies the slot of the Field Device the alarm is generated for. The ATYPE input shall contain the alarm type. The ASPEC input shall contain the alarm specifier. The LEN input contains the length in byte of the additional alarm information stored in the AINFO parameter. The Variable given as AINFO parameter shall be at least of LEN byte. If the alarm is transmitted successfully, the VALID output indicates that the alarm was received by the Host Controller. If an error occurred, the ERROR output indicates an error and the STATUS output contains the error code. Code-Example PROGRAM SendAlarm VAR sender : CommFB.SALARM ; alarmPayload : ARRAY [0..3] OF BYTE := [0, 1, 2, 3] ; // encoding for Profinet: USI (UInt16), ARRAY[0..n] OF BYTE; ID : DWORD := CommFB.Constants.INVALID_ID ; END_VAR ID := CommFB.SUBSLOT_ID ( EN := TRUE , ID := PN_Device.DeviceID , SLOT := 2 , SUBSLOT := 1 ); sender.ID := ID ; sender.ATYPE := ProfinetCommon.AlarmType.PROCESS ; sender.ASPEC := 0 ; // 0 for process-alarm sender.LEN := SIZEOF ( alarmPayload ); sender.AINFO := ADR ( alarmPayload ); sender (); IF ( sender.DONE OR sender.ERROR ) THEN sender ( REQ := FALSE ); END_IF InOut: Scope Name Type Comment Input REQ BOOL The function is invoked when the REQ input is equal to 1. ID DWORD Handle of the slot of the alarm source ATYPE UINT Type of the alarm ASPEC UINT Specifier of the alarm LEN UINT Length of AINFO data in bytes AINFO POINTER TO BYTE Additional alarm information Output DONE BOOL Indicates that the alarm was received by the Host Controller BUSY BOOL FB is busy ERROR BOOL Error detected STATUS DWORD Last detected status
GETIO_PART (FB) ¶ FUNCTION_BLOCK GETIO_PART The GETIO_PART function block gets a subset of the input data associated to a slot or subslot of a Field Device. The input data are addressed within the slot or subslot through OFFSET and LEN parameters. The GETIO_PART function block gets the input data from the Host Controller interface out of the cyclically read input data of the Field Device. The function block is invoked by a 1 of the EN input. If the input data are valid, the ENO output is set to 1, the ERROR output is set to 0, and the input data are stored in the variable given at the INPUTS parameter. The variable passed to the INPUTS parameter shall be of appropriate size to receive the input data. Never use GETIO-/SETIO_PART FBs concurrently with %I/%Q-Input/Output-Mapping for the same slot/subslot ! InOut: Scope Name Type Comment Input EN BOOL Enable ID DWORD Identifier of a slot or subslot of a Field Device OFFSET INT Count of the first byte within the IO data object LEN INT Length of the data to read INPUTS POINTER TO BYTE Requested subset of the input data Output ENO BOOL Flag indication received data OK STATUS DWORD Last detected status ERROR BOOL Flag indication an error