IsLibReleased (FUN) ¶ FUNCTION IsLibReleased : BOOL This function has been automatically generated from the project information. InOut: Scope Name Type Return IsLibReleased BOOL
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 16.02.2023, 16:33:30 companyName string 3S-Smart Software Solutions GmbH libraryFile AC_ModuleBase.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile AC_ModuleBase.clean.json version version 2.0.0.0 ProjectInformation Released bool True LastModificationDateTime date 16.02.2023, 16:33:29 LibraryCategories library-category-list Application|Composer Author string 3S - Smart Software Solutions GmbH Company 3S - Smart Software Solutions GmbH CompiledLibraryCompatibilityVersion CODESYS V3.5 SP16 DefaultNamespace AC Description See: Description DocFormat reStructuredText LanguageModelAttribute qualified-access-only Placeholder AC_ModuleBase Project AC_ModuleBase Title AC_ModuleBase Version version 4.2.0.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. AC_Persistence ¶ Library Identification ¶ Placeholder: AC_Persistence Default Resolution: AC_Persistence, * (3S - Smart Software Solutions GmbH) Namespace: AC_PERSIST Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: AC_Persistence Library Parameter ¶ Parameter: C_UIBUFFERSIZE = 16#8000 CAA Behaviour Model ¶ Library Identification ¶ Placeholder: CAA Behaviour Model Default Resolution: CAA Behaviour Model, * (CAA Technical Workgroup) Namespace: CBM Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA Behaviour Model CAA Types Extern ¶ Library Identification ¶ Placeholder: CAA Types Default Resolution: CAA Types Extern, * (CAA Technical Workgroup) Namespace: CAA Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA Types CmpIecTask ¶ Library Identification ¶ Placeholder: CmpIecTask Default Resolution: CmpIecTask, * (System) Namespace: CmpIecTask Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpIecTask CmpLog ¶ Library Identification ¶ Placeholder: CmpLog Default Resolution: CmpLog, * (System) Namespace: CmpLog Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpLog Component Manager ¶ Library Identification ¶ Placeholder: Component Manager Default Resolution: Component Manager, * (System) Namespace: Component_Manager Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Component Manager IoStandard ¶ Library Identification ¶ Placeholder: IoStandard Default Resolution: IoStandard, * (System) Namespace: IoStandard Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: IoStandard Standard ¶ Library Identification ¶ Placeholder: Standard Default Resolution: Standard, * (System) Namespace: Standard Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Standard SysCpuHandling ¶ Library Identification ¶ Placeholder: SysCpuHandling Default Resolution: SysCpuHandling, * (System) Namespace: SysCpuHandling Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysCpuHandling 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) VisuElem3DPath ¶ Library Identification ¶ Placeholder: System_VisuElem3DPath Default Resolution: VisuElem3DPath, 3.5.15.0 (System) Namespace: VisuElem3DPath Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuElem3DPath Library Parameter ¶ Parameter: GC_POINTS_PER_POLYGON = 100 VisuElemCamDisplayer ¶ Library Identification ¶ Placeholder: System_VisuElemCamDisplayer Default Resolution: VisuElemCamDisplayer, 3.5.15.0 (System) Namespace: VisuElemCamDisplayer Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuElemCamDisplayer Library Parameter ¶ Parameter: GC_POINTS_PER_CAM = 100 VisuElemMeter ¶ Library Identification ¶ Placeholder: System_VisuElemMeter Default Resolution: VisuElemMeter, 3.5.15.0 (System) Namespace: VisuElemMeter Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuElemMeter VisuElemTextEditor ¶ Library Identification ¶ Placeholder: System_VisuElemTextEditor Default Resolution: VisuElemTextEditor, 3.5.15.0 (System) Namespace: VisuElemTextEditor Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuElemTextEditor VisuElemTrace ¶ Library Identification ¶ Placeholder: System_VisuElemTrace Default Resolution: VisuElemTrace, 3.5.15.0 (System) Namespace: VisuElemTrace Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuElemTrace VisuElemXYChart ¶ Library Identification ¶ Placeholder: System_VisuElemXYChart Default Resolution: VisuElemXYChart, 3.5.15.0 (System) Namespace: VisuElemXYChart Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuElemXYChart VisuElems ¶ Library Identification ¶ Placeholder: System_VisuElems Default Resolution: VisuElems, 3.5.15.0 (System) Namespace: VisuElems Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuElems VisuElemsAlarm ¶ Library Identification ¶ Placeholder: System_VisuElemsAlarm Default Resolution: VisuElemsAlarm, 3.5.15.0 (System) Namespace: VisuElemsAlarm Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuElemsAlarm VisuElemsDateTime ¶ Library Identification ¶ Placeholder: System_VisuElemsDateTime Default Resolution: VisuElemsDateTime, 3.5.15.0 (System) Namespace: VisuElemsDateTime Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuElemsDateTime VisuElemsSpecialControls ¶ Library Identification ¶ Placeholder: System_VisuElemsSpecialControls Default Resolution: VisuElemsSpecialControls, 3.5.15.0 (System) Namespace: VisuElemsSpecialControls Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuElemsSpecialControls VisuElemsWinControls ¶ Library Identification ¶ Placeholder: System_VisuElemsWinControls Default Resolution: VisuElemsWinControls, 3.5.15.0 (System) Namespace: VisuElemsWinControls Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuElemsWinControls VisuInputs ¶ Library Identification ¶ Placeholder: system_visuinputs Default Resolution: VisuInputs, 3.5.16.30 (System) Namespace: visuinputs Library Properties ¶ LinkAllContent: False Optional: False PublishSymbolsInContainer: True QualifiedOnly: False SystemLibrary: True Key: system_visuinputs VisuNativeControl ¶ Library Identification ¶ Placeholder: System_VisuNativeControl Default Resolution: VisuNativeControl, 3.5.15.0 (System) Namespace: VisuNativeControl Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuNativeControl
AC_Persistence Library Documentation ¶ Company 3S - Smart Software Solutions GmbH Title AC_Persistence Version 4.3.0.0 Categories Application|Composer Namespace AC_PERSIST Author 3S - Smart Software Solutions GmbH Placeholder AC_Persistence Description 1 ¶ Persistence functionality of the Application Composer. Contents: ¶ BufferSize (ParamList) GlobalImagePool (GlobalImagePool) GlobalTextList (GlobalTextList) Library Information GetLibVersion (Function) GetLibVersionNumber (Function) IsLibReleased (Function) PersistenceManager AutomaticActionOnlineChange (Enum) AutomaticActionPlcStop (Enum) CallbackHandle (Struct) Constants (GVL) DataStorage DecoupledBinaryMemoryStorage GetDateTime (Function) HelpFunctions IP_PersistenceManager (ImagePool) IPersistenceChannel (Interface) IPersistenceChannel2 (Interface) IPersistenceChannel3 (Interface) IPersistenceChannel4 (Folder) IPersistenceChannel5 (Folder) IPersistenceManager (Folder) IPersistenceManager2 (Folder) OnlineChangeDetection PersistenceChannel (FunctionBlock) PersistenceChannel (FunctionBlock) PersistenceChannelAction (Enum) PersistenceManager (FunctionBlock) PersistenceManager (FunctionBlock) PersistentInstanceList (Struct) PersistentVarDesc (Struct) TL_PersistenceManager (TextList) Indices and tables ¶ 1 Based on AC_Persistence.library, last modified 08.08.2023, 09:14:51. LibDoc 4.4.0.0-b.27 The content file AC_Persistence.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 08.08.2023, 09:14:51.
RMPMessageBuffer.GetMessageForReceiver (METH) ¶ METHOD FINAL GetMessageForReceiver : UINT Returns position of oldest message treceived for uireceiverID (16#FFFF if no message received) InOut: Scope Name Type Comment Return GetMessageForReceiver UINT Input uiReceiverModuleID UINT The id of the receiver to get the message from the buffer for
RMPMessageBuffer.GetMessageToApplication (METH) ¶ METHOD FINAL GetMessageToApplication : UINT Returns position of oldest message to be transmitted to uiApplicationID (16#FFFF if no message to transmit) InOut: Scope Name Type Comment Return GetMessageToApplication UINT Input uiReceiverAppID UINT The ID of the receiver application to get the message from the buffer for
RMPMessageBuffer.Lock (METH) ¶ METHOD FINAL Lock : BOOL Locks a certain message InOut: Scope Name Type Comment Return Lock BOOL Input uiIndex UINT The index of the message to be locked in the buffer
RMPMessageBuffer.Unlock (METH) ¶ METHOD FINAL Unlock : BOOL Unlocks a certain message InOut: Scope Name Type Comment Return Unlock BOOL Input uiIndex UINT Index of the message to unlock in the buffer
RMPSendMessage (FB) ¶ FUNCTION_BLOCK FINAL RMPSendMessage EXTENDS CBM.ETRIG Function block that can be used to send a message from a module to another module. Use this function block for sending messages. If sending succeded xDone gets TRUE. If an error occurs during sending (i.e. receiving could not be assured) xError gets TRUE. Reset xExecute to FALSE before reusage of the function block by setting xExecute to TRUE. A possible call semantic could be: RMPSendMessage(xExecute := TRUE, itfRmp := pEnv^.rmps, udiReceiverID := udiProxyCom, uiSenderModuleID:= UDINT_TO_UINT(ComAddress AND 16#FFFF), tValidity:=T#1S, mdData := mdData ); This function block needs to be called until xDone is TRUE. If so, sending was successfull. InOut: Scope Name Type Initial Comment Inherited from Input xExecute BOOL Rising edge: Action starts Falling edge: Resets outputs If a falling edge occurs before the function block has completed its action, the outputs operate in the usual manner and are only reset if either the action is completed or in the event of an error. In this case, the corresponding output values ( xDone , xError ) are present at the outputs for exactly one cycle. ETrig Output xDone BOOL TRUE : Action successfully completed ETrig xBusy BOOL TRUE : Function block active ETrig xError BOOL TRUE : Error occurred, function block aborts action FALSE : No error ETrig Inout mdData ARRAY [0..63] OF BYTE The data to send Input itfRmp IRmpService The RMP (Reliable Message Protocoll) sevrice to use for sending. This service can be aquired via the environment available in any module via IModule (see example of the function block description). udiReceiverID UDINT 32-Bit-ID of receiver. This ID normaly is received, when receiving a message from a proxy (via Receive of IRMPService in an RMP (Reliable Message Protocoll) service uiSenderModuleID UINT The (local) 16 bit address of the receiver, which equals the first 16bit of the ComAddress (see AND 16#FFFF) tValidity TIME TIME#1s0ms The time this message is valid when sending it Output uiError UINT If an error occured, the number accounts for one of the following errors: 1: send buffer full; 2: message cannot be transmitted before tValidity (connection broken or remote receive buffer full) 3: receiver application not connected to this app
RMPService (FB) ¶ FUNCTION_BLOCK FINAL RMPService IMPLEMENTS IRmpService3 This function block is unique in an application and gets automatically created and initialized during the generation of the composer for every applicrt of the RMP (Reliable Message Protocoll) communication. InOut: Scope Name Type Initial Comment Input uiLocalAppID UINT Local app ID uiNumberOfConnections UINT Number of connections to other apps pSendConnection POINTER TO RMPConnection Pointer to array of RMPServiceconncetions representing sending connections created by the composer during generation pReceiveConnection POINTER TO RMPConnection Pointer to array of RMPServiceconncetions representing receiving connections created by the composer during generation pRMPComFB POINTER TO IRMPFBCommunication 0 Pointer to array of IRMPFBCommunication representing FBs used for communiction (0 if no communication FBs are used) Properties: LocalAppID Methods: GetComFBForComAddress GetIsActionOngoing SetIsActionOngoing CyclicCall IsMessageSent QueueSendMessage Receive Structure: Cyclic CyclicCall (Method) GetComFBForComAddress (Method) GetIsActionOngoing (Method) LocalAppID (Property) Receive Receive (Method) Send IsMessageSent (Method) QueueSendMessage (Method) SetIsActionOngoing (Method)