BACnetCommand.InitializeActionCommandBACnetBinaryPV (METH) ¶ METHOD InitializeActionCommandBACnetBinaryPV Initialized a BACnet-ActionCommand, which writes a BACnet-BinaryPV 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 bacBinaryPV CmpBACnet.IEC_BACNET_BINARY_PV The BinaryPV value to be written. bacActionCommand CmpBACnet.IEC_BACNET_ACTION_COMMAND The action command structure to be filled.
BACnetCommand.InitializeActionCommandBACnetBoolean (METH) ¶ METHOD InitializeActionCommandBACnetBoolean Initialized a BACnet-ActionCommand, which writes a BACnet-Boolean 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 bacBoolean CmpBACnet.IEC_BACNET_BOOLEAN The boolean value to be written. bacActionCommand CmpBACnet.IEC_BACNET_ACTION_COMMAND The action command structure to be filled.
BACnetSchedule.AddExceptionReference (METH) ¶ METHOD AddExceptionReference : CmpBACnet.IEC_BACNET_STATUS Adds a reference (to a BACnet-Calendar-Object) to the Exception_Schedule-Property of this BACnet-Object. InOut: Scope Name Type Comment Return AddExceptionReference CmpBACnet.IEC_BACNET_STATUS Input calendarInstance CmpBACnet.IEC_BACNET_DWORD The instance number of the calendar object to reference. pEntries POINTER TO CmpBACnet.IEC_BACNET_TIME_VALUE The times and values during the calendar entries 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.
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.
BACnetSchedule.RemoveExceptionEntry (METH) ¶ METHOD RemoveExceptionEntry : CmpBACnet.IEC_BACNET_STATUS Removes a entry at index nIndex from the Exception_Schedule-Property of this BACnet-Object. InOut: Scope Name Type Initial Comment Return RemoveExceptionEntry CmpBACnet.IEC_BACNET_STATUS Input nIndex CmpBACnet.IEC_BACNET_ELEMENT_COUNT 0 The 1 based index of the exception entry to remove.
BACnetSchedule.AddPropertyReference (METH) ¶ METHOD AddPropertyReference : CmpBACnet.IEC_BACNET_STATUS Adds device object property reference to the List_Of-Object_Property_References-Property (which lists all the Objects to influenced by this Schedule) of this BACnet-Object. InOut: Scope Name Type Initial Comment Return AddPropertyReference CmpBACnet.IEC_BACNET_STATUS Input deviceInstance CmpBACnet.IEC_BACNET_DWORD The BACnet device to reference. objInstance CmpBACnet.IEC_BACNET_DWORD The BACnet object instance number of the BACnet device to reference. objType CmpBACnet.IEC_BACNET_OBJECT_TYPE The BACnet object type number of the BACnet device to reference. propID CmpBACnet.IEC_BACNET_PROPERTY_ID The BACnet property ID of the BACnet object to reference. nIndex CmpBACnet.IEC_BACNET_SIGNED The 1 based index to reference of the BACnet property. xDevicePresent BOOL TRUE Whether the BACnet device is present or not.
BACnetSchedule.GetExceptionEntry (METH) ¶ METHOD GetExceptionEntry : CmpBACnet.IEC_BACNET_STATUS Gets a entry with index nIndex of the Exception_Schedule-Property of this BACnet-Object. The returned data (pSpecialEvt) is allocated by the stack and therefore has to be freed after usage using FreeStackAllocatedMemory again! InOut: Scope Name Type Comment Return GetExceptionEntry CmpBACnet.IEC_BACNET_STATUS Input nIndex CmpBACnet.IEC_BACNET_ELEMENT_COUNT The 1 based index of the exception entry to get. Output pSpecialEvt POINTER TO CmpBACnet.IEC_BACNET_SPECIAL_EVENT 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 again.
BACnetSchedule.GetExceptionEntryCount (METH) ¶ METHOD GetExceptionEntryCount : CmpBACnet.IEC_BACNET_STATUS Gets the number of entries in the Exception_Schedule-Property of this BACnet-Object. InOut: Scope Name Type Comment Return GetExceptionEntryCount CmpBACnet.IEC_BACNET_STATUS Output count CmpBACnet.IEC_BACNET_ELEMENT_COUNT The count of the exception entries of this object.
BACnetSchedule.AddExceptionBACnetDate (METH) ¶ METHOD AddExceptionBACnetDate : CmpBACnet.IEC_BACNET_STATUS Adds a date to the Exception_Schedule-Property of this BACnet-Object. InOut: Scope Name Type Comment Return AddExceptionBACnetDate CmpBACnet.IEC_BACNET_STATUS Input bacDat CmpBACnet.IEC_BACNET_DATE The exception date to add. pEntries POINTER TO CmpBACnet.IEC_BACNET_TIME_VALUE The times and values during the date 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.
BACnetSchedule.AddExceptionBACnetDateRange (METH) ¶ METHOD AddExceptionBACnetDateRange : CmpBACnet.IEC_BACNET_STATUS Adds a date range to the Exception_Schedule-Property of this BACnet-Object. InOut: Scope Name Type Comment Return AddExceptionBACnetDateRange CmpBACnet.IEC_BACNET_STATUS Input bacStartDat CmpBACnet.IEC_BACNET_DATE The start of the exception date range. bacEndDat CmpBACnet.IEC_BACNET_DATE The end of the exception date range. pEntries POINTER TO CmpBACnet.IEC_BACNET_TIME_VALUE The times and values during the date range 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.