Loop (LOP)
- Last UpdatedDec 08, 2020
- 4 minute read
Supported properties of the Loop object (LOP)
|
Property |
Value Format |
Example |
|
OBJECT-IDENTIFIER |
String [ObjectNumber]: [Instance Number] |
12:0 |
|
OBJECT-NAME |
String |
Object: Loop |
|
OBJECT-TYPE |
Integer |
12 |
|
PRESENT-VALUE |
Float |
This property indicates the current output value of the loop algorithm in units of the Output Units property For example:100 |
|
DESCRIPTION STATUS-FLAGS |
String 4Booleanvalues(1=true,0=false)encodedasstring4 Boolean values (1 = true, 0 = false) encoded as string {IN_ALARM, FAULT, OVERRIDDEN, OUT_OF_SERVICE} |
This sensor monitors the core activity For example:Description:Loop This property, of type BACnetStatusFlags, represents four Boolean flags that indicate the general "health" of the loop For example:1101 |
|
EVENT-STATE |
String |
The Event State property, of type BACnetEventState, is included in order to provide a way to determine if this object has an active event state associated with it. For example:1.0 |
|
RELIABILITY OUT-OF-SERVICE |
Integer Boolean |
The Reliability property, of type BACnetReliability, provides an indication of whether the Present Value of the loop in question is reliable as far as the BACnet Device or operator can determine and, if not, why. For example: 1 The Out Of Service property, of type BOOLEAN, is an indication whether (TRUE) or not (FALSE) the algorithm this object represents is or is not in service. For example: 1 |
|
UPDATE-INTERVAL |
Integer |
This property, of type Unsigned, indicates the interval in milliseconds at which the loop algorithm updates the output (Present Value property). For example: 150 |
|
OUTPUT-UNITS |
Integer |
This property, of type BACnetEngineeringUnits, indicates the engineering units for the output (Present Value property) of this control loop. For example: 13 |
|
MANIPULATED-VARIABLE-REFERENCE |
String [OBJECT-IDENTIFIER] | [PROPERTY-IDENTIFIER] | [PROPERTY-ARRAY- INDEX (Optional)] |
This property is of type BACnetObjectPropertyReference.The output (Present Value) of the control loop is written to the object and property designated by the Manipulated Variable Reference. For example: 29,4194303|29|786 |
|
CONTROLLED-VARIABLE-REFERENCE |
String [OBJECT-IDENTIFIER] | [PROPERTY-IDENTIFIER] | [PROPERTY-ARRAY- INDEX (Optional)] Float |
This property is of type BACnetObjectPropertyReference. The Controlled Variable Reference identifies the property used to set the Controlled Variable Value property of the Loop object. For example: 29,4194303|29|786 |
|
CONTROLLED-VARIABLE-VALUE |
This property, of type REAL, is the value of the property of the object referenced by the Controlled Variable Reference property. This control loop compares the Controlled Variable Value with the Setpoint to calculate the error. For example: 0 |
|
|
CONTROLLED-VARIABLE-UNITS SETPOINT-REFERENCE |
Integer String [OBJECT-IDENTIFIER] | [PROPERTY-IDENTIFIER] | [PROPERTY-ARRAY-INDEX (Optional)] | [DEVICE- IDENTIFIER (Optional)] |
This property, of type BACnetEngineeringUnits, indicates the engineering units for the Controlled Variable Value property of this object. For example: 2 This property, of type BACnetSetpointReference, is a list of references that has a length of zero or one. A length of zero indicates that the setpoint for this control loop is fixed and is contained in the Setpoint property. For example: 8,0|85|15 |
|
SETPOINT ACTION |
Float Integer |
This property, of type REAL, is the value of the loop setpoint or of the property of the object referenced by the Setpoint Reference, expressed in units of the Controlled Variable Units property. For example: 10 This property, of type BACnetAction, defines whether the loop is DIRECT or REVERSE acting. For example: 1 |
|
PROPORTIONAL-CONSTANT PROPORTIONAL-CONSTANT-UNITS |
Float Integer |
This property, of type REAL, is the value of the proportional gain parameter used by the loop algorithm. It may be used to represent any of the various forms of gain for the proportional control mode, such as overall gain, throttling range, or proportional band. For example: 5 This property, of type BACnetEngineeringUnits, indicates the engineering units of the Proportional Constant property of this object. For example: 2 |
|
INTEGRAL-CONSTANT |
Float |
This property, of type REAL, is the value of the integral gain parameter used by the loop algorithm. For example: 1.2 |
|
INTEGRAL-CONSTANT-UNITS |
Integer |
This property, of type BACnetEngineeringUnits, indicates the engineering units of the Integral Constant property of this object. For example: 3 |
|
DERIVATIVE-CONSTANT |
Float |
This property, of type REAL, is the value of the derivative gain parameter used by the loop algorithm. For example: 4.5 |
|
PRIORITY-FOR-WRITING |
Integer |
Loop objects may be used to control the commandable property of an object. This property, of type Unsigned, provides a priority to be used by the command prioritization mechanism. It identifies the particular priority slot in the Priority Array of the Controlled Variable Reference that is controlled by this loop. It shall have a value in the range 1-16 For example: 27 |
|
COV-INCREMENT |
Float |
This property, of type REAL, shall specify the minimum change in Present Value that will cause a COVNotification to be issued to subscriber COV-clients. This property is required if COV reporting is supported by this object. For example: 1.44 |
|
TIME-DELAY |
Integer |
This property, of type Unsigned, shall specify the minimum period of time in seconds that the difference between the Setpoint and the Controlled Variable Value (the Error) must remain outside the band defined by the Error Limit property before a TO-OFFNORMAL event is generated or within the same band before a TO-NORMAL event is generated. This property is required if intrinsic reporting is supported by this object. For example: 17 |
|
NOTIFICATION-CLASS |
Integer |
This property, of type Unsigned, shall specify the notification class to be used when handling and generating event notifications for this object. For example: 0 |
|
ERROR-LIMIT |
Float |
This property, of type REAL, shall convey the absolute magnitude that the difference between the Setpoint and Controlled Variable Value (the Error) must exceed before a TO-OFFNORMAL event is generated. For example: 5 |
|
EVENT-ENABLE |
3 Boolean values (1 = true, 0 = false) encoded as a string {to-offnormal, to- fault, to-normal} |
This property, of type BACnetEventTransitionBits, shall convey three flags that separately enable and disable reporting of TO-OFFNORMAL, TO-FAULT, and TO-NORMAL events. This property is required if intrinsic reporting is supported by this object. |
|
ACKED-TRANSITIONS |
3 Boolean values (1 = true, 0 = false) encoded as a string {to-offnormal, to- fault, to-normal} |
This property, of type BACnetEventTransitionBits, shall convey three flags that separately indicate the receipt of acknowledgments for TO-OFFNORMAL, TO-FAULT, and TO-NORMAL events. For example: 111 |
|
NOTIFY-TYPE |
Integer |
This property, of type BACnetNotifyType, shall convey whether the notifications generated by the object should be Events or Alarms. This property is required if intrinsic reporting is supported by this object For example:21 |
|
EVENT-TIME-STAMPS PROFILE-NAME |
Sequence of time stamps encoded as a string String |
This optional property, of type BACnetARRAY[3] of BACnetTimeStamp, shall convey the times of the last event notifications for TO-OFFNORMAL, TO- FAULT, and TO-NORMAL events, respectively. For example: 2|1-1-1970 11:0:0.0;2|1-1-1970 11:0:0.0;2|1-1-1970 11:0:0.0 Profile: Loop |