agent

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

Device composed of an Agent and all its connected data sources. An agent MUST be provided by all Agent implementations. An agent MUST provide notifications when devices are added or changed. An agent MUST provide connection information for each data source currently supplying data to the Agent. An agent MAY provide information about telemetry relating to data sources. An agent MAY provide information about the Agent resource utilization.

Properties

id

Type: string
Required

Unique identifier for the component.

name

Type: string
Required

Name of an element or a piece of equipment.

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
Required

Universally unique identifier for the element.

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.

auxiliaries

Type: auxiliaries

controllers

Type: controllers

interfaces

Type: interfaces

resources

Type: resources

structures

Type: structures

version

Type: string

Version of the device information used to configure the information to be published for a piece of equipment in an response.

systems

Type: systems

axes

Type: axes

adapters

Type: adapters

hash

Type: string

Condensed message digest from a secure one-way hash function. FIPS PUB 180-4

Referenced By

• mtConnectDevices eco.wonderland.workcell.protocol.mtconnect.device.defs
• mtConnectDevices eco.wonderland.workcell.probe
• components eco.wonderland.workcell.device.component.defs

Schema

{
  "type": "object",
  "required": [
    "id",
    "uuid",
    "name"
  ],
  "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"
    },
    "auxiliaries": {
      "type": "ref",
      "ref": "lex:eco.wonderland.workcell.device.auxiliary.defs#auxiliaries"
    },
    "controllers": {
      "type": "ref",
      "ref": "lex:eco.wonderland.workcell.device.controller.defs#controllers"
    },
    "interfaces": {
      "type": "ref",
      "ref": "lex:eco.wonderland.workcell.device.interface.defs#interfaces"
    },
    "resources": {
      "type": "ref",
      "ref": "lex:eco.wonderland.workcell.device.resource.defs#resources"
    },
    "structures": {
      "type": "ref",
      "ref": "lex:eco.wonderland.workcell.device.structure.defs#structures"
    },
    "version": {
      "type": "string"
    },
    "systems": {
      "type": "ref",
      "ref": "lex:eco.wonderland.workcell.device.system.defs#systems"
    },
    "axes": {
      "type": "ref",
      "ref": "lex:eco.wonderland.workcell.device.axis.defs#axes"
    },
    "adapters": {
      "type": "ref",
      "ref": "lex:eco.wonderland.workcell.device.adapter.defs#adapters"
    },
    "hash": {
      "type": "string"
    }
  }
}