Index | Prev | Next
VYKON Pro - RollingAvgMaster
The RollingAvgMaster component is used to calculate an average of the configured input slot values. The RollingAvg
component is located in the vykonPro palette under the hvac sub folder.
Inputs are defined using BOrd property slots whose names are determined by the Input Slot Name property value. Each
BOrd property must map to a BRollingAvg component in the station. During execution the component evaluates all
inputs to determine their validity. Inputs are considered invalid if any of the below conditions exist.
- The In Service property is false
- The out slot value is NaN
- The out slot status includes the alarm bit and the RollingAvgMaster Ignore In Alarm property is true
- The out slot status includes the fault bit and the RollingAvgMaster Ignore In Fault property is true
Mode
The component functions in one of three modes.
- Single Input - The Single Input Select property selects the primary input to be used. If the primary
input is invalid, the component uses the configured input with the lowest value as a backup. If the backup input
becomes invalid the component uses the next configured input with the lowest value. If all inputs are invalid the
out slot value is held at the last calculated value, the out slot status is set to stale and the noValidInput slot
is set to true.
- Multiple Input - The Multiple Input Select property selects one or more inputs used to calculate an
average value. If three or more inputs are configured and valid, the component calculates the standard deviation
of each input value and excludes the input with the greatest standard deviation from the average calculation. The
out slot stores the calculated average, the maximum deviation slot stores the calculated maximum deviation of the
input values and the max deviation input slot stores the name of the component referenced by the input slot with the
maximum deviation. If all inputs are invalid the out slot value is held at the last calculated value, the out slot
status is set to stale and the noValidInput slot is set to true.
- All Inputs - The component uses all valid inputs to calculate an average value. If all inputs are invalid the
out slot value is held at the last calculated value, the out slot status is set to stale and the noValidInput slot
is set to true.
Figure - Rolling Avg Master Example
Properties
- Facets - The user configurable facets assigned to the Input and Out slots.
- Proxy Ext - Standard null proxy ext.
- Out - The average result calculated from the input slot value based on configured mode.
- No Valid Input - Boolean property which indicates whether any valid inputs are availalbe for
the component to update the out slot. When true, the out slot value is held at last calculated value and
the status is stale. When false, the out slot value updates when inputs change.
- Deviation Facets - The user configurable facets assigned to the Average Deviation and Maximum Deviation
slots.
- Maximum Deviation - If mode is Multiple Input and three or more valid sensors are available, the
maximum deviation of any input.
- Maximunm Deviation Input - The name of the component referenced by the input with the maximum
deviation value.
- Config Status - Readonly BStatus property which reflects configuration issues.
- Fault Cause - Readonly string property which displays the fault cause when the Config Status has the
fault bit present.
- Mode - Enum property which configures the mode of operation as Single Input, Multiple Input or All
Inputs. This determines which inputs may be used in the average calculation.
- Propagate Flags - BStatus property which configures the status bits from the inputs which are
propagated to the out slot.
- Number Of Inputs - Configures the number of input slots (BOrd) for the component. Increasing the number
results in slots being added while decreasing the number results in slots being removed.
- Input Slot Name - The base name of the input slots.
- Single Input Select - Readonly Enum property with an assigned range matching the number and name of the input slots
on the component. The selected slot is used as the primary input when the mode is Single Input. The setSingleInput
action is used to change the property value.
- Multiple Input Select - Readonly Enum property with an assigned range matching the number and name of the input
slots on the component. The selected slots are used as primary inputs when the mode is Multiple Input. Selected
items will have the Master Selected property value set to true. The setMultipleInput action is used to change
the property value.
- Ignore In Fault - When true the component ignores any input values which have the fault status bit.
- Ignore In Alarm - When true the component ignores any input values which have the alarm status bit.
- Input X - Dynamically added BOrd slots whose names are based on the Input Slot Name property value. The
number of slots is determined by the Number Of Inputs property value. Input slots must reference BRollingAvg
components in the station.
Actions
- Set Single Input - The action dialog is populated with an enum range corresponding to the input slots
which map to RollingAvg components which have valid values at the time of invocation. Invoking this action sets the
Single Input Select property value.
- Set Multiple Input - The action dialog is populated with an enum range corresponding to the input slots
whcih map to RollingAVg components which have valid values as the time of invocation. Invoking this action sets the
Multiple Input Select property value
Index | Prev | Next