Binary Lighting Output object (LgtBOut)
The Binary Lighting Output (LtgBOut) object type defines a BACnet object that represents standardized characteristics of a binary lighting actuator connected as a hardwired or networked field device. LtgBOut object properties are:
✳ Indicates a Siemens proprietary property.
Present value |
|
|
|---|---|---|
"Present value" indicates whether a binary actuator is active (switched on) or inactive (switched off). | ||
Threshold for binary lighting ✳ |
|
|
|---|---|---|
"Threshold for binary lighting" defines the threshold value at or above which a binary lighting actuator becomes active (switched on), and below becomes inactive (switched off).
| ||
Binary present value ✳ |
|
| |
|---|---|---|---|
"Binary present value" property indicates whether a binary actuator is ACTIVE or INACTIVE.
| |||
ACTIVE | Binary lighting actuator is switched on | ||
INACTIVE | Binary lighting actuator is switched off | ||
Present priority ✳ |
|
|
|---|---|---|
"Present priority" property indicates the priority of the highest not released priority slot. If all priority slots are released and "Default command" is used as "Present value", "Present priority" will be set to 17. | ||
Default command |
|
|
|---|---|---|
"Default command" is the default value to be used for the "Present value" property when all command priority values in the "Priority array" property have a NULL value. The placement of NULL in the value parameter indicates the absence of any command at that priority. When all elements of the priority table array contain NULL, the commandable property shall assume the value defined in the "Default command" property of the object. | ||
Default command kind ✳ |
|
|
|---|---|---|
"Default command kind" allows configuring the behavior if no priority slot is active. If the property is FALSE, "Default command" is used as a resulting present value and output to the peripheral device if no other target state or direct control command will be commanded by the time of the first peripheral output. If the property is TRUE, "Default command" is used as a resulting present value, but no output is sent to the peripheral device if no other target state or direct control command will be commanded by the time of the first peripheral output. | ||
Command lighting control ✳ |
|
| ||
|---|---|---|---|---|
"Command lighting control" property allows control commanding of a lighting actuator in the same way as state commanding by writing an operation value including additional operation parameters, and a respective priority to this property, or by releasing a particular priority. Reading:
Commanding:
Releasing:
Direct control after releasing:
| ||||
Operation | Stop | |||
Dimming up | ||||
Step up | ||||
Switch on | ||||
Go to level | ||||
Ramp to | Uses the value "RmpRate" for calculating dimming up or dimming down to the commanded value. If "RmpRate" = 0 then the value of the LgtAOut property "Ramp rate" is used. | |||
Fade to
| Uses the time "TiFade" to fading to the commanded value. If "TiFade" = 0 then the value of the LgtAOut property "Fade time" is used. | |||
TgtLvl |
| |||
DimmStep |
| |||
TiFade | Fixed time span for fading to the commanded value. | |||
RmpRate | Dimming rate in percent per second to calculating dimming up or dimming down. | |||
Present command kind ✳ |
|
| |
|---|---|---|---|
"Present command kind" indicates whether the current value of property Present-Value is the result of a target state command or a control command. | |||
Control-command | Present-Value results from control commanding. | ||
Commanded | Present-Value results from target state commanding. | ||
State flag ✳ |
|
|
|---|---|---|
"State flag" represents four boolean flags ("Out of service", "Overridden", "Fault", "In-Alarm") that indicate the general status of an object. | ||
Reliability |
|
|
|---|---|---|
'Reliability' indicates whether the property value 'Present value' is reliable. If the 'Present value' is not reliable, the property 'Reliability' indicates the cause of the fault and the bit "Fault" of the state indication is set to 'True'. In a normal case, the property 'Reliability' is set to "No fault". | ||
Property ID: 103 | ||
Out of service |
|
|
|---|---|---|
"Out of service" allows decoupling the object from being modified by a control program, system program or peripheral device.
| ||
Property ID: 81 | ||
Inactive text |
|
|
|---|---|---|
'Inactive text' describes the inactive state of property 'Present value'. | ||
Property ID: 46 | ||
Active text |
|
|
|---|---|---|
'Active text' describes the active state of property 'Present value'. | ||
Property ID: 4 | ||
Progress value ✳ |
|
|
|---|---|---|
A BACnet object property that indicates the actual state of the light.
Direct control after releasing:
| ||
In progress ✳ |
|
| |
|---|---|---|---|
"In progress" indicates whether a command is being processed (i.e. the blind is moving, the light is changing). | |||
No | No command is being performed. | ||
Yes | A target state or control command is being performed. | ||
Tracking value |
|
|
|---|---|---|
'Tracking value' represents the uncorrected value as measured by the subsystem. It has the same data type as the 'Present value'.
| ||
Property ID: 5107 | ||
Operating hours |
|
|
|---|---|---|
"Operating hours" represents the accumulated number of seconds that the "Present value" property has had the value ACTIVE since the "Operating hours" property was most recently set to a zero value. | ||
Time stamp for op.hour reset ✳ |
|
|
|---|---|---|
"Time stamp for op.hour reset" includes the date and time at which the property "Operating hours" was most recently set to a zero value. | ||
Property ID: 114 | ||
Expected operating hours ✳ |
|
|
|---|---|---|
"Expected operating hours" indicates the expected life time of the illuminant.
| ||
Operating hours state ✳ |
|
|
|---|---|---|
"Operating hours state" indicates the lifecycle state of the illuminant. Possible states are:
"Operating hours state" will be used by a control program, or operation and monitoring function to support a respective lifecycle management. | ||
Field device type |
|
|
|---|---|---|
"Field device type" is a text description of the physical peripheral device connected to the input or output. Typically contains the product part number of the connected device. To be completed by the engineer. Is not used by the data acquisition. Example: QAX3.P84 (room unit) - Entrance | ||
I/O address ✳ |
|
|
|---|---|---|
"I/O address" identifies and documents the data source, and facilitates configuring, modifying, and querying the assignment in a standardized way. The content of "I/O address" is technology-specific and includes:
| ||
Commissioning state ✳ |
|
|
|---|---|---|
"Commissioning state" is an enumerated value representing the commissioning state (Not checked, Check failed, Check successful) of the BACnet object. Typically set during commissioning by means of engineering and commissioning function (for example, Automation Building Tool or installer tool). It can be inspected by engineering and commissioning, or operation and monitoring functions, and used in commissioning reports. | ||
Commissioning information ✳ |
|
|
|---|---|---|
"Commissioning information" indicates additional, human-readable information about the BACnet object's commissioning state. For example, "cable defect". Typically set during commissioning by means of engineering and commissioning function (for example, Automation Building Tool or installer tool). It can be inspected by engineering and commissioning, or operation and monitoring functions, and used in commissioning reports. | ||
Automatic switch-off function ✳ |
|
|
|---|---|---|
"Automatic switch-off function" controls the behavior of performing the autonomous timed-off function at runtime. The property can be enabled or disabled. If enabled, the device will be switched off after a defined period of time. The period of time can be defined in the property "Automatic switch-off time". | ||
Automatic switch-off time ✳ |
|
|
|---|---|---|
"Automatic switch-off time" indicates the period of time before the device is automatically switched off. | ||
Prewarning function ✳ |
|
|
|---|---|---|
"Prewarning function" defines whether a warning is indicated before the device is switched off e.g. by blinking. The property can be enabled or disabled. The prewarning duration e.g. blinking time, is defined in the "Prewarning time" property. | ||
Prewarning time ✳ |
|
|
|---|---|---|
"Prewarning time" indicates the period of time at which a prewarning is indicated e.g. by blinking. The prewarning can be enabled or disabled in the "Prewarning function" property. | ||
Change of value, COV ✳ |
|
|
|---|---|---|
'Change of value, COV' specifies the minimum change in 'Present value' property that will cause a COV notification to be issued to change-of-value subscribers of this object. | ||
Property ID: 22 | ||
Calibration ✳ |
|
| |
|---|---|---|---|
"Calibration" allows triggering and canceling the calibration of illuminants. The Status-Flag Overridden of the BA-Lighting-Output-Object will be set true indicating that a reference measurement is performed. | |||
Ready | Ready for a new request. | ||
Start-Ref-Measurement | Request that a new reference measurement will be started. Data Acquisition will set Status-Flag Overridden as soon as the start of new reference measurement is triggered. Data Acquisition will reset Status-Flag Overridden and set "Calibration" to Ready as soon as the reference measurement has been performed, or if the Peripheral Device does not support calibration. | ||
Stop-Ref-Measurement | Request that a reference measurement will be canceled. Data Acquisition will set Status-Flag Overridden as soon as a stop of a reference measurement is triggered. Data Acquisition will reset Status-Flag Overridden and set "Calibration" to Ready as soon as the reference measurement has been performed, or if no calibration is active. | ||
Object access level ✳ |
|
| ||
|---|---|---|---|---|
"Object access level" defines the instance-specific object access level. "Object access level" is used for generic filtering and processing an object by a client application.
| ||||
Access level | Name | Description | ||
7 | Basic operation | Access to BACnet objects and properties for a room user e.g. data points visible on a room unit. | ||
6 | Standard operation | Access to BACnet objects and properties for standard operation and monitoring (daily business), .e.g. room and plant information on a management station. | ||
5 | Extended operation | Access to BACnet objects and properties for extended operation and monitoring such as network and device objects. All I/Os are visible | ||
4 | Administrator | Not used by HQ solutions yet. | ||
3 | Basic service | Access to BACnet objects and properties used for commissioning, e.g. configuration value extensions, I/O extensions, etc. | ||
2 | Extended service | Not used by HQ solutions yet. | ||
1 | Internal | Access to all BACnet objects and properties for very specialized actions e.g. during development. | ||
Object usage ✳ |
|
|
|---|---|---|
"Object usage" indicates whether the object is used or unused. The "Object usage" property can hide or display respective objects and their functionality in a client. For example, room functionality can be marked for flexible room arrangements as used/unused. An object that is marked as unused behaves as if the object does not exist. | ||
Property ID: 4930 | ||
Description |
|
|
|---|---|---|
"Description" is a string of printable characters whose content is not restricted. | ||
Object name |
|
|
|---|---|---|
"Object name" represents a name for the object that is unique internetwork-wide. The minimum length of the string is one character. The set of characters used in the "Object name" are restricted to printable characters. | ||
Comment |
|
|
|---|---|---|
A string of printable characters whose content is not restricted. | ||