Skip to content

Commit abb7299

Browse files
committed
refactor: linting
Signed-off-by: Goetz Goerisch <[email protected]>
1 parent c341494 commit abb7299

18 files changed

+811
-754
lines changed

.github/linters/.markdown-lint.yml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
###########################
3+
###########################
4+
## Markdown Linter rules ##
5+
###########################
6+
###########################
7+
8+
# Linter rules doc:
9+
# - https://github.com/DavidAnson/markdownlint
10+
#
11+
# Note:
12+
# To comment out a single error:
13+
# <!-- markdownlint-disable -->
14+
# any violations you want
15+
# <!-- markdownlint-restore -->
16+
#
17+
18+
###############
19+
# Rules by id #
20+
###############
21+
MD004: false # Unordered list style
22+
MD007:
23+
indent: 2 # Unordered list indentation
24+
MD013:
25+
line_length: 400 # Line length 80 is far too short
26+
MD026:
27+
punctuation: ".,;:!。,;:" # List of not allowed
28+
MD029: false # Ordered list item prefix
29+
MD033: false # Allow inline HTML
30+
MD036: false # Emphasis used instead of a heading
31+
32+
#################
33+
# Rules by tags #
34+
#################
35+
blank_lines: false # Error on blank lines

FAQ.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This is most likely because your enterprise firewall is blocking UDP-Requests on
88

99
## Organizational questions
1010

11-
**The participant shall connect to the demonstrator scenario with a machine and/ or a “value-added service” (platform, dashboard,…). Are there any number limits or is just one machine OK?**
11+
**The participant shall connect to the demonstrator scenario with a machine and/ or a “value-added service” (platform, dashboard,…). Are there any number limits or is just one machine OK?**
1212
Yes, one is enough, but you are free to connect more.
1313

1414
**After implemented UMATI on the machine, the UMATI booth will show my machine on the dashboard as well as the machines of other participants. Is my understanding, right?**

Organization.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@ Participants can provide more than one umati partner solution type.
2222

2323
Regulations concerning offered services, obligations of the participants and brand usage are collected in a **memorandum of understanding** (MoU) which participants of the umati showcase will need to sign ahead of the umati showcase demonstration. Please refer to **MoU document** for further information. (Please request a copy by mailing to [[email protected]](mailto:[email protected]))
2424

25-
Every participant is permitted to advertise his or her involvement in the umati community through the free, time-limited **&quot;umati partner&quot;** logo, e.g. in the web or in prints etc. Details of this permission are regulated in the individual **MoU**.
25+
Every participant is permitted to advertise his or her involvement in the umati community through the free, time-limited **&quot;umati partner&quot;** logo, e.g. in the web or in prints etc. Details of this permission are regulated in the individual **MoU**.
2626

2727
### Services offered by umati iniative include
2828

29-
- Listing all participants on the [http://umati.org](http://umati.org) website, prints, presentations etc. where practicable in scope and extent.
29+
- Listing all participants on the [http://umati.org](http://umati.org) site, prints, presentations etc. where practicable in scope and extent.
3030
- Providing a corporate design to be used by all participants for free.
3131
- Advertisement flyers, press conference, social media campaign with mentioning of all participants.
3232
- Access to a partners-only repositiory with necessary files and instructions to implement a solution

Specs/Fairs.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
# Defined Fair shortnames
22

3-
| Shortname | Description | Site |
4-
|-----------|------------------------|------|
5-
| AMB | AMB Stuttgart | <https://www.messe-stuttgart.de/amb/> |
6-
| AMTC | automatica | <https://automatica-munich.com/de/> |
7-
| AMTECH | AMTech Shenzhen | <http://www.amtech-china.com/?lang=en> |
8-
| CIMT | CIMT Beijing | <http://www.cimtshow.com/enindex.jsp> |
9-
| CTRL | Control Stuttgart | <https://www.control-messe.de/> |
10-
| EMO | EMO | <https://emo-milano.com/> |
11-
| FORMNEXT | Formnext | <https://formnext.mesago.com/> |
12-
| GLASSTEC | glasstec | <https://www.glasstec.de/> |
13-
| GRIND | GrindingHub Stuttgart | <https://www.grindinghub.de/> |
14-
| HMI | Hannover Messe | <https://www.hannovermesse.de/> |
15-
| IMTS | IMTS | <https://www.imts.com/> |
16-
| INNOTEQ | Innoteq | <https://www.innoteq.digital/> |
17-
| ITMA | ITMA Milano | <https://itma.com/> |
18-
| JIMTOF | JIMTOF | <https://www.jimtof.org/en/> |
19-
| K | K | <https://www.k-online.de/> |
20-
| LASER | Laser World of Photonics | <https://world-of-photonics.com/de/> |
21-
| LIGNA | LIGNA Hannover | <https://www.ligna.de/> |
22-
| METAV | METAV | <https://metav.de> |
23-
| SPS | SPS Nürnberg | <https://sps.mesago.com/> |
24-
| VIRTUAL | Permanent virtual fair | <https://umati.app> |
3+
| Shortname | Description | Site |
4+
| --------- | ------------------------ | -------------------------------------- |
5+
| AMB | AMB Stuttgart | <https://www.messe-stuttgart.de/amb/> |
6+
| AMTC | automatica | <https://automatica-munich.com/de/> |
7+
| AMTECH | AMTech Shenzhen | <http://www.amtech-china.com/?lang=en> |
8+
| CIMT | CIMT Beijing | <http://www.cimtshow.com/enindex.jsp> |
9+
| CTRL | Control Stuttgart | <https://www.control-messe.de/> |
10+
| EMO | EMO | <https://emo-milano.com/> |
11+
| FORMNEXT | Formnext | <https://formnext.mesago.com/> |
12+
| GLASSTEC | glasstec | <https://www.glasstec.de/> |
13+
| GRIND | GrindingHub Stuttgart | <https://www.grindinghub.de/> |
14+
| HMI | Hannover Messe | <https://www.hannovermesse.de/> |
15+
| IMTS | IMTS | <https://www.imts.com/> |
16+
| INNOTEQ | Innoteq | <https://www.innoteq.digital/> |
17+
| ITMA | ITMA Milano | <https://itma.com/> |
18+
| JIMTOF | JIMTOF | <https://www.jimtof.org/en/> |
19+
| K | K | <https://www.k-online.de/> |
20+
| LASER | Laser World of Photonics | <https://world-of-photonics.com/de/> |
21+
| LIGNA | LIGNA Hannover | <https://www.ligna.de/> |
22+
| METAV | METAV | <https://metav.de> |
23+
| SPS | SPS Nürnberg | <https://sps.mesago.com/> |
24+
| VIRTUAL | Permanent virtual fair | <https://umati.app> |

Specs/Flatglass.md

Lines changed: 32 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The following describes the umati showcase information model for Flat Glass Proc
66

77
For participants that are familiar with the information model, we have included comments and descriptions about changes between the release candidate information model and the showcase information model.
88

9-
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.
9+
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.
1010

1111
## NodeSets for the showcase
1212

@@ -15,7 +15,7 @@ All participants not familiar with the release candidate information model do no
1515
## General information valid for the umati showcase demonstration
1616

1717
| **DISCLAIMER** | For all applications the OPC UA server is to be configured without predefined NodeIDs for the instances. Clients will need to browse Instances or translate BrowsePaths find the NodeID for accessing the address space and available instances. |
18-
| --- | --- |
18+
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1919

2020
### Identification data
2121

@@ -24,34 +24,34 @@ To fill the demo dashboard machine page with the most content the variables mark
2424

2525
#### [**MachineIdentificationType Definition**](https://reference.opcfoundation.org/Machinery/docs/8.6/)
2626

27-
| **Attribute** | **Value** | | | | |
28-
| --- | --- | --- | --- | --- | --- |
29-
| BrowseName | MachineIdentificationType |
30-
| IsAbstract | False |
31-
| Description | Contains information about the identification and nameplate of a machine |
32-
| | | | | | |
33-
| **References** | **NodeClass** | **BrowseName** | **DataType** | **TypeDefinition** | **Other** |
34-
| Subtype of the 2:FunctionalGroupType defined in OPC 10000-100, i.e. inheriting the InstanceDeclarations of that Node. |
35-
| 0:HasProperty | Variable | 0:DefaultInstanceBrowseName | 0:QualifiedName | 0:PropertyType | |
36-
| 0:HasInterface | ObjectType | IMachineVendorNameplateType |
37-
| 0:HasInterface | ObjectType | IMachineTagNameplateType |
38-
| Applied from IMachineVendorNameplateType | | | | | |
39-
| 0:HasProperty | Variable | 2:ProductInstanceUri | 0:String | 0:PropertyType | M, RO |
40-
| 0:HasProperty | Variable | 2:Manufacturer | 0:LocalizedText | 0:PropertyType | M, RO |
41-
| 0:HasProperty | Variable | 2:ManufacturerUri | 0:String | 0:PropertyType | O, RO |
42-
| 0:HasProperty | Variable | **2:Model** | 0:LocalizedText | 0:PropertyType | **M**, RO |
43-
| 0:HasProperty | Variable | **2:ProductCode** | 0:String | 0:PropertyType | **M**, RO |
44-
| 0:HasProperty | Variable | 2:HardwareRevision | 0:String | 0:PropertyType | O, RO |
45-
| 0:HasProperty | Variable | **2:SoftwareRevision** | 0:String | 0:PropertyType | **M**, RO |
46-
| 0:HasProperty | Variable | **2:DeviceClass** | 0:String | 0:PropertyType | **M**, RO |
47-
| 0:HasProperty | Variable | 2:SerialNumber | 0:String | 0:PropertyType | M, RO |
48-
| 0:HasProperty | Variable | **YearOfConstruction** | UInt16 | 0:PropertyType | **M**, RO |
49-
| 0:HasProperty | Variable | MonthOfConstruction | Byte | 0:PropertyType | O, RO |
50-
| 0:HasProperty | Variable | InitialOperationDate | DateTime | 0:PropertyType | O, RO |
51-
| Applied from IMachineTagNameplateType | | | | | |
52-
| 0:HasProperty | Variable | 2:AssetId | 0:String | 0:PropertyType | O, RW |
53-
| 0:HasProperty | Variable | 2:ComponentName | 0:LocalizedText | 0:PropertyType | O, RW |
54-
| 0:HasProperty | Variable | **Location** | 0:String | 0:PropertyType | **M**, RW |
27+
| **Attribute** | **Value** | | | | |
28+
| --------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | --------------------------- | --------------- | ------------------ | --------- |
29+
| BrowseName | MachineIdentificationType | | | | |
30+
| IsAbstract | False | | | | |
31+
| Description | Contains information about the identification and nameplate of a machine | | | | |
32+
| | | | | | |
33+
| **References** | **NodeClass** | **BrowseName** | **DataType** | **TypeDefinition** | **Other** |
34+
| Subtype of the 2:FunctionalGroupType defined in OPC 10000-100, i.e. inheriting the InstanceDeclarations of that Node. | | | | | |
35+
| 0:HasProperty | Variable | 0:DefaultInstanceBrowseName | 0:QualifiedName | 0:PropertyType | |
36+
| 0:HasInterface | ObjectType | IMachineVendorNameplateType | | | |
37+
| 0:HasInterface | ObjectType | IMachineTagNameplateType | | | |
38+
| Applied from IMachineVendorNameplateType | | | | | |
39+
| 0:HasProperty | Variable | 2:ProductInstanceUri | 0:String | 0:PropertyType | M, RO |
40+
| 0:HasProperty | Variable | 2:Manufacturer | 0:LocalizedText | 0:PropertyType | M, RO |
41+
| 0:HasProperty | Variable | 2:ManufacturerUri | 0:String | 0:PropertyType | O, RO |
42+
| 0:HasProperty | Variable | **2:Model** | 0:LocalizedText | 0:PropertyType | **M**, RO |
43+
| 0:HasProperty | Variable | **2:ProductCode** | 0:String | 0:PropertyType | **M**, RO |
44+
| 0:HasProperty | Variable | 2:HardwareRevision | 0:String | 0:PropertyType | O, RO |
45+
| 0:HasProperty | Variable | **2:SoftwareRevision** | 0:String | 0:PropertyType | **M**, RO |
46+
| 0:HasProperty | Variable | **2:DeviceClass** | 0:String | 0:PropertyType | **M**, RO |
47+
| 0:HasProperty | Variable | 2:SerialNumber | 0:String | 0:PropertyType | M, RO |
48+
| 0:HasProperty | Variable | **YearOfConstruction** | UInt16 | 0:PropertyType | **M**, RO |
49+
| 0:HasProperty | Variable | MonthOfConstruction | Byte | 0:PropertyType | O, RO |
50+
| 0:HasProperty | Variable | InitialOperationDate | DateTime | 0:PropertyType | O, RO |
51+
| Applied from IMachineTagNameplateType | | | | | |
52+
| 0:HasProperty | Variable | 2:AssetId | 0:String | 0:PropertyType | O, RW |
53+
| 0:HasProperty | Variable | 2:ComponentName | 0:LocalizedText | 0:PropertyType | O, RW |
54+
| 0:HasProperty | Variable | **Location** | 0:String | 0:PropertyType | **M**, RW |
5555

5656
#### Special requirements for correct location of the machine icon on the dashboard
5757

@@ -68,7 +68,8 @@ Fair shortnames are defined [here.](Fairs.md)
6868

6969
`http://www.<MANUFACTURERDOMAIN>/example`
7070

71-
- The rules for creating a URI can be found online. Please follow [this link](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier). In the case of a URL as a URI, it is not necessary that the site actually exists, it only identifies the machine uniquely. In order to simplify debugging it is recommended to choose a URI which allows an identification of the machine also for third persons, e.g. by including the company name.
71+
- The rules for creating a URI can be found online. Please follow [this link](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier).
72+
In the case of a URL as a URI, it is not necessary that the site actually exists, it only identifies the machine uniquely. In order to simplify debugging it is recommended to choose a URI which allows an identification of the machine also for third persons, e.g. by including the company name.
7273

7374
- The machine will get a unique NamespaceURI after being integrated to the datahub by addition of a suffix to ensure unique namespaces.
7475

0 commit comments

Comments
 (0)