Skip to content

Commit

Permalink
Updated ReadMe
Browse files Browse the repository at this point in the history
  • Loading branch information
PatrickRitchie committed Dec 6, 2023
1 parent ce9c2f0 commit 817dbae
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 10 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

# MTConnect.NET

[![MTConnect.NET](https://github.com/TrakHound/MTConnect.NET/actions/workflows/dotnet.yml/badge.svg)](https://github.com/TrakHound/MTConnect.NET/actions/workflows/dotnet.yml)

> 12/4/2023 : Version 6.0 Released with new Agent, Adapter, & SysML Import
## Download
Expand Down
40 changes: 34 additions & 6 deletions agent/MTConnect.NET-Agent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,15 @@
</thead>
<tbody>
<tr>
<td>Agent</td>
<td>Installer</td>
<td><img src="https://img.shields.io/github/downloads/TrakHound/MTConnect.NET/total?style=for-the-badge&logo=github&label=%20&color=%23333"/></td>
<td><a href="https://github.com/TrakHound/MTConnect.NET/releases/download/v5.4.3/MTConnect-Agent-HTTP-5.4.3-Install.exe">https://github.com/TrakHound/MTConnect.NET/releases</a></td>
</tr>
<tr>
<td>Docker</td>
<td><img src="https://img.shields.io/docker/pulls/trakhound/mtconnect.net-agent?style=for-the-badge&logo=docker&label=%20&color=%23333"/></td>
<td><a href="https://hub.docker.com/repository/docker/trakhound/mtconnect.net-agent">https://hub.docker.com/repository/docker/trakhound/mtconnect.net-agent</a></td>
</tr>
</tbody>
</table>

Expand All @@ -37,6 +42,33 @@ This project is a full implementation of an MTConnect Agent used to read data fr
- Configuration File monitoring to automatically restart the Agent upon configuration file changes
- Flexible Logging using NLog which can be used to output log information to separate files for easier analysis

## Capabilites
| Description | Supported |
| :----------------------------------- |:------------------:|
| MTConnect Probe | :white_check_mark: |
| MTConnect Current | :white_check_mark: |
| MTConnect Sample | :white_check_mark: |
| MTConnect Assets | :white_check_mark: |
| MTConnect Interfaces | :white_check_mark: |
| HTTP Server | :white_check_mark: |
| MQTT Server (Internal Broker) | :white_check_mark: |
| MQTT Server (External Broker) | :white_check_mark: |
| SHDR Adapters (Input Data) | :white_check_mark: |
| HTTP Adapters (Input Data) | :white_check_mark: |
| MQTT Adapters (Input Data) | :white_check_mark: |
| Configuration File Monitoring | :white_check_mark: |
| Unit Conversion | :white_check_mark: |
| Script Transformation (Python) | :white_check_mark: |
| Windows Service | :white_check_mark: |
| Linux Supported | :white_check_mark: |
| Durable File Buffer | :white_check_mark: |
| Debug Logging | :white_check_mark: |
| XML Stylesheets | :white_check_mark: |
| XML Static Files | :white_check_mark: |
| XML Schemas | :white_check_mark: |
| XML Validation | :white_check_mark: |


## Installation
Follow the steps below to install the MTConnect Agent HTTP application.

Expand Down Expand Up @@ -309,10 +341,6 @@ The default [NLog Configuration File](https://github.com/TrakHound/MTConnect.NET
</nlog>
```

## Releases
Releases for this application are located under the Releases tab. The current release is listed below:
- [MTConnect Agent Current Release](https://github.com/TrakHound/MTConnect.NET/releases)

## Source Code
This project uses the MTConnect.NET-Applications-Agents library (available on [Nuget](https://www.nuget.org/packages/MTConnect.NET-Applications-Agents)) to create an MTConnect Agent application. More information about this library can be found [Here](https://github.com/TrakHound/MTConnect.NET/tree/master/src/MTConnect.NET-Applications-Agents). The MTConnect.NET-Applications-Agents library makes creating an MTConnect Agent application simple as well as makes it easy to keep updated using Nuget. A fully functionaly MTConnect Application can be created in just a few lines of code.

Expand All @@ -322,4 +350,4 @@ This project uses the MTConnect.NET-Applications-Agents library (available on [N
- For any other questions or feedback, please contact TrakHound directly at **[email protected]**.

## License
This application and it's source code is licensed under the [MIT License](https://choosealicense.com/licenses/mit/) and is free to use.
This application and it's source code is licensed under the [MIT License](https://choosealicense.com/licenses/mit/) and is free to use and distribute.
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,6 @@ public class MTConnectAgentApplication : IMTConnectAgentApplication

public string ServiceDescription { get; set; }

protected Type ConfigurationType { get; set; }

public IMTConnectAgentBroker Agent => _mtconnectAgent;


Expand All @@ -69,8 +67,6 @@ public MTConnectAgentApplication()
ServiceName = DefaultServiceName;
ServiceDisplayName = DefaultServiceDisplayName;
ServiceDescription = DefaultServiceDescription;

if (ConfigurationType == null) ConfigurationType = typeof(AgentApplicationConfiguration);
}


Expand Down

0 comments on commit 817dbae

Please sign in to comment.