Index | Prev | Next
VYKON Pro - RollingAvg
The RollingAvg component is used to calculate a rolling average of the input slot value. The RollingAvg
component is located in the vykonPro palette under the hvac sub folder.
The component executes at a frequency configured by the Sample Rate property. When the component executes, it reads
the current Input slot value and stores the value in an array. The array size is configured using the Sample Count property.
When the array is full, new values push the oldest value out of the array.
During each execution the component calculates the deviation betwen the consecutive records in the array and updates
the Average Deviation and Maximum Deviation slots with the calculated values. The component also calculates the average
value of all values in the array and updates the Output slot value. The component excludes any infinite or NaN value
and any null statuses from the calculations.
Figure - Rolling Avg Example
Properties
- Facets - The user configurable facets assigned to the Input and Out slots.
- Proxy Ext - Standard null proxy ext.
- Out - The rolling average result calculated from the input slot value.
- Input - Status Numeric input slot. This slot value is used to calculate a rolling average result which
is stored as the Out slot value.
- Propagate Flags - BStatus property which configures the status bits from the input which are
propagated to the out slot.
- Deviation Facets - The user configurable facets assigned to the Average Deviation and Maximum Deviation
slots.
- Average Deviation - The average of the deviation between each value in the array.
- Maximum Deviation - The maximum deviation between any two consecutive values in the array.
- In Service - User configurable boolean property which indicates whether this reading should be
considered in service by a RollingAvgMaster components in the station. If the reading is not "in service" the
RollingAvgMaster will ignore the component's value.
- Master Selected - Readonly boolean property which indicates whether this component is selected by
a RollingAvgMaster component in the station.
- Sample Count - The desired number of samples to use when calculating the rolling average.
- Sample Rate - The desired rate at which the component executes to update slot values.
Actions
- Reset - Operator action when invoked clears the array and updates the components slot values.
Index | Prev | Next