R_MNFTR: Read main feature

R_MNFTR reads the Main feature configuration of a preloaded application on startup and provides a signal to enable/disable the appropriate Main feature for runtime operation.

The XFB is used in context of preloaded applications to evaluate the configured Main Feature and provide an enable signal to enable the appropriate Main Feature chart.

Note
The interface of R_MNFTR is identical to the interface for R_FTR (Read features) XFB, except for which input/output pins are visible. For R_MNFTR, only Ftr1, EnFtr1, FtrValid and ErrCode are visible. The other pins are not visible but are ready for future use (for example, with Main feature variants).

Compatible with:

View node object (Functional)

Required properties:

Node subtype (datatype = character string, 14 character max length)

Pin description (inputs)

BaObjRef
BA-Object reference Structure [BaObjRef] defines a bound connection between XFB and BACnet object. The binding occurs automatically when a CFC chart is bound to an application function. Manual configuration attempts are not necessary and can result in system errors.
DeviceId	Device identifier Double word (default value: 16#3FFFFF) [DeviceId] is not used. The value will remain at default for Indirect access referencing.
ObjectId	Object identifier Double word (default value: 16#3FFFFF) [ObjectId] comprises object type and object instance in a single identifier. [ObjectId] and [ItemId] together define an indirect access reference to the BACnet object. The binding occurs automatically when a CFC chart is bound to an application function.
ItemId	Item identifier Integer (default value: -1) [ItemId] represents an index item in the functional view node object, which references the BACnet object. [ObjectId] and [ItemId] together define an indirect access reference to the BACnet object. The binding occurs automatically when a CFC chart is bound to an application function.

FtrTyp
Feature type Integer (default value: 0) <not visible> [FtrTyp] is an enumeration that specifies the type of feature selection managed by the xFB: 0: Optional (this feature is not required; the option can be enabled) 1: Mandatory alternative (this feature is required; a variant must be enabled) 2: Optional alternative (this feature is not required; a variant can be enabled)

FtrTyp

Feature type

Integer (default value: 0)

[FtrTyp] is an enumeration that specifies the type of feature selection managed by the xFB:

0: Optional (this feature is not required; the option can be enabled)
1: Mandatory alternative (this feature is required; a variant must be enabled)
2: Optional alternative (this feature is not required; a variant can be enabled)

Ftr1
Feature 1 String, 14 character max length (default value: <empty>) [Ftr1] is one of several input pins used to specify feature variants. The pin(s) are set by the application engineer in CFC. If [Ftr1] matches the Node subtype property string in the View node object of the configured feature, output pin [EnFtr1] is set to True, sending a signal which the application uses to enable the corresponding nested application module for that feature. [Ftr2]...[Ftr10] functionality is identical to [Ftr1].

Ftr1

Feature 1

String, 14 character max length (default value: <empty>)

[Ftr1] is one of several input pins used to specify feature variants. The pin(s) are set by the application engineer in CFC.

If [Ftr1] matches the Node subtype property string in the View node object of the configured feature, output pin [EnFtr1] is set to True, sending a signal which the application uses to enable the corresponding nested application module for that feature.

[Ftr2]...[Ftr10] functionality is identical to [Ftr1].

Pin description (outputs)

NoFtrCnf
No feature configured Boolean (default value: False) <not visible> [NoFtrCnf] is used to indicate when a feature has not been configured / is not being used. [NoFtrCnf] is initialized as False. When [FtrTyp] is optional (≠1) and the xFB detects successfully that no feature has been configured, [NoFtrCnf] will be set to True (in this case [FtrValid] will be True). [NoFtrCnf] will also be set to True if the feature configuration could not be read successfully by the xFB (in this case [FtrValid] will be False).
0 (False)	The feature has been configured.
1 (True)	The feature has not been configured or the feature configuration could not be read successfully.

NoFtrCnf

No feature configured

Boolean (default value: False)

[NoFtrCnf] is used to indicate when a feature has not been configured / is not being used.

[NoFtrCnf] is initialized as False. When [FtrTyp] is optional (≠1) and the xFB detects successfully that no feature has been configured, [NoFtrCnf] will be set to True (in this case [FtrValid] will be True).

[NoFtrCnf] will also be set to True if the feature configuration could not be read successfully by the xFB (in this case [FtrValid] will be False).

0 (False)

The feature has been configured.

1 (True)

The feature has not been configured or the feature configuration could not be read successfully.

EnFtr1
Enable feature 1 Boolean (default value: False) [EnFtr1] indicates if the feature specified by [Ftr1] has been configured. [EnFtr1] is initialized as False. If [Ftr1] matches the Node subtype property string in the View node of the configured feature, [EnFtr1] is set to True, sending a signal which the application uses to enable the corresponding nested application module. [EnFtr2]...[EnFtr10] functionality is identical to [EnFtr1]. Note Two or more Enable feature output pins can not be True at the same time.

EnFtr1

Enable feature 1

Boolean (default value: False)

[EnFtr1] indicates if the feature specified by [Ftr1] has been configured.

[EnFtr1] is initialized as False. If [Ftr1] matches the Node subtype property string in the View node of the configured feature, [EnFtr1] is set to True, sending a signal which the application uses to enable the corresponding nested application module.

[EnFtr2]...[EnFtr10] functionality is identical to [EnFtr1].

Note
Two or more Enable feature output pins can not be True at the same time.

FtrValid
Feature valid Boolean (default value: False) [FtrValid] indicates whether the feature configuration is valid. [FtrValid] will be set to False if: [FtrTyp] is mandatory (= 1) but no feature has been configured. None of the [Ftr1..Ftr10] entries match the (successfully read) Node subtype property. The feature configuration could not be read successfully by the xFB.
0 (False)	The feature configuration is not valid or could not be read successfully.
1 (True)	The feature configuration is valid and the xFB is able to successfully read it.

FtrValid

Feature valid

Boolean (default value: False)

[FtrValid] indicates whether the feature configuration is valid.

[FtrValid] will be set to False if:

[FtrTyp] is mandatory (= 1) but no feature has been configured.
None of the [Ftr1..Ftr10] entries match the (successfully read) Node subtype property.
The feature configuration could not be read successfully by the xFB.

0 (False)

The feature configuration is not valid or could not be read successfully.

1 (True)

The feature configuration is valid and the xFB is able to successfully read it.

ErrCode
Error code indication Integer (default value: 20) The status of the last execution of the xFB read operation. When [FtrValid] is True, [ErrCode] will = 0, no error.
= 0	No error.
> 0	Error, see XFB error codes.

ErrCode

Error code indication

Integer (default value: 20)

The status of the last execution of the xFB read operation.

When [FtrValid] is True, [ErrCode] will = 0, no error.

= 0

No error.

> 0

Error, see XFB error codes.