BACnetServerConfEventNotification (FB) ¶ FUNCTION_BLOCK PUBLIC FINAL BACnetServerConfEventNotification EXTENDS BACnetClientBase Common Behaviour Model conform (ETrigA) FB to send a ConfirmedEventNotification-Request in the BACnet-Network. If execution completed successfully and xDone is TRUE, the request was successful. In any other case eStatus and errorResult may hold additional information of what failed. 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 initObject CmpBACnet.IEC_BACNET_OBJECT_ID This parameter, of type BACnetObjectIdentifier, specifies the Object_Identifier of the object that is initiating the notification. messageText CmpBACnet.IEC_BACNET_STRING This optional parameter, of type CharacterString, contains a string of printable characters. This parameter may be used to transport a message to be logged or displayed, which pertains to the occurrence of the event. Set string type to BACNET_STRING_NONE for no message text to be sent. pMandatoryParams POINTER TO CmpBACnet.IEC_BACNET_EN_MANDATORY A pointer to the mandatory service parameters. pConditionalParams POINTER TO CmpBACnet.IEC_BACNET_EN_CONDITIONAL A pointer to the conditional service parameters. 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: Request SampleInputs InitializeOutputs , inherited from BACnetClientBase RegisterToServer , inherited from BACnetClientBase UnregisterFromServer , inherited from BACnetClientBase Structure: Request (Method) SampleInputs (Method)
BACnetServer ¶ Function blocks for the use of a BACnet server being inserted into the device tree of CODESYS. Internally a BACnet server corresponds to a BACnet devide, but is extended to cover a lot of local functionalities needed by the BACnet user. Async BACnetServerConfCOVNotification (FunctionBlock) Request (Method) SampleInputs (Method) BACnetServerConfEventNotification (FunctionBlock) Request (Method) SampleInputs (Method) BACnetIPdatalink (FunctionBlock) Bbmd0 (Property) Bbmd1 (Property) Bbmd2 (Property) Bbmd3 (Property) Bbmd4 (Property) Bbmd5 (Property) Bbmd6 (Property) Bbmd7 (Property) CntBbmd (Property) ForeignDevAddr (Property) ForeignDevAddrPort (Property) ForeignDevRegTimeout (Property) IPaddress (Property) MaxMsgReq (Property) NetworkNumber (Property) UDP_Port (Property) protected CheckNetworkSettings (Method) GetIPaddrFromETH (Method) BACnetMSTPdatalink (FunctionBlock) Runtime changes of broadcast distribution table entries as well as foreign device table Baudrate (Property) Connection (Property) DeviceName (Property) MSTPaddr (Property) MaxInfoFrames (Property) MaxMaster (Property) MaxMsgReq (Property) NetworkNumber (Property) ReplyTimeout (Property) TokenTimeout (Property) protected CheckMstpDeviceDriverReady (Method) BACnetServer (FunctionBlock) DemoMode (Property) DeviceAddressBindings GetAddressBinding (Method) GetAddressBindingsCount (Method) UpdateAddressBindings (Method) DeviceId (Property) DeviceObject (Property) GenerateBACstackConfig (Method) HideToOutside (Property) HooksCallbacks HasRegisteredHook (Method) RegisterCallback (Method) RegisterHook (Method) UnregisterCallback (Method) UnregisterHook (Method) LocalProcessID (Property) Objects ConstructDefaultObject (Method) DestroyObject (Method) FindObject (Method) GetObject (Method) GetObjectCount (Method) GetStructuredObject (Method) GetStructuredObjectCount (Method) IsObjectTypeSupported (Method) Persistence ActivatePersistence (Method) DeactivatePersistence (Method) Plugins RegisterPlugin (Method) UnregisterPlugin (Method) PropertyAttributes GetConfiguredPropertyAttributes (Method) PropertyConfiguration ActivatePropertyConfiguration (Method) DeactivatePropertyConfiguration (Method) Running (Property) Services ConfCOVNotification (Method) GetNextAvailableInstanceNumberForType (Method) UnconfCOVNotification (Method) UpdateAccumulatorDataSourceValue (Method) WritePropertyInstance (Method) SrvrInit RWPropCBComplete (Property) StartBACnetStack (Method) StopBACnetStack (Method) StringType (Property) SupportUnsolicitedCOV (Property) IBACnetServer (Interface) DemoMode (Property) DeviceAddressBindings GetAddressBinding (Method) GetAddressBindingsCount (Method) UpdateAddressBindings (Method) DeviceId (Property) DeviceObject (Property) HideToOutside (Property) HooksCallbacks RegisterCallback (Method) RegisterHook (Method) UnregisterCallback (Method) UnregisterHook (Method) LocalProcessID (Property) Objects ConstructDefaultObject (Method) DestroyObject (Method) FindObject (Method) GetObject (Method) GetObjectCount (Method) GetStructuredObject (Method) GetStructuredObjectCount (Method) IsObjectTypeSupported (Method) Persistence ActivatePersistence (Method) DeactivatePersistence (Method) Plugins RegisterPlugin (Method) UnregisterPlugin (Method) PropertyAttributes GetConfiguredPropertyAttributes (Method) GetNumPersistentObjects (Method) IsBACnetPropertyExistent (Method) IsBACnetPropertyPersistent (Method) IsBACnetPropertyWritable (Method) ObjectHasPersistentProperties (Method) PropertyConfiguration ActivatePropertyConfiguration (Method) DeactivatePropertyConfiguration (Method) Running (Property) Services ConfCOVNotification (Method) NumClientCreatedObjects (Method) UnconfCOVNotification (Method) UpdateAccumulatorDataSourceValue (Method) WritePropertyInstance (Method) SrvrInit RWPropCBComplete (Property) StartBACnetStack (Method) StopBACnetStack (Method) StringType (Property) SupportUnsolicitedCOV (Property)
Async ¶ Function blocks for sending confirmed event / COV notification from the BACnet server. BACnetServerConfCOVNotification (FunctionBlock) Request (Method) SampleInputs (Method) BACnetServerConfEventNotification (FunctionBlock) Request (Method) SampleInputs (Method)
BACnetIPdatalink (FB) ¶ FUNCTION_BLOCK BACnetIPdatalink IMPLEMENTS IBACnetDatalink BACnet IP datalink. A BACnet IP datalink (device) can be placed underneath a ETH device. In this case BACnetIPdatalink obtains the IP address from the ETH device and checks the ETH device network settings for consistency. In case this BACnet IP datalink (device) has been placed underneath another node we rely on ETH autodetect of the BACstack (using first ETH adapter found) or the IP address has to be set by the application. Information configured in BACnetIPdatalink (including the IP address) is used to generate the BACstack configuration file (bacstac.ini) on the PLC. Please note the BACnetServer configuration AutoGenerateBACstackConfig, you can control if the BACstack configuration file is generated during BACnetServer.StartBACnetStack. Otherwise you can call BACnetServer.GenerateBACstackConfig. BBMD broadcast distribution table entries as well as foreign device table entries added from clients requests are stored in the BACstack configuration file. Take care to re-generate the BACstack configuration file only if needed, to ensure keeping tbose entries. CODESYSControl.cfg contains a setting: [CmpBACnet] IniFile=bacstac.ini to define where the BACstack ini file is to be found. Because the BACstack ini file is written using the information from BACnetIPdatalink, it is accessed from either the runtime system (component) CmpBACnet and the IEC application. So an absolute path has to be used for this setting, for example: [CmpBACnet] IniFile=/tmp/bacstac.ini If sandboxing the runtime system filesystem is chosen, the setting [SysFile] ForceFilePath= has to be used to allow access for the absolute path of the BACstack ini file. Properties: Bbmd0 Bbmd1 Bbmd2 Bbmd3 Bbmd4 Bbmd5 Bbmd6 Bbmd7 CntBbmd ForeignDevAddr ForeignDevAddrPort ForeignDevRegTimeout IPaddress MaxMsgReq NetworkNumber UDP_Port Methods: CheckNetworkSettings GetIPaddrFromETH Structure: Bbmd0 (Property) Bbmd1 (Property) Bbmd2 (Property) Bbmd3 (Property) Bbmd4 (Property) Bbmd5 (Property) Bbmd6 (Property) Bbmd7 (Property) CntBbmd (Property) ForeignDevAddr (Property) ForeignDevAddrPort (Property) ForeignDevRegTimeout (Property) IPaddress (Property) MaxMsgReq (Property) NetworkNumber (Property) UDP_Port (Property) protected CheckNetworkSettings (Method) GetIPaddrFromETH (Method)
BACnetIPdatalink.Bbmd0 (PROP) ¶ PROPERTY Bbmd0 : BBMD_Info BBMD 0
BACnetServerConfEventNotification.Request (METH) ¶ METHOD PROTECTED Request : CmpBACnet.IEC_BACNET_STATUS InOut: Scope Name Type Return Request CmpBACnet.IEC_BACNET_STATUS
BACnetServerConfEventNotification.SampleInputs (METH) ¶ METHOD PROTECTED SampleInputs
BACnetTrendLogMultiple.TotalRecordCount (PROP) ¶ PROPERTY TotalRecordCount : CmpBACnet.IEC_BACNET_UNSIGNED
BACnetTrendLogMultiple.Trigger (PROP) ¶ PROPERTY Trigger : BOOL
BACnetIPdatalink.Bbmd3 (PROP) ¶ PROPERTY Bbmd3 : BBMD_Info BBMD 3