MTConnect.NET

Appearance

MTConnect.NETThe .NET implementation of the MTConnect Standard

100% Open Source
100% Free
100% Public-surface API coverage
100% MTConnect Standard compliance

Get started
Download latest release
View on GitHub
MTConnect.NET

MTConnect Standard compliance

Every shipped envelope (Streams, Devices, Assets, Error) validates against the corresponding XSD across MTConnect v1.0 through v2.7. Wire output is byte-for-byte cppagent-parity for the JSON-CPPAGENT v2 array-of-wrappers codec.

Compliance posture

Public-surface API coverage

Every public class, interface, method, property, event, and enum has a documentation page generated from the library's XML doc comments — with a real usage example.

API reference

Configure-and-use guides

End-to-end guides for installing the NuGet packages, configuring an agent, configuring an adapter, running locally / in Docker / as a service, and connecting a consumer over HTTP or MQTT.

Configure & Use

Wire-format reference

XML, JSON v1, JSON-CPPAGENT (v2 codec), JSON-CPPAGENT-MQTT, SHDR — sample envelopes, codec class names, round-trip pseudocode, and Mermaid diagrams for the wire-flow handshakes.

Wire formats

Cookbook

Recipes for common problems — write an agent, write an adapter, write a module, configure the MQTT relay, write a JSON-MQTT consumer.

Cookbook

Runnable examples

Four self-contained console applications in `examples/` — an embedded agent, an HTTP client, an MQTT client, and an SHDR client. Each is `dotnet run`-able directly from the repository.

Examples

Troubleshooting

XSD validation failures, schema-version mismatches, MQTT TLS handshake failures — common errors and the fixes that work.

Troubleshooting

What is MTConnect.NET? ​

See More

MTConnect.NET is a fully open-source .NET library set, agent application, and adapter application that implements the MTConnect Standard end to end. It ships:

  • A standalone agent application — a preconfigured executable that hosts an MTConnect agent with a modular architecture (HTTP server, MQTT broker, MQTT relay, SHDR adapter, MQTT adapter, HTTP adapter). Runs on Windows, Linux, and macOS, with installers, a Docker image, and Windows-service / systemd-unit deployment paths.
  • A standalone adapter application — for shipping data from a PLC or other source into an MTConnect agent over SHDR or MQTT.
  • Embeddable libraries — fourteen NuGet packages (MTConnect.NET, MTConnect.NET-Common, MTConnect.NET-HTTP, MTConnect.NET-SHDR, MTConnect.NET-MQTT, MTConnect.NET-XML, MTConnect.NET-JSON, MTConnect.NET-JSON-cppagent, MTConnect.NET-TLS, MTConnect.NET-Services, MTConnect.NET-DeviceFinder, MTConnect.NET-SysML, plus the MTConnect.NET-Applications-Agents and MTConnect.NET-Applications-Adapter host packages) for embedding agent / adapter / client functionality inside a custom application.
  • Spec coverage through v2.7 — the SysML model drives source generation, so every spec-version-introduced type is present, every deprecation is recorded, and every type carries its MinimumVersion / MaximumVersion metadata.

Target frameworks ​

The libraries multi-target .NET 9.0, .NET 8.0, .NET 7.0, .NET 6.0, .NET 5.0, .NET Core 3.1, .NET Standard 2.0, and .NET Framework 4.6.1 through 4.8.

Architecture at a glance ​

The diagram above is rendered by the Mermaid plugin. Every architecture / sequence / state-machine / wire-flow diagram in this site is authored in Mermaid — no ASCII art, no external image renders for schematic content.

Where to next ​

  • New to MTConnect.NET? Start with Getting started.
  • Deciding whether the library covers your spec target? Read the Compliance posture.
  • Standing up an agent against real equipment? Walk through Configure & Use.
  • Looking up a specific class or method? Open the API reference.
  • Want to see a working program first? Browse the Examples — four dotnet run-able console apps for the common integration shapes.

Released under the MIT License.

Copyright © TrakHound Inc.