BACnetServer.RegisterHook (METH) ¶ METHOD RegisterHook : CmpBACnet.IEC_BACNET_STATUS Registers a FB implementing IBACnetEventConsumer (itfEvent) to a BACnet-Stack-Hook of type eHookType. The method of the IBACnetEventConsumer interface gets called whenever the specified hook occurs after registration. InOut: Scope Name Type Comment Return RegisterHook CmpBACnet.IEC_BACNET_STATUS Input eHookType CmpBACnet.IEC_BACNET_CB_TYPE The hook to to register to. itfEvent IBACnetEventConsumer The event consumer to register to the hook.
BACnetServer.DestroyObject (METH) ¶ METHOD DestroyObject : CmpBACnet.IEC_BACNET_STATUS Destroys a BACnet-Object under the BACnet-Device-Object of this BACnet-Server. Note that any previously with this Object-ID initialized BACnetObjectBase-FBs will be not be usable anymore. InOut: Scope Name Type Comment Return DestroyObject CmpBACnet.IEC_BACNET_STATUS Input objIDTyp CmpBACnet.IEC_BACNET_OBJECT_TYPE The type of the BACnet-Object that shall be constructed. objIDInstance UDINT Unique (!along the same Type!) BACnet-Object-Identifier of the BACnet-Object, which also defines the Object-Type.
BACnetServer.FindObject (METH) ¶ METHOD FindObject : BOOL Search for object with given ID. InOut: Scope Name Type Comment Return FindObject BOOL Input objID CmpBACnet.IEC_BACNET_OBJECT_ID Inout bacObj BACnetObjectBase Empty BACnetObjectBase-Structure, which will be initialized with the BACnet-Object if we found th object searched for.
BACnetServer.DeviceId (PROP) ¶ PROPERTY DeviceId : DWORD
HooksCallbacks ¶ Functionalitites for registering Hooks and Callbacks into the BACnet implementation via the BACnet server. HasRegisteredHook (Method) RegisterCallback (Method) RegisterHook (Method) UnregisterCallback (Method) UnregisterHook (Method)
BACnetServer.HasRegisteredHook (METH) ¶ METHOD HasRegisteredHook : BOOL Check, if one or more IBACnetEventConsumer (itfEvent) are already registered to a BACnet-Stack-Hook of type eHookType. InOut: Scope Name Type Return HasRegisteredHook BOOL Input eHookType CmpBACnet.IEC_BACNET_CB_TYPE Output status CmpBACnet.IEC_BACNET_STATUS
IBACnetServerPlugin (ITF) ¶ INTERFACE PUBLIC IBACnetServerPlugin EXTENDS IBACnetEmpty Interface for BACnetServerPlugin(s). BACnetServer allows to register / unregister plugins, to provide flexible implementation options for user specific behaviour. A BACnetServerPlugin can implement multiple service application hooks and multiple service application callbacks if needed, to bundle functionality which needs to be split into multiple application service hooks and multiple callbacks. CODESYS BACnet default implementations use the BACnetServer plugin mechanism as well. Properties: Logging Name NumCallbacks NumHooks Methods: GetCallback GetCallbackAttachmentsForProperty GetHook PostRegister PostStartBACnetStack PostStopBACnetStack PostUnregister PreRegister PreStartBACnetStack PreStopBACnetStack PreUnregister Structure: GetCallback (Method) GetCallbackAttachmentsForProperty (Method) GetHook (Method) Logging (Property) Name (Property) NumCallbacks (Property) NumHooks (Property) PostRegister (Method) PostStartBACnetStack (Method) PostStopBACnetStack (Method) PostUnregister (Method) PreRegister (Method) PreStartBACnetStack (Method) PreStopBACnetStack (Method) PreUnregister (Method)
IBACnetServerPlugin.GetCallback (METH) ¶ METHOD GetCallback : IBACnetServerPluginCallback Gets a callback. InOut: Scope Name Type Comment Return GetCallback IBACnetServerPluginCallback Input index UINT index of the callback.
BACnetServerPluginHookBase.HookType (PROP) ¶ PROPERTY HookType : CmpBACnet.IEC_BACNET_CB_TYPE
BACnetServerPluginBase.PostRegister (METH) ¶ METHOD PostRegister : UDINT Initialization, gets called during BACnetServer.RegisterPlugin after application service hooks/callbacks are registered. Return CmpErrors.Errors.ERR_OK if successfully. InOut: Scope Name Type Return PostRegister UDINT