Telemetries Data

The Telemetry and KPIs suites allow the exploitation of multiple calls to retrieve the telemetry data of interest, both at plant and/or single device level.

The APIs within these suites are divided, based on data modeling and presentation, into two main types:

  • AGGREGATED: allows to call the desired type of data (dataType) with an aggregation criterion (valueType) within a defined time window (startDate & endDate). Calls of this type always return a single value, aggregated according to the defined queryParameters;
  • TIMESERIES: allows to call the desired type of data (dataType) with an aggregation criterion (valueType) within a defined time window (startDate & endDate) and according to a defined sampling frequency (sampleTime). Calls of this type always return an array of values, the length of which varies based on the defined queryParameters.

For the development of a transparent and fully integrated third party business logic, it is important to take into account some key principles on the manipulation and presentation of data from Aurora Vision:

Sampling
Time

Aurora Vision performs a store of samples sent at minimum every 5 minutes, it is therefore not possible to request data below a sampling rate of 5 minutes.

Power
Data

All power telemetries (for any compatible device) are provided as a single on-time value, which changes from one sampling instant to another.

Energy
Data

All energy telemetries (for any compatible device) are provided as cumulative over time, from the first moment in which the compatible device began to effectively work.

With these concepts, it is possible to analyze in detail the two main types of telemetry calls:

  • On Page 2 you can find a detailed analysis of the Aggregated APIs;
  • On Page 3 you can find a detailed analysis of the Timeseries APIs.

Since the Telemetry and KPIs suites provide many dataTypes that can be called, a complete table with description for each of them is available at Page 4.