From c5f633e9dd7c60d5431be67a205a4d39492bf12c Mon Sep 17 00:00:00 2001 From: Daniel Kluge Date: Mon, 1 Jan 2024 17:39:03 +0100 Subject: [PATCH] Add readme --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..25356dd --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# Multimessagebroker + +This software was created as part of my diploma thesis. +It should make the Industry 4.0 accessible to brownfield machines. + +It works like a gateway by serving a I4.0 Interface (the Asset Administration Shell) and an arbitrary protocol to connect to the asset. + +- `lib` contains the main logic for the library. +- `example` shows how to use the lib +- `testasset` contains a simple script that pushes some values on MQTT +- `owntest.json` contains the AASX description of the testasset + +`lib` must be build first, as it's currently not in npm and `example` uses it by path. +Both can be build using `npm run build` and both have documentation that can be created using `npm run docs`.