Skip to main content

Information model and API

Channels#

Channels endpoints allow to set up signals data in the system.

signals

Channel object#

The information contained in a Channel object.

  • Channel number (unique id)
  • Asset References (*)
    • main system
      • id (*)
      • name
      • design object
    • plant linked to main system
  • Aggregation parameters for the channel
    • Aggregation calculation method (Calculation method of statistical data. Allowed values: UNSPECIFIED | TRUE_RMS | PEAK_FUNDAMENTAL | RMS_FUNDAMENTAL | MIN | MAX | AVG | SDV | PREDICTION | RATE)
    • Aggregation period (number of units to consider to calculate the calculation interval duration)
    • Calculation mode (Calculation mode of statistical data. Allowed values: TOTAL | PERIOD | SLIDING)
    • Calculation interval type (Calculation interval of statistical data. Allowed values: MS, PER-CYCLE, CYCLE, DAY, WEEK, MONTH, YEAR)
  • Measurement unit (according to SI Unit)
  • Measurand (*)
  • Object Owner Id (object owner of main system)

Asset References#

assetReferences is a way to link channel to a specific asset and is a required field. 

  "assetReferences": {    "mainSystem": {      "id": "769f8f43-3828-412d-a974-747da17fb647",      "name": "Main System",      "designObject": {        "designId": "eb19f142-9887-42f2-9ee8-5466e609cea16",        "designVersion": 2,        "designObjectId": "ee2a4cac-ffc8-47ea-ab34-5cf921478a4d",        "designObjectName": "Design Object"      },      "plant": {        "id": "50380bb2-2fb2-4f5e-9e70-85188d429d3d",        "name": "Plant"      }    }  }

For referencing channel to an asset user must specify main system id. User also can reference a channel to designation. For it the user needs to specify the design object id, which has a specified main system. The design id, the design version, the plant id and the plant name fields should be inherited automatically from the specified main system.

Signals#

Once channels are configured in AIH, the corresponding signals data can be uploaded and retrieved from the system.

signals

Signal Object#

The information contained in a Signal object.

  • Channel number (the identifier for a channel which the signal belongs to)
  • Measurement (the magnitude of the measurement)
  • Timestamp (seconds since epoch)
  • Fractions of second (default is 0, if the information is not available)
  • Timestamp quality (binary value encoded as a number. Default value will be defined for when information is not available)
  • Quality (binary value encoded as a number. Default value will be defined for when information is not available)
  • Angle (required only with complex measured values, the angle of the measurement)