BACnet Property | Short name | BACnet Description | Notes |
|---|---|---|---|
enable | Enable | Enable logging | A writable property that indicates and controls whether (TRUE) or not (FALSE) logging of events and collected data is enabled. Logging occurs if and only if Enable is TRUE, Local_Time is on or after Start_Time, and Local_Time is before Stop_Time. If Start_Time contains any wildcards, it is considered equal to 'the start of time'. If Stop_Time contains any wildcards, it is considered equal to 'the end of time'. Log_Buffer records of type log-status recorded without regard to the value of the Enable property. |
logging-type | LogTyp | Logging Type | A writable property that specifies whether the Trend Log collects records using polling, or COV. |
log-interval | LogIvl | Logging interval | A writable property that specifies the periodic interval in hundredths of seconds for the referenced property to be logged, when Logging_Type has the value POLLED. If the Logging_Type property has either of the values COV or TRIGGERED, the value of the Log_Interval property is zero and ignored. Writing 0 to the log-interval property while the logging type is POLLED changes the logging-type to COV. |
start-time | TiStt | Start time | A writable property that specifies the date and time at or after logging is enabled. If any of the fields of the BACnetDateTime contain wildcard values, the conditions for logging to be enabled by Start_Time is ignored. |
stop-time | TiStp | Stop time | A writable property that specifies the date and time at or after logging is disabled. |
Object-Name-Reference | ObjNameRef | Object name reference | A writable proprietary property that references the data source object for this TrendLog-Simple object instance. |
Source-Property-Identifier | SrcPrpyId | Source property identifier | A read-only proprietary property that specifies the data source property for this TrendLog-Simple object instance. Property-Identifier may be displayed a string. For example, "85". |
log-device-object-property | LogDOP | Log device object property | A read-only standard BACnet property that specifies the DOPR (device object property reference) of the value is to be trended for present value. This property may be specified in a create object service request and the contents will be mapped to the corresponding PXC.A properties (object name reference, source property ID). |
stop-when-full | StpFull | Stop when full | A writable property that specifies whether (TRUE) or not (FALSE) logging ceases when the buffer is full. When logging ceases because the addition of one more record would cause the buffer to be full, Enable is set to FALSE and the event recorded. If Stop_When_Full is writable, attempts to write the value TRUE to the Stop_When_Full property while Record_Count is equal to Buffer_Size result in the oldest Log_Buffer record being discarded, and cause the Enable property to be set to FALSE and the event to be recorded. |
buffer-size | BufSize | Buffer size | A writable property that specifies the maximum number of records the buffer may hold. If writable, it may not be written when Enable is TRUE. If the buffer size is written to be smaller than the current record count, records are removed to adjust to the new buffer size. |
align-intervals | AlgnIvl | Align intervals | A writable property that specifies whether (TRUE) or not (FALSE) clock-aligned periodic logging is enabled. If periodic logging is enabled and the value of Log_Interval is a factor of (that is, it divides without remainder) a second, minute, hour or day, then the beginning of the period specified for logging is aligned to the second, minute, hour or day, respectively. This property is required if the object supports clock-aligned logging. This property has no effect on the behavior of the Trend Log object if the Logging_Type property has a value other than POLLED. |
interval-offset | IvlOfs | Interval offset | A writable property that specifies the offset in hundredths of seconds from the beginning of the period specified for logging until the actual acquisition of a log record begins. The offset used is the value of Interval_Offset modulo the value of Log_Interval. That is, if Interval_Offset has the value 31 and Log_Interval is 30, the offset used is 1. Interval_Offset has no effect if Align_Intervals = FALSE. This property is required if the object supports clock-aligned logging. |
log-buffer | LogBuf | Log buffer | Not supported. |
status-flags | StaFlg | State flag | This read-only property, of type BACnetStatusFlags, represents four Boolean flags that indicate the general "health" of a Trend Log object. The IN_ALARM and FAULT flags are associated with the values of other properties of this object. A more detailed status may be determined by reading the properties that are linked to these flags. The relationship between individual flags is not defined by the protocol. |
reliability | Rlb | Reliability | A read-only property, of type BACnetReliability, that provides an indication of whether the application-specific properties of the object or the process executing the application program are "reliable" as far as the BACnet device can determine. |
record-count | RecCnt | Record count | A writable property that represents the number of log records currently resident in the Log_Buffer. A write of the value zero to this property causes all log records in the Log_Buffer to be deleted and Records_Since_Notification to be reset to zero. Upon completion, this event is reported in the log as the initial entry. |
total-record-count | TotRecnt | Total record count | A read-only property that represents the total number of log records collected by the Trend Log object since creation. When the value of Total_Record_Count reaches its maximum possible value of 232 --- 1, the next value it takes is one. Once this value has wrapped to one, its semantic value (the total number of log records collected) has been lost, but its use in generating notifications remains. |
notification-threshold | NotifThd | Notification threshold | A writable property that specifies the value of Records_Since_Notification at which notification occurs. This property is required if intrinsic reporting is supported by this object. |
cov-resubscription-interval | CovRI | COV resubscr.interval | A read-only property. If the Trend Log is acquiring data from a remote device by COV subscription, this optional property, of type Unsigned, specifies the number of seconds between COV resubscriptions, provided that COV subscription is in effect. SubscribeCOV requests specify twice this lifetime for the subscription and specify the issuance of confirmed notifications. If COV subscriptions are in effect, the first COV subscription is issued when the Trend Log object begins operation or when Enable becomes TRUE. If present, the value of this property is non-zero. If this property is not present, then COV subscription is not attempted. |
records-since-notification | RecNotif | Coll.records since notif. | A read-only property that represents the number of records collected since the previous notification, or since the beginning of logging if no previous notification has occurred. This property is required if intrinsic reporting is supported by this object. |
last-notify-record | LstRecNr | Last notified record number | A read-only property that represents the SequenceNumber associated with the most recently collected record whose collection caused the value of the Records_Since_Notification property to become equal to or greater than the value of the Notification_Threshold property that triggered a notification. If no notification has occurred since logging began the value of this property is zero. This property is required if intrinsic reporting is supported by this object. |
notification-class | NotifCl | Notification Class | A writable proeprty that specifies the notification class to be used when handling and generating event notifications for this object. It is equal to the instance number of the Notification Class object to be used. This property is required if intrinsic reporting is supported by this object. |
acked-transitions | AckTra | Acked transitions | Conveys three flags that separately indicate the receipt of acknowledgments for TO-OFFNORMAL, TO-FAULT and TO-NORMAL events. These flags is cleared upon the occurrence of the corresponding event and set under any of these conditions: Upon receipt of the corresponding acknowledgment; Upon the occurrence of the event if the corresponding flag is not set in the Event_Enable property (meaning event notifications will not be generated for this condition and thus no acknowledgment is expected); Upon the occurrence of the event if the corresponding flag is set in the Event_Enable property and the corresponding flag in the Ack_Required property of the Notification Class object implicitly referenced by the Notification_Class property of this object is not set (meaning no acknowledgment is expected). |
notify-type | NotifTyp | Notification type | Conveys whether the notifications generated by the object should be Events or Alarms. This property is required if intrinsic reporting is supported by this object. |
event-time-stamps | TiStmEvt | Time stamp of event | Conveys the times of the last event notifications for TO-OFFNORMAL, TO-FAULT, and TO-NORMAL events, respectively. Time stamps of type Time or Date shall have X'FF' in each octet and Sequence number time stamps shall have the value 0 if no event notification of that type has been generated since the object was created. This property is required if intrinsic reporting is supported by this object. |
event-detection-enable | EnEvtDet | Enable event detection | A read-only standard BACnet property that indicates whether (true) or not (false) event reporting is enabled in the object and controls whether (true) or not (false) the object will be considered by event summarization services. |
event-state | EvtSta | Event state | Included in order to provide a way to determine if this object has an active event state associated with it. The Event_State property indicates the event state of the object. If the object does not support intrinsic reporting, then the value of this property is NORMAL. |
description | Des | Description | A string of printable characters whose content is not restricted. Default: Trend |
object-name | ObjNam | Object name | Display only. Represents a name for the object that is unique within the BACnet Device that maintains it. The minimum length of the string is one character. The set of characters used in the Object_Name is restricted to printable characters. |
object-identifier | ObjId | Object identifier | A numeric code that is used to identify the object. It is unique within the BACnet Device that maintains it. |
object-type | ObjTyp | Object type | A read-only property that indicates membership in a particular object type class. The value of this property is TREND_LOG. This property displays as an enum type and will look like a number, not a string. |
Prototype | BAObjTyp | Building automation profile | An enumeration that indicates a particular type of Siemens proprietary object. Siemens objects are based on standard BACnet objects. For example, Siemens Analog Input, Analog Output, Analog Calculated Value, and Analog Configuration Value are based on standard Analog Input, Analog Output, and Analog Value BACnet objects. |
profile-name | PrfNam | Profile name | The name of an object profile to which this object conforms. To ensure uniqueness, a profile name must begin with a vendor identifier code followed by a dash. All subsequent characters are administered by the organization registered with that vendor identifier code. The vendor identifier code that prefixes the profile name indicates the organization that publishes and maintains the profile document named by the remainder of the profile name. This vendor identifier need not have any relationship to the vendor identifier of the device within which the object resides. |