R_LGTCMD: Read lighting command

BA-Object reference

Structure

[BaObjRef] defines a bound connection between XFB and BACnet object. The binding occurs automatically.

Manual configuration attempts are not necessary and can result in system errors.

DeviceId

Device identifier

Double word (default value: 16#3FFFFF)

[DeviceId] comprises object type and object instance in a single identifier.

It is used to identify device object: local or remote. Local device object could also be identified by value 16#3FFFFF.

ObjectId

Object identifier

Double word (default value: 16#3FFFFF)

[ObjectId] comprises object type and object instance in a single identifier.

It is used to identify object within a device.

ItemId

Item identifier

Integer (default value: -1)

[ItemId] represents an item index in the functional view node object, which references the BACnet object.

[ObjectId] and [ItemId] together define an indirect access reference to the BACnet object.

Value -1 indicates that direct binding is used.

Priority X

Integer (default value: 17)

A parameterized input that can be used to query if a particular priority contains a valid commanded value or is released (NULL).

[PrioX] cannot be changed during runtime.

If [PrioX] is set to a value 1...16, the corresponding priority will be queried. The result is provided by the output pin [PrioXAct].

Present value

Real (default value: 0.0)

The arbitrated present value of the referenced lighting output object, based on the priority array.

If the arbitrated value is a target state command, [PrVal] represents the commanded target-state value. If the arbitrated value is a control-command, [PrVal] represents the progress value of the actuator.

Valid

Boolean (default value: False)

An indication of whether output pin [PrVal] is reliable.

1 (True)

[PrVal] is reliable.

• XFB can access the lighting output object.

AND

• Fault flag in state flag property = 0 (no fault)
  (Reliability = 0 (no error) or Reliability was not detected).

0 (False)

[PrVal] is not reliable.

• XFB cannot access the lighting output object.

OR

• Fault flag in state flag property = 1 (fault)
  (Reliability ≠ 0).

Control command operation

Integer (default value: 0)

The value of the operation element from the structured Control command property, as read from the referenced BACnet object.

If the BACnet object cannot be read successfully, the last valid value will be shown and Valid will be set to False.

Control command level

Real (default value: 0.0)

The value of the target level element from the structured Control command property, as read from the referenced BACnet object.

If the BACnet object cannot be read successfully, the last valid value will be shown and Valid will be set to False.

Control command step

Real (default value: 0.0)

The value of the step increment element from the structured Control command property, as read from the referenced BACnet object.

If the BACnet object cannot be read successfully, the last valid value will be shown and Valid will be set to False.

Present priority

Integer (default value: 17)

The active priority of the referenced BACnet object.

[PrPrio] is set to:

• Active priority if the present priority property is accessible.
• 17 if all priorities are released, or if the present priority property is not accessible.

Present command

Boolean (default value: False)

Indicates whether the current present value is from a target state command or a control-command command.

1 (True)

Control-command.

0 (False)

Target state.

Priority X active

Boolean (default value: False)

[PrioXAct] indicates whether the priority being queried by input pin [PrioX] contains a valid commanded value or is released (NULL).

Note
If input pin [PrioX] is not being used, [PrioXAct] remains at default value.

1 (True)

The queried priority is commanded.

0 (False)

The queried priority is released (NULL), or the input pin [PrioX] is not being used.

Progress value

Real (default value: 0.0)

The actual value of the lighting actuator as indicated by the progress value property.

In progress

Boolean (default value: False)

An indication of whether a lighting command is being processed and if the light is changing, based on the In process property.

1 (True)

A lighting command is being processed.

0 (False)

No lighting command.

Operating state

Boolean (default value: False)

[OpSta] indicates whether the lighting actuator is on or off.

1 (True)

For analog lighting output object, [PrgsVal] is greater than 0.0.

For binary lighting output object, Present value = 1 (True).

0 (False)

Operating hours state

Integer (default value: 0)

[OphSta] represents the lifecycle state property, which indicates the lifecycle state of the illuminant.

Burn-in operating hours

Double word (default value: 0)

The required burn-in time of an illuminant based on the burn-in time property from the output object.

Expected operating hours

Double word (default value: 0)

[OphExpd] represents the Life time property of the output object and indicates the expected lifetime of an illuminant.

Operating hours

Double word (default value: 0)

[Oph] represents the elapsed active time property of the output object and indicates the accumulated operating hours of the illuminant. It is only updated in intervals of 15 minutes, or when another property of the output object changes.

Error code indication

Integer (default value: 20)

The status of the last performance of the XFB read operation.

= 0

No error.

> 0

Error, see XFB error codes.