[RP_BOOL] Read property for boolean value

Function block RP_BOOL reads the specified property or array element value of data type Boolean from the data point.

RP_BOOL reads the specified property or array element value of data type Boolean from the data point.

Functioning

Compatible data points:

  • Any BACnet data point with read property or array element of data type Boolean.
info

RP_BOOL does not consider the BACnet object state nor the BACnet object usage.

Pins

Input

Description

Data type

Default value
Value range

BaObjRef

BA-Object reference
Link between function block and BACnet object.

Structure

---

BaObjRef
> DeviceID

Device identifier
[DeviceID] includes object type and object instance in one ID.
Identifies the device object: local or remote. A local device object can also be identified by value 16#3FFFFF.

Double Word

16#3FFFFF

BaObjRef
> ObjectID

Object identifier
[ObjectID] includes object type and object instance in one ID.
Identifies the object on a device.

Double Word

16#3FFFFF

BaObjRef
> ItemID

Item identifier
[ItemID] represents an index in a view node object that references the BACnet object.
[ObjectID] and [ItemID] together define an indirect reference to the BACnet object.
Value -1 indicates a direct interface.

Integer

-1

PrpyId

Property identifier

Parameterized BACnet ID number of the property that is read.

Integer

0

ArrayIdx

Array index

Index number of the array element accessed by the function block.
Optional, configured input to indicate access to a property element of data type BACnetArray or BACnetPriorityArray.
Cannot be changed during runtime.

Integer

-1

-1: Not used.
0: Specifies the array length of the referenced property.
Note
Only RP_UNSG supports reading the array length.
>0: Configured value.

 

Output

Description

Data type

Default value
Value range

Val

Value

Value of the referenced property of a BACnet object.

The function block supplies the last, valid value if a previously accessible object or property is no longer accessible (e.g. communication error).

Boolean

0

Dstb

Disturbed

[Dstb] indicates whether the referenced BACnet object was accessed.
[Dstb] = 0, if:
BACnet object access = Access successful
[Dstb] = 1, if:
BACnet object access = Error during access

Boolean

0

PrioAct

Priority active

Indication whether the priority array element queried by [ArrayIdx] contains a commanded value or value 'NULL'.

Note
If the referenced property is no priority array element, [PrioAct] remains at the default value.

Boolean

0

0 - The queried priority is 'NULL' or the referenced property is not a priority array element.
1 - The queried priority is commanded.

ErrCode

Error code indication

Integer

0: No error

= 0 - No error
> 0 - XFB error codes