fix: update documentation and reformat

.github/workflows/linter.yml

@@ -10,7 +10,6 @@ on: # yamllint disable-line rule:truthy
 
 permissions:
   contents: read
-  packages: write
 
 jobs:
   build:
@@ -25,16 +24,18 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           # super-linter needs the full git history to get the
           # list of files that changed across commits
           fetch-depth: 0
+          persist-credentials: false
 
       - name: Super-linter
-        uses: super-linter/super-linter@v7
+        uses: super-linter/super-linter@ffde3b2b33b745cb612d787f669ef9442b1339a6 # v8.1.0
         env:
           # To report GitHub Actions status checks
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           VALIDATE_ALL_CODEBASE: true
           VALIDATE_CHECKOV: false
+          VALIDATE_XML: false

README.md

@@ -4,22 +4,22 @@
 [![.NET](https://img.shields.io/badge/.NET-9.0-blue.svg)](https://dotnet.microsoft.com/download/dotnet/9.0)
 [![Python](https://img.shields.io/badge/Python-3.11-blue.svg)](https://www.python.org/downloads/)
 
-Bidirectional data bridge between umati OPC UA for Machine Tools and MTConnect.
+Bidirectional data bridge between umati OPC UA for Machine Tools (UA4MT) and MTConnect.
 
 ## Architecture
 
 This project provides two software adapters:
 
-- **`mtc2umati`** (.NET 9.0): Sets up an umati OPC UA Server, reads MTConnect
+- **`mtc2umati`** (.NET 9.0): Sets up an UA4MT OPC UA Server, reads MTConnect
   XML data streams and writes to the corresponding OPC UA nodes
-- **`umati2mtc`** (Python 3.11): Translates umati OPC UA data provided by the
-  umati Gateway to MTConnect SHDR format and sends it to an MTConnect Agent.
+- **`umati2mtc`** (Python 3.11): Translates UA4MT OPC UA data provided by the
+  umatiGateway to MTConnect SHDR format and sends it to an MTConnect Agent.
 
 Both components support Excel-based mapping configurations and containerized deployment.
 
 ## Quick Start
 
-### MTConnect → umati OPC UA4MT (C#/.NET)
+### MTConnect → OPC UA4MT (C#/.NET)
 
 ```bash
 cd mtc2umati
@@ -31,7 +31,7 @@ docker compose up --build -d
 - New server can be added or configured in the config.json file.
 - The umati OPC UA Server will be available at `opc.tcp://localhost:5440`.
 
-### umati OPC UA4MT → MTConnect (Python)
+### OPC UA4MT → MTConnect (Python)
 
 ```bash
 cd umati2mtc
@@ -52,10 +52,22 @@ allowing data transformations between protocols without code changes.
 
 ## Standards Compliance
 
-- **umati**: OPC UA Companion Specification for Machine Tools (OPC 40501-1)
+- **UA4MT**: OPC UA Companion Specification for Machine Tools (OPC 40501-1 v1.02)
 - **MTConnect**: MTConnect Standard Part 2 & 3 (v2.2.0)
 - **OPC UA**: Core specifications with security profiles
 
+For details see [Specs](mapping/Specs/Specs.md)
+
+## Limitations
+
+Currently this project is limited to **OPC UA for Machine Tools** and the corresponding variables in **MTConnect**.
+
 ## License
 
 This implementation is licensed under the [Apache License v2.0](LICENSE).
+
+## Trademarks
+
+umati is a registered trademark of VDW - German Machine Tool builders' association.
+
+MTConnect® is a registered trademark of AMT - The Association for Manufacturing Technology.

mapping/MTConnect_data/DMG.xml

@@ -1,4 +1,26 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+SPDX-License-Identifier: MIT
+Copyright (c) 2025 Aleks Arzer, IFW Hannover. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 
+SOFTWARE.
+-->
 <MTConnectStreams xmlns:m="urn:mtconnect.org:MTConnectStreams:1.3" xmlns="urn:mtconnect.org:MTConnectStreams:1.3" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:mtconnect.org:MTConnectStreams:1.3 http://www.mtconnect.org/schemas/MTConnectStreams_1.3.xsd">
   <Header creationTime="2025-03-17T10:29:53Z" sender="DM208756B9C484" instanceId="1740146806" version="1.3.0.17" bufferSize="262144" nextSequence="174688" firstSequence="1" lastSequence="174687"/>
   <Streams>

mapping/MTConnect_data/Mazak.xml

@@ -1,4 +1,26 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+SPDX-License-Identifier: MIT
+Copyright (c) 2025 Aleks Arzer, IFW Hannover. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 
+SOFTWARE.
+-->
 <MTConnectStreams xmlns:m="urn:mtconnect.org:MTConnectStreams:1.3" xmlns="urn:mtconnect.org:MTConnectStreams:1.3" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:x="urn:mazakusa.com:MazakStreams:1.3" xsi:schemaLocation="urn:mazakusa.com:MazakStreams:1.3 /schemas/MazakStreams_1.3.xsd">
   <Header creationTime="2025-05-12T09:44:27Z" sender="MAZATROL-PC" instanceId="1746714531" version="1.3.0.17" bufferSize="131072" nextSequence="36907" firstSequence="1" lastSequence="36906"/>
   <Streams>