Skip to content

Commit

Permalink
refactor: linting
Browse files Browse the repository at this point in the history
Signed-off-by: Goetz Goerisch <[email protected]>
  • Loading branch information
GoetzGoerisch committed Jan 15, 2025
1 parent c341494 commit 02e21bf
Show file tree
Hide file tree
Showing 18 changed files with 799 additions and 752 deletions.
35 changes: 35 additions & 0 deletions .github/linters/.markdown-lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
###########################
###########################
## Markdown Linter rules ##
###########################
###########################

# Linter rules doc:
# - https://github.com/DavidAnson/markdownlint
#
# Note:
# To comment out a single error:
# <!-- markdownlint-disable -->
# any violations you want
# <!-- markdownlint-restore -->
#

###############
# Rules by id #
###############
MD004: false # Unordered list style
MD007:
indent: 2 # Unordered list indentation
MD013:
line_length: 400 # Line length 80 is far too short
MD026:
punctuation: ".,;:!。,;:" # List of not allowed
MD029: false # Ordered list item prefix
MD033: false # Allow inline HTML
MD036: false # Emphasis used instead of a heading

#################
# Rules by tags #
#################
blank_lines: false # Error on blank lines
2 changes: 1 addition & 1 deletion FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This is most likely because your enterprise firewall is blocking UDP-Requests on

## Organizational questions

**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?**
**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?**
Yes, one is enough, but you are free to connect more.

**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?**
Expand Down
4 changes: 2 additions & 2 deletions Organization.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ Participants can provide more than one umati partner solution type.

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]))

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**.
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**.

### Services offered by umati iniative include

- Listing all participants on the [http://umati.org](http://umati.org) website, prints, presentations etc. where practicable in scope and extent.
- Listing all participants on the [http://umati.org](http://umati.org) site, prints, presentations etc. where practicable in scope and extent.
- Providing a corporate design to be used by all participants for free.
- Advertisement flyers, press conference, social media campaign with mentioning of all participants.
- Access to a partners-only repositiory with necessary files and instructions to implement a solution
Expand Down
44 changes: 22 additions & 22 deletions Specs/Fairs.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
# Defined Fair shortnames

| Shortname | Description | Site |
|-----------|------------------------|------|
| AMB | AMB Stuttgart | <https://www.messe-stuttgart.de/amb/> |
| AMTC | automatica | <https://automatica-munich.com/de/> |
| AMTECH | AMTech Shenzhen | <http://www.amtech-china.com/?lang=en> |
| CIMT | CIMT Beijing | <http://www.cimtshow.com/enindex.jsp> |
| CTRL | Control Stuttgart | <https://www.control-messe.de/> |
| EMO | EMO | <https://emo-milano.com/> |
| FORMNEXT | Formnext | <https://formnext.mesago.com/> |
| GLASSTEC | glasstec | <https://www.glasstec.de/> |
| GRIND | GrindingHub Stuttgart | <https://www.grindinghub.de/> |
| HMI | Hannover Messe | <https://www.hannovermesse.de/> |
| IMTS | IMTS | <https://www.imts.com/> |
| INNOTEQ | Innoteq | <https://www.innoteq.digital/> |
| ITMA | ITMA Milano | <https://itma.com/> |
| JIMTOF | JIMTOF | <https://www.jimtof.org/en/> |
| K | K | <https://www.k-online.de/> |
| LASER | Laser World of Photonics | <https://world-of-photonics.com/de/> |
| LIGNA | LIGNA Hannover | <https://www.ligna.de/> |
| METAV | METAV | <https://metav.de> |
| SPS | SPS Nürnberg | <https://sps.mesago.com/> |
| VIRTUAL | Permanent virtual fair | <https://umati.app> |
| Shortname | Description | Site |
| --------- | ------------------------ | -------------------------------------- |
| AMB | AMB Stuttgart | <https://www.messe-stuttgart.de/amb/> |
| AMTC | automatica | <https://automatica-munich.com/de/> |
| AMTECH | AMTech Shenzhen | <http://www.amtech-china.com/?lang=en> |
| CIMT | CIMT Beijing | <http://www.cimtshow.com/enindex.jsp> |
| CTRL | Control Stuttgart | <https://www.control-messe.de/> |
| EMO | EMO | <https://emo-milano.com/> |
| FORMNEXT | Formnext | <https://formnext.mesago.com/> |
| GLASSTEC | glasstec | <https://www.glasstec.de/> |
| GRIND | GrindingHub Stuttgart | <https://www.grindinghub.de/> |
| HMI | Hannover Messe | <https://www.hannovermesse.de/> |
| IMTS | IMTS | <https://www.imts.com/> |
| INNOTEQ | Innoteq | <https://www.innoteq.digital/> |
| ITMA | ITMA Milano | <https://itma.com/> |
| JIMTOF | JIMTOF | <https://www.jimtof.org/en/> |
| K | K | <https://www.k-online.de/> |
| LASER | Laser World of Photonics | <https://world-of-photonics.com/de/> |
| LIGNA | LIGNA Hannover | <https://www.ligna.de/> |
| METAV | METAV | <https://metav.de> |
| SPS | SPS Nürnberg | <https://sps.mesago.com/> |
| VIRTUAL | Permanent virtual fair | <https://umati.app> |
63 changes: 32 additions & 31 deletions Specs/Flatglass.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The following describes the umati showcase information model for Flat Glass Proc

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.

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.
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

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

| **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. |
| --- | --- |
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

### Identification data

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

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

| **Attribute** | **Value** | | | | |
| --- | --- | --- | --- | --- | --- |
| BrowseName | MachineIdentificationType |
| IsAbstract | False |
| Description | Contains information about the identification and nameplate of a machine |
| | | | | | |
| **References** | **NodeClass** | **BrowseName** | **DataType** | **TypeDefinition** | **Other** |
| Subtype of the 2:FunctionalGroupType defined in OPC 10000-100, i.e. inheriting the InstanceDeclarations of that Node. |
| 0:HasProperty | Variable | 0:DefaultInstanceBrowseName | 0:QualifiedName | 0:PropertyType | |
| 0:HasInterface | ObjectType | IMachineVendorNameplateType |
| 0:HasInterface | ObjectType | IMachineTagNameplateType |
| Applied from IMachineVendorNameplateType | | | | | |
| 0:HasProperty | Variable | 2:ProductInstanceUri | 0:String | 0:PropertyType | M, RO |
| 0:HasProperty | Variable | 2:Manufacturer | 0:LocalizedText | 0:PropertyType | M, RO |
| 0:HasProperty | Variable | 2:ManufacturerUri | 0:String | 0:PropertyType | O, RO |
| 0:HasProperty | Variable | **2:Model** | 0:LocalizedText | 0:PropertyType | **M**, RO |
| 0:HasProperty | Variable | **2:ProductCode** | 0:String | 0:PropertyType | **M**, RO |
| 0:HasProperty | Variable | 2:HardwareRevision | 0:String | 0:PropertyType | O, RO |
| 0:HasProperty | Variable | **2:SoftwareRevision** | 0:String | 0:PropertyType | **M**, RO |
| 0:HasProperty | Variable | **2:DeviceClass** | 0:String | 0:PropertyType | **M**, RO |
| 0:HasProperty | Variable | 2:SerialNumber | 0:String | 0:PropertyType | M, RO |
| 0:HasProperty | Variable | **YearOfConstruction** | UInt16 | 0:PropertyType | **M**, RO |
| 0:HasProperty | Variable | MonthOfConstruction | Byte | 0:PropertyType | O, RO |
| 0:HasProperty | Variable | InitialOperationDate | DateTime | 0:PropertyType | O, RO |
| Applied from IMachineTagNameplateType | | | | | |
| 0:HasProperty | Variable | 2:AssetId | 0:String | 0:PropertyType | O, RW |
| 0:HasProperty | Variable | 2:ComponentName | 0:LocalizedText | 0:PropertyType | O, RW |
| 0:HasProperty | Variable | **Location** | 0:String | 0:PropertyType | **M**, RW |
| **Attribute** | **Value** | | | | |
| --------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | --------------------------- | --------------- | ------------------ | --------- |
| BrowseName | MachineIdentificationType | | | | |
| IsAbstract | False | | | | |
| Description | Contains information about the identification and nameplate of a machine | | | | |
| | | | | | |
| **References** | **NodeClass** | **BrowseName** | **DataType** | **TypeDefinition** | **Other** |
| Subtype of the 2:FunctionalGroupType defined in OPC 10000-100, i.e. inheriting the InstanceDeclarations of that Node. | | | | | |
| 0:HasProperty | Variable | 0:DefaultInstanceBrowseName | 0:QualifiedName | 0:PropertyType | |
| 0:HasInterface | ObjectType | IMachineVendorNameplateType | | | |
| 0:HasInterface | ObjectType | IMachineTagNameplateType | | | |
| Applied from IMachineVendorNameplateType | | | | | |
| 0:HasProperty | Variable | 2:ProductInstanceUri | 0:String | 0:PropertyType | M, RO |
| 0:HasProperty | Variable | 2:Manufacturer | 0:LocalizedText | 0:PropertyType | M, RO |
| 0:HasProperty | Variable | 2:ManufacturerUri | 0:String | 0:PropertyType | O, RO |
| 0:HasProperty | Variable | **2:Model** | 0:LocalizedText | 0:PropertyType | **M**, RO |
| 0:HasProperty | Variable | **2:ProductCode** | 0:String | 0:PropertyType | **M**, RO |
| 0:HasProperty | Variable | 2:HardwareRevision | 0:String | 0:PropertyType | O, RO |
| 0:HasProperty | Variable | **2:SoftwareRevision** | 0:String | 0:PropertyType | **M**, RO |
| 0:HasProperty | Variable | **2:DeviceClass** | 0:String | 0:PropertyType | **M**, RO |
| 0:HasProperty | Variable | 2:SerialNumber | 0:String | 0:PropertyType | M, RO |
| 0:HasProperty | Variable | **YearOfConstruction** | UInt16 | 0:PropertyType | **M**, RO |
| 0:HasProperty | Variable | MonthOfConstruction | Byte | 0:PropertyType | O, RO |
| 0:HasProperty | Variable | InitialOperationDate | DateTime | 0:PropertyType | O, RO |
| Applied from IMachineTagNameplateType | | | | | |
| 0:HasProperty | Variable | 2:AssetId | 0:String | 0:PropertyType | O, RW |
| 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 location of the machine icon on the dashboard

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

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

- 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.
- 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.

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

Expand Down
Loading

0 comments on commit 02e21bf

Please sign in to comment.