motionProgram

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

Motion-program

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: condition
Default: motion-program
Required

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.

nativeCode

Type: string

Native code is the proprietary identifier designating a specific alarm, fault or warning code provided by the piece of equipment.

nativeSeverity

Type: string

Severity information to a client software application if the piece of equipment designates a severity level to a fault.

qualifier

Type: qualifier

Additional information regarding a condition state associated with the measured value of a process variable. qualifier defines whether the condition state represented indicates a measured value that is above or below an expected value of a process variable.

statistic

Type: statistic

Statistic provides additional information describing the meaning of the condition entity. statistic MUST match the statistic defined in the devices response.

lang

Type: string

Specifies the language of the value returned for the condition. See IETF RFC 4646 (http://www.ietf.org/rfc/rfc4646.txt).

state

Type: conditionState

Condition state of the piece of equipment or component.

conditionId

Type: string
Required

Identifier of an individual condition activation provided by a piece of equipment. conditionId MUST be unique for all concurrent condition activation. conditionId MUST be maintained for all state transitions related to the same condition activation. Multiple conditionIds MAY exist for the same nativeCode. If conditionId is not given, the value is the nativeCode. If nativeCode and conditionId are not given, conditionId MUST be generated.

Referenced By

• conditions eco.wonderland.workcell.observation.condition.defs
• observations eco.wonderland.workcell.observation.defs

Schema

{
  "type": "object",
  "required": [
    "dataItemId",
    "sequence",
    "timestamp",
    "type",
    "isUnavailable",
    "conditionId"
  ],
  "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": "motion-program"
    },
    "units": {
      "type": "ref",
      "ref": "lex:eco.wonderland.workcell.common.data.defs#unit"
    },
    "isUnavailable": {
      "type": "boolean"
    },
    "value": {
      "type": "string"
    },
    "nativeCode": {
      "type": "string"
    },
    "nativeSeverity": {
      "type": "string"
    },
    "qualifier": {
      "type": "ref",
      "ref": "lex:eco.wonderland.workcell.observation.data.defs#qualifier"
    },
    "statistic": {
      "type": "ref",
      "ref": "lex:eco.wonderland.workcell.common.data.defs#statistic"
    },
    "lang": {
      "type": "string"
    },
    "state": {
      "type": "ref",
      "ref": "lex:eco.wonderland.workcell.observation.data.defs#conditionState"
    },
    "conditionId": {
      "type": "string"
    }
  }
}