observation

Lexicon: eco.wonderland.workcell.observation.defs
Type: object

Abstract entity that provides telemetry data for a dataItem at a point in time.

Properties

compositionId

Type: string

Identifier of the composition entity defined in the devices response associated with the data reported for the observation.

dataItemId

Type: string
Required

Unique identifier of the dataItem associated with this observation. dataItemId MUST match the associated id defined in the devices response.

name

Type: string

Name of the dataItem associated with this observation. name MUST match the associated name defined in the devices response.

sequence

Type: uint64
Required

Number representing the sequential position of an occurrence of an observation in the data buffer of an agent. sequence MUST have a value represented as an unsigned 64-bit value from 1 to $$ 2^{64}-1 $$.

subType

Type: dataItemSubType

Subtype of the dataItem associated with this observation. subType MUST match the associated subType defined in the devices response.

timestamp

Type: timestamp
Required

Most accurate time available to a piece of equipment that represents the point in time that the data reported was measured.

type

Type: dataItemType
Required

Type of the dataItem associated with this observation. type MUST match the associated type defined in the devices response.

units

Type: unit

Units of the dataItem associated with this observation. units MUST match the associated units defined in the devices response.

isUnavailable

Type: boolean
Required

value

Type: string

Observation of the observation entity. The default value type is string.

Referenced By

• observations eco.wonderland.workcell.observation.defs

Schema

{
  "type": "object",
  "required": [
    "dataItemId",
    "sequence",
    "timestamp",
    "type",
    "isUnavailable"
  ],
  "properties": {
    "compositionId": {
      "type": "string"
    },
    "dataItemId": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "sequence": {
      "type": "integer"
    },
    "subType": {
      "type": "ref",
      "ref": "lex:eco.wonderland.workcell.common.data.defs#dataItemSubType"
    },
    "timestamp": {
      "type": "string",
      "format": "datetime"
    },
    "type": {
      "type": "ref",
      "ref": "lex:eco.wonderland.workcell.common.data.defs#dataItemType"
    },
    "units": {
      "type": "ref",
      "ref": "lex:eco.wonderland.workcell.common.data.defs#unit"
    },
    "isUnavailable": {
      "type": "boolean"
    },
    "value": {
      "type": "string"
    }
  }
}