Adapter Commands

There are a number of commands that can be sent as part of the adapter stream. These change some dynamic elements of the device information, the interpretation of the data, or the associated default device. Commands are given on a single line starting with an asterisk * as the first character of the line and followed by a : . They are as follows:

Specify the Adapter Software Version the adapter supports:

* adapterVersion: <version>

Set the calibration in the device component of the associated device:

* calibration: XXX

Tell the agent that the data coming from this adapter requires conversion:

* conversionRequired: <yes|no>

Specify the default device for this adapter. The device can be specified as either the device name or UUID:

* device: <uuid|name>

Set the description in the device header of the associated device:

* description: XXX

Set the manufacturer in the device header of the associated device:

* manufacturer: XXX

Specify the MTConnect Version the adapter supports:

* mtconnectVersion: <version>

Set the nativeName in the device component of the associated device:

* nativeName: XXX

Tell the agent that the data coming from this adapter would like real-time priority:

* realTime: <yes|no>

Tell the agent that the data coming from this adapter is specified in relative time:

* relativeTime: <yes|no>

Set the serialNumber in the device header of the associated device:

* serialNumber: XXX

Specify the version of the SHDR protocol delivered by the adapter. See ShdrVersion above:

* shdrVersion: <version>

Set the station in the device header of the associated device:

* station: XXX

Set the device model of the associated device:
* deviceModel: --multiline--AAAAA\n<XML Fragment>\n--multiline--AAAAA
    Note: The XML is expected to be an XML fragment of the <Device /> intended to be injected into the local device configuration.
    WARNING: If the device configuration is empty, this SHDR command MUST be issued before other commands such as * mtconnectVersion or * device. The only exception is if a device is appropriately defined in the local device configuration before the Agent connectes to an adapter.

Any other command will be logged as a warning.