BACnetSubscribeCOVProperty (FUN) ¶ FUNCTION BACnetSubscribeCOVProperty : IEC_BACNET_STATUS Sends an SubscribeCovProperty request Sends a message to subscribe a COV client to receive COV notifications for an arbitrary property in an arbitrary BACnet object, or to cancel an existing subscription. If the object supports COV reporting, COV notifications 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 initiating object, and a logical process within the COV-client. This routine may control APDU Properties like APDU length and segmentation and timeout for both request and response processing. This routine may send asynchronous messages, i.e. this routine will complete its execution before the BACnet reply comes so the application 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 messages are sent, the responses shall be queued and identified by the transaction handles. If no BACNET_SIMPLE_ACK_COMPLETE_CB routine is used then BACnetSubscribeCOVProperty routine sends a request message and waits for the reply. NOTE : If fLifeTimePresent and fCovIncrementPresent of pSubscriber are not set to 1, on some systems errors may occur. However, these parameters can be 1 any time, because a liftime of 0 indicates infinite lifetime and an increment of 0 an infinitesimal small increment. InOut: Scope Name Type Comment Return BACnetSubscribeCOVProperty 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_COVP_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, monitored property reference, COV increment, 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.
BACnetUnconfPrivateTransfer (FUN) ¶ FUNCTION BACnetUnconfPrivateTransfer : IEC_BACNET_STATUS Sends a UnconfirmedPrivateTransfer request. Sends a BACnet Unconfirmed-Private-Transfer service request to invoke proprietary or non-standard service in a remote device. return IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetUnconfPrivateTransfer IEC_BACNET_STATUS Input pSourceAddress POINTER TO IEC_BACNET_ADDRESS If the BACnet application has only one device constructed and installed, this can be NULL. 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. pServiceInfo POINTER TO IEC_BACNET_PRIVATE_TRANSFER_INFO A pointer to the service information data structure. This data structure is to transport the service parameters to the destination device.
BACnetSchedule.AddExceptionWeekAndDay (METH) ¶ METHOD AddExceptionWeekAndDay : CmpBACnet.IEC_BACNET_STATUS Adds a week and day entry (i.e. weekly at day) to the Exception_Schedule-Property of this BACnet-Object. InOut: Scope Name Type Comment Return AddExceptionWeekAndDay CmpBACnet.IEC_BACNET_STATUS Input month CmpBACnet.IEC_BACNET_MONTH The month of the exception date. weekOfMonth CmpBACnet.IEC_BACNET_WEEK_OF_MONTH The week of the month of the exception date. dayOfWeek CmpBACnet.IEC_BACNET_DAY_OF_WEEK The day of the week of the exception date. pEntries POINTER TO CmpBACnet.IEC_BACNET_TIME_VALUE The times and values during the week and day dates which correspond to the exception date. entryCount CmpBACnet.IEC_BACNET_ELEMENT_COUNT The number of times and values for the exceptions. eventPriority BYTE The priority with which the values are written.
BACnetUnconfTextMessage (FUN) ¶ FUNCTION BACnetUnconfTextMessage : IEC_BACNET_STATUS Sends an unconfirmed TextMessage. Sends an Unconfirmed-Text-Message service request to remote device. This service may be broadcast, multicast, or addressed to a single recipient. This service may be used in cases where confirmation that the text message was received is not required. Message may be prioritized into Normal or Urgent categories. A text message may be optionally classified by a numeric class code or class identification string. The interpretation of the class is a local matter. InOut: Scope Name Type Comment Return BACnetUnconfTextMessage IEC_BACNET_STATUS Input pSourceAddress POINTER TO IEC_BACNET_ADDRESS If the BACnet application has only one device constructed and installed, this can be NULL. 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. pServiceInfo POINTER TO IEC_BACNET_TEXT_MESSAGE_INFO A pointer to the service information data structure. This data structure of datatype BACNET_TEXT_MESSAGE_INFO contains an object Identifier of device object of the request initiator, a boolen if Message Class Present attribute, a message class, a message priority, a message string type and a message string.
CmpBinTagUtilIec Library Documentation ¶ Company System Title CmpBinTagUtilIec Version 3.5.17.0 Categories System|SysLibs Author 3S - Smart Software Solutions GmbH Placeholder CmpBinTagUtilIec Description 1 ¶ This Library contains wrapper functions for the communication services on layer7. These functions can be used to create or read requests on layer7 of the Codesys protocol. Contents: ¶ BTagAlignment (Struct) BTagAlignments (GVL) BTagElementType (Enum) BTagSwapHeader (Function) Reader BTagReaderCreate (Function) BTagReaderCreateDynamic (Function) BTagReaderDestroy (Function) BTagReaderGetComplexContent (Function) BTagReaderGetContent (Function) BTagReaderGetString (Function) BTagReaderGetTagId (Function) BTagReaderGetTagLen (Function) BTagReaderInit (Function) BTagReaderIsDataTag (Function) BTagReaderMoveNext (Function) BTagReaderPeekNext (Function) BTagReaderSkipContent (Function) ReturnValues (GVL) Test Test_Prg (Program) Testcases (Enum) Writer BTagWriterAppendBlob (Function) BTagWriterAppendDummyBytes (Function) BTagWriterAppendFillBytes (Function) BTagWriterAppendRaw (Function) BTagWriterAppendWString (Function) BTagWriterCreate (Function) BTagWriterCreateDynamic (Function) BTagWriterCreateSavePoint (Function) BTagWriterCreateSavePointDynamic (Function) BTagWriterDestroy (Function) BTagWriterDestroySavePoint (Function) BTagWriterEndTag (Function) BTagWriterFinish (Function) BTagWriterInit (Function) BTagWriterInit2 (Function) BTagWriterRestoreSavePoint (Function) BTagWriterStartTag (Function) BTagWriterSwitchBuffer (Function) Indices and tables ¶ 1 Based on CmpBinTagUtilIec.library, last modified 20.04.2021, 15:36:27. LibDoc 4.4.0.0-b.27 The content file CmpBinTagUtilIec.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 20.04.2021, 15:36:27.
BACnetSchedule.GetPropertyReference (METH) ¶ METHOD GetPropertyReference : CmpBACnet.IEC_BACNET_STATUS Gets the device object property reference at index nIndex in the List_Of-Object_Property_References-Property of this BACnet-Object. InOut: Scope Name Type Comment Return GetPropertyReference CmpBACnet.IEC_BACNET_STATUS Input nIndex CmpBACnet.IEC_BACNET_ELEMENT_COUNT The 1 based index of the reference to get. Output devObjPropRef CmpBACnet.IEC_BACNET_DEV_OBJ_PROP_REFERENCE The object property reference gotten after a call to this method.
BTagAlignment (STRUCT) ¶ TYPE BTagAlignment : STRUCT InOut: Name Type uiModulus UINT uiRemainder UINT
BTagAlignments (GVL) ¶ InOut: Name Type Initial Align42 BTagAlignment STRUCT(uiModulus := 4, uiRemainder := 2) Align40 BTagAlignment STRUCT(uiModulus := 4, uiRemainder := 0)
BTagElementType (ENUM) ¶ TYPE BTagElementType : InOut: Name Initial StartTag 0 EndTag 1 Eof 2
BTagSwapHeader (FUN) ¶ FUNCTION BTagSwapHeader : DWORD InOut: Scope Name Type Comment Return BTagSwapHeader DWORD Input pHeaderTag POINTER TO DWORD A pointer to the header tag that has to be swapped correctly bSwap DINT Determines if the header should be swapped (1) or not (0)