Print
PDF
This document lists the Option parameters for the FP-3000.
Parameters
BLOCK_RESET (FP-3000 Specific)
This parameter is specific to the National Instruments FP-3000 device. It lets you reset the statistics or the configuration of an individual function block.
CFG_OPTS (FP-3000 Specific)
This parameter is specific to the National Instruments FP-3000 device. An option in the I/O function blocks to automatically set the scaling or alter the block behavior.
CLR_FSTATE
Writing Clear to this parameter causes the device-wide faultstate to be cleared and output blocks to resume normal execution. Also see SET_FSTATE and FAULT_STATE parameters.
CONTROL_OPTS
A list of options used to adjust the way control blocks, such as the PID block, operate. The options are described in the following table.
DEV_OPTS (FP-3000 Specific)
This parameter is specific to the National Instruments FP-3000 device. A list of device-wide options that can be turned on and off at will. The current firmware supports only one option.
EVENT_FILTER (FP-3000 Specific)
This parameter is specific to the National Instruments FP-3000 device. It restricts the entries shown in the log of the Log Block. The values are a combination of: Configuration Error, Operational Warning, and Operational Error
FAULT_STATE
The current status of the device faultstate. It can be set and cleared with SET_FSTATE and CLR_FSTATE. If it is set, all output blocks in the device initiate their own faultstate behavior.
FEATURE_SEL/FEATURES
The FEATURES parameter lists features supported by the device. Use the FEATURE_SEL parameter to manually enable and disable the supported features listed in the FEATURES parameter. The features are listed in the table below.
FP_AUTOCONFIGURE (FP-3000 Specific)
This parameter is specific to the National Instruments FP-3000 device. This parameter, present in the resource block, causes the FP-3000 to automatically configure itself. The FP-3000 detects all the I/O modules present and instantiates the appropriate I/O function blocks. It creates a function block for each I/O channel. It tags the function blocks and sets the contained parameters to appropriate defaults. The resource block must be set to OOS mode before you set the Autoconfigure option. If Autoconfigure is set on an existing configuration, the FP-3000 deletes all the existing blocks and linkages before creating new blocks.
FSTATE_TIME
Time (in seconds) to delay from the detection of loss of communications with the host for the output block remotes setpoint until the enaction of the fault state output.
FSTATE_VAL
The setpoint value to be used on failure. Note: The I/O option Faultstate to Value must be selected.
FSTATE_VAL_D
The discrete setpoint value to be used on failure. Note: The I/O option Faultstate to Value must be selected.
GRANT_DENY
Allows HMI applications to determine access privileges for block parameters.
Note: The device does not use this parameter to restrict parameter access itself. It is only for the benefit of host applications.
IO_OPTS
A bitmask used to adjust the way I/O blocks (AI, DI, AO, and DO) operate. The following table describes the operation bitmasks.
LOW_CUT
With an L_TYPE of Indirect Square Root, this can be used to establish a floor (in percent of scale) for values from the transducer. Values below this floor are considered to be zero. This feature must first be enabled by setting Low Cutoff in the IO_OPTS parameter.
RESTART
Allows the user to restart the device remotely. The table below lists restart values.
SET_FSTATE
Allows the user to set the device faultstate to active. This, in turn, forces all output blocks into their own faultstate behavior.
SHED_OPT
Controls the way blocks enter mode shedding. Each option listed below has a companion No Return option. The No Return shedding options change the target mode of the device to the shed mode and prevent the device from re-entering RCas or ROut mode after the shed condition has ended. The table below lists shed conditions. Refer to the article on Mode Shedding for more information.
SIMULATE
Used to bypass the physical I/O channel and allow the block to operate normally, using a simulated I/O channel. For this feature to be enabled on an FP-3000, you must set a switch on the back of the device. To see how to configure the switch, refer to the FP-3000 User Manual.
SIMULATE_D
Used to bypass the physical I/O channel and allow the block to operate normally, using a simulated discrete I/O channel. For this feature to be enabled on an FP-3000, you must set a switch on the back of the device. To see how to configure the switch, refer to the FP-3000 User Manual.
SP_HI_LIM
The upper limit on an operator-entered setpoint for the block. If the operator enters a setpoint that exceeds this value, the setpoint is considered to be SP_HI_LIM with a status that indicates that it is limited.
SP_LO_LIM
The lower limit on an operator-entered setpoint of the block. If the operator enters a setpoint is below this value, the setpoint is considered to be SP_LO_LIM with a status that indicates that it is limited.
SP_RATE_DN
In Auto mode, the rate, in PV units per second, the setpoint can be moved downwards. If the setpoint moves faster than SP_RATE_DN, the block acts as if the setpoint is moving downwards at the maximum rate with a status bit that indicates that it is limited. If set to zero, the set point is used immediately.
SP_RATE_UP
In Auto mode, the rate, in PV units per second, the setpoint can be moved upwards. If the setpoint moves faster than SP_RATE_UP, the block acts as if the setpoint is moving upwards at the maximum rate with a status bit that indicates that it is limited. If set to zero, the set point is used immediately.
STATUS_OPTS
A collection of options that affects the status behavior of the block. The table below lists the status options.
WRITE_LOCK
The software write lock for the device. When this is set to true, writes to all configuration parameters of all blocks are disallowed. The WRITE_ALM block alarm is active when writes are allowed and clear when they are disallowed.
WRITE_PRI
The priority of the write alarm.
Related Links:
FieldPoint FP-3000 Network Module User Manual
Parameters
BLOCK_RESET (FP-3000 Specific)
This parameter is specific to the National Instruments FP-3000 device. It lets you reset the statistics or the configuration of an individual function block.
Table 1. Block Reset Options
Option | Description |
| Contained Parameters | Sets all the contained parameters (standard and FP-3000 specific) of the function block to default values. This is useful to set a specific block to a known state without affecting the behavior of the other blocks in the FP-3000. The block should be in OOS mode to reset the contained parameters. |
| Statistics | Resets the various statistics counts associated with the block. |
CFG_OPTS (FP-3000 Specific)
This parameter is specific to the National Instruments FP-3000 device. An option in the I/O function blocks to automatically set the scaling or alter the block behavior.
Table 2. Configuration Options
Option | Description |
| Automatically Adjust XD_SCALE | Enabling this option allows the block to automatically determine its XD_SCALE parameter, based on the physical I/O channel range, which is set by parameters such as FP_AI_100 range. |
| Ignore Unconnected Interlock Inputs | By default, all interlock inputs on the CDO block must be good, or the block enters fault state. Enabling this option allows inputs with a status of Bad::Not_Connected to be ignored. |
CLR_FSTATE
Writing Clear to this parameter causes the device-wide faultstate to be cleared and output blocks to resume normal execution. Also see SET_FSTATE and FAULT_STATE parameters.
CONTROL_OPTS
A list of options used to adjust the way control blocks, such as the PID block, operate. The options are described in the following table.
Table 3. Control Options
Options | Description |
| Bypass Enable | If set, allows you to set the BYPASS parameter and bypass the algorithm’s control. |
| SP-PV Track in Man | Causes the setpoint to track the process variable in Man. |
| SP-PV Track in ROut | Causes the setpoint to track the process variable in ROut. |
| SP-PV Track in LO or IMan | Causes the setpoint to track the process variable in LO or IMan. |
| SP Track Retained Target | Causes the setpoint to track the input value of the retained target of the block. The retained target of the block is the lowest priority mode set in the target mode field of the MODE_BLK parameter of the block. For example, if the RCas bit is set in the target mode, the setpoint tracks RCAS_IN. |
| Direct Acting | Defines the relationship between changes to the PV and changes to the output. When set, an increase in the process variable causes the output value to be increased. When clear, an increase in the process variable causes the output value to be decreased. |
| Track Enable | Enables external tracking. If Track Enable is true, and TRK_IN_D is true, TRK_VAL overwrites the value at the output of the block except when Man is the target mode. |
| Track in Manual | This enables tracking in Manual mode. |
| Use PV for BKCAL_OUT | When set, this uses the process variable as the value for BKCAL_OUT, instead of the setpoint. |
| Obey SP Limits if Cas or RCas | When set, this confines the setpoint to values within SP_HI_LIM and SP_LO_LIM, even when the setpoint comes from another function block. |
| No OUT Limits in Man | Unused in FieldPoint. |
DEV_OPTS (FP-3000 Specific)
This parameter is specific to the National Instruments FP-3000 device. A list of device-wide options that can be turned on and off at will. The current firmware supports only one option.
Table 4. Device Options
Option | Description |
| Disable CFG_OPTS in all I/O blocks | This bit disables all block configuration options in CFG_OPTS. It is not recommended that this bit be set since the additional behavior can make configuration easier. |
EVENT_FILTER (FP-3000 Specific)
This parameter is specific to the National Instruments FP-3000 device. It restricts the entries shown in the log of the Log Block. The values are a combination of: Configuration Error, Operational Warning, and Operational Error
FAULT_STATE
The current status of the device faultstate. It can be set and cleared with SET_FSTATE and CLR_FSTATE. If it is set, all output blocks in the device initiate their own faultstate behavior.
FEATURE_SEL/FEATURES
The FEATURES parameter lists features supported by the device. Use the FEATURE_SEL parameter to manually enable and disable the supported features listed in the FEATURES parameter. The features are listed in the table below.
Table 5. Feature Parameter Options
Option | Description |
| Unicode | The device supports strings in Unicode format. The FP-3000 does not support this feature. |
| Reports | The device supports event report messages for alarming. If this feature is not selected in the FEATURE_SEL parameter, the FP-3000 continues to detect alarms and events, but does not report them over the bus. In this case, the host must poll the alarm parameters to detect alarm conditions as they change. |
| Faultstate | The device supports Faultstate behavior for output blocks. |
| Soft Write Lock | The device supports locking of configuration of parameters with the WRITE_LOCK parameter in the resource block. With this feature selected and the WRITE_LOCK parameter written to “set,” writes to all static configuration parameters are disallowed. |
| Hard Write Lock | The device supports locking of configuration parameters. For the FP-3000, a switch on the back of the device must also be set. If Hard Write Lock is enabled, the switch disallows writes to all configuration parameters in the device, including FEATURE_SEL. |
| Out Readback | The device provides a way for the action of output transducers to be verified through a readback. The FP-3000 does not support this feature. |
| Direct Write | The device provides a manufacturer-specific way to directly write to I/O channels. The FP-3000 does not support this feature. |
FP_AUTOCONFIGURE (FP-3000 Specific)
This parameter is specific to the National Instruments FP-3000 device. This parameter, present in the resource block, causes the FP-3000 to automatically configure itself. The FP-3000 detects all the I/O modules present and instantiates the appropriate I/O function blocks. It creates a function block for each I/O channel. It tags the function blocks and sets the contained parameters to appropriate defaults. The resource block must be set to OOS mode before you set the Autoconfigure option. If Autoconfigure is set on an existing configuration, the FP-3000 deletes all the existing blocks and linkages before creating new blocks.
FSTATE_TIME
Time (in seconds) to delay from the detection of loss of communications with the host for the output block remotes setpoint until the enaction of the fault state output.
FSTATE_VAL
The setpoint value to be used on failure. Note: The I/O option Faultstate to Value must be selected.
FSTATE_VAL_D
The discrete setpoint value to be used on failure. Note: The I/O option Faultstate to Value must be selected.
GRANT_DENY
Allows HMI applications to determine access privileges for block parameters.
Note: The device does not use this parameter to restrict parameter access itself. It is only for the benefit of host applications.
IO_OPTS
A bitmask used to adjust the way I/O blocks (AI, DI, AO, and DO) operate. The following table describes the operation bitmasks.
Table 6. Operation Bitmasks
Bitmask | Description |
| Invert | In discrete blocks, this maps a physical state of Discret_State_0 to Discret_State_1 and maps every other physical transducer state to Discret_State_0. |
| SP-PV Track in Man | Causes the setpoint to track the process variable in Man. |
| SP-PV Track in LO or IMan | Causes the setpoint to track the process variable in LO or IMan. |
| SP Track Retained Target | Causes the setpoint to track the input value of the retained target of the block. The retained target of the block is the lowest priority mode set in the target mode field of the MODE_BLK parameter of the block. For example, if the RCas bit is set in the target mode, the setpoint tracks RCAS_IN. For a list of modes in priority order, see the article on Mode Shedding. |
| Increase to Close | Remaps the block’s scaling so that as the input increases, the output decreases. |
| Faultstate to Value | When set, the block’s faultstate behavior sets the output value to the value in FSTATE_VAL. When clear, the block’s faultstate behavior leaves the output value at its current setting. |
| Use Faultstate Value on Restart | When set, causes the output value of output blocks to go to faultstate value immediately after a device restart. When clear, uses the value in nonvolatile memory. |
| Target to Man if Faultstate Active | When set, this sets the target mode of the block to manual mode when faultstate goes active. |
| Use PV for BKCAL_OUT | When set, this uses the process variable as the value for BKCAL_OUT, instead of the setpoint. |
| Low Cutoff | When set, this enables the AI low cutoff parameter. |
LOW_CUT
With an L_TYPE of Indirect Square Root, this can be used to establish a floor (in percent of scale) for values from the transducer. Values below this floor are considered to be zero. This feature must first be enabled by setting Low Cutoff in the IO_OPTS parameter.
RESTART
Allows the user to restart the device remotely. The table below lists restart values.
Table 7. Restart Values
Value | Behavior |
| Restart Resource | Restarts the device. |
| Restart to Defaults | Restarts the device, restoring all parameter values to default values. |
| Restart Processor | Restarts the device as if the power was cycled. |
SET_FSTATE
Allows the user to set the device faultstate to active. This, in turn, forces all output blocks into their own faultstate behavior.
SHED_OPT
Controls the way blocks enter mode shedding. Each option listed below has a companion No Return option. The No Return shedding options change the target mode of the device to the shed mode and prevent the device from re-entering RCas or ROut mode after the shed condition has ended. The table below lists shed conditions. Refer to the article on Mode Shedding for more information.
Table 8. Shed Conditions
Shed Mode | Behavior |
| Normal Shed | The block sheds into the next higher priority mode set in the permitted mode field of MODE_BLK. |
| Shed to Auto | The block sheds into automatic mode. |
| Shed to Manual | The block sheds into manual mode. |
| Shed to Retained | The block sheds to the next higher priority mode set in the target mode field of MODE_BLK. |
SIMULATE
Used to bypass the physical I/O channel and allow the block to operate normally, using a simulated I/O channel. For this feature to be enabled on an FP-3000, you must set a switch on the back of the device. To see how to configure the switch, refer to the FP-3000 User Manual.
SIMULATE_D
Used to bypass the physical I/O channel and allow the block to operate normally, using a simulated discrete I/O channel. For this feature to be enabled on an FP-3000, you must set a switch on the back of the device. To see how to configure the switch, refer to the FP-3000 User Manual.
SP_HI_LIM
The upper limit on an operator-entered setpoint for the block. If the operator enters a setpoint that exceeds this value, the setpoint is considered to be SP_HI_LIM with a status that indicates that it is limited.
SP_LO_LIM
The lower limit on an operator-entered setpoint of the block. If the operator enters a setpoint is below this value, the setpoint is considered to be SP_LO_LIM with a status that indicates that it is limited.
SP_RATE_DN
In Auto mode, the rate, in PV units per second, the setpoint can be moved downwards. If the setpoint moves faster than SP_RATE_DN, the block acts as if the setpoint is moving downwards at the maximum rate with a status bit that indicates that it is limited. If set to zero, the set point is used immediately.
SP_RATE_UP
In Auto mode, the rate, in PV units per second, the setpoint can be moved upwards. If the setpoint moves faster than SP_RATE_UP, the block acts as if the setpoint is moving upwards at the maximum rate with a status bit that indicates that it is limited. If set to zero, the set point is used immediately.
STATUS_OPTS
A collection of options that affects the status behavior of the block. The table below lists the status options.
Table 9. Status Options
Option | Meaning |
| IFS if Bad IN | Set the status of the block output to initiate faultstate if the IN parameter goes bad. |
| IFS if Bad CAS_IN | Set the status of the block output to initiate faultstate if the CAS_IN parameter goes bad. |
| Use Uncertain as Good | If set, blocks will treat the Uncertain status on an input parameter as if it were a Good status. If clear, Uncertain status is treated as Bad. |
| Propagate Failure Forward | If the status of the IN parameter of the block is Bad::Device_Failure or Bad::Sensor_Failure, the failure will be propagated to the OUT parameter. No alarm will be generated. |
| Propagate Failure Backward | If the status at BKCAL_IN or from the physical I/O channel is bad, the failure will be propagated to the BKCAL_OUT parameter. No alarm will be generated. |
| Target to Manual if Bad IN | Set the target mode of the block to Man if the IN parameter has a bad status. |
| Uncertain if Limited | For input or calculation blocks, the output status will be set to Uncertain if the transducer or calculated value is limited (i.e., at its high or low limit). |
| Bad if Limited | Set the output status to Bad if the transducer value is limited (i.e., at its high or low limit). |
| Uncertain if Manual Mode | Set the output status to Uncertain if the block is in Man mode. |
| Do Not Select if Not Auto Mode | Set the output status to Do Not Select if the block is not in an actual mode of Auto, CAS, or RCas and not initializing. This is useful for blocks upstream of the selector block. |
| Do Not Select if Not Cas Mode | Set the output status to Do Not Select if the block is not in an actual mode of CAS or RCas and is not initializing. This is useful for blocks connected to a selector block. |
WRITE_LOCK
The software write lock for the device. When this is set to true, writes to all configuration parameters of all blocks are disallowed. The WRITE_ALM block alarm is active when writes are allowed and clear when they are disallowed.
WRITE_PRI
The priority of the write alarm.
Related Links:
FieldPoint FP-3000 Network Module User Manual
Reader Comments | Submit a comment »
Legal
This tutorial (this "tutorial") was developed by National Instruments ("NI"). Although technical support of this tutorial may be made available by National Instruments, the content in this tutorial may not be completely tested and verified, and NI does not guarantee its quality in any way or that NI will continue to support this content with each new revision of related products and drivers. THIS TUTORIAL IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND AND SUBJECT TO CERTAIN RESTRICTIONS AS MORE SPECIFICALLY SET FORTH IN NI.COM'S TERMS OF USE (http://ni.com/legal/termsofuse/unitedstates/us/).