header

Lexicon: eco.wonderland.workcell.protocol.mtconnect.stream.defs
Type: object

Provides information from an agent defining version information, storage capacity, and parameters associated with the data management within the agent.

Properties

firstSequence

Type: uint64
Required

Sequence number assigned to the oldest piece of streaming data stored in the buffer of the agent immediately prior to the time that the agent published the response document.

lastSequence

Type: uint64
Required

Sequence number assigned to the last piece of streaming data that was added to the buffer of the agent immediately prior to the time that the agent published the response document.

nextSequence

Type: uint64
Required

Sequence number of the piece of streaming data that is the next piece of data to be retrieved from the buffer of the agent that was not included in the response document published by the agent. If the streaming data included in the response document includes the last piece of data stored in the buffer of the agent at the time that the document was published, then the value reported for nextSequence MUST be equal to lastSequence + 1.

version

Type: string
Required

Major, minor, and revision number that defines the semantic data model that represents the content of the response document.

testIndicator

Type: boolean

Indicates whether the agent that published the response document is operating in a test mode. If testIndicator is not specified, the value for testIndicator MUST be interpreted to be false.

sender

Type: string
Required

Identification defining where the agent that published the response document is installed or hosted. sender MUST be either an IP Address or Hostname describing where the agent is installed or the URL of the agent; e.g., http://<address>[:port]/.

Note: The port number need not be specified if it is the default HTTP port 80.

instanceId

Type: uint64
Required

Identifier for a specific instantiation of the buffer associated with the agent that published the response document. instanceId MUST be changed to a different unique number each time the buffer is cleared and a new set of data begins to be collected.

creationTime

Type: timestamp
Required

Timestamp that an agent published the response document.

bufferSize

Type: uint32
Required

Maximum number of DataItem that MAY be retained in the agent that published the response document at any point in time.

Note 1 to entry: bufferSize represents the maximum number of sequence numbers that MAY be stored in the agent. Note 2 to entry: The implementer is responsible for allocating the appropriate amount of storage capacity required to accommodate the bufferSize.

deviceModelChangeTime

Type: timestamp
Required

Timestamp of the last update of the device information for any device.

Referenced By

• mtConnectStreamsExceptionsReport eco.wonderland.workcell.protocol.mtconnect.exception.defs
• mtConnectStreams eco.wonderland.workcell.protocol.mtconnect.stream.defs
• mtConnectStreams eco.wonderland.workcell.sample
• mtConnectStreamsExceptionsReport eco.wonderland.workcell.sample
• mtConnectStreams eco.wonderland.workcell.current
• mtConnectStreamsExceptionsReport eco.wonderland.workcell.current

Schema

{
  "type": "object",
  "required": [
    "firstSequence",
    "lastSequence",
    "nextSequence",
    "version",
    "sender",
    "instanceId",
    "creationTime",
    "bufferSize",
    "deviceModelChangeTime"
  ],
  "properties": {
    "firstSequence": {
      "type": "integer"
    },
    "lastSequence": {
      "type": "integer"
    },
    "nextSequence": {
      "type": "integer"
    },
    "version": {
      "type": "string"
    },
    "testIndicator": {
      "type": "boolean"
    },
    "sender": {
      "type": "string"
    },
    "instanceId": {
      "type": "integer"
    },
    "creationTime": {
      "type": "string",
      "format": "datetime"
    },
    "bufferSize": {
      "type": "integer"
    },
    "deviceModelChangeTime": {
      "type": "string",
      "format": "datetime"
    }
  }
}