materialRetractResponse

Lexicon: eco.wonderland.workcell.interface.interaction.defs
Type: object

Operating state of the response to a request to remove or retract material or product.

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
Default: 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: interfaceEvent
Default: material-retract
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: responseState

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.

Referenced By

• events eco.wonderland.workcell.observation.event.defs
• 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": "string",
      "default": "response"
    },
    "timestamp": {
      "type": "string",
      "format": "datetime"
    },
    "type": {
      "type": "string",
      "default": "material-retract"
    },
    "units": {
      "type": "ref",
      "ref": "lex:eco.wonderland.workcell.common.data.defs#unit"
    },
    "isUnavailable": {
      "type": "boolean"
    },
    "value": {
      "type": "ref",
      "ref": "lex:eco.wonderland.workcell.interface.data.defs#responseState"
    },
    "resetTriggered": {
      "type": "ref",
      "ref": "lex:eco.wonderland.workcell.observation.data.defs#resetTriggered"
    }
  }
}