CmpAppBP Library Documentation ¶ Company System Title CmpAppBP Version 3.5.17.0 Categories System|SysLibs Author 3S - Smart Software Solutions GmbH Placeholder CmpAppBP Description 1 ¶ Library to get access to breakpoints within IEC. Indices and tables ¶ 1 Based on CmpAppBP.library, last modified 20.04.2021, 15:33:30. LibDoc 4.4.0.0-b.27 The content file CmpAppBP.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 20.04.2021, 15:33:31.
BACnetCommand.InitializeActionCommandBACnetReal (METH) ¶ METHOD InitializeActionCommandBACnetReal Initialized a BACnet-ActionCommand, which writes a BACnet-Real/Double value to another BACnet-Object-Property. The initialized command then normally is used as part of a BACnet-ActionList. InOut: Scope Name Type Comment Input devInst CmpBACnet.IEC_BACNET_DWORD The instance number of the targeted BACnet device. bacObjectInst CmpBACnet.IEC_BACNET_DWORD The instance number of the targeted BACnet object under the BACnet device. bacObjectType CmpBACnet.IEC_BACNET_OBJECT_TYPE The type of the targeted BACnet object under the BACnet device. bacPropertyID CmpBACnet.IEC_BACNET_PROPERTY_ID The property ID of the targetedn property under the BACnet object. priority CmpBACnet.IEC_BACNET_SIGNED The priority used to write the BinaryPV value to the targeted property. postDelay CmpBACnet.IEC_BACNET_UNSIGNED The post delay after writing the BinaryPV value. quitOnFailure CmpBACnet.IEC_BACNET_BOOLEAN Whether the action list execution shall be quited on failure of this action command or not. Inout bacReal CmpBACnet.IEC_BACNET_REAL The real value to be written. bacActionCommand CmpBACnet.IEC_BACNET_ACTION_COMMAND The action command structure to be filled.
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 20.04.2021, 15:33:31 companyName string 3S-Smart Software Solutions GmbH libraryFile CmpAppBP.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile CmpAppBP.clean.json version version 2.0.0.0 ProjectInformation Released bool True LastModificationDateTime date 20.04.2021, 15:33:30 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 Placeholder CmpAppBP Project CmpAppBP Title CmpAppBP Version version 3.5.17.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. CmpApp ¶ Library Identification ¶ Placeholder: CmpApp Default Resolution: CmpApp, * (System) Namespace: CmpApp Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpApp SysTypes2 Interfaces ¶ Library Identification ¶ Name: SysTypes2 Interfaces Version: newest Company: System Namespace: SysTypes_Interfaces 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.
BACnetCommand.InitializeActionCommandBACnetUnsigned (METH) ¶ METHOD InitializeActionCommandBACnetUnsigned Initialized a BACnet-ActionCommand, which writes a BACnet-Unsigned value to another BACnet-Object-Property. The initialized command then normally is used as part of a BACnet-ActionList. InOut: Scope Name Type Comment Input devInst CmpBACnet.IEC_BACNET_DWORD The instance number of the targeted BACnet device. bacObjectInst CmpBACnet.IEC_BACNET_DWORD The instance number of the targeted BACnet object under the BACnet device. bacObjectType CmpBACnet.IEC_BACNET_OBJECT_TYPE The type of the targeted BACnet object under the BACnet device. bacPropertyID CmpBACnet.IEC_BACNET_PROPERTY_ID The property ID of the targetedn property under the BACnet object. priority CmpBACnet.IEC_BACNET_SIGNED The priority used to write the BinaryPV value to the targeted property. postDelay CmpBACnet.IEC_BACNET_UNSIGNED The post delay after writing the BinaryPV value. quitOnFailure CmpBACnet.IEC_BACNET_BOOLEAN Whether the action list execution shall be quited on failure of this action command or not. Inout bacUnsigned CmpBACnet.IEC_BACNET_UNSIGNED The unsinged value to be written. bacActionCommand CmpBACnet.IEC_BACNET_ACTION_COMMAND The action command structure to be filled.
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
BACnetClientAPI ¶ Functions for directly accessing BACnet client functionalities of the BACnet component on the runtime system. 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 BACnetBackupBACnetDevice (Function) BACnetCloseClientCustomer (Function) BACnetGetClientDeviceCommunication (Function) BACnetOpenClientCustomer (Function) BACnetRegisterClientCommunicationStateCallback (Function) BACnetRegisterClientDataPoint (Function) BACnetRegisterClientEventNotification (Function) BACnetRegisterClientUnsubscribeCompletionCallback (Function) BACnetRestartAllClients (Function) BACnetRestoreBACnetDevice (Function) BACnetSetClientDeviceCommunication (Function) BACnetSetClientDeviceFixAddress (Function) BACnetSetClientDeviceFixSubscribeCovTime (Function) BACnetSetClientGlobalCommTimingParameters (Function) BACnetSetClientGlobalMaxDeviceActions (Function) BACnetUnregisterClientDataPoint (Function) BACnetUnregisterClientEventNotification (Function)
BACnetRemoveListElement (FUN) ¶ FUNCTION BACnetRemoveListElement : IEC_BACNET_STATUS Sends an Remove-List-Element request Sends a request to remove one or more list elements from an object property which is a list. This routine may control APDU properties like APDU length, segmentation, and timeout for both request and in response. This routine can execute asynchronously, i.e. this routine will return to the caller before the BACnet reply comes so that the applications can keep running. In this case the response information will be received by the thread which is responsible for receiving asynchronous responses. An optional BACNET_CHANGE_LIST_COMPLETE_CB routine, which is provided by the BACnet application, shall be used to process this information. If a number of asynchronous requests are sent, the responses shall be queued and identified by the transaction handles. If the application does not supply the BACNET_CHANGE_LIST_COMPLETE_CB routine then the BACnetRemoveListElement routine sends a request and waits for the reply. InOut: Scope Name Type Comment Return BACnetRemoveListElement IEC_BACNET_STATUS A status indicating whether the operation worked. Input pSourceAddress POINTER TO IEC_BACNET_ADDRESS If the BACnet application has only one device constructed and installed, this can be 0. In this case the MAC address of this device will be used. Otherwise this shall be the MAC address returned on device object construction. pDestinationAddress POINTER TO IEC_BACNET_ADDRESS This is the MAC address of the device to which the request should be sent. pRemoveInfo POINTER TO IEC_BACNET_CHANGE_LIST_INFO A pointer to the service information data structure. This data structure contains the objectID, ePropertyID, nIndex and a buffer in which the Property Contents datatype list is placed. pAPDUParams POINTER TO IEC_BACNET_APDU_PROPERTIES A pointer to the APDU-Properties structure which sets APDU properties for this transaction only. This does not change global defaults or settings for the application APDU Properties. This argument may be 0. In this case APDU properties are used which were specified in the device object properties of the applications device which sends the request. pTransactionToken POINTER TO BACnetAsyncTransactionToken Transaction token of the asynchronous call - see BACnetAsyncTransactionToken . pError POINTER TO IEC_BACNET_ERROR A pointer to a structure to hold BACnet Error information. pError may be 0 if the application isn’t interested in detailed error information. pFirstFailed POINTER TO IEC_BACNET_UNSIGNED A pointer to a buffer in which to place the sequence number of the first element in the pElements list which cannot be added to the property. pFirstFailed may be 0.
BACnetSubscribeCOV (FUN) ¶ FUNCTION BACnetSubscribeCOV : IEC_BACNET_STATUS Sends an SubscribeCov request Sends a message to subscribe a COV client to receive COV notifications from a BACnet standard object, or cancel the existing subscription. If the standard object supports COV reporting, COV notification may be sent to one or more subscriber clients. A subscription establishes a connection between the change of value detection and reporting mechanism within the COV-server device, and a logical Process within a COV-client. This routine may control APDU properties like APDU length, segmentation, and timeout for both request and in response. This routine can execute asynchronously, i.e. this routine will return to the caller before the BACnet reply comes so that the applications can keep running. In this case the response information will be received by the thread which is responsible for receiving asynchronous responses. An optional BACNET_SIMPLE_ACK_COMPLETE_CB routine, which is provided by the BACnet application, shall be used to process this information. If a number of asynchronous requests are sent, the responses shall be queued and identified by the transaction handles. If the application does not supply the BACNET_SIMPLE_ACK_COMPLETE_CB routine then the BACnetSubscribeCOV routine sends a request and waits for the reply. InOut: Scope Name Type Comment Return BACnetSubscribeCOV IEC_BACNET_STATUS A status indicating whether the operation worked. Input pSourceAddress POINTER TO IEC_BACNET_ADDRESS If the BACnet application has only one device constructed and installed, this can be 0. In this case the MAC address of this device will be used. Otherwise this shall be the MAC address returned on device object construction. pDestinationAddress POINTER TO IEC_BACNET_ADDRESS This is the MAC address of the device to which the request should be sent. pSubscriber POINTER TO IEC_BACNET_SUBSCRIBE_COV_INFO A pointer to a memory block which contains data structure defining a set of parameters: whether this request is for subscription or cancellation, the destination Process identifier, monitored object identifier, whether confirmed or unconfirmed notification is required, and subscription lifetime. pAPDUParams POINTER TO IEC_BACNET_APDU_PROPERTIES A pointer to the APDU-Properties structure which sets APDU properties for this transaction only. This does not change global defaults or settings for the application APDU Properties. This argument may be 0. In this case APDU properties are used which were specified in the device object properties of the applications device which sends the request. pTransactionToken POINTER TO BACnetAsyncTransactionToken Transaction token of the asynchronous call - see BACnetAsyncTransactionToken . pError POINTER TO IEC_BACNET_ERROR A pointer to a structure to hold BACnet Error information. pError may be 0 if the application isn’t interested in detailed error information.