Adapt documentation to new architecture (#48)

* feat: Update Server spec

* Removes OpenVPN, Datahub requirements

* feat: Updates implemented specs

* feat: Update Dashboard description

* feat: Add gateway documentation

* fix: Remove client documentation

* refactor: Improve documentation

* feat(doc): Refine documentation

* fix(doc): Liniting

* fix(doc): Linting

Dashboard.md

@@ -2,47 +2,53 @@
 
 The umati dashboard at [https://umati.app](https://umati.app) is available as a neutral sample application to demonstrate OPC UA companion specification standardization.
 
-- This dashboard shows all error free machine servers according to the defined [standards](Specs.md).
+- This dashboard shows all error free machine servers according to the defined [companion specifications](Specs.md).
 - It lists [software solutions](Specs/Software.md) from umati partners, who provide a web accessible demonstration instance.
 
-It is connected as an OPC UA client application to the datahub OPC UA endpoint.
-
-Currently the integration of [OPC 40001-1 UA for Machinery](https://reference.opcfoundation.org/Machinery/docs/) [OPC 40501-1 UA for MachineTool](https://reference.opcfoundation.org/MachineTool/docs/) is developed.
+Machine data are available in a MQTT broker to provide live to the umati.app
 
+Currently the companion specifications listed at [Specs](Specs.md) are implemented.
 Integrations of future additional companion specification implementations based on the [OPC 40001-1 UA for Machinery](https://www.vdma.org/viewer/-/v2article/render/2737109) are in progress.
 
 ## Location of Fair, Machine and Software icons on the dashboard
 
-### Fairs
+### Fair pin
 
 ![Fair](img/map_pin_fair.svg)
 
-Location is set by fair organiser.
+Fair location and icon is set by fair organiser.
 
-### Machines
+### Machine pin
 
 ![Machine](img/map_pin_machine_magenta.svg)
 
-The machine instance _Location_ property (according to OPC 40001-1) shall be provided in the format `<fair> <hall> <booth>`, e.g, “METAV 1 A22” or format `<N/S> <Latitude|##.#########> <EW> <Longitude|###.#########>`, e.g. `N 51.257315 E 6.740885` for GPS coordinates.
-
-NOTE: **The machine only gets a map icon, if it provides at least the GPS location**
+The machine instance _Location_ property (according to OPC 40001-1) shall be set to the following definition:
 
-Machines can be referenced to more than one fair by providing a list of fair locations, deliminated by slash e.g. `METAV <XXX> <XXX>/EMO 12 D17/N 51.257315 E 6.740885`
+- Add GPS coordinates `<N/S> <Latitude|##.#########> <EW> <Longitude|###.#########>`, e.g. `N 51.257315 E 6.740885` to get a machine icon on the world map
+- Add fair information `<fairshortname> <hall> <booth>`, e.g, “METAV 1 A22” to be associated to a fair
+- **NOTE:** Machines can be referenced to more than one fair by providing a list of fair locations, deliminated by slash e.g. `METAV <XXX> <XXX>/EMO 12 D17/N 51.257315 E 6.740885`
 
-#### FAIR Shortnames
+### FAIR Shortnames
 
-Fair shortnames are defined [here.](Specs/Fairs.md)
+Fair shortnames are defined [here](Specs/Fairs.md).
 
 ### Software
 
 ![Software](img/map_pin_software_cyan.svg)
 
-The software location will be manual set for now, based on the same principle like machines.
+The software location will be manual set as discribed [here](Specs/Software.md).
+
+## Dashboard Features
+
+The dashboard provides information to solve a few use cases which are common in the companion specifications.
 
-## Datahub
+- Identifiy machines from different manufactures
+- Provide an status overview of the machines
+- Provide tool/measurment data
+- Provide monitoring information
 
-### Datahub connection
+For the usage on fairs, the above location information provide the additional use case:
 
-For this showcase we will have a datahub provided off premise. This will act as an OPC UA aggregation server. The machine server (M) will connect via an OpenVPN tunnel to an VPN endpoint. An OPC UA client will connect to the [OPC UA Server(s)](Server.md) of that partner through the VPN tunnel. This client will browses for all instances of the supported specifications and will read all values and events of these instances. These values and events are forwarded to an aggregating OPC UA server, which will provide a copy of the instances with values. The application providers (A) will connect to the aggregating [OPC UA Server](Server.md) of this datahub. This ensures a constant load on the unterlying OPC UA servers of the machines, no matter how many applications read the OPC UA data in the aggregating OPC UA server.
+- Identify machines on a fair
 
-To connect to this datahub (M) need an [OPC UA Server](Server.md) and OpenVPN client to access one dedicated endpoint per partner. (A) will connect via OPC UA directly to the datahub.
+These use cases can be access through the Overview, Machines and Software tabs, as well as the filter functionality.

Gateway.md

@@ -0,0 +1,35 @@
+# Gateway
+
+To connect your local OPC UA server to the umati.app the initiative provides a software gateway.
+This gateway subscribes via OPC UA (Client/Server; TCP Binary) to your server and publishes the information to and MQTT broker.
+
+This [gateway](https://github.com/umati/Dashboard-OPCUA-Client) is provided as an open source version based on [open62541](https://open62541.org) and currently uses a _custom_ JSON encoding for the payload. It is planned to migrate to OPC UA part 14 JSON encoding and defined topic tree, as soon as v1.05.03 is published.
+
+## Architecture
+
+### High level
+
+OPC UA server --- Gateway --- MQTT Broker --- umati.app
+
+### With protocols
+
+- OPC UA server --- OPC UA TCP binary ---> Gateway
+
+- Gateway --- MQTT over Websockets ---> MQTT Broker
+- MQTT broker --- MQTT over Websockets ---> device viewing umati.app
+
+## Configuration and connection
+
+The detailed configuration of the client and how to deploy and run it is described in the [source repository](https://github.com/umati/Dashboard-OPCUA-Client/blob/development/usage.md).
+
+### The gateway is provided as
+
+- Standalone binary x86 (32bit) Linux/Windows
+- Standalone binary x86_64 (64bit) Linux/Windows
+- Standalone binary x86 (32bit) Linux .deb package for ubuntu 20.04 and 22.04
+- Standalone binary x86_64 (64bit) Linux .deb package for ubuntu 20.04 and 22.04
+- container image x86_64
+
+A configuration file example as well as documentation is available [here](https://github.com/umati/Dashboard-OPCUA-Client/blob/docs/docker/doc/Configuration.md).
+
+To obtain credentials to connect to the umati.app MQTT broker please follow [Server documentation](Server.md#connecting-an-opc-ua-server-to-umatiapp).

Organization.md

@@ -51,7 +51,7 @@ Every participant is permitted to advertise his or her involvement in the umati
 
 #### Obligations of participants (C) supplying components
 
-- Participants (C) without connected machines must verifiably offer support to other participants (M) for the connectivity via the umati interface.
+- Participants (C) without connected machines must verifiably offer support to other participants (M) for the connectivity to the umati.app.
 
 #### Obligations of participants (A) showing applications
 
@@ -67,7 +67,7 @@ All participants received a marketing package which will be updated as the trade
 
 - **umati partner logo:** The umati Partner logo should be used in your marketing and press materials online as well as offline.
 
-- **umati sticker for the connected machines:** [is currently prepared – not yet available] Each machine should be outfitted with a umati sticker. If you are connecting a machine that is not located on the fair ground, please find a suitable place for this sticker on your booth to enable visitors to access the dashboard side of your machine with this code. A picture of the sticker is shown below (diameter 200mm).
+- **umati sticker for the connected machines:** Each machine should be outfitted with a umati sticker. If you are connecting a machine that is not located on the fair ground, please find a suitable place for this sticker on your booth to enable visitors to access the dashboard side of your machine with this code.
 
 - **press release from umati** : informs about the showcase and the registered parties. Please use it also for your own communication as a template. Further press releases are going to follow.
 - **umati showcase folder** : [is currently prepared – not yet available] we will prepare a umati showcase folder, with more content and listing every partner and the booth information.

Readme.md

@@ -4,26 +4,27 @@ This repository provides the specification to connect to the umati virtual demon
 
 ## What is umati - the universal machine technology interface
 
-To learn more please visit [https://umati.org](https://umati.org)
+To learn more about the umati initative, please visit [https://umati.org](https://umati.org)
 
 ---
 
 ## Structure of the specification
 
 - [Overview](index.md)
 - [OPC UA Server](Server.md)
-- [OPC UA Client](Client.md)
+- [OPC UA Gateway](Gateway.md)
 - [Dashboard](Dashboard.md)
 - [Implemented Specifications](Specs.md)
+  - [Flat Glass Processing](Specs/Flatglass.md)
+  - [Geometrical Measuring Systems](Specs/GeometricalMeasuringSystems.md)
+  - [IJT - Tightening](Specs/WIP.md)
   - [MachineTool](Specs/MachineTool.md)
+  - [MachineVision](Specs/WIP.md)
   - [PlasticsRubber](Specs/PlasticsRubber.md)
+  - [Robotics](Specs/WIP.md)
   - [Software Solutions](Specs/Software.md)
   - [WoodWorking](Specs/Woodworking.md)
-  - [Geometrical Measuring Systems](Specs/GeometricalMeasuringSystems.md)
-  - [Flat Glass Processing](Specs/Flatglass.md)
 - Upcoming Specifications
-  - [Robotics](Specs/WIP.md)
-  - [MachineVision](Specs/WIP.md)
   - [Scales](Specs/WIP.md)
 - [Organizational Information](Organization.md)
   - [Fairs](Specs/Fairs.md)