File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 20.04.2021, 15:33:39 companyName string 3S-Smart Software Solutions GmbH libraryFile CmpAsyncMgr.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile CmpAsyncMgr.clean.json version version 2.0.0.0 ProjectInformation LinkInSimulation bool True Released True LastModificationDateTime date 20.04.2021, 15:33:39 LibraryCategories library-category-list System|SysLibs Author string 3S - Smart Software Solutions GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 Description See: Description DocFormat reStructuredText Placeholder CmpAsyncMgr Project CmpAsyncMgr Title CmpAsyncMgr 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)
CmpBACnet Library Documentation ¶ Company 3S - Smart Software Solutions GmbH Title CmpBACnet Version 3.5.18.0 Categories System|SysLibs Namespace CmpBACnet Author 3S - Smart Software Solutions GmbH Placeholder CmpBACnet Description 1 ¶ CmpBACnet library is the library corresponding to CmpBACnet runtime component. Contents: ¶ BACnetAsyncTransactionToken (Struct) BACnetClientAPI BACnetAcknowledgeAlarm (Function) BACnetAddListElement (Function) BACnetCancelPendingConfirmedRequest (Function) BACnetConfPrivateTransfer (Function) BACnetConfTextMessage (Function) BACnetCreateObject (Function) BACnetCreateObjectResult (Struct) BACnetDeleteObject (Function) BACnetDeviceCommControl (Function) BACnetGetAlarmSummary (Function) BACnetGetEnrollmentSummary (Function) BACnetGetEventInfo (Function) BACnetLifeSafetyOperation (Function) BACnetReadAllPropertyDataContents (Function) BACnetReadFile (Function) BACnetReadProperty (Function) BACnetReadPropertyMultiple (Function) BACnetReadRange (Function) BACnetReinitializeDevice (Function) BACnetRemoveListElement (Function) BACnetSubscribeCOV (Function) BACnetSubscribeCOVProperty (Function) BACnetUnconfPrivateTransfer (Function) BACnetUnconfTextMessage (Function) BACnetWhoHas (Function) BACnetWhoIs (Function) BACnetWriteFile (Function) BACnetWriteGroup (Function) BACnetWriteProperty (Function) BACnetWritePropertyMultiple (Function) advanced Indices and tables ¶ 1 Based on CmpBACnet.library, last modified 01.04.2022, 08:11:46. LibDoc 4.4.0.0-b.27 The content file CmpBACnet.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 01.04.2022, 08:11:46.
BACnetAsyncTransactionToken (STRUCT) ¶ TYPE BACnetAsyncTransactionToken : STRUCT A transaction token for BACnet “asynchronous calls”. For all “asynchronous calls” there is a callback in CODESYS runtime component CmpBACnet, which get’s called asynchronously after the IEC-code has startet the “asynchronous call”. This had been chosen as the best solution to avoid the complexitity of handling those callbacks via “IEC-Events”. The callback in CODESYS runtime component CmpBACnet sets a request status, which can be checked by the IEC-code, this mechanism is referenced as “caller status polling” later on. BACnetAsyncTransactionToken is used to identify transactions of “asynchronous calls” like BACnetReadProperty , and to allow BACnetCancelPendingConfirmedRequest if needed. BACnetAsyncTransactionToken transports a pointer to the request status, to allow “caller status polling”. The caller had to provide the memory pointed to by this pointer. InOut: Name Type Initial Comment transactionID UDINT 0 Unique ID to identify the transaction. Set the transactionID prio to the “asynchronous call”. Reset the transactionID to 0 after the “asynchronous call” is done or after a call to BACnetCancelPendingConfirmedRequest . pStatus POINTER TO IEC_BACNET_STATUS 0 Asynchronous Status of the call. If this value switches from IEC_BACNET_STATUS.BACNET_STATUS_BUSY to another state, for example IEC_BACNET_STATUS.BACNET_STATUS_OK , the asynchronous call has finished. callbackDone UDINT 0 internal information to keep track of transaction status cancelled UDINT 0 internal information to keep track of transaction status
EVTPARAM_CmpAppDenyStart (STRUCT) ¶ TYPE EVTPARAM_CmpAppDenyStart : STRUCT <category>Event parameter</category> <element name=”pApp” type=”IN”>Pointer to application description</element> <element name=”bDeny” type=”OUT”>1=Stop is denied, 0=stop is executed</element> InOut: Name Type pApp POINTER TO APPLICATION bDeny DINT
EVTPARAM_CmpAppDenyStop (STRUCT) ¶ TYPE EVTPARAM_CmpAppDenyStop : STRUCT <category>Event parameter</category> <element name=”pApp” type=”IN”>Pointer to application description</element> <element name=”ulStop” type=”IN”>Reason for the stop, see corresponding category</element> <element name=”bDeny” type=”OUT”>1=Stop is denied, 0=stop is executed</element> InOut: Name Type pApp POINTER TO APPLICATION ulStopReason DWORD bDeny DINT
EVTPARAM_CmpAppException (STRUCT) ¶ TYPE EVTPARAM_CmpAppException : STRUCT InOut: Name Type pApp POINTER TO APPLICATION hIecTask RTS_IEC_HANDLE udiException UDINT
EVTPARAM_CmpAppExit (STRUCT) ¶ TYPE EVTPARAM_CmpAppExit : STRUCT <category>Event parameter</category> <element name=”pApp” type=”IN”>Pointer to application description</element> <element name=”ulExitReason” type=”IN”>Exit reason. See category “OperationReason” for details</element> InOut: Name Type pApp POINTER TO APPLICATION ulExitReason UDINT
EVTPARAM_CmpAppOEMServiceTag (STRUCT) ¶ TYPE EVTPARAM_CmpAppOEMServiceTag : STRUCT <category>Event parameter</category> <element name=”pApp” type=”IN”>Pointer to application description</element> <element name=”udiChannelId” type=”IN”>ChannelId of the actual online service</element> <element name=”ulTopLevelTag” type=”IN”>TopLevelTag</element> <element name=”udiHeaderTag” type=”IN”>Addreass of the Header Tag</element> <element name=”udiReader” type=”IN”>Address of the actual bin tag util reader</element> <element name=”udiWriter” type=”IN”>Address of the actual bin tag util writer</element> <element name=”udiResult” type=”OUT”>Result</element> InOut: Name Type pApp POINTER TO APPLICATION udiChannelId UDINT udiTopLevelTag UDINT udiHeaderTag UDINT udiReader UDINT udiWriter UDINT udiResult UDINT
EVTPARAM_CmpAppOperatingStateChanged (STRUCT) ¶ TYPE EVTPARAM_CmpAppOperatingStateChanged : STRUCT <category>Event parameter</category> <element name=”pApp” type=”IN”>Pointer to application description</element> <element name=”udiPrevOpState” type=”IN”>Previous operating state</element> InOut: Name Type pApp POINTER TO APPLICATION udiPrevOpState UDINT