doc(WWM): Prepare Woodworking for release

umati · Sep 1, 2021 · 7642c16 · 7642c16
1 parent 0c9895a
commit 7642c16
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -17,6 +17,7 @@ To learn more please visit [https://umati.org](https://umati.org)
 - [Implemented Specifications](Specs.md)
   - [Machinetools](Specs/Machinetools.md)
   - [Software Solutions](Specs/Software.md)
+  - [WoodWorking](Specs/WoodWorking.md)
 - Upcoming Specifications
   - [Robotics](Specs/WIP.md)
   - [PlasticsRubber](Specs/WIP.md)

diff --git a/Specs/WoodWorking.md b/Specs/WoodWorking.md
@@ -10,13 +10,11 @@ For participants that are familiar with the information model, we have included
 
 All participants not familiar with the release candidate information model do not need to review these changes in detail but rather follow the described model and refer to the provided xml Nodeset files and UA modeler project.
 
-### NodeSets for the showcase
+## NodeSets for the showcase
 
 [Release NodeSet](https://)
 
-[Protoyping NodeSet](https://)
-
-**Remark:** You have to be umati partner and added to the access list. (Contact: [info@umati.org](mailto:info@umati.org))
+[Protoyping NodeSet](https://github.com/umati/Woodworking/tree/main/Model) **Remark:** You have to be umati partner and added to the access list. (Contact: [info@umati.org](mailto:info@umati.org))
 
 ## General information valid for the umati showcase demonstration
 
@@ -28,7 +26,7 @@ All participants not familiar with the release candidate information model do no
 The identification for machine tools are inherited from the Machinery companion specification.
 To fill the demo dashboard machine page with the most content the variables marked with a **strong mandatory** should be provided if you like to look the machine identification nicely.
 
-#### [**MachineIdentificationType Definition**](https://opcua.vdma.org/catalog-detail/-/catalog/3803)
+#### [**MachineIdentificationType Definition**](https://reference.opcfoundation.org/Machinery/docs/8.6/)
 
 | **Attribute** | **Value** |     |     |     |     |
 | --- | --- | --- | --- | --- | --- |
@@ -59,11 +57,9 @@ To fill the demo dashboard machine page with the most content the variables mark
 | 0:HasProperty | Variable | 2:ComponentName | 0:LocalizedText | 0:PropertyType | O, RW |
 | 0:HasProperty | Variable | **Location** | 0:String | 0:PropertyType | **M**, RW |
 
-#### Special requirements for correct locating on the dashboard
-
-The instance Location 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`
+#### Special requirements for correct location of the machine icon on the dashboard
 
-If the machine shall be referenced to more than one fair, provide a list of fair location, deliminated by slash e.g. `METAV <XXX> <XXX>/EMO 12 D17/N 51.257315 E 6.740885`
+The instance _Location_ property is evaluated according to the special requirements detailed [here](DASHBOARD.md#location-of-fair-machine-and-software-icons-on-the-dashboard) to place a map icon for the machine.
 
 #### FAIR Shortnames
 
@@ -85,7 +81,7 @@ Fair shortnames are defined [here.](Fairs.md)
 ### Wood Working - Overview
 
 ![Overview](../img/WoodWorking/WWM-Overview.png "WW Overview")
- 
+
 ### Active Program Statusbar
 
 For the status overview in the dashboard, the *State* of the *RecipeInRun* is stored and plotted over time. The status bar **does NOT relate to the stacklight** status!
@@ -120,11 +116,20 @@ A gap is left for periods of time in which no data was recorded (e.g. machine of
 
 ### Device Classes
 
+Based on the _DeviceClass_ the image for the individual machine page is selected.
+
+This is the current mapping:
+
+#### Throughfeed
+
 - SawingMachine --> Throughfeed
 - ProfilingMachine --> Throughfeed
 - EdgebandingMachine --> Throughfeed
 - BoringMachine --> Throughfeed
 - SandingMachine --> Throughfeed
-- MachiningCenter --> Stationary
-- Press --> Stationary
 - HandlingMachine --> Throughfeed
+
+#### Stationary
+
+- MachiningCenter
+- Press
diff --git a/index.md b/index.md
@@ -19,8 +19,8 @@ To learn more please visit [https://umati.org](https://umati.org)
 - [Implemented Specifications](Specs.md)
   - [Machinetools](Specs/Machinetools.md)
   - [Software Solutions](Specs/Software.md)
-- Upcoming Specifications
   - [Woodworking](Specs/Woodworking.md)
+- Upcoming Specifications
   - [Robotics](Specs/WIP.md)
   - [PlasticsRubber](Specs/WIP.md)
   - [MachineVision](Specs/WIP.md)
@@ -43,6 +43,7 @@ This documentation is versioned, as some content details will be delivered later
 | v1.02.2 | 23.11.2020 | Update License and activate CLA |
 | v1.02.3 | 18.02.2021 | Update on Machine Tools and Software Solutions |
 | v1.03.0 | 21.05.2021 | Complete update to latest developments |
+| v1.04.0 | 03.09.2021 | Addition of WoodWorking companion specification |
 
 ### Changelog
 
@@ -58,7 +59,7 @@ This documentation is versioned, as some content details will be delivered later
 | [Machinetools](Specs/Machinetools.md) | Description | Clarification of nodesets and requirements | [c61c73f](https://github.com/umati/Showcase/commit/c61c73fa74b17dce58fd7c938f9992746dbf688d) [e9313fb](https://github.com/umati/Showcase/commit/e9313fb65cd264aee6c256a43e3fd758b737c449) |
 | [Machinetools](Specs/Machinetools.md) | Mapping | Updated pictures and mapping | [938a064](https://github.com/umati/Showcase/commit/938a0645771e879ca7cb5ab79be7706b0d4267d4)
 | [Server](SERVER.md) | Fairconnect | Updated fairconnect and connection possibilities | [4f46e04](https://github.com/umati/Showcase/commit/4f46e04431582ccbd1c6714cbd018255e1d09262) |
-
+| [Woodworking](Specs/Woodworking.md) | Specficaiton | Added specification for WoodWorking companion specification | [commit](commit) |
 
 ## Demonstrator story umati showcase