The agent and adapter accept YAML or JSON configuration. The schema below is derived from the source declarations of every option class — the JsonPropertyName / YamlMember.Alias value gives the on-the-wire key, and the /// summary above each property is reproduced verbatim.
Worked example
A minimal agent.config.yaml for an HTTP agent on port 5000:
observationBufferSize: 150000
assetBufferSize: 1000
defaultVersion: "2.5"
enableAgentDevice: true
enableMetrics: true
modules:
- http:
port: 5000
documentFormat: xml
Option classes
AdapterApplicationConfiguration
- Namespace:
MTConnect.Configurations - Source:
libraries/MTConnect.NET-Common/Configurations/AdapterApplicationConfiguration.cs
Configuration for an MTConnect Http Agent Application
| Key | C# property | Type | Description |
|---|---|---|---|
changeToken |
ChangeToken |
string |
An opaque token regenerated each time the configuration is saved, allowing consumers to detect that the configuration has changed. |
configurationFileRestartInterval |
ConfigurationFileRestartInterval |
int |
Gets or Sets the minimum time (in seconds) between Adapter restarts when MonitorConfigurationFiles is enabled |
deviceKey |
DeviceKey |
string |
The Name or UUID of the Device to create a connection for |
enableBuffer |
EnableBuffer |
bool |
Determines whether to send all changes to data or only most recent at the specified Interval |
engine |
Engine |
Dictionary<string, object> |
Free-form key/value settings consumed by the adapter engine; keys correspond to engine property names with loosely typed values. |
filterDuplicates |
FilterDuplicates |
bool |
Determines whether to filter out duplicate data |
id |
Id |
string |
Get a unique identifier for the Adapter |
modules |
Modules |
IEnumerable<object> |
The raw, untyped module configuration sections declared for the adapter, each later resolved to a strongly typed configuration on demand. |
monitorConfigurationFiles |
MonitorConfigurationFiles |
bool |
Gets or Sets whether Configuration files are monitored. If enabled and a configuration file is changed, the Adapter will restart |
outputTimestamps |
OutputTimestamps |
bool |
Determines whether to output Timestamps for each SHDR line |
readInterval |
ReadInterval |
int |
The interval (in milliseconds) at which new data is read from the Data Source |
serviceAutoStart |
ServiceAutoStart |
bool |
Sets the Service Start Type. True = Auto | False = Manual |
serviceName |
ServiceName |
string |
Changes the service name when installing or removing the service. This allows multiple Adapters to run as services on the same machine. |
writeInterval |
WriteInterval |
int |
The interval (in milliseconds) at which new data is sent to the Agent |
AgentApplicationConfiguration
- Namespace:
MTConnect.Configurations - Source:
libraries/MTConnect.NET-Common/Configurations/AgentApplicationConfiguration.cs
Configuration for an MTConnect Http Agent Application
| Key | C# property | Type | Description |
|---|---|---|---|
agentUuid |
AgentUuid |
string |
Optional static UUID to assign to the Agent meta-device. Must parse as an RFC 4122 UUID — any format |
configurationFileRestartInterval |
ConfigurationFileRestartInterval |
int |
Gets or Sets the minimum time (in seconds) between Agent restarts when MonitorConfigurationFiles is enabled |
devices |
Devices |
string |
The Path to look for the file(s) that represent the Device Information Models to load into the Agent. The path can either be a single file or a directory. The path can be absolute or relative to the executable's directory |
durable |
Durable |
bool |
Gets or Sets whether the Agent buffers are durable and retain state after restart |
durableBufferPath |
DurableBufferPath |
string |
The base path to the directory to write the File Buffers when 'durable = true' |
modules |
Modules |
IEnumerable<object> |
The raw, untyped module configuration sections declared for the agent, each later resolved to a strongly typed configuration on demand. |
monitorConfigurationFiles |
MonitorConfigurationFiles |
bool |
Gets or Sets whether Configuration files are monitored. If enabled and a configuration file is changed, the Agent will restart |
processors |
Processors |
IEnumerable<object> |
The raw, untyped processor configuration sections declared for the agent's observation/asset processing pipeline. |
serviceAutoStart |
ServiceAutoStart |
bool |
Sets the Service Start Type. True = Auto | False = Manual |
serviceDisplayName |
ServiceDisplayName |
string |
Changes the display name of the service. This helps with identification when multiple agents on run as services on the same machine. |
serviceDisplayName |
ServiceDescription |
string |
Changes the description of the service. This helps with identification when multiple agents on run as services on the same machine. |
serviceName |
ServiceName |
string |
Changes the service name when installing or removing the service. This allows multiple agents to run as services on the same machine. |
useBufferCompression |
UseBufferCompression |
bool |
Gets or Sets whether the durable Agent buffers use Compression |
AgentConfiguration
- Namespace:
MTConnect.Configurations - Source:
libraries/MTConnect.NET-Common/Configurations/AgentConfiguration.cs
Configuration for an MTConnect Agent
| Key | C# property | Type | Description |
|---|---|---|---|
allowEmptyResultForEnumEvents |
AllowEmptyResultForEnumEvents |
bool |
Gets or Sets whether an empty, null, or whitespace-only Result is preserved for Event DataItems whose Type has a controlled vocabulary (for example EXECUTION, CONTROLLER_MODE). Defaults to |
assetBufferSize |
AssetBufferSize |
uint |
The maximum number of assets the agent can hold in its buffer |
changeToken |
ChangeToken |
string |
An opaque token regenerated each time the configuration is saved, allowing consumers to detect that the configuration has changed. |
convertUnits |
ConvertUnits |
bool |
Gets or Sets the default for Converting Units when adding Observations |
defaultVersion |
DefaultVersionValue |
string |
The string form of |
deviceValidationLevel |
DeviceValidationLevel |
DeviceValidationLevel |
Gets or Sets the default Device (MTConnectDevices) validation level. 0 = Ignore, 1 = Warning, 2 = Remove, 3 = Strict |
enableAgentDevice |
EnableAgentDevice |
bool |
Gets or Sets whether the Agent Device is output |
enableMetrics |
EnableMetrics |
bool |
Gets or Sets whether Metrics are captured (ex. ObserationUpdateRate, AssetUpdateRate) |
enableValidation |
EnableValidation |
bool |
Gets or Sets whether validation information is output |
ignoreObservationCase |
IgnoreObservationCase |
bool |
Gets or Sets the default for Ignoring the case of Observation values |
ignoreTimestamps |
IgnoreTimestamps |
bool |
Overwrite timestamps with the agent time. This will correct clock drift but will not give as accurate relative time since it will not take into consideration network latencies. This can be overridden on a per adapter basis. |
inputValidationLevel |
InputValidationLevel |
InputValidationLevel |
Gets or Sets the default Input (Observation or Asset) validation level. 0 = Ignore, 1 = Warning, 2 = Remove, 3 = Strict |
observationBufferSize |
ObservationBufferSize |
uint |
The maximum number of Observations the agent can hold in its buffer |
sender |
Sender |
string |
The value emitted as the |
timezoneOutput |
TimeZoneOutput |
string |
Sets the TimeZone to use when timestamps are output from the Agent |
DataSourceConfiguration
- Namespace:
MTConnect.Configurations - Source:
libraries/MTConnect.NET-Common/Configurations/DataSourceConfiguration.cs
Configuration for an MTConnect Data Source
| Key | C# property | Type | Description |
|---|---|---|---|
readInterval |
ReadInterval |
int |
The interval (in milliseconds) at which new data is read from the Data Source |
FileConfiguration
- Namespace:
MTConnect.Configurations - Source:
libraries/MTConnect.NET-HTTP/Configurations/FileConfiguration.cs
Configuration for Static Files that can served from an Http Server
| Key | C# property | Type | Description |
|---|---|---|---|
location |
Location |
string |
The path to match in the requested URL |
path |
Path |
string |
The location of the files on the server (where the Agent is running) |
HttpClientConfiguration
- Namespace:
MTConnect.Configurations - Source:
libraries/MTConnect.NET-HTTP/Configurations/HttpClientConfiguration.cs
Configuration for a MTConnect Http Client
| Key | C# property | Type | Description |
|---|---|---|---|
address |
Address |
string |
The URL address the client MTConnect Agent is located at. |
currentOnly |
CurrentOnly |
bool |
Gets or Sets whether the stream requests a Current (true) or a Sample (false) |
deviceKey |
DeviceKey |
string |
The Name or UUID of the MTConnect Device |
heartbeat |
Heartbeat |
int |
The streaming heartbeat in milliseconds passed to the agent as the |
interval |
Interval |
int |
The polling/streaming interval in milliseconds. For polling clients this is the wait between successive |
outputConnectionInformation |
OutputConnectionInformation |
bool |
Gets or Sets whether the Connection Information (Host / Port) is output to the Agent to be collected by a client |
port |
Port |
int |
The port to connect to the client MTConnect Agent. |
useSSL |
UseSSL |
bool |
When true, the client connects to the agent over |
useStreaming |
UseStreaming |
bool |
Gets or Sets whether the client should use Streaming (true) or Polling (false) |
IAdapterApplicationConfiguration
- Namespace:
MTConnect.Configurations - Source:
libraries/MTConnect.NET-Common/Configurations/IAdapterApplicationConfiguration.cs
Configuration for an MTConnect Adapter
| Key | C# property | Type | Description |
|---|---|---|---|
changeToken |
ChangeToken |
string |
An opaque token that changes whenever the underlying configuration source is reloaded, allowing consumers to detect that the configuration has been replaced. |
configurationFileRestartInterval |
ConfigurationFileRestartInterval |
int |
Gets or Sets the minimum time (in seconds) between Adapter restarts when MonitorConfigurationFiles is enabled |
deviceKey |
DeviceKey |
string |
The Name or UUID of the Device to create a connection for |
enableBuffer |
EnableBuffer |
bool |
Determines whether to send all changes to data or only most recent at the specified Interval |
engine |
Engine |
Dictionary<string, object> |
Free-form key/value settings consumed by the adapter engine; keys correspond to engine property names with loosely typed values. |
filterDuplicates |
FilterDuplicates |
bool |
Determines whether to filter out duplicate data |
id |
Id |
string |
Get a unique identifier for the Adapter |
modules |
Modules |
IEnumerable<object> |
The raw, untyped module configuration sections declared for the adapter, each later resolved to a strongly typed configuration on demand. |
monitorConfigurationFiles |
MonitorConfigurationFiles |
bool |
Gets or Sets whether Configuration files are monitored. If enabled and a configuration file is changed, the Adapter will restart |
outputTimestamps |
OutputTimestamps |
bool |
Determines whether to output Timestamps for each SHDR line |
path |
Path |
string |
The file system path the configuration was loaded from, used as the default target when the configuration is saved back to disk. |
serviceAutoStart |
ServiceAutoStart |
bool |
Sets the Service Start Type. True = Auto | False = Manual |
serviceName |
ServiceName |
string |
Changes the service name when installing or removing the service. This allows multiple Adapters to run as services on the same machine. |
writeInterval |
WriteInterval |
int |
The interval (in milliseconds) at which new data is sent to the Agent |
IAgentApplicationConfiguration
- Namespace:
MTConnect.Configurations - Source:
libraries/MTConnect.NET-Common/Configurations/IAgentApplicationConfiguration.cs
Configuration for an MTConnect Shdr > Http Agent
| Key | C# property | Type | Description |
|---|---|---|---|
agentUuid |
AgentUuid |
string |
Optional static UUID to assign to the Agent meta-device. Must parse as an RFC 4122 UUID (any |
configurationFileRestartInterval |
ConfigurationFileRestartInterval |
int |
Gets or Sets the minimum time (in seconds) between Agent restarts when MonitorConfigurationFiles is enabled |
devices |
Devices |
string |
The Path to look for the file(s) that represent the Device Information Models to load into the Agent. The path can either be a single file or a directory. The path can be absolute or relative to the executable's directory |
durable |
Durable |
bool |
Gets or Sets whether the Agent buffers are durable and retain state after restart |
durableBufferPath |
DurableBufferPath |
string |
The base path to the directory to write the File Buffers when 'durable = true' |
modules |
Modules |
IEnumerable<object> |
The raw, untyped module configuration sections declared for the agent, each later resolved to a strongly typed configuration on demand. |
monitorConfigurationFiles |
MonitorConfigurationFiles |
bool |
Gets or Sets whether Configuration files are monitored. If enabled and a configuration file is changed, the Agent will restart |
processors |
Processors |
IEnumerable<object> |
The raw, untyped processor configuration sections declared for the agent's observation/asset processing pipeline. |
serviceAutoStart |
ServiceAutoStart |
bool |
Sets the Service Start Type. True = Auto | False = Manual |
serviceDescription |
ServiceDescription |
string |
Changes the description of the service. This helps with identification when multiple agents on run as services on the same machine. |
serviceDisplayName |
ServiceDisplayName |
string |
Changes the display name of the service. This helps with identification when multiple agents on run as services on the same machine. |
serviceName |
ServiceName |
string |
Changes the service name when installing or removing the service. This allows multiple agents to run as services on the same machine. |
useBufferCompression |
UseBufferCompression |
bool |
Gets or Sets whether the durable Agent buffers use Compression |
IAgentConfiguration
- Namespace:
MTConnect.Configurations - Source:
libraries/MTConnect.NET-Common/Configurations/IAgentConfiguration.cs
Configuration for an MTConnect Agent
| Key | C# property | Type | Description |
|---|---|---|---|
allowEmptyResultForEnumEvents |
AllowEmptyResultForEnumEvents |
bool |
Gets whether an empty, null, or whitespace-only Result is preserved for Event DataItems whose Type has a controlled vocabulary (for example EXECUTION, CONTROLLER_MODE). When |
assetBufferSize |
AssetBufferSize |
uint |
The maximum number of assets the agent can hold in its buffer |
changeToken |
ChangeToken |
string |
An opaque token that changes whenever the underlying configuration source is reloaded, allowing consumers to detect that the configuration has been replaced. |
convertUnits |
ConvertUnits |
bool |
Gets the default for Converting Units when adding Observations |
defaultVersion |
DefaultVersion |
Version |
Gets the default MTConnect version to output response documents for. |
deviceValidationLevel |
DeviceValidationLevel |
DeviceValidationLevel |
Gets or Sets the default Device (MTConnectDevices) validation level. 0 = Ignore, 1 = Warning, 2 = Remove, 3 = Strict |
enableAgentDevice |
EnableAgentDevice |
bool |
Gets or Sets whether the Agent Device is output |
enableMetrics |
EnableMetrics |
bool |
Gets whether Metrics are captured (ex. ObserationUpdateRate, AssetUpdateRate) |
enableValidation |
EnableValidation |
bool |
Gets or Sets whether validation information is output |
ignoreObservationCase |
IgnoreObservationCase |
bool |
Gets the default for Ignoring the case of Observation values |
ignoreTimestamps |
IgnoreTimestamps |
bool |
Overwrite timestamps with the agent time. This will correct clock drift but will not give as accurate relative time since it will not take into consideration network latencies. This can be overridden on a per adapter basis. |
inputValidationLevel |
InputValidationLevel |
InputValidationLevel |
Gets the default Input (Observation or Asset) validation level. 0 = Ignore, 1 = Warning, 2 = Remove, 3 = Strict |
observationBufferSize |
ObservationBufferSize |
uint |
The maximum number of Observations the agent can hold in its buffer |
path |
Path |
string |
The file system path the configuration was loaded from, used as the default target when the configuration is saved back to disk. |
sender |
Sender |
string |
The value emitted as the |
timeZoneOutput |
TimeZoneOutput |
string |
Sets the TimeZone to use when timestamps are output from the Agent |
IDataSourceConfiguration
- Namespace:
MTConnect.Configurations - Source:
libraries/MTConnect.NET-Common/Configurations/IDataSourceConfiguration.cs
Configuration for an MTConnect Data Source
| Key | C# property | Type | Description |
|---|---|---|---|
readInterval |
ReadInterval |
int |
The interval (in milliseconds) at which new data is read from the Data Source |
IFileConfiguration
- Namespace:
MTConnect.Configurations - Source:
libraries/MTConnect.NET-HTTP/Configurations/IFileConfiguration.cs
Configuration for Static Files that can served from an Http Server
| Key | C# property | Type | Description |
|---|---|---|---|
location |
Location |
string |
The path to match in the requested URL |
path |
Path |
string |
The location of the files on the server (where the Agent is running) |
IHttpClientConfiguration
- Namespace:
MTConnect.Configurations - Source:
libraries/MTConnect.NET-HTTP/Configurations/IHttpClientConfiguration.cs
Configuration for a MTConnect Http Client
| Key | C# property | Type | Description |
|---|---|---|---|
address |
Address |
string |
The URL address the client MTConnect Agent is located at. |
currentOnly |
CurrentOnly |
bool |
Gets or Sets whether the stream requests a Current (true) or a Sample (false) |
deviceKey |
DeviceKey |
string |
The Name or UUID of the MTConnect Device |
heartbeat |
Heartbeat |
int |
|
id |
Id |
string |
The unique identifier for the Adapter |
interval |
Interval |
int |
|
outputConnectionInformation |
OutputConnectionInformation |
bool |
Gets or Sets whether the Connection Information (Host / Port) is output to the Agent to be collected by a client |
port |
Port |
int |
The port to connect to the client MTConnect Agent. |
useSSL |
UseSSL |
bool |
|
useStreaming |
UseStreaming |
bool |
Gets or Sets whether the client should use Streaming (true) or Polling (false) |
IShdrAdapterClientConfiguration
- Namespace:
MTConnect.Configurations - Source:
libraries/MTConnect.NET-SHDR/Configurations/IShdrAdapterClientConfiguration.cs
Configuration for an MTConnect SHDR Adapter
| Key | C# property | Type | Description |
|---|---|---|---|
availableOnConnection |
AvailableOnConnection |
bool |
For devices that do not have the ability to provide available events, if yes, this sets the Availability to AVAILABLE upon connection. |
convertUnits |
ConvertUnits |
bool |
Adapter setting for data item units conversion in the agent. Assumes the adapter has already done unit conversion. Defaults to global. |
ignoreHeartbeatOnChange |
IgnoreHeartbeatOnChange |
bool |
Gets or Sets whether Heartbeat PING requests are not sent if data has been received within the Heartbeat period |
ignoreObservationCase |
IgnoreObservationCase |
bool |
Gets or Sets the default for Ignoring the case of Observation values |
ignoreTimestamps |
IgnoreTimestamps |
bool |
Overwrite timestamps with the agent time. This will correct clock drift but will not give as accurate relative time since it will not take into consideration network latencies. This can be overridden on a per adapter basis. |
outputConnectionInformation |
OutputConnectionInformation |
bool |
Gets or Sets whether the Connection Information (Host / Port) is output to the Agent to be collected by a client |
IShdrClientConfiguration
- Namespace:
MTConnect.Configurations - Source:
libraries/MTConnect.NET-SHDR/Configurations/IShdrClientConfiguration.cs
Configuration for an MTConnect SHDR Client
| Key | C# property | Type | Description |
|---|---|---|---|
connectionTimeout |
ConnectionTimeout |
int |
The amount of time (in milliseconds) an adapter can be silent before it is disconnected. This is only for legacy adapters that do not support heartbeats. If heartbeats are present, this will be ignored. |
deviceKey |
DeviceKey |
string |
The UUID or Name of the device that corresponds to the name of the device in the Devices file. |
heartbeat |
Heartbeat |
int |
The Heartbeat interval (in milliseconds) that the TCP Connection will use to maintain a connection when no new data has been sent |
hostname |
Hostname |
string |
The host the adapter is located on. |
id |
Id |
string |
The unique identifier for the Adapter |
port |
Port |
int |
The port to connect to the adapter. |
reconnectInterval |
ReconnectInterval |
int |
The amount of time (in milliseconds) between adapter reconnection attempts. This is useful for implementation of high performance adapters where availability needs to be tracked in near-real-time. |
ShdrAdapterClientConfiguration
- Namespace:
MTConnect.Configurations - Source:
libraries/MTConnect.NET-SHDR/Configurations/ShdrAdapterClientConfiguration.cs
Configuration for an MTConnect SHDR Adapter
| Key | C# property | Type | Description |
|---|---|---|---|
availableOnConnection |
AvailableOnConnection |
bool |
For devices that do not have the ability to provide available events, if TRUE, this sets the Availability to AVAILABLE upon connection. |
convertUnits |
ConvertUnits |
bool |
Adapter setting for data item units conversion in the agent. Assumes the adapter has already done unit conversion. Defaults to global. |
ignoreHeartbeatOnChange |
IgnoreHeartbeatOnChange |
bool |
Gets or Sets whether Heartbeat PING requests are not sent if data has been received within the Heartbeat period |
ignoreObservationCase |
IgnoreObservationCase |
bool |
Gets or Sets the default for Ignoring the case of Observation values |
ignoreTimestamps |
IgnoreTimestamps |
bool |
Overwrite timestamps with the agent time. This will correct clock drift but will not give as accurate relative time since it will not take into consideration network latencies. This can be overridden on a per adapter basis. |
outputConnectionInformation |
OutputConnectionInformation |
bool |
Gets or Sets whether the Connection Information (Host / Port) is output to the Agent to be collected by a client |
ShdrClientConfiguration
- Namespace:
MTConnect.Configurations - Source:
libraries/MTConnect.NET-SHDR/Configurations/ShdrClientConfiguration.cs
Configuration for an MTConnect SHDR Client
| Key | C# property | Type | Description |
|---|---|---|---|
connectionTimeout |
ConnectionTimeout |
int |
The amount of time (in milliseconds) an adapter can be silent before it is disconnected. This is only for legacy adapters that do not support heartbeats. If heartbeats are present, this will be ignored. |
deviceKey |
DeviceKey |
string |
The UUID or Name of the device that corresponds to the name of the device in the Devices file. |
heartbeat |
Heartbeat |
int |
The Heartbeat interval (in milliseconds) that the TCP Connection will use to maintain a connection when no new data has been sent |
hostname |
Hostname |
string |
The host the adapter is located on. |
id |
Id |
string |
The unique identifier for the Adapter |
port |
Port |
int |
The port to connect to the adapter. |
reconnectInterval |
ReconnectInterval |
int |
The amount of time (in milliseconds) between adapter reconnection attempts. This is useful for implementation of high performance adapters where availability needs to be tracked in near-real-time. |
PemCertificateConfiguration
- Namespace:
MTConnect.Tls - Source:
libraries/MTConnect.NET-TLS/PemCertificateConfiguration.cs
Configures a TLS certificate loaded from PEM-encoded files.
| Key | C# property | Type | Description |
|---|---|---|---|
certificateAuthority |
CertificateAuthority |
string |
The path to the PEM file containing the trusted certificate authority chain. |
certificatePath |
CertificatePath |
string |
The path to the PEM file containing the server or client certificate. |
privateKeyPassword |
PrivateKeyPassword |
string |
The password protecting the private key, when it is encrypted. |
privateKeyPath |
PrivateKeyPath |
string |
The path to the PEM file containing the certificate's private key. |
PfxCertificateConfiguration
- Namespace:
MTConnect.Tls - Source:
libraries/MTConnect.NET-TLS/PfxCertificateConfiguration.cs
Configures a TLS certificate loaded from a PKCS#12 (PFX) file.
| Key | C# property | Type | Description |
|---|---|---|---|
certificatePassword |
CertificatePassword |
string |
The password protecting the PFX file, when it is encrypted. |
certificatePath |
CertificatePath |
string |
The path to the PFX file containing the certificate and its private key. |
TlsConfiguration
- Namespace:
MTConnect.Tls - Source:
libraries/MTConnect.NET-TLS/TlsConfiguration.cs
Configures TLS for an MTConnect endpoint, selecting either a PFX or PEM certificate and its validation options.
| Key | C# property | Type | Description |
|---|---|---|---|
omitCAValidation |
OmitCAValidation |
bool |
Whether certificate-authority chain validation is skipped. |
pem |
Pem |
PemCertificateConfiguration |
The PEM certificate configuration, used when |
pfx |
Pfx |
PfxCertificateConfiguration |
The PFX certificate configuration; takes precedence over |
verifyClientCertificate |
VerifyClientCertificate |
bool |
Whether the endpoint requires and verifies a client certificate. |