MTConnect.NET-AgentModule-MqttRelay 6.4.2

dotnet add package MTConnect.NET-AgentModule-MqttRelay --version 6.4.2
NuGet\Install-Package MTConnect.NET-AgentModule-MqttRelay -Version 6.4.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="MTConnect.NET-AgentModule-MqttRelay" Version="6.4.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add MTConnect.NET-AgentModule-MqttRelay --version 6.4.2
#r "nuget: MTConnect.NET-AgentModule-MqttRelay, 6.4.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install MTConnect.NET-AgentModule-MqttRelay as a Cake Addin
#addin nuget:?package=MTConnect.NET-AgentModule-MqttRelay&version=6.4.2

// Install MTConnect.NET-AgentModule-MqttRelay as a Cake Tool
#tool nuget:?package=MTConnect.NET-AgentModule-MqttRelay&version=6.4.2

MTConnect.NET Logo

MTConnect MQTT Relay Module

This Agent Module writes data to an External MQTT Broker

Configuration

modules:
  - mqtt-relay:
      server: localhost
      port: 1883
      topic: enterprise/site/area/line/cell/MTConnect
      topicStructure: Document
  • server - The MQTT broker hostname

  • port - The MQTT broker port number

  • timeout - The UUID or Name of the Device to read data for

  • reconnectInterval - The UUID or Name of the Device to read data for

  • username - Sets the Username to use for authentication

  • password - Sets the Password to use for authentication

  • clientId - Sets the Client ID to use for the connection

  • qos - Sets the Quality Of Service (QoS) to use. 0 = At Most Once, 1 = At least Once, 2 = Exactly Once

  • useTls - Sets whether to use TLS or not (true or false)

  • topicPrefix - The prefix to add to the MQTT topics that are published

  • topicStructure - (Document or Entity) Sets how MQTT topics and messages are stuctured

  • currentInterval - Sets the Interval (in milliseconds) to send Current messages at

  • sampleInterval - Sets the Interval (in milliseconds) to send Sample messages at

  • documentFormat - The Document Format ID to use to format the payload

  • tls - Sets the TLS settings

    • pfx - The PFX certificate settings

      • certificatePath - The path to the (.pfx) file
      • certificatePassword - The certificate password
    • pem - The PEM certificate settings

      • certificatePath - The path to the (.pem) file
      • privateKeyPath - The path to the key containing the private key
      • privateKeyPassword - The certificate password
      • certificateAuthority - The path to the (.pem) file containing the Certificate Authority
    • verifyClientCertificate - Toggles whether Client Certificate chains are verified ("true" or "false")

AWS IoT Configuration Example

- mqtt-relay:
    server: akljadkfjdlsf-ats.iot.us-east-1.amazonaws.com
    port: 8883
    tls:
      pem:
        certificateAuthority: certs/AmazonRootCA1.pem
        certificatePath: certs/asfdslkafjdslkfjdklsdjf-certificate.pem.crt
        privateKeyPath: certs/sdlkajlksdajfldskjfdldlskfjdslkaj-private.pem.key
    documentFormat: json-cppagent
    currentInterval: 5000
    sampleInterval: 500
    topicPrefix: enterprise/site/area/line/cell/MTConnect

AWS Greengrass Moquette Configuration Example

modules:
  - mqtt-relay:
      server: localhost
      port: 8883
      clientId: mtconnect-test # Set the ClientId to the AWS Thing ID
      tls:
        verifyClientCertificate: false
        pem:
          certificateAuthority: certs/AmazonRootCA1.pem
          certificatePath: certs/2316549874654321654984984158961634984794-certificate.pem.crt
          privateKeyPath: certs/2316549874654321654984984158961634984794-private.pem.key
      documentFormat: json-cppagent
      currentInterval: 5000
      sampleInterval: 500
      topicPrefix: enterprise/site/area/line/cell/MTConnect

HiveMQ Configuration Example

modules:
  - mqtt-relay:
      server: 5679887d308d402888f32.s1.eu.hivemq.cloud
      port: 8883
      username: mtconnect
      password: mtconnect
      useTls: true
      documentFormat: json-cppagent
      currentInterval: 5000
      sampleInterval: 500
      topicPrefix: enterprise/site/area/line/cell/MTConnect

Contribution / Feedback

  • Please use the Issues tab to create issues for specific problems that you may encounter
  • Please feel free to use the Pull Requests tab for any suggested improvements to the source code
  • For any other questions or feedback, please contact TrakHound directly at info@trakhound.com.

License

This application and it's source code is licensed under the MIT License and is free to use.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 is compatible.  net462 is compatible.  net463 was computed.  net47 is compatible.  net471 is compatible.  net472 is compatible.  net48 is compatible.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on MTConnect.NET-AgentModule-MqttRelay:

Package Downloads
MTConnect.NET-Applications-Agents

MTConnect.NET-Applications-Agents contains classes to fully implement an MTConnect Agent application. Supports MTConnect Versions up to 2.3. Supports .NET Framework 4.6.1 up to .NET 8

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
6.4.2 18 6/12/2024
6.4.1 95 5/17/2024
6.4.0 103 5/14/2024
6.3.2-beta 61 5/2/2024
6.3.1-beta 118 4/24/2024
6.3.0-beta 93 4/17/2024
6.2.2-beta 81 4/5/2024
6.2.1-beta 81 4/3/2024
6.2.0-beta 66 3/27/2024
6.1.3-beta 78 3/15/2024
6.1.2-beta 85 3/15/2024
6.0.11-beta 89 2/2/2024
6.0.10-beta 75 1/26/2024
6.0.9-beta 110 12/28/2023
6.0.8-beta 74 12/27/2023
6.0.7-beta 95 12/19/2023
6.0.5-beta 111 12/14/2023
6.0.3-beta 106 12/12/2023
6.0.1-beta 94 12/7/2023
6.0.0-beta 96 12/7/2023