Skip to content

Functions

The RTDIP SDK enables users to perform complex queries, including aggregation on datasets within the Platform. Please find below the various types of queries available for specific dataset types. These SDK Functions are also supported by the RTDIP API Docker Image.

Time Series Events

Raw

Raw facilitates performing raw extracts of time series data, typically filtered by a Tag Name or Device Name and an event time.

Latest

Latest queries provides the latest event values. The RTDIP SDK requires the following parameters to retrieve the latest event values: - TagNames - A list of tag names

Resample

Resample enables changing the frequency of time series observations. This is achieved by providing the following parameters:

  • Time Interval Rate - The time interval rate
  • Time Interval Unit - The time interval unit (second, minute, day, hour)
  • Aggregation Method - Aggregations including first, last, avg, min, max

Plot

Plot enables changing the frequency of time series observations and performing Average, Min, Max, First, Last and StdDev aggregations. This is achieved by providing the following parameters:

  • Time Interval Rate - The time interval rate
  • Time Interval Unit - The time interval unit (second, minute, day, hour)

Interpolate

Interpolate - takes resampling one step further to estimate the values of unknown data points that fall between existing, known data points. In addition to the resampling parameters, interpolation also requires:

  • Interpolation Method - Forward Fill, Backward Fill or Linear

Interpolation at Time

Interpolation at Time - works out the linear interpolation at a specific time based on the points before and after. This is achieved by providing the following parameter:

  • Timestamps - A list of timestamp or timestamps

Time Weighted Averages

Time Weighted Averages provide an unbiased average when working with irregularly sampled data. The RTDIP SDK requires the following parameters to perform time weighted average queries:

  • Time Interval Rate - The time interval rate
  • Time Interval Unit - The time interval unit (second, minute, day, hour)
  • Window Length - Adds a longer window time for the start or end of specified date to cater for edge cases
  • Step - Data points with step "enabled" or "disabled". The options for step are "true", "false" or "metadata" as string types. For "metadata", the query requires that the TagName has a step column configured correctly in the meta data table

Circular Averages

Circular Averages computes the circular average for samples in a range. The RTDIP SDK requires the following parameters to perform circular average queries:

  • Time Interval Rate - The time interval rate
  • Time Interval Unit - The time interval unit (second, minute, day, hour)
  • Lower Bound - The lower boundary for the sample range
  • Upper Bound - The upper boundary for the sample range

Circular Standard Deviations

Circular Standard Deviations computes the circular standard deviations for samples assumed to be in the range. The RTDIP SDK requires the following parameters to perform circular average queries:

  • Time Interval Rate - The time interval rate
  • Time Interval Unit - The time interval unit (second, minute, day, hour)
  • Lower Bound - The lower boundary for the sample range
  • Upper Bound - The upper boundary for the sample range

Summary

Summary computes a summary of statistics (Avg, Min, Max, Count, StDev, Sum, Variance).

Time Series Metadata

Metadata

Metadata queries provide contextual information for time series measurements and include information such as names, descriptions and units of measure.

Note

RTDIP are continuously adding more to this list so check back regularly.

Query Examples

For examples of how to use the RTDIP functions, click the following links: