The ShdrAdapterClient class handles the TCP connection to read from the Adapter and add data to an IMTConnectAgent class.

Usage

There are several different ways to setup and add data to the ShdrAdapter

ShdrAdapter

The example below creates a new ShdrAdapter. The added DataItem will be sent using the "adapter.SendChanged()" method

SHDR Output

ShdrAdapter (specific Port)

The example below creates a new ShdrAdapter on the 7980 TCP Port.

ShdrAdapter (specific Device)

The example below creates a new ShdrAdapter for the "OKUMA-Lathe" device. The added DataItem will be sent using the "adapter.SendChanged()" method

SHDR Output

ShdrAdapter (specific Device and Port)

The example below creates a new ShdrAdapter for the "OKUMA-Lathe" device on the 7980 TCP Port.

ShdrIntervalAdapter

The example below creates a new ShdrIntervalAdapter and sets the Interval to 500ms. Only the most recent DataItem with the ID = "L2estop" will be sent after 500ms has elapsed.

SHDR Output

ShdrQueueAdapter

The example below creates a new ShdrQueueAdapter. All of the added DataItems will be sent using the "adapter.SendBuffer()" method

SHDR Output

ShdrIntervalQueueAdapter

The example below creates a new ShdrIntervalQueueAdapter and sets the Interval to 500ms. All of the added DataItems will be sent after 500ms has elapsed.

SHDR Output

Configuration

• Id - Get a unique identifier for the Adapter

• DeviceKey - The Name or UUID of the Device to create a connection for

• Port - The TCP Port used for communication

• Heartbeat - The heartbeat used to maintain a connection between the Adapter and the Agent

• ConnectionTimeout - The amount of time (in milliseconds) to allow for a connection attempt to the Agent

• ReconnectInterval - The amount of time (in milliseconds) between adapter reconnection attempts

• MultilineAssets - Use multiline Assets

• MultilineDevices - Sets the default for Converting Units when adding Observations

• FilterDuplicates - Determines whether to filter out duplicate data

• OutputTimestamps - Determines whether to output Timestamps for each SHDR line

OutputTimestamps

Timestamps may be output in the SHDR protocol in order to pass the timestamp from the Adapter instead of allowing the Agent to apply a timestamp.

OutputTimestamp = true

OutputTimestamp = false

Sending Data

Add DataItems Individually

If no timestamp is given then the timestamp will be set when the DataItem is sent to the Agent. To insure that all dataitems have the same timestamp, it can be set explicitly.

Add List of DataItems

Output

Store DataItems in Variables

Send DataItem Manually

DataItems can be added to the Adapter and immediately send to the Agent using the "SendDataItem()" method

Conditions

The ShdrCondition class is used to send MTConnect Condition data using the 5 primary values Level, NativeCode, NativeSeverity, Qualifier, and Message (referred to as Result in the MTConnect Standard). A Condition is made up of 1 or more FaultStates. Each FaultState is represented by the ShdrFaultState class.

Add a Fault Condition

A Condition can also be added by using the built-in functions:

Set the Condition to Normal

Set the Condition to Warning

Set the Condition to Fault

Set multiple FaultStates

Set the Condition to Unavailable

Add FaultStates Individually

Send Condition Manually

Conditions can be added to the Adapter and immediately send to the Agent using the "SendCondition()" method

TimeSeries

Output

Send TimeSeries Manually

TimeSeries can be added to the Adapter and immediately send to the Agent using the "SendTimeSeries()" method

DataSets

Output

Send DataSets Manually

DataSets can be added to the Adapter and immediately send to the Agent using the "SendDataSets()" method

Tables

Output

Send Tables Manually

Tables can be added to the Adapter and immediately send to the Agent using the "SendTables()" method

Assets

MTConnect Assets are sent by first defining the Asset using the appropriate class (CuttingToolAsset, FileAsset, etc.) then using the "AddAsset()".

CuttingTool Asset

Output (with MultilineAssets = true)

File Asset

Output (with MultilineAssets = true)

Add Multiple Assets

Send Asset Manually

Assets can be added to the Adapter and immediately send to the Agent using the "SendAsset()" method

Remove Individual Asset by AssetId

Output

Remove All Assets of a specified Type

Output

SHDR Conversion

Conversion to and from an SHDR message is done through methods in the ShdrDataItem, ShdrCondition, ShdrTimeSeries, ShdrDataSet, and ShdrTable classes. Each class overrides the base "ToString()" method and also contains a "FromString()" method. The "ToString()" method creates an SHDR compatible string from the object and the "FromString()" creates an object from an SHDR string.

ShdrDataItem.ToString()

2022-02-01T13:53:03.6940000Z|L2avail|AVAILABLE

ShdrCondition.ToString()

2022-02-01T13:55:11.8460000Z|L2p1system|FAULT|404|100|LOW|Testing from new adapter

ShdrTimeSeries.ToString()

2022-02-01T13:56:58.7700000Z|L2p1Sensor|6|100|12 15 14 18 25 30

ShdrDataSet.ToString()

2022-02-01T13:58:31.8150000Z|L2p1Variables|V1=5 V2=205

ShdrTable.ToString()

2022-02-01T13:59:47.5980000Z|L2p1ToolTable|T1={LENGTH=7.123 DIAMETER=0.494 TOOL_LIFE=0.35} T2={LENGTH=10.456 DIAMETER=0.125 TOOL_LIFE=1} T3={LENGTH=6.251 DIAMETER=1.249 TOOL_LIFE=0.93}