AsyncRemove (FUN) ¶ FUNCTION AsyncRemove : RTS_IEC_RESULT Remove a job. InOut: Scope Name Type Comment Return AsyncRemove RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors.library): ERR_OK: Job has been successfully removed ERR_FAILED: Job cannot be removed because it has been started ERR_PARAMETER: hJob is invalid ERR_PENDING: Job cannot be removed because it is active Input hJob RTS_IEC_HANDLE Handle of job, returned by AsyncAdd

AsyncRemoveAll (FUN) ¶ FUNCTION AsyncRemoveAll : RTS_IEC_RESULT On shutdown or reset, or before download, call AsyncRemoveAll() to removed all registered asynchronous jobs. InOut: Scope Name Type Comment Return AsyncRemoveAll RTS_IEC_RESULT Always returns ERR_OK

GVL (GVL) ¶ Global defines for CmpAsyncMgr InOut: Scope Name Type Initial Comment Constant ASYNCJOB_TASK UDINT 0 Parameter ulType of AsyncAdd ASYNCJOB_EVENT UDINT 1 Parameter ulType of AsyncAdd ASYNCJOB_HOOK UDINT 2 Parameter ulType of AsyncAdd ASYNCSTATE_INVALID UDINT 16#FFFFFFFF State of an async job ASYNCSTATE_PENDING UDINT 0 State of an async job ASYNCSTATE_ACTIVE UDINT 1 State of an async job ASYNCSTATE_READY UDINT 2 State of an async job ASYNCSTATE_ERROR UDINT 3 State of an async job ASYNCSTATE_TIMEOUT UDINT 4 State of an async job ASYNC_TIMEOUT_INFINITE UDINT 0 Parameter ulTimeout of AsyncAdd ASYNC_IS_IEC UDINT 1 Parameter ulIecFunc of AsyncAdd ASYNC_ISNOT_IEC UDINT 0 Parameter ulIecFunc of AsyncAdd CH_COMM_CYCLE UDINT 20 Hooks

GVL_2 (GVL) ¶ Version define for CmpAsyncMgr InOut: Scope Name Type Initial Constant CMPASYNCMGR_VERSION_3_5_6_0 BOOL TRUE

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