enclosure

Lexicon: eco.wonderland.workcell.device.system.defs
Type: object

System composed of a structure that is used to contain or isolate a piece of equipment or area. enclosure may provide information regarding access to the internal components of a piece of equipment or the conditions within the enclosure. For example, door may be defined as a lower level component or composition entity of the enclosure.

Properties

id

Type: string
Required

Unique identifier for the component.

name

Type: string

Name of the component. When provided, name MUST be unique for all child component entities of a parent component.

nativeName

Type: string

Common name associated with component.

sampleInterval

Type: binary32

Interval in milliseconds between the completion of the reading of the data associated with the component until the beginning of the next sampling of that data. This information may be used by client software applications to understand how often information from a component is expected to be refreshed. The refresh rate for data from all child component entities will be the same as for the parent component element unless specifically overridden by another sampleInterval provided for the child component.

uuid

Type: string

Universally unique identifier for the component.

description

Type: description

compositions

Type: compositions

components

Type: components

configuration

Type: configuration

dataItems

Type: dataItems

references

Type: references

coordinateSystemIdRef

Type: string

Specifies the coordinateSystem for this component and its children.

Referenced By

• components eco.wonderland.workcell.device.component.defs
• systems eco.wonderland.workcell.device.system.defs

Schema

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "nativeName": {
      "type": "string"
    },
    "sampleInterval": {
      "type": "bytes",
      "minLength": 4,
      "maxLength": 4
    },
    "uuid": {
      "type": "string"
    },
    "compositions": {
      "type": "ref",
      "ref": "lex:eco.wonderland.workcell.device.composition.defs#compositions"
    },
    "components": {
      "type": "ref",
      "ref": "lex:eco.wonderland.workcell.device.component.defs#components"
    },
    "configuration": {
      "type": "ref",
      "ref": "lex:eco.wonderland.workcell.device.configuration.defs#configuration"
    },
    "dataItems": {
      "type": "ref",
      "ref": "lex:eco.wonderland.workcell.device.data.defs#dataItems"
    },
    "references": {
      "type": "ref",
      "ref": "lex:eco.wonderland.workcell.device.reference.defs#references"
    },
    "coordinateSystemIdRef": {
      "type": "string"
    }
  }
}