tsaggregates.clients package

Submodules

tsaggregates.clients.aggregates_client module

IoT TS Aggregates API

The aggregate service enables querying aggregated time series data including:
  • Aggregates generated on the fly
  • Aggregates pre-calculated during ingest Depending on, if entity is performance or simulation entity, different aggregation intervals are supported.
Performance Entity Pre-calculated aggregates are available in the following intervals:
  • 2 minute
  • 1 hour
  • 1 day
  • Intervals smaller than 2 minutes are also available and generated on the fly.
Simulation Entity Pre-calculated aggregates are available in the following intervals:
  • 1 millisecond
  • 10 millisecond
  • 1 second
  • On the fly aggregation is not supported for simulation entities.
Note: There might be time series data ingested in the past for which pre-calculated aggregates have not been computed. In that case for simulation entities, no aggregated data is returned.
class AggregatesClient(rest_client_config=None, mindsphere_credentials=None)[source]

Bases: object

get_aggregate_timeseries(request_object)[source]

read aggregated time series

Read time series data aggregated over a certain interval for a single entity and propertyset within the provided time range.

Parameters:request_object (GetAggregateTimeseriesRequest) – It contains the below parameters –>
( entity* - Unique identifier of the entity. ),
( propertyset* - Name of the propertyset. ),
( from* - Beginning of the time range to read. ),
( to* - End of the time range to read. ),
( intervalValue* - Interval duration for the aggregates in intervalUnits. ),
( intervalUnit* - Interval duration unit for the aggregates. ),
( select - Properties and fields to select. By default all properties and the availale fields are returned. Providing a property name selects all fields of a property. A property name followed by a ‘.’ and field name selects a specific field of a property. )
Returns:list[Aggregates]

Module contents