Package com.inductiveautomation.gateway.tags.history.simulator

Class SimulatorHistorianProvider

  • All Implemented Interfaces:
    AnnotationQueryProvider, TagHistoryProvider, TagHistoryQueryInterface
    public class SimulatorHistorianProvider
extends java.lang.Object
implements TagHistoryProvider
    The simulator historian provider offers simple simulation functions that are guaranteed to be repeatable for a given path and timeframe. All of the different parameters are encoded in the tag path.

    Path syntax:

    function_periodTime_amplitude_resolutionTime

    *Note: “Realistic” only uses period. It is not currently possible to change the amplitude, and resolution is calculated automatically.

    Functions Ramp - From 0 to Amplitude across the period, restarts at 0 for next cycle. Sine, Cos - Standard Sine and Cosine functions Square - 50% off, 50% on (at amplitude) across period Realistic - 400 random but somewhat realistic data points that repeat each period.

    Time Parameters Period - How often the data sequence starts over Resolution - How often a raw data point is generated.

    For example, if a Ramp has a period of 10 seconds, a resolution of 1 second, and an amplitude of 10, you would get a point incrementing by 1 each second, repeating every 10 seconds.

    Syntax Time units are specified as numbers with a unit qualifier: Ms - milliseconds S - seconds M - minutes H - hours D - day

    Examples: Ramp_60s_100_1s - Ramp 0 to 100, repeat every 60 seconds, publish every second. Sine_1d_10_5m - Sine with amplitude of 10, repeats every day, raw value every 5 minute. Square_1m_1000_500ms - Square wave with 1 minute period generating values ever 500ms.