Skip to content

docs: add readme.md #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 11, 2024
Merged

docs: add readme.md #24

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
# mtconnect-java

![License](https://img.shields.io/badge/license-Apache2.0-green) ![Language](https://img.shields.io/badge/language-Java-blue.svg) [![version](https://img.shields.io/github/v/tag/protocol-laboratory/mtconnect-java?label=release&color=blue)](https://github.com/protocol-laboratory/mtconnect-java/releases) [![codecov](https://codecov.io/gh/protocol-laboratory/mtconnect-java/branch/main/graph/badge.svg)](https://codecov.io/gh/protocol-laboratory/mtconnect-java)

### Overview
`mtconnect-java` is a Java sdk for mtconnect.

### Detail
It helps users complete the underlying implementation of Java projects that interface with the mtconnect protocol.
For example, you can use `mtconnect-client` to integrate into Java projects and query information such as Asset and Device through the mtconnect protocol.
You can also use `mtconnect-server` to interface with PLCs, some IoT cloud service platforms, and other devices to obtain specific device information, and establish a simple and easy-to-use server.

When building a complete, it allows users to customize the implementation of MTProcessor to complete more complex functions.
The sample 'MTConnectIoTDAServerExample' has the ability to use Huawei Cloud IoT platform to complete the query of device list.