BACnetCommand (FB) ¶ FUNCTION_BLOCK PUBLIC BACnetCommand EXTENDS BACnetStaticObjectBase IMPLEMENTS IBACnetCommand FB reflecting a BACnet-Command-Object. All Properties of this FB give access to the client writeable BACnet-Properties of the reflected BACnet-Object, although the access is done not client sided (without checking access restrictions). Since the Action- and Action_Text-BACnet-Property shall also be writeable for this BACnet-Command-Object, additional functions for accessing and modifying these properties are given within this FB. Moreover utility functions for initializing Commands which are insertable into the Action-Property are available in this FB. Additionally see documentation of BACnetObjectBase . Properties: AllWritesSuccessful Description InProcess PresentValue ProfileName NumberOfProperties , inherited from BACnetObjectBase ObjectID , inherited from BACnetObjectBase Methods: AddActionList GetActionList GetActionListCount RemoveActionList GetBACnetAccumulatorRecordProperty , inherited from BACnetObjectBase GetBACnetArraySizeOfProperty , inherited from BACnetObjectBase GetBACnetArraySizeOfTwoProperties , inherited from BACnetObjectBase GetBACnetBitStringProperty , inherited from BACnetObjectBase GetBACnetBooleanProperty , inherited from BACnetObjectBase GetBACnetClientCOVProperty , inherited from BACnetObjectBase GetBACnetDateProperty , inherited from BACnetObjectBase GetBACnetDateRangeProperty , inherited from BACnetObjectBase GetBACnetDateTimeProperty , inherited from BACnetObjectBase GetBACnetDevObjPropReferenceProperty , inherited from BACnetObjectBase GetBACnetDoubleProperty , inherited from BACnetObjectBase GetBACnetEnumeratedProperty , inherited from BACnetObjectBase GetBACnetObjPropReferenceProperty , inherited from BACnetObjectBase GetBACnetObjectIDProperty , inherited from BACnetObjectBase GetBACnetPrescaleProperty , inherited from BACnetObjectBase GetBACnetRealProperty , inherited from BACnetObjectBase GetBACnetScaleProperty , inherited from BACnetObjectBase GetBACnetSetpointReferenceProperty , inherited from BACnetObjectBase GetBACnetSignedProperty , inherited from BACnetObjectBase GetBACnetStringProperty , inherited from BACnetObjectBase GetBACnetTimeProperty , inherited from BACnetObjectBase GetBACnetTimeStampProperty , inherited from BACnetObjectBase GetBACnetUnsignedProperty , inherited from BACnetObjectBase GetPropertyAccessRight , inherited from BACnetObjectBase GetPropertyCallbackAttachment , inherited from BACnetObjectBase GetPropertyId , inherited from BACnetObjectBase GetPropertyInstanceStackAllocContentBuffer , inherited from BACnetObjectBase GetPropertyInstanceWithContentBuffer , inherited from BACnetObjectBase InitializeActionCommandBACnetBinaryPV InitializeActionCommandBACnetBoolean InitializeActionCommandBACnetReal InitializeActionCommandBACnetUnsigned IsBACnetDateTimePropertyUnspecified , inherited from BACnetObjectBase IsPropertyExistent , inherited from BACnetObjectBase IsPropertyWriteable , inherited from BACnetObjectBase SetBACnetAccumulatorRecordProperty , inherited from BACnetObjectBase SetBACnetBitStringProperty , inherited from BACnetObjectBase SetBACnetBooleanProperty , inherited from BACnetObjectBase SetBACnetClientCOVProperty , inherited from BACnetObjectBase SetBACnetDateProperty , inherited from BACnetObjectBase SetBACnetDateRangeProperty , inherited from BACnetObjectBase SetBACnetDateTimeProperty , inherited from BACnetObjectBase SetBACnetDateTimePropertyToUnspecified , inherited from BACnetObjectBase SetBACnetDevObjPropReferenceProperty , inherited from BACnetObjectBase SetBACnetDoubleProperty , inherited from BACnetObjectBase SetBACnetEnumeratedProperty , inherited from BACnetObjectBase SetBACnetObjPropReferenceProperty , inherited from BACnetObjectBase SetBACnetObjectIDProperty , inherited from BACnetObjectBase SetBACnetPrescaleProperty , inherited from BACnetObjectBase SetBACnetRealProperty , inherited from BACnetObjectBase SetBACnetScaleProperty , inherited from BACnetObjectBase SetBACnetSetpointReferenceProperty , inherited from BACnetObjectBase SetBACnetSignedProperty , inherited from BACnetObjectBase SetBACnetStringProperty , inherited from BACnetObjectBase SetBACnetTimeProperty , inherited from BACnetObjectBase SetBACnetTimeStampProperty , inherited from BACnetObjectBase SetBACnetUnsignedProperty , inherited from BACnetObjectBase SetObjectName , inherited from BACnetObjectBase SetPropertyAccessRight , inherited from BACnetObjectBase SetPropertyCallbackAttachment , inherited from BACnetObjectBase SetPropertyInstance , inherited from BACnetObjectBase WritePropertyInstance , inherited from BACnetObjectBase Structure: AddActionList (Method) AllWritesSuccessful (Property) Description (Property) GetActionList (Method) GetActionListCount (Method) InProcess (Property) InitializeActionCommands InitializeActionCommandBACnetBinaryPV (Method) InitializeActionCommandBACnetBoolean (Method) InitializeActionCommandBACnetReal (Method) InitializeActionCommandBACnetUnsigned (Method) PresentValue (Property) ProfileName (Property) RemoveActionList (Method)

BACnetCommand.AddActionList (METH) ¶ METHOD AddActionList : CmpBACnet.IEC_BACNET_STATUS Adds a action list and action list text to the Action-BACnet-Propetrty and Action_Text-BACnetProperty of this BACnet-Command-Object at the same time. So both description and action are added simultaneously (inputs actionList with corresponding description actionListText). The entries of the action list (actionList) may be initialized using the helper functions InitializeActionCommandBACnetBinaryPV,… of this FB. InOut: Scope Name Type Comment Return AddActionList CmpBACnet.IEC_BACNET_STATUS Input actionList CmpBACnet.IEC_BACNET_ACTION_LIST The action list to add to the Action-Property. actionListText WSTRING(255) The action text to add to the Action_Text-Property.

BACnetCommand.GetActionList (METH) ¶ METHOD GetActionList : CmpBACnet.IEC_BACNET_STATUS Gets a action list and action list text at index nIndex from the Action-BACnet-Propetrty and Action_Text-BACnetProperty of this BACnet-Command-Object at the same time. So both description and action are aquired simultaneously (outputs pActionList and sctionListText). InOut: Scope Name Type Comment Return GetActionList CmpBACnet.IEC_BACNET_STATUS Input nIndex CmpBACnet.IEC_BACNET_ELEMENT_COUNT The 1 based index of the action list to get. Output pActionList POINTER TO CmpBACnet.IEC_BACNET_ACTION_LIST The returned Pointer gets filled with the data of IEC_BACNET_EVENT_PARAMETER AND (!) the data referenced within evtParams. After usage, use FreeStackAllocatedMemory , to free the used memory. The pointer only points to a single action list. actionListText WSTRING(255) The corresponding action text describing the aquired action list.

BACnetCommand.GetActionListCount (METH) ¶ METHOD GetActionListCount : CmpBACnet.IEC_BACNET_STATUS Gets the count of action list and action list text entries in the Action-BACnet-Property and Action_Text-BACnetProperty of this BACnet-Command-Object. Both the count of action lists and action texts have to be the same, so can be aquired at once. InOut: Scope Name Type Comment Return GetActionListCount CmpBACnet.IEC_BACNET_STATUS Output count CmpBACnet.IEC_BACNET_ELEMENT_COUNT The count of action list in the Actio-Property of this object.

BACnetCalendar.RemoveEntry (METH) ¶ METHOD RemoveEntry : CmpBACnet.IEC_BACNET_STATUS Removes the calendar entry in the Date_List-Property of this BACnet-Calendar-Object, which has index nIndex. Use the function GetEntryCount, to be able to get valid indices for removing. InOut: Scope Name Type Initial Comment Return RemoveEntry CmpBACnet.IEC_BACNET_STATUS Input nIndex CmpBACnet.IEC_BACNET_ELEMENT_COUNT 0 The 1 based index of the entry to remove.

Command ¶ The BACnet Command object. BACnetCommand (FunctionBlock) AddActionList (Method) AllWritesSuccessful (Property) Description (Property) GetActionList (Method) GetActionListCount (Method) InProcess (Property) InitializeActionCommands InitializeActionCommandBACnetBinaryPV (Method) InitializeActionCommandBACnetBoolean (Method) InitializeActionCommandBACnetReal (Method) InitializeActionCommandBACnetUnsigned (Method) PresentValue (Property) ProfileName (Property) RemoveActionList (Method)

BACnetCalendar.GetEntry (METH) ¶ METHOD GetEntry : CmpBACnet.IEC_BACNET_STATUS Gets the calendar entry in the Date_List-Property of this BACnet-Calendar-Object, which has index nIndex. Use The function GetEntryCount, to be able to go through all entries of the Date_List-Property. InOut: Scope Name Type Comment Return GetEntry CmpBACnet.IEC_BACNET_STATUS Input nIndex CmpBACnet.IEC_BACNET_ELEMENT_COUNT The 1 based index of the entry to get. Output entry CmpBACnet.IEC_BACNET_CALENDAR_ENTRY The entry specified by nIndex (filled after calling this method).

BACnetCalendar.GetEntryCount (METH) ¶ METHOD GetEntryCount : CmpBACnet.IEC_BACNET_STATUS Gets the number of calendar entries in the Date_List-Property of this BACnet-Calendar-Object. InOut: Scope Name Type Comment Return GetEntryCount CmpBACnet.IEC_BACNET_STATUS Output count CmpBACnet.IEC_BACNET_ELEMENT_COUNT The count of entries in the Date_List-Property in this object.

BACnetCalendar.AddWeekAndDay (METH) ¶ METHOD AddWeekAndDay : CmpBACnet.IEC_BACNET_STATUS Adds a week and day specification (i.e. every week at day xy) as calendar entry to the Date_List-Property of this BACnet-Calendar-Object. InOut: Scope Name Type Comment Return AddWeekAndDay CmpBACnet.IEC_BACNET_STATUS Input month CmpBACnet.IEC_BACNET_MONTH The month for the entry to add to the Date_List-Property of this object. weekOfMonth CmpBACnet.IEC_BACNET_WEEK_OF_MONTH The week of the month for the entry to add to the Date_List- Property of this object. dayOfWeek CmpBACnet.IEC_BACNET_DAY_OF_WEEK The day of the week for the entry to add to the Date_List- Property of this object.

BACnetCalendar.Description (PROP) ¶ PROPERTY Description : WSTRING(255)