zdimension

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

Z-dimension

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: sample
Default: z-dimension
Required

units

Type: unit
Default: millimeter
Required

isUnavailable

Type: boolean
Required

value

Type: binary32

duration

Type: binary32

Time-period over which the data was collected. duration MUST be provided when the statistic is defined in the devices response.

resetTriggered

Type: resetTriggered

Identifies when a reported value has been reset and what has caused that reset to occur for those dataItem entities that may be periodically reset to an initial value. resetTriggered MUST only be provided for the specific occurrence of a dataItem reported in the streams response when the reset occurred.

sampleRate

Type: binary32

Rate at which successive samples of the value are recorded. sampleRate is expressed in terms of samples per second. If sampleRate is smaller than one, the number can be represented as a decimal type floating-point number. For example, a rate of 1 per 10 seconds would be 0.1 sampleRate MUST be provided when representation defined in the devices response is time-series. When representation is not time-series, it MUST be assumed that the data reported is represented by a single value and sampleRate MUST NOT be reported in the streams response.

statistic

Type: statistic

Type of statistical calculation defined by the statistic defined in the devices response.

Referenced By

• observations eco.wonderland.workcell.observation.defs
• samples eco.wonderland.workcell.observation.sample.defs

Schema

{
  "type": "object",
  "required": [
    "dataItemId",
    "sequence",
    "timestamp",
    "type",
    "isUnavailable",
    "units"
  ],
  "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": "string",
      "default": "z-dimension"
    },
    "units": {
      "type": "string",
      "default": "millimeter"
    },
    "isUnavailable": {
      "type": "boolean"
    },
    "value": {
      "type": "bytes",
      "minLength": 4,
      "maxLength": 4
    },
    "duration": {
      "type": "bytes",
      "minLength": 4,
      "maxLength": 4
    },
    "resetTriggered": {
      "type": "ref",
      "ref": "lex:eco.wonderland.workcell.observation.data.defs#resetTriggered"
    },
    "sampleRate": {
      "type": "bytes",
      "minLength": 4,
      "maxLength": 4
    },
    "statistic": {
      "type": "ref",
      "ref": "lex:eco.wonderland.workcell.common.data.defs#statistic"
    }
  }
}