Param (PARAMS) ¶ InOut: Scope Name Type Initial Comment Constant TABLE_UPPER_BOUND INT 15 size of table for AnalyzeExpressionTable and AnalyzeExpressionTableEx STRING_LENGTH_EXP INT 255 string length of one entry in table (variable or complex expression) STRING_LENGTH_ADDRESS INT 20 string length for address in table STRING_LENGTH_COMMENT INT 255 string length of comment in table STRING_LENGTH_OUTSTRING INT 255 string length of string output for AnalyzeExpression and AnalyzeExpressionCombined and AnalyzeExpressionCombinedEx TABLE_SHOW_VALID_ITEMS BOOL FALSE if TRUE, also valid items are added to the table, and the failed-entry of the table is filled correspondingly if FALSE, only failed items are added to the table and the failed-entry of the table is always true
POUs ¶ AnalyzeExpression (FunctionBlock) AnalyzeExpressionCombined (FunctionBlock) AnalyzeExpressionTable (FunctionBlock)
AnalyzeExpression (FB) ¶ FUNCTION_BLOCK AnalyzeExpression Function block to analyze a expression of a SFC transion. AnalyzeExpression returns in a string the components of the expression, which are adding to the total value FALSE. InOut: Scope Name Type Comment Input InputExp BOOL Expression to be analysed DoAnalyze BOOL TRUE starts analysis Output ExpResult BOOL Current value of the expression OutString STRING(STRING_LENGTH_OUTSTRING) Result of the analysis, Sequence of the concerned components of the expression (e.g. y < x | d)
AnalyzeExpressionCombined (FB) ¶ FUNCTION_BLOCK AnalyzeExpressionCombined AnalyseExpressionCombined combines the functionalities of AnalyzeExpression plus AnalyseExpressionTable InOut: Scope Name Type Comment Input InputExp BOOL Expression to be analysed DoAnalyze BOOL TRUE starts analysis Output ExpResult BOOL Current value of the expression OutTable ARRAY [0..TABLE_UPPER_BOUND] OF ExpressionResult Result of the analyzation OutString STRING(STRING_LENGTH_OUTSTRING) Result of the analysis, Sequence of the concerned components of the expression (e.g. y < x | d)
AnalyzeExpressionTable (FB) ¶ FUNCTION_BLOCK AnalyzeExpressionTable AnalyseExpressionTable writes the components of the expression, which are adding to the total value FALSE, to an array. For each component the following information is provided by structure ExpressionResult: name, address, comment, (current)value. InOut: Scope Name Type Comment Input InputExp BOOL Expression to be analysed DoAnalyze BOOL TRUE starts analysis Output ExpResult BOOL Current value of the expression OutTable ARRAY [0..TABLE_UPPER_BOUND] OF ExpressionResult Result of the analyzation
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 28.10.2021, 08:36:41 companyName string 3S-Smart Software Solutions GmbH libraryFile Analyzation.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile Analyzation.clean.json version version 2.0.0.0 ProjectInformation Released bool True LastModificationDateTime date 28.10.2021, 08:36:40 LibraryCategories library-category-list Intern|SFC Author string 3S-Smart Software Solutions Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 DefaultNamespace Analyzation Description See: Description DocFormat reStructuredText Placeholder Analyzation Project Analyzation Title Analyzation Version string Version version 4.1.0.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces.
BACnet Library Documentation ¶ Company 3S - Smart Software Solutions GmbH Title BACnet Version 1.7.0.0 Categories Intern|BACnet Namespace BACnet Author 3S - Smart Software Solutions GmbH Placeholder BACnet Description 1 ¶ The BACnet library is the connection between BACnet devices inserted in the device tree, to the CmpBACnet library, which then communicates the BACnet configuration and dynamics to the component on the runtime system. An introduction of BACnet can be found at http://www.bacnet.org . There is a tutorial at http://www.bacnet.org/Tutorial/HMN-Overview/sld001.htm and a tutorial covering BACnet IP http://www.bacnet.org/Tutorial/BACnetIP/index.html . The CODESYS BACnet package includes extensive examples covering lots of practical aspects using CODESYS BACnet in applications. Since this library is intended to be easy usable and is not confined to specialized runtime component functionalities, the BACnet library should be always used instead of directly accessing the runtime component via the CmpBACnet library. CODESYS BACnet library - detailed information ¶ Contents: ¶ BACnetClient BACnetClientAlarmsEvents BACnetClientBase (FunctionBlock) BACnetClientConfirm BACnetClientDeviceManagement BACnetClientFile BACnetClientLifeSafetyOperation BACnetClientProperty IBACnetClient (Interface) BACnetHooksCallbacks IBACnetEventConsumer (Interface) BACnetObjects Accumulator AnalogInput AnalogOutput AnalogValue Averaging BACnetObjectBase (FunctionBlock) BinaryInput BinaryOutput BinaryValue Calendar Command Device EventEnrollment EventLog File Global Group Group IBACnetObjectBase (Interface) IBACnetStaticObjectBase (Interface) IntegerValue LargeAnalogValue LifeSafetyPoint LifeSafetyZone Loop MultistateInput MultistateOutput MultistateValue NotificationClass PositiveIntegerValue Program PulseConverter Schedule StructuredView TrendLog TrendLogMultiple BACnetServer Async BACnetIPdatalink (FunctionBlock) BACnetMSTPdatalink (FunctionBlock) BACnetServer (FunctionBlock) IBACnetServer (Interface) BACnetServerPlugin BACnetServerPluginBase (FunctionBlock) BACnetServerPluginCallbackBase (FunctionBlock) BACnetServerPluginHookBase (FunctionBlock) IBACnetServerPlugin (Interface) IBACnetServerPluginCallback (Interface) IBACnetServerPluginHook (Interface) Constants (GVL) Debug Doc compile options to enable specific logging other compile options Enums BACnetPropertyAttributeExistent (Enum) BACnetPropertyAttributePersistent (Enum) BACnetPropertyAttributeWritable (Enum) Library Information GetLibVersion (Function) GetLibVersionNumber (Function) IsLibReleased (Function) Persistence BACnetPersistenceInfo (Struct) IBACnetPersistence (Interface) PropertyConfiguration IBACnetPropertyConfiguration (Interface) Structs BACnetDateRange (Struct) BACnetDateTime (Struct) BACnetDevObjPropReference (Struct) BACnetPropertyAttributes (Struct) BACnetSetpointReference (Struct) BACnetTimeStamp (Struct) BACnetTimeStampUnion (Union) BBMD_Info (Struct) Utilities BACnetUtilities IOUtilities Mem RegisterEventUtilities StringConversions ToString Indices and tables ¶ 1 Based on BACnet.library, last modified 16.08.2022, 11:23:18. LibDoc 4.4.0.0-b.27 The content file BACnet.clean.json was generated with CODESYS V3.5 SP16 Patch 1 on 16.08.2022, 11:23:19.
BACNetClientGetEnrollmentSummary (FB) ¶ FUNCTION_BLOCK PUBLIC FINAL BACNetClientGetEnrollmentSummary EXTENDS BACnetClientBase Common Behaviour Model conform (ETrigA) FB to execute a Get-Enrollment-Summary-Reqeust in the BACnet-Network. If execution completed successfully, xDone is set to TRUE. InOut: Scope Name Type Initial Comment Inherited from Input xExecute BOOL Rising edge: Starts defined operation FALSE : Resets the defined operation after ready condition was reached ETrigATo xAbort BOOL TRUE : Aborts the operation ETrigATo udiTimeOut UDINT Max. operating time for executing [µs], 0: No operating time limit ETrigATo Output xDone BOOL TRUE : Ready condition reached ETrigATo xBusy BOOL TRUE : Operation is running ETrigATo xError BOOL TRUE : Error condition reached ETrigATo xAborted BOOL TRUE : Abort condition reached ETrigATo Input dwTargetDeviceNumber DWORD The device number of the targeted device in the BACnet- Network. BACnetClientBase pTargetDeviceAddress POINTER TO CmpBACnet.IEC_BACNET_ADDRESS 0 Optional : The device address of the targeted device in the BACnet-Network. If an adress is given the given device number is ignored. BACnetClientBase Output eStatus CmpBACnet.IEC_BACNET_STATUS CmpBACnet.IEC_BACNET_STATUS.BACNET_STATUS_OK If an error occured, the error state. BACnetClientBase errorResult CmpBACnet.IEC_BACNET_ERROR STRUCT(tag := CmpBACnet.IEC_BACNET_FAILURE_TYPE._FAILURE_MAX_SIZE) If an error occured (this means eStatus <> BACNET_STATUS_OK), whereas the sent BACnet-Request was answered with an specific error information, the latter is contained in this structure. BACnetClientBase iState DINT 0 The State in which the FB is during execution: 0: No execution, resetted state 1: Searching for the Target-Device and a valid address for it 2: Sending the BACnet-Request into the network 3: Waiting for the answer (if there is one) to the BACnet-Request made in 2 4: Finishing the call, setting of the output variables BACnetClientBase Input filter CmpBACnet.IEC_BACNET_ENROLLMENT_FILTER Filter for the aquired enrollment summary. Output result CmpBACnet.IEC_BACNET_ENROLLMENT_INFO If the BACnet-Request succeeded (xDone is TRUE and no error occured (xError is FALSE)), this variable holds the contents of the enrollment info. Properties: Instance , inherited from BACnetClientBase Running , inherited from BACnetClientBase Server , inherited from BACnetClientBase SourceDeviceAddress , inherited from BACnetClientBase SourceDeviceNumber , inherited from BACnetClientBase TargetDeviceAddress , inherited from BACnetClientBase TargetDeviceNumber , inherited from BACnetClientBase Methods: FreeResult HasResult InitializeOutputs Request SampleInputs RegisterToServer , inherited from BACnetClientBase UnregisterFromServer , inherited from BACnetClientBase Structure: FreeResult (Method) HasResult (Method) InitializeOutputs (Method) Request (Method) SampleInputs (Method)
BACNetClientGetEnrollmentSummary.FreeResult (METH) ¶ METHOD PROTECTED FreeResult