[R_MSCHED] Read multistate scheduler

Function block R_MSCHED reads the present value and additional properties of a multistate scheduler object.

R_MSCHED reads the present value and additional properties of a multistate scheduler object.

Functioning

Compatible data points:

  • Multistate schedule [MSchedule].

Required properties:

  • Present value
  • Status flag
  • Next value
  • Time to next value

Optional properties:

  • Reliability
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

 

Output

Description

Data type

Default value
Value range

PrVal

Present value

Value of property 'Present value' for the referenced BACnet object.

[PrVal] supplies the last valid value in the event of a fault.

Note
The default initial value for [PrVal] can be changed to another value in the programming editor as needed.

Integer

1

PrValSta

Present value state

Indicates whether scheduling for the current period is enabled. Scheduling is enabled when the property 'Present value' has not the value Null.
In the event of fault, [PrValSta] indicates the last valid value.

Boolean

0

0 - Scheduling for the current period is disabled.
1 - Scheduling for the current period is enabled and [PrVal] shows its value.

NxVal

Next value

Value of property 'Next value' for the referenced BACnet object.
In the event of fault [NxVal] indicates the last valid value.

Integer

1

NxValSta

Next value state

Indicates whether scheduling for the next period is enabled. Scheduling is enabled when the property 'Next value' has not the value Null.
In the event of fault, [NxValSta] indicates the last valid value.

Boolean

0

0 – Scheduling for the next period is disabled.
1 – Scheduling for the next period is enabled and [NxVal] shows its value.

TiNxVal

Time to next value

The value for property 'Time' to the next value of the referenced BACnet object.
In the event of fault [TiNxVal] indicated the last valid value.

Time

0 ms

Dstb

Disturbed

[Dstb] indicates whether the referenced BACnet object is in fault.

[Dstb] = 1 if:
BACnet object = Error during access
OR
'Status flag' = Fault

Otherwise [Dstb] = 0

Boolean

0

Rlb

Reliability
Indicates the value of property 'Reliability', if the property is available.

Integer

0: No fault detected

ErrCode

Error code indication

Integer

0: No error

= 0 - No error
> 0 - XFB error codes