diff --git a/published/Data Model for Asset Location/1/0/docs/antora.yml b/published/Data Model for Asset Location/1/0/docs/antora.yml new file mode 100644 index 00000000..5db8771a --- /dev/null +++ b/published/Data Model for Asset Location/1/0/docs/antora.yml @@ -0,0 +1,4 @@ +name: Data Model for Asset Location +title: 'Data Model for Asset Location' +version: 'v1.0' +start_page: ROOT:index.adoc \ No newline at end of file diff --git a/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/Figure_1.png b/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/Figure_1.png new file mode 100644 index 00000000..e587999b Binary files /dev/null and b/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/Figure_1.png differ diff --git a/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/Figure_2.png b/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/Figure_2.png new file mode 100644 index 00000000..51cb49be Binary files /dev/null and b/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/Figure_2.png differ diff --git a/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/Figure_3.png b/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/Figure_3.png new file mode 100644 index 00000000..896f5485 Binary files /dev/null and b/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/Figure_3.png differ diff --git a/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/SMT-template-cover.svg b/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/SMT-template-cover.svg new file mode 100644 index 00000000..356c2fb6 --- /dev/null +++ b/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/SMT-template-cover.svg @@ -0,0 +1,1266 @@ + + + +SPECIFICATIONSubmodel Template of theAsset Administration Shell diff --git a/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/asciidoc-style-idta.css b/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/asciidoc-style-idta.css new file mode 100644 index 00000000..cc2879f2 --- /dev/null +++ b/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/asciidoc-style-idta.css @@ -0,0 +1,97 @@ +@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"; +@import "https://cdn.jsdelivr.net/gh/asciidoctor/asciidoctor@2.0/data/stylesheets/asciidoctor-default.css"; + +h1, h2, h3, h4, h5, h6, #toctitle, +.sidebarblock > .content > .title { + color: rgba(0, 0, 0, 0.8); +} + +#toc { + background:-color #ffffff; +} + +#toctitle { + color: #0028cd; +} + +a { + color: #17418a; +} + +a:hover, a:focus { + color: rgb(8, 24, 117); +} + +h1, h2, h3, .sidebarblock > .content > .title, h4, h5, h6 { + color: #3149cc; +} + +.subheader, .admonitionblock td.content > .title, .audioblock > .title, .exampleblock > .title, .imageblock > .title, .listingblock > .title, .literalblock > .title, .stemblock > .title, .openblock > .title, .paragraph > .title, .quoteblock > .title, table.tableblock > .title, .verseblock > .title, .videoblock > .title, .dlist > .title, .olist > .title, .ulist > .title, .qlist > .title, .hdlist > .title { + color: #303030; +} + +:not(pre):not([class^=L])>code { + background-color: #e0e0e0; +} + +table thead, table tfoot { + background: #f7f8f7; + background-color: rgb(247, 248, 247); + background-position-x: 0%; + background-position-y: 0%; + background-repeat: repeat; + background-attachment: scroll; + background-image: none; + background-size: auto; + background-origin: padding-box; + background-clip: border-box; +} + +/* Problem handling with long strings in the tables */ +/* This seems no appropriate or last resort (sliders) + table { + display: block; + width: max-content; + max-width: 100%; + overflow-x: auto; + } +*/ + +/* This seems to work: */ +table { + word-wrap: anywhere; +} + +.huge { + font-family: 'Open Sans'; + font-size: 3em; + line-height: 1.1em; +} + +.large { + font-family: 'Open Sans'; + font-size: 1.8em; + line-height: 1.1em; +} + +.normal { + font-family: 'Open Sans'; + font-size: 1em; + line-height: 1.1em; +} + +.white { + color: #ffffff; +} + +.redboxoneround { + padding: 0.3em 1em 0.3em 1em; + margin: 0.5em 0 0.5em 0; + font-family: 'Open Sans'; + font-size: 2em; + color: #ffffff; + line-height: 1.1em; + letter-spacing: 0.1em; + background-color: #fe4f0e; + border-radius: 0 0.35em 0 0; +} \ No newline at end of file diff --git a/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/compile-html.bat b/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/compile-html.bat new file mode 100644 index 00000000..662c550b --- /dev/null +++ b/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/compile-html.bat @@ -0,0 +1 @@ +docker run -it -v .:/documents/ asciidoctor/docker-asciidoctor asciidoctor -r asciidoctor-diagram -a toc=left -a stylesheet=asciidoc-style-idta.css *.adoc \ No newline at end of file diff --git a/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/compile-pdf-line-nrs.bat b/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/compile-pdf-line-nrs.bat new file mode 100644 index 00000000..9be41708 --- /dev/null +++ b/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/compile-pdf-line-nrs.bat @@ -0,0 +1 @@ +docker run -it -v .:/documents/ asciidoctor/docker-asciidoctor asciidoctor-pdf -r asciidoctor-diagram -r ./extended.rb -a toc=macro -a pdf-theme=my-theme.yml -a env-pdf *.adoc \ No newline at end of file diff --git a/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/compile-pdf.bat b/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/compile-pdf.bat new file mode 100644 index 00000000..65c255ef --- /dev/null +++ b/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/compile-pdf.bat @@ -0,0 +1 @@ +docker run -it -v .:/documents/ asciidoctor/docker-asciidoctor asciidoctor-pdf -r asciidoctor-diagram -a toc=macro -a pdf-theme=my-theme.yml -a env-pdf *.adoc \ No newline at end of file diff --git a/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/extended.rb b/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/extended.rb new file mode 100644 index 00000000..757cc465 --- /dev/null +++ b/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/extended.rb @@ -0,0 +1,27 @@ +# This file is taken from the extension examples from the asciidoctor-pdf repository. +# https://github.com/asciidoctor/asciidoctor-pdf/blob/main/docs/modules/extend/examples/pdf-converter-numbered-paragraphs.rb + + +class PDFConverterNumberedParagraphs < (Asciidoctor::Converter.for 'pdf') + register_for 'pdf' + + def init_pdf doc + doc + .find_by(context: :paragraph) {|candidate| [:document, :section].include? candidate.parent.context } + .each_with_index {|paragraph, idx| paragraph.set_attr 'number', idx + 1 } + super + end + + def convert_paragraph node + if (paragraph_number = node.attr 'number') + float do + label = %(#{paragraph_number}.#{::Prawn::Text::NBSP}) + label_width = rendered_width_of_string label + bounding_box [-label_width, cursor], width: label_width do + ink_prose label, color: 'CCCCCC', align: :right, margin: 0, single_line: true + end + end + end + super + end +end diff --git a/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/idta-cover-logo-small.png b/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/idta-cover-logo-small.png new file mode 100644 index 00000000..8e821f9f Binary files /dev/null and b/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/idta-cover-logo-small.png differ diff --git a/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/idta-smt-badge.png b/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/idta-smt-badge.png new file mode 100644 index 00000000..ab505e50 Binary files /dev/null and b/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/idta-smt-badge.png differ diff --git a/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/idta-spec-badge.png b/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/idta-spec-badge.png new file mode 100644 index 00000000..5ef5260f Binary files /dev/null and b/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/idta-spec-badge.png differ diff --git a/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/my-theme.yml b/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/my-theme.yml new file mode 100644 index 00000000..cba8d6c2 --- /dev/null +++ b/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/my-theme.yml @@ -0,0 +1,103 @@ +extends: default-for-print + +title-page: + text_align: left + margin-inner: -1cm + margin-outer: -1cm + title: + top: 8cm + font_size: 42 + font_style: bold + font_color: D9D9D9 + line_height: 1.2 + subtitle: + margin-top: 1cm + font_size: 42 + font_color: D9D9D9 + font_style: normal + line_height: 1.0 + authors: + margin-top: 1cm + font_size: 18 + font_color: D9D9D9 + font_style: normal + line_height: 1 + revision: + margin-top: 1cm + font_size: 18 + font_color: D9D9D9 + font_style: normal + line_height: 1 + background-image: image:SMT-template-cover.svg[fit=cover] + logo: + top: 21.7cm + align: right + image: image:idta-smt-badge.png[pdfwidth=48%] +page: + layout: portrait + margin: [1.5cm, 2cm, 1.5cm, 2cm] + size: A4 +base: + font-color: #333333 + font-family: Helvetica + font-size: 10 + line-height-length: 11.5 + line-height: $base-line-height-length / $base-font-size +role: + removed: + font-style: italic + text-decoration: line-through + text-decoration-color: #FF0000 + huge: + font-family: Helvetica + font-size: 24 + large: + font-family: Helvetica + font-size: 16 + normal: + font-family: Helvetica + font-size: 12 + white: + font-color: #ffffff + redboxoneround: + border-radius: [0.3cm, 0cm, 0cm, 0cm] + font-family: Helvetica + font-size: 16 + letter-spacing: $base-font-size * 1.1 + font-color: #ffffff + background-color: #fe4f0e +heading: + font-color: #3149cc + font-size: 17 + font-family: Helvetica + line-height: 1.2 + margin-bottom: 10 +link: + font-color: #17418a +list: + indent: $base-font-size * 1.2 + +table: + font-size: 10 + border-width: 0.5 + grid-width: 0.5 + border-color: #707070 + grid-color: #707070 + +pre: + font-color: #ff0000 + +code: + font-color: #505050 + font-style: bold + font-size: 11 + font-weight: 600 + +literal: + font-color: #3149cc + font-style: bold + font-size: 12 + font-weight: 800 +image: + # align: center + # problem: caption not able to center \ No newline at end of file diff --git a/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/watch_new_unzip_and_show.ps1 b/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/watch_new_unzip_and_show.ps1 new file mode 100644 index 00000000..46e59c47 --- /dev/null +++ b/published/Data Model for Asset Location/1/0/docs/modules/ROOT/images/watch_new_unzip_and_show.ps1 @@ -0,0 +1,107 @@ +# from: https://stackoverflow.com/questions/62350872/powershell-file-watcher-register-objectevent-wait-for-file-to-complete-copying + +# IMPORTANT: Copy this file to the folder being watchd (typically one level above) and run + +Clear-Host +$ErrorActionPreference = [System.Management.Automation.ActionPreference]::Stop + +$fileSystemWatcherDirPath = '.' +$fileSystemWatcherFilter = '*.zip' + +$fileSystemWatcher = [System.IO.FileSystemWatcher]::new($fileSystemWatcherDirPath , $fileSystemWatcherFilter) +$fileSystemWatcher.IncludeSubdirectories = $true +$fileSystemWatcher.EnableRaisingEvents = $true +$fileSystemWatcher.NotifyFilter = [System.IO.NotifyFilters]::FileName -bor [System.IO.NotifyFilters]::DirectoryName -bor [System.IO.NotifyFilters]::LastWrite # [System.Linq.Enumerable]::Sum([System.IO.NotifyFilters].GetEnumValues()) + +# Create syncronized hashtable +# $syncdFsItemEventHashT = [hashtable]::Synchronized([hashtable]::new()) +$global:syncdFsItemEventHashT = @{} + +$fileSystemWatcherAction = { + try { + $fsItemEvent = [pscustomobject]@{ + EventIdentifier = $Event.EventIdentifier + SourceIdentifier = $Event.SourceIdentifier + TimeStamp = (Get-Date) # $Event.TimeGenerated + FullPath = $Event.SourceEventArgs.FullPath + ChangeType = $Event.SourceEventArgs.ChangeType + } + + # Collecting event in synchronized hashtable (overrides existing keys so that only the latest event details are available) + # $syncdFsItemEventHashT = @{} + Write-Host $fsItemEvent.FullPath + Write-Host $syncdFsItemEventHashT + $syncdFsItemEventHashT[$fsItemEvent.FullPath] = $fsItemEvent + } catch { + Write-Host ($_ | Format-List * | Out-String ) -ForegroundColor red + } +} + +# Script block which processes collected events and do further actions like copying for backup, etc... +# That scriptblock was initially used to test "Start-Job". Unfortunately it's not possible to access and modify the synchronized hashtable created within this scope. +$fSItemEventProcessingJob = { + $keys = [string[]]$syncdFsItemEventHashT.psbase.Keys + + foreach ($key in $keys) { + $fsEvent = $syncdFsItemEventHashT[$key] + + try { + + Write-Host "Event has TS = ", $fsEvent.TimeStamp + + if ( ( (Get-Date) - $fsEvent.TimeStamp ).TotalSeconds -gt 3) { + + Write-Host "Finally processing: ", $fsEvent.FullPath + $syncdFsItemEventHashT.Remove($key) + + # do the work + Remove-Item 'new' -Recurse -ErrorAction SilentlyContinue + Expand-Archive -Path $fsEvent.FullPath -DestinationPath new + Set-Location .\new\ + Start-Process -FilePath 'compile-html.bat' -Wait + Start-Process -FilePath @(Get-ChildItem *.html)[0] + Set-Location .. + } + + } catch { + Write-Host ($_ | Format-List * | Out-String ) -ForegroundColor red + } + } +} + +[void] (Register-ObjectEvent -InputObject $fileSystemWatcher -EventName 'Created' -SourceIdentifier 'FSCreated' -Action $fileSystemWatcherAction) +[void] (Register-ObjectEvent -InputObject $fileSystemWatcher -EventName 'Changed' -SourceIdentifier 'FSChanged' -Action $fileSystemWatcherAction) +[void] (Register-ObjectEvent -InputObject $fileSystemWatcher -EventName 'Renamed' -SourceIdentifier 'FSRenamed' -Action $fileSystemWatcherAction) +[void] (Register-ObjectEvent -InputObject $fileSystemWatcher -EventName 'Deleted' -SourceIdentifier 'FSDeleted' -Action $fileSystemWatcherAction) + +Write-Host "Watching for changes in '$fileSystemWatcherDirPath'.`r`nPress CTRL+C to exit!" +try { + do { + Wait-Event -Timeout 1 + + if ($syncdFsItemEventHashT.Count -gt 0) { + Write-Host "`r`n" + Write-Host ('-' * 50) -ForegroundColor Green + Write-Host "Collected events in hashtable queue:" -ForegroundColor Green + $syncdFsItemEventHashT.Values | Format-Table | Out-String + } + + # Process hashtable items and do something with them (like copying, ..) + .$fSItemEventProcessingJob + + # Garbage collector + [GC]::Collect() + + } while ($true) + +} finally { + # unregister + Unregister-Event -SourceIdentifier 'FSChanged' + Unregister-Event -SourceIdentifier 'FSCreated' + Unregister-Event -SourceIdentifier 'FSDeleted' + Unregister-Event -SourceIdentifier 'FSRenamed' + + # dispose + $FileSystemWatcher.Dispose() + Write-Host "`r`nEvent Handler removed." +} diff --git a/published/Data Model for Asset Location/1/0/docs/modules/ROOT/pages/index.adoc b/published/Data Model for Asset Location/1/0/docs/modules/ROOT/pages/index.adoc new file mode 100644 index 00000000..d77c87ae --- /dev/null +++ b/published/Data Model for Asset Location/1/0/docs/modules/ROOT/pages/index.adoc @@ -0,0 +1,2123 @@ + += IDTA 02045-1-0 Data Model for Asset Location + +=== Imprint + +Publisher +[verse] +____ +Industrial Digital Twin Association +Lyoner Strasse 18 +60528 Frankfurt am Main +Germany +https://www.industrialdigitaltwin.org/ +____ + +=== Version history + +[cols="1,1,4"] +|=== + +|Date +|Version +|Comment + +|2024-07-01 +|1.0 +|Release of the official Submodel template published by IDTA. + +|=== + +:sectnums: + +:toclevels: 3 + +:xrefstyle: short + +<<< +toc::[] +<<< + +== General + +=== About this document +This document is a part of a specification series. Each part specifies the contents of a Submodel template for the Asset Administration Shell (AAS). The AAS is described in [1], [2], [3] and [6]. First exemplary Submodel contents were described in [4], while the actual format of this document was derived by the "Administration Shell in Practice" [5]. The format aims to be very concise, giving only minimal necessary information for applying a Submodel template, while leaving deeper descriptions and specification of concepts, structures and mapping to the respective documents [1] to [6]. + +The target group of the specification are developers and editors of technical documentation and manufacturer information, which are describing assets in smart manufacturing by means of the Asset Administration Shell (AAS) and therefore need to create a Submodel instance with a hierarchy of SubmodelElements. This document especially details on the question, which SubmodelElements with which semantic identification shall be used for this purpose. + +=== Scope of the Submodel +The location of static or mobile objects (assets / goods / trackables) and, if applicable, the origin and destination of transport processes are naturally the most important information in transport and internal logistics. In the past, the postal address or a simple location description (e.g., hall B, aisle 3) or a GNSS coordinate (Global Navigation Satellite System, like GPS) was sufficient as location information for controlling logistics processes. + +With the increasing propagation of localization technologies such as Ultra-Wideband (UWB), BLE (Bluetooth Low Energy), RFID (Radio-Frequency Identification) and others, the continuous and precise tracking of objects becomes possible at reasonable costs. This opens up new possibilities for the automation, monitoring and analysis of goods flows and internal transportation tasks. It is also possible to measure masses of localization data for short distances within buildings, which is why the integration of a localization solution into warehouse systems or production lines is becoming increasingly popular. The systems for localization are usually referred to as real-time location systems (RTLS). + +Automated guided vehicles (AGVs) and autonomous transport robots with free navigation (AGVs) are also increasingly being used for internal transportation tasks. These are another driver for the use of localization technologies in companies. + +*Further applications that require localization information are augmented reality or robotics applications in which in addition to the position the orientation of an object, the pose (6DoF), is of interest. This Submodel is not supporting 6DoF orientation information for now.* + +Location data for assets are determined by different localization systems during the life cycle and even at the same point in time more than one system can deliver a location information. Today location data originate from a variety of non-interoperable systems, for which the data model for the localization information is not standardized. + +Since asset location data are generated and used by different systems, for different use cases, in different life cycle phases and by different organizations it makes particular sense to manage the location data in the AAS of an asset in the form of a standardized Submodel. + +=== Relevant standards for the Submodel template +One important standard that aims the interoperability in the field of localization is the open locating standard omlox. Omlox is hosted under the umbrella of the PROFIBUS & PROFINET International (PI) organization. Omlox includes also a specification for omlox compliant locating systems and corresponding APIs. + +More information can be found here: + +• https://omlox.com/ +• https://www.profibus.com/technology/industrie-40/omlox-the-open-locating-standard + +In the attachment of this Submodel specification a mapping between the Submodel template and the omlox specification has been included. + +Further standards that have been considered regarding data for asset locations were: + +• link:https://www.geopose.org/[Open Geospatial Consortium (OGC) GeoPose 1.0 Data Exchange Standard] +• ISO 19116:2019(en): Geographic information – positioning services +• World Geodetic System - 1984 (WGS-84) + +There is as well an initiative announced for an OPC UA Companion Specification “Global Positioning”. + +== Approach of the Submodel + +=== Use cases and requirements +The use cases for localization of mobile objects can be, for example, divided into use cases for track & trace, location-based automation, production execution and maintenance as well as material flow. With track & trace, for example, manual search efforts can be reduced, or transportation resource utilization can be determined based on movement analyses. Track means the determination of the current location and trace means the traceability of the shipment's progress. This also includes applications for the traceability of the transport chain. + +Location-based automation means that events such as transport orders are triggered depending on the position of an object. + +When carrying out production or maintenance, location data helps to quickly reach the required components or machines to be serviced. + +The control and optimization of the material flow along the entire logistics chain using various transport and control systems is another field of application for localization technologies. + +In addition, also static objects have a permanent location that needs to be modeled. This can be used for example for use cases like navigation or as input for transportation orders where the origin and the destination can be linked to the Submodel instance. + +*In many applications the origin and destination of an asset will play a role, e.g., for navigation or transport orders. Origin and destination can again be, in this case stationary, assets with this location data Submodel.* + +The requirement was to reflect the wide rage of track & trace and localization use cases, the different needs on the quality of location data as well the different localization technologies with the Submodel template. + +Three structure elements ensure that the multitude of use cases can be supported. First the semantic structure of a geographically referenced region which is site, area (or building) and fence (see Figure 1) where a site can have one or more areas and/or fences assigned, and an area can have fences assigned. The second structure element are coordinate reference systems (CRS) which have so called “ground control points” for a mapping between a global geographic CRS and the local CRS which enables the coordinate transformation between all local coordinate reference systems. Site, area and fence can share the same coordinate reference system or just have their own. + +There is no need to model a site, area or fence in the AAS. At the minimum a position with an assigned CRS is sufficient. + +image::Figure_1.png[id="Figure_1", width="100.0%",title="Structure elements of a geographically outlined region."] + +A position (x,y,z-coordinate) is referenced to a CRS which will make it possible that an application based on +the data of an AAS is able to determine the semantic relationships for a position, namely the assignment to +one or more areas which the asset overlaps. + +An area can be of kind SITE, BUILDING or AREA_NOT_SPECIFIED. An area of kind +AREA_NOT_SPECIFIED can be a virtual boundary (fence) that unlike a SITE or BUILDING is not +representing a physical defined region. The main point of an area is to enable capturing entry and exit events +of assets entering or leaving an area. An area is therefore an essential concept for location-automation + +image::Figure_2.png[id="Figure_2", width="100.0%",title="Modelling of the height"] + +The modelling of the height is illustrated in Figure 2. For every CRS an ElevationReference has to be set +which is defining the reference for the height (z-value of a position). + +=== Structure and design decisions +The structure of the Submodel template is shown in Figure 3. The SubmodelElementLists “Adresses” and +“VisitedAreas” contain geographically referenced locations that an asset has visited during its lifecycle +phases. Areas can be referenced to their address(es). +VisitedAreas are regions that are defined wherein events are generated when an asset enters or leaves that +area. The SubmodelCollection AssetTraces contains the records of events, namely the entry and exit of +assets for VisitedAreas and with the SubmodelElementList LocationRecords the records of locations. + +The regions of VisitedAreas can be nested or overlap in arbitrary ways. In general, if the location of an asset +lies within multiple overlapping regions, individual events for each of the regions are generated. The events +are generated solely based of geographic relationship, e.g VisitedAreas have no direct relationship to +another but may spatially overlap. + +*For the SubmodelElementLists of the SubmodelElementCollection AssetTraces the order is relevant. The last entry +is the latest event or location that has been recorded.* + +image::Figure_3.png[id="Figure_3", width="100.0%",title="Information structuring of the Submodel template “Data Model for Asset Location”"] + + +== Approach of the Submodel + +=== SubmodelElements of the Submodel template “Data Model for Asset Location” + +// Table generated from [Submodel, www.example.com/ids/sm/2131_9040_9042_1482],[SubmodelElementCollection, Section_3_Submodel_and_SubmodelElements],[SubmodelElementCollection, Section_3_1_SubmodelElements_of_the_Submodel_template_Data_Model_for_Asset_Location],[ReferenceElement, Table_SubmodelElements_of_the_Submodel_template_Data_Model_for_Asset_Location] + + + +[width="100%", id="Table_SubmodelElements_of_the_Submodel_template_Data_Model_for_Asset_Location", title="SubmodelElements of the Submodel template “Data Model for Asset Location”", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}AssetLocation + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}Submodel + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/smt/assetlocation/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}- + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}Submodel for tracking & tracing of the location of an assets + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[SML] + + + +Addresses +|https://admin-shell.io/idta/sml/addresses/1/0 + + + + + +List with postal addresses where an object has been located +|[] + + + +1 elements +|0..1 + + + +|[SML] + + + +CoordinateSystems +|https://admin-shell.io/idta/sml/coordinatesystems/1/0 + + + + + +List with information about different coordinate systems that have been used to determine the location of an asset +|[] + + + +1 elements +|0..1 + + + +|[SML] + + + +VisitedAreas +|https://admin-shell.io/idta/sml/visitedareas/1/0 + + + + + +List with areas (e.g., sites, buildings, field warehouses) where an asset has been located or is located +|[] + + + +1 elements +|0..1 + + + +|[SMC] + + + +AssetTraces +|https://admin-shell.io/idta/smc/assettraces/1/0 + + + + + +Collection of localization event records for sites, areas, fences and locations +|[] + + + +4 elements +|0..1 + + + +|[SMC] + + + +AssetLocatingInformation +|https://admin-shell.io/idta/sml/assetlocatinginformation/1/0 + + + + + +Collection with additional information concerning the localization of an asset +|[] + + + +4 elements +|0..1 + + + +|=== + + + + +=== SubmodelElements of SML “Addresses” + +// Table generated from [Submodel, www.example.com/ids/sm/2131_9040_9042_1482],[SubmodelElementCollection, Section_3_Submodel_and_SubmodelElements],[SubmodelElementCollection, Section_3_2_SubmodelElements_of_SML_Addresses],[ReferenceElement, Table_SubmodelElements_of_SML_Addresses] + + + +[width="100%", id="Table_SubmodelElements_of_SML_Addresses", title="SubmodelElements of SML “Addresses”", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}Addresses + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementList + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/sml/addresses/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}AssetLocation + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}List with postal addresses where an object has been located + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}orderRelevant=No, semanticIdListElement=[GlobalReference, 0173-1#01-ADR442#007], typeValueListElement=SubmodelElementCollection + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[SMC] + + + +Address00 +|0173-1#01-ADR442#007 + + + + + +Postal addresses where an object has been located +|[] + + + +10 elements +| + + + +|=== + + + + +=== SubmodelElements of SMC “Address” + +// Table generated from [Submodel, www.example.com/ids/sm/2131_9040_9042_1482],[SubmodelElementCollection, Section_3_Submodel_and_SubmodelElements],[SubmodelElementCollection, Section_3_3_SubmodelElements_of_SMC_Address],[ReferenceElement, Table_SubmodelElements_of_SMC_Address] + + + +[width="100%", id="Table_SubmodelElements_of_SMC_Address", title="SubmodelElements of SMC “Address”", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}Address00 + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementCollection + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}0173-1#01-ADR442#007 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}Addresses + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}Postal addresses where an object has been located + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Prop] + + + +AddressLine1 +|0173-1#02-AAO124#004 + + + + + +address line 1 +|[String] + + + + +|0..1 + + + +|[Prop] + + + +AddressLine2 +|0173-1#02-AAO125#004 + + + + + +address line 2 +|[String] + + + + +|0..1 + + + +|[Prop] + + + +AddressLine3 +|0173-1#02-AAO126#004 + + + + + +address line 3 +|[String] + + + + +|0..1 + + + +|[Prop] + + + +AddressOfAdditionalLink +|0173-1#02-AAQ326#003 + + + + + +address of additional link +|[String] + + + + +|0..1 + + + +|[Prop] + + + +AddressRemarks +|0173-1#02-AAO202#004 + + + + + +address remarks +|[String] + + + + +|0..1 + + + +|[Prop] + + + +NationalCode +|0173-1#02-AAO134#003 + + + + + +national code +|[String] + + + + +|0..1 + + + +|[Prop] + + + +Statecounty +|0173-1#02-AAO133#003 + + + + + +state/county +|[String] + + + + +|0..1 + + + +|[Prop] + + + +Citytown +|0173-1#02-AAO132#003 + + + + + +city/town +|[String] + + + + +|0..1 + + + +|[Prop] + + + +Street +|0173-1#02-AAO128#003 + + + + + +street +|[String] + + + + +|0..1 + + + +|[Prop] + + + +ZipCode +|0173-1#02-AAO129#003 + + + + + +zip code +|[String] + + + + +|0..1 + + + +|=== + + + + +=== SubmodelElements of SML “CoordinateSystems” + +// Table generated from [Submodel, www.example.com/ids/sm/2131_9040_9042_1482],[SubmodelElementCollection, Section_3_Submodel_and_SubmodelElements],[SubmodelElementCollection, Section_3_4_SubmodelElements_of_SML_CoordinateSystems],[ReferenceElement, Table_SubmodelElements_of_SML_CoordinateSystems] + + + +[width="100%", id="Table_SubmodelElements_of_SML_CoordinateSystems", title="SubmodelElements of SML “CoordinateSystems”", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}CoordinateSystems + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementList + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/sml/coordinatesystems/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}AssetLocation + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}List with information about different coordinate systems that have been used to determine the location of an asset + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}orderRelevant=Yes, semanticIdListElement=[GlobalReference, https://admin-shell.io/idta/smc/coordinatesystemsrecord/1/0], typeValueListElement=SubmodelElementCollection + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[SMC] + + + +CoordinateSystem00 +|https://admin-shell.io/idta/smc/coordinatesystemsrecord/1/0 + + + + + +Coordinate reference system (CRS) record +|[] + + + +6 elements +| + + + +|=== + + + + +=== SubmodelElements of SMC “CoordinateSystemsRecord” + +// Table generated from [Submodel, www.example.com/ids/sm/2131_9040_9042_1482],[SubmodelElementCollection, Section_3_Submodel_and_SubmodelElements],[SubmodelElementCollection, Section_3_5_SubmodelElements_of_SMC_CoordinateSystemsRecord],[ReferenceElement, Table_SubmodelElements_of_SMC_CoordinateSystemsRecord] + + + +[width="100%", id="Table_SubmodelElements_of_SMC_CoordinateSystemsRecord", title="SubmodelElements of SMC “CoordinateSystemsRecord”", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}CoordinateSystem00 + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementCollection + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/smc/coordinatesystemsrecord/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}CoordinateSystems + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}Coordinate reference system (CRS) record + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Prop] + + + +CoordinateSystemName +|https://admin-shell.io/idta/prop/coordinatesystemname/1/0 + + + +coordinate system name +|[String] + + + + +|0..1 + + + +|[Prop] + + + +CoordinateSystemId +|https://admin-shell.io/idta/prop/coordinatesystemid/1/0 + + + +Identification of a coordinate system +|[String] + + + + +|1 + + + +|[Prop] + + + +CoordinateSystemType +|https://admin-shell.io/idta/prop/coordinatesystemtype/1/0 + + + +Type of a coordinate system with the allowed enumeration values "EPSG:4326" or "LOCAL" +|[String] + + + + +|1 + + + +|[Prop] + + + +ElevationReference +|https://admin-shell.io/idta/prop/elevationreference/1/0 + + + +Reference of the elevation information in a coordinate system; with the allowed enumeration values "SEALEVEL" or "LOCAL" +|[String] + + + + +|1 + + + +|[Prop] + + + +SeaLevelOfBaseHeight +|https://admin-shell.io/idta/prop/sealevelofbaseheight/1/0 + + + +Sea level of the base height of a coordinate system; normally the base height is at the origin of the coordinate system with Z=0,00 m +|[Float] + + + + +|0..1 + + + +|[SML] + + + +GroundControlPoints +|https://admin-shell.io/idta/sml/groundcontrolpoints/1/0 + + + + + +Arrays containing a mapping between geographic coordinates (longitude, latitude) in WGS84 (EPSG:4326) and relative coordinates (x,y) +|[] + + + +1 elements +|1 + + + +|=== + + + + +=== SubmodelElements of SML “GroundControlPoints” + +// Table generated from [Submodel, www.example.com/ids/sm/2131_9040_9042_1482],[SubmodelElementCollection, Section_3_Submodel_and_SubmodelElements],[SubmodelElementCollection, Section_3_6_SubmodelElements_of_SML_GroundControlPoints],[ReferenceElement, Table_SubmodelElements_of_SML_GroundControlPoints] + + + +[width="100%", id="Table_SubmodelElements_of_SML_GroundControlPoints", title="SubmodelElements of SML “GroundControlPoints”", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}GroundControlPoints + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementList + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/sml/groundcontrolpoints/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}CoordinateSystem00 + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}Arrays containing a mapping between geographic coordinates (longitude, latitude) in WGS84 (EPSG:4326) and relative coordinates (x,y) + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}orderRelevant=Yes, semanticIdListElement=[GlobalReference, https://admin-shell.io/idta/smc/groundcontrolpointsentry/1/0], typeValueListElement=SubmodelElementCollection + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[SMC] + + + +GroundControlPoint00 +|https://admin-shell.io/idta/smc/groundcontrolpointsentry/1/0 + + + + + +An array containing a mapping between geographic coordinates (longitude, latitude) in WGS84 (EPSG:4326) and relative coordinates (x,y) +|[] + + + +2 elements +| + + + +|=== + + + + +=== SubmodelElements of SMC “GroundControlPointsEntry + +// Table generated from [Submodel, www.example.com/ids/sm/2131_9040_9042_1482],[SubmodelElementCollection, Section_3_Submodel_and_SubmodelElements],[SubmodelElementCollection, Section_3_7_SubmodelElements_of_SMC_GroundControlPointsEntry],[ReferenceElement, Table_SubmodelElements_of_SMC_GroundControlPointsEntry] + + + +[width="100%", id="Table_SubmodelElements_of_SMC_GroundControlPointsEntry", title="SubmodelElements of SMC “GroundControlPointsEntry", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}GroundControlPoint00 + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementCollection + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/smc/groundcontrolpointsentry/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}GroundControlPoints + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}An array containing a mapping between geographic coordinates (longitude, latitude) in WGS84 (EPSG:4326) and relative coordinates (x,y) + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[SMC] + + + +GeographicCoordinates +| 0173-1#02-ABH934#002 + + + + +|[] + + + +2 elements +|1 + + + +|[SMC] + + + +RelativeCoordinates +|0173-1#02-ABG741#001 + + + + + +Coordinates within a cartisian coordinate system +|[] + + + +2 elements +|1 + + + +|=== + + + + +=== SubmodelElements of SMC “GeographicCoordinates” + +// Table generated from [Submodel, www.example.com/ids/sm/2131_9040_9042_1482],[SubmodelElementCollection, Section_3_Submodel_and_SubmodelElements],[SubmodelElementCollection, Section_3_8_SubmodelElements_of_SMC_GeographicCoordinates],[ReferenceElement, Table_SubmodelElements_of_SMC_GeographicCoordinates] + + + +[width="100%", id="Table_SubmodelElements_of_SMC_GeographicCoordinates", title="SubmodelElements of SMC “GeographicCoordinates”", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}GeographicCoordinates + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementCollection + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee} 0173-1#02-ABH934#002 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}GroundControlPoint00 + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee} + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Prop] + + + +Longitude +| 0173-1#02-ABH961#002 + + + + +|[Double] + + + + +|1 + + + +|[Prop] + + + +Latitude +| 0173-1#02-ABH960#002 + + + + +|[Double] + + + + +|1 + + + +|=== + + + + +=== SubmodelElements of SMC “RelativeCoordinates” + +// Table generated from [Submodel, www.example.com/ids/sm/2131_9040_9042_1482],[SubmodelElementCollection, Section_3_Submodel_and_SubmodelElements],[SubmodelElementCollection, Section_3_9_SubmodelElements_of_SMC_RelativeCoordinates],[ReferenceElement, Table_SubmodelElements_of_SMC_RelativeCoordinates] + + + +[width="100%", id="Table_SubmodelElements_of_SMC_RelativeCoordinates", title="SubmodelElements of SMC “RelativeCoordinates”", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}RelativeCoordinates + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementCollection + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}0173-1#02-ABG741#001 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}GroundControlPoint00 + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}Coordinates within a cartisian coordinate system + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Prop] + + + +X +|https://admin-shell.io/idta/prop/x/1/0 + + + +X-coordinate value within a coordinate system +|[Float] + + + + +|1 + + + +|[Prop] + + + +Y +|https://admin-shell.io/idta/prop/y/1/0 + + + +Y-coordinate value within a coordinate system +|[Float] + + + + +|1 + + + +|=== + + + + +=== SubmodelElements of SML “VisitedAreas” + +// Table generated from [Submodel, www.example.com/ids/sm/2131_9040_9042_1482],[SubmodelElementCollection, Section_3_Submodel_and_SubmodelElements],[SubmodelElementCollection, Section_3_10_SubmodelElements_of_SML_VisitedAreas],[ReferenceElement, Table_SubmodelElements_of_SML_VisitedAreas] + + + +[width="100%", id="Table_SubmodelElements_of_SML_VisitedAreas", title="SubmodelElements of SML “VisitedAreas”", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}VisitedAreas + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementList + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/sml/visitedareas/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}AssetLocation + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}List with areas (e.g., sites, buildings, field warehouses) where an asset has been located or is located + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}orderRelevant=No, semanticIdListElement=[GlobalReference, https://admin-shell.io/idta/smc/visitedareasrecord/1/0], typeValueListElement=SubmodelElementCollection + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[SMC] + + + +VisitedArea00 +|https://admin-shell.io/idta/smc/visitedareasrecord/1/0 + + + + + +Areas (e.g., site, building, field warehouse) where an asset has been located or is located +|[] + + + +9 elements +| + + + +|=== + + + + +=== SubmodelElements of SMC “VisitedAreasRecord” + +// Table generated from [Submodel, www.example.com/ids/sm/2131_9040_9042_1482],[SubmodelElementCollection, Section_3_Submodel_and_SubmodelElements],[SubmodelElementCollection, Section_3_11_SubmodelElements_of_SMC_VisitedAreasRecord],[ReferenceElement, Table_SubmodelElements_of_SMC_VisitedAreasRecord] + + + +[width="100%", id="Table_SubmodelElements_of_SMC_VisitedAreasRecord", title="SubmodelElements of SMC “VisitedAreasRecord”", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}VisitedArea00 + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementCollection + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/smc/visitedareasrecord/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}VisitedAreas + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}Areas (e.g., site, building, field warehouse) where an asset has been located or is located + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Ref] + + + +CoordinateSystemOfArea +|https://admin-shell.io/idta/ref/coordinatesystemreference/1/0 + + + + + +Reference to a local coordinate reference system for an area +|[] + + + +[Submodel, https://admin-shell.io/idta/smt/assetlocation] +|0..1 + + + +|[SML] + + + +AddressReferences +|https://admin-shell.io/idta/sml/addressreferences/1/0 + + + + + +List with references to addresses for the area (area addresses) +|[] + + + +1 elements +|0..1 + + + +|[SML] + + + +AreaRegionCoordinates +|https://admin-shell.io/idta/sml/regioncoordinates/1/0 + + + + + +Coordinates forming a polygon that describes the area within the coordinate reference system of the area +|[] + + + +1 elements +|0..1 + + + +|[Prop] + + + +KindOfArea +|https://admin-shell.io/idta/prop/kindofarea/1/0 + + + +Arealart +|[String] + + + + +|0..1 + + + +|[Prop] + + + +AreaName +|https://admin-shell.io/idta/prop/areaname/1/0 + + + + + +Name of the area or building +|[String] + + + + +|0..1 + + + +|[Prop] + + + +AreaId +|https://admin-shell.io/idta/prop/areaid/1/0 + + + + + +Identification of an area +|[String] + + + + +|1 + + + +|[MLP] + + + +AreaDesciption +|https://admin-shell.io/idta/mlp/areadescription/1/0 + + + + + +Description of an area +|[] + + + +Description of an area@en +|0..1 + + + +|[File] + + + +AreaLayout +|https://admin-shell.io/idta/file/arealayout/1/0 + + + + + +File with a layout (map) of the area (e.g., hall plan) +|[] + + + + +|0..1 + + + +|[Prop] + + + +BuildingLevel +|0173-1#02-ABJ094#001 + + + + +|[String] + + + + +|0..1 + + + +|=== + + + + +=== SubmodelElements of SML ”AreaRegionCoordinates” + +// Table generated from [Submodel, www.example.com/ids/sm/2131_9040_9042_1482],[SubmodelElementCollection, Section_3_Submodel_and_SubmodelElements],[SubmodelElementCollection, Section_3_12_SubmodelElements_of_SML_AreaRegionCoordinates],[ReferenceElement, Table_SubmodelElements_of_SML_AreaRegionCoordinates] + + + +[width="100%", id="Table_SubmodelElements_of_SML_AreaRegionCoordinates", title="SubmodelElements of SML ”AreaRegionCoordinates”", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}AreaRegionCoordinates + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementList + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/sml/regioncoordinates/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}VisitedArea00 + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}Coordinates forming a polygon that describes the area within the coordinate reference system of the area + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}orderRelevant=Yes, semanticIdListElement=[GlobalReference, https://admin-shell.io/idta/smc/regioncoordinateentry/1/0], typeValueListElement=SubmodelElementCollection + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[SMC] + + + +AreaRegionCoordinate00 +|https://admin-shell.io/idta/smc/regioncoordinateentry/1/0 + + + + + +One coordinate of coordinates forming a polygon that describes the region of the area within the coordinate reference system of the area +|[] + + + +2 elements +| + + + +|=== + + + + +=== SubmodelElements of SMC ”RegionCoordinateEntry” + +// Table generated from [Submodel, www.example.com/ids/sm/2131_9040_9042_1482],[SubmodelElementCollection, Section_3_Submodel_and_SubmodelElements],[SubmodelElementCollection, Section_3_13_SubmodelElements_of_SMC_RegionCoordinateEntry],[ReferenceElement, Table_SubmodelElements_of_SMC_RegionCoordinateEntry] + + + +[width="100%", id="Table_SubmodelElements_of_SMC_RegionCoordinateEntry", title="SubmodelElements of SMC ”RegionCoordinateEntry”", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}AreaRegionCoordinate00 + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementCollection + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/smc/regioncoordinateentry/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}AreaRegionCoordinates + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}One coordinate of coordinates forming a polygon that describes the region of the area within the coordinate reference system of the area + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Prop] + + + +X +|https://admin-shell.io/idta/prop/x/1/0 + + + +X-coordinate value within a coordinate system +|[Float] + + + + +|1 + + + +|[Prop] + + + +Y +|https://admin-shell.io/idta/prop/y/1/0 + + + +Y-coordinate value within a coordinate system +|[Float] + + + + +|1 + + + +|=== + + + + +=== SubmodelElements of SMC “AssetTraces” + +// Table generated from [Submodel, www.example.com/ids/sm/2131_9040_9042_1482],[SubmodelElementCollection, Section_3_Submodel_and_SubmodelElements],[SubmodelElementCollection, Section_3_14_SubmodelElements_of_SMC_AssetTraces],[ReferenceElement, Table_SubmodelElements_of_SMC_AssetTraces] + + + +[width="100%", id="Table_SubmodelElements_of_SMC_AssetTraces", title="SubmodelElements of SMC “AssetTraces”", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}AssetTraces + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementCollection + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/smc/assettraces/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}AssetLocation + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}Collection of localization event records for sites, areas, fences and locations + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Ref] + + + +AreaEventTimeSeriesData +|https://admin-shell.io/idta/ref/eventtimeseriesdata/1/0 + + + + + +Reference to an AAS time series data Submodel instance of the same AAS with AreaRecords +|[] + + + +[Submodel, https://admin-shell.io/idta/ref/eventtimeseriesdata/1/0] +|0..1 + + + +|[Ref] + + + +LocationEventTimeSeriesData +|https://admin-shell.io/idta/ref/eventtimeseriesdata/1/0 + + + + + +Reference to an AAS time series data Submodel instance of the same AAS with LocationRecords +|[] + + + +[Submodel, https://admin-shell.io/idta/ref/eventtimeseriesdata/1/0] +|0..1 + + + +|[SML] + + + +AreaRecords +|https://admin-shell.io/idta/sml/arearecords/1/0 + + + + + +List with records for area localization events +|[] + + + +1 elements +|0..1 + + + +|[SML] + + + +LocationRecords +|https://admin-shell.io/idta/sml/locationrecords/1/0 + + + + + +List with records for location (position) localization events +|[] + + + +1 elements +|0..1 + + + +|=== + + + + +=== SubmodelElements of SML “AreaRecords” + +// Table generated from [Submodel, www.example.com/ids/sm/2131_9040_9042_1482],[SubmodelElementCollection, Section_3_Submodel_and_SubmodelElements],[SubmodelElementCollection, Section_3_15_SubmodelElements_of_SML_AreaRecords],[ReferenceElement, Table_SubmodelElements_of_SML_AreaRecords] + + + +[width="100%", id="Table_SubmodelElements_of_SML_AreaRecords", title="SubmodelElements of SML “AreaRecords”", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}AreaRecords + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementList + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/sml/arearecords/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}AssetTraces + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}List with records for area localization events + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}orderRelevant=Yes, semanticIdListElement=[GlobalReference, https://admin-shell.io/idta/smc/arearecordsrecord/1/0], typeValueListElement=SubmodelElementCollection + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[SMC] + + + +AreaRecord00 +|https://admin-shell.io/idta/smc/arearecordsrecord/1/0 + + + + + +Record of an area localization event +|[] + + + +5 elements +| + + + +|=== + + + + +=== SubmodelElements of SMC “AreaRecordsRecord” + +// Table generated from [Submodel, www.example.com/ids/sm/2131_9040_9042_1482],[SubmodelElementCollection, Section_3_Submodel_and_SubmodelElements],[SubmodelElementCollection, Section_3_16_SubmodelElements_of_SMC_AreaRecordsRecord],[ReferenceElement, Table_SubmodelElements_of_SMC_AreaRecordsRecord] + + + +[width="100%", id="Table_SubmodelElements_of_SMC_AreaRecordsRecord", title="SubmodelElements of SMC “AreaRecordsRecord”", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}AreaRecord00 + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementCollection + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/smc/arearecordsrecord/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}AreaRecords + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}Record of an area localization event + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Ref] + + + +AreaRef +|https://admin-shell.io/idta/ref/areareference/1/0 + + + + + +Reference to the area where the event has been recorded for +|[] + + + +[Submodel, https://admin-shell.io/idta/smt/assetlocation] +|1 + + + +|[Prop] + + + +Time +| 0173-1#02-ABF198#002 + + + + + +Time when the event occurred +|[DateTime] + + + + +|1 + + + +|[Prop] + + + +EventId +|https://admin-shell.io/idta/prop/eventid/1/0 + + + + + +Identification of an event +|[String] + + + + +|0..1 + + + +|[Prop] + + + +ProviderId +|https://admin-shell.io/idta/prop/providerid/1/0 + + + + + +Identifikation of the location provider which triggered the event +|[String] + + + + +|0..1 + + + +|[Prop] + + + +EventType +|https://admin-shell.io/idta/prop/eventtype/1/0 + + + +Type of an event that is triggered when an asset is located at a localization fence +|[String] + + + + +|1 + + + +|=== + + + + +=== SubmodelElements of SML “LocationRecords” + +// Table generated from [Submodel, www.example.com/ids/sm/2131_9040_9042_1482],[SubmodelElementCollection, Section_3_Submodel_and_SubmodelElements],[SubmodelElementCollection, Section_3_17 SubmodelElements of SML “LocationRecords”],[ReferenceElement, Table_SubmodelElements_of_SML_LocationRecords] + + + +[width="100%", id="Table_SubmodelElements_of_SML_LocationRecords", title="SubmodelElements of SML “LocationRecords”", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}LocationRecords + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementList + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/sml/locationrecords/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}AssetTraces + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}List with records for location (position) localization events + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}orderRelevant=Yes, semanticIdListElement=[GlobalReference, https://admin-shell.io/idta/smc/locationrecordsrecord/1/0], typeValueListElement=SubmodelElementCollection + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[SMC] + + + +LocationRecord00 +|https://admin-shell.io/idta/smc/locationrecordsrecord/1/0 + + + + + +Record of a location (position) localization event +|[] + + + +14 elements +| + + + +|=== + + + + +=== SubmodelElements of SMC “LocationRecordsRecord” + +// Table generated from [Submodel, www.example.com/ids/sm/2131_9040_9042_1482],[SubmodelElementCollection, Section_3_Submodel_and_SubmodelElements],[SubmodelElementCollection, Section_3_18_SubmodelElements_of_SMC_LocationRecordsRecord],[ReferenceElement, Table_SubmodelElements_of_SMC_LocationRecordsRecord] + + + +[width="100%", id="Table_SubmodelElements_of_SMC_LocationRecordsRecord", title="SubmodelElements of SMC “LocationRecordsRecord”", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}LocationRecord00 + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementCollection + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/smc/locationrecordsrecord/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}LocationRecords + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}Record of a location (position) localization event + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Ref] + + + +CoordinateSystemReference +|https://admin-shell.io/idta/ref/coordinatesystemreference/1/0 + + + + + +Reference to a coordinate reference system for the position +|[] + + + +[Submodel, https://aas-connect.com/smt/data_model_for_asset_location] +|1 + + + +|[SMC] + + + +Position +|0173-1#02-ABI783#001 + + + + + +Position of the asset +|[] + + + +3 elements +|1 + + + +|[Prop] + + + +ProviderId +|https://admin-shell.io/idta/prop/providerid/1/0 + + + + + +Identifikation of the location provider which triggered the event +|[String] + + + + +|0..1 + + + +|[Prop] + + + +ProviderType +|https://admin-shell.io/idta/prop/providertype/1/0 + + + +Type of the location information provider, e.g. "UWB tag" +|[String] + + + + +|0..1 + + + +|[Prop] + + + +Accuracy +|https://admin-shell.io/idta/prop/accuracy/1/0 + + + +The horizontal accuracy of the position data +|[Double] + + + + +|0..1 + + + +|[Prop] + + + +MagneticHeading +|https://admin-shell.io/idta/prop/magneticheading/1/0 + + + +The magnetic heading direction of the Asset +|[Integer] + + + + +|0..1 + + + +|[Prop] + + + +TrueHeading +|https://admin-shell.io/idta/prop/trueheading/1/0 + + + +The corrected magnetic heading direction of the Asset +|[Integer] + + + + +|0..1 + + + +|[Prop] + + + +HeadingAccuracy +|https://admin-shell.io/idta/prop/headingaccuracy/1/0 + + + +The maximum deviation between the reported magnetic heading and the true heading +|[Integer] + + + + +|0..1 + + + +|[Prop] + + + +Time +|0173-1#02-ABF198#002 + + + + + +The time (timestamp) when the location data was generated (e.g., by a RTLS) +|[DateTime] + + + + +|1 + + + +|[Prop] + + + +TransmissionTime +|https://admin-shell.io/idta/prop/transmissiontime/1/0 + + + +Time (timestamp) when the location information has been updated + +Time (timestemp) when the location information has been updated +|[DateTime] + + + + +|0..1 + + + +|[MLP] + + + +LocationDescription +|https://admin-shell.io/idta/mlp/locationdescription/1/0 + + + + + +Location description (meta information for the position) , it is recommended to refer to the origin of the CRS +|[] + + + +Location description (meta information for the position) , it is recommended to refer to the origin of the CRS@en +|0..1 + + + +|[Prop] + + + +Speed +| 0173-1#02-AAV544#004 + + + + + +Speed of the asset at the time where the position was determined +|[Float] + + + + +|0..1 + + + +|[Prop] + + + +Course +|https://admin-shell.io/idta/prop/course/1/0 + + + +The current course ("compass direction") where the asset is heading to +|[Integer] + + + + +|0..1 + + + +|[Prop] + + + +ReferencePointId +|https://admin-shell.io/idta/prop/referencepointid/1/0 + + + +Identificator of a reference point at the Asset for which the position has been submitted +|[String] + + + + +|0..1 + + + +|=== + + + + +=== SubmodelElements of SMC “Position” + +// Table generated from [Submodel, www.example.com/ids/sm/2131_9040_9042_1482],[SubmodelElementCollection, Section_3_Submodel_and_SubmodelElements],[SubmodelElementCollection, Section_3_19_SubmodelElements_of_SMC_Position],[ReferenceElement, Table_SubmodelElements_of_SMC_Position] + + + +[width="100%", id="Table_SubmodelElements_of_SMC_Position", title="SubmodelElements of SMC “Position”", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}Position + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementCollection + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}0173-1#02-ABI783#001 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}LocationRecord00 + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}Position of the asset + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Prop] + + + +X +|https://admin-shell.io/idta/prop/x/1/0 + + + +X-coordinate value within a coordinate system +|[Float] + + + + +|1 + + + +|[Prop] + + + +Y +|https://admin-shell.io/idta/prop/y/1/0 + + + +Y-coordinate value within a coordinate system +|[Float] + + + + +|1 + + + +|[Prop] + + + +Z +|https://admin-shell.io/idta/prop/z/1/0 + + + +Z-coordinate (height) value within a coordinate system +|[Float] + + + + +|1 + + + +|=== + + + + +=== SubmodelElements of SMC “AssetLocatingInformation” + +// Table generated from [Submodel, www.example.com/ids/sm/2131_9040_9042_1482],[SubmodelElementCollection, Section_3_Submodel_and_SubmodelElements],[SubmodelElementCollection, Section_3_20_SubmodelElements_of_SMC_AssetLocatingInformation],[ReferenceElement, Table_SubmodelElements_of_SMC_AssetLocatingInformation] + + + +[width="100%", id="Table_SubmodelElements_of_SMC_AssetLocatingInformation", title="SubmodelElements of SMC “AssetLocatingInformation”", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}AssetLocatingInformation + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementCollection + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/sml/assetlocatinginformation/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}AssetLocation + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}Collection with additional information concerning the localization of an asset + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Prop] + + + +Localizable +|https://admin-shell.io/idta/prop/localizable/1/0 + + + +Information wether the position can be currently updated with the correct position +|[Boolean] + + + + +|0..1 + + + +|[MLP] + + + +AssetLocationServiceRealTimeCapability +|https://admin-shell.io/idta/mlp/realtimecapabilityofaas/1/0 + + + +Description of the extend and conditions for real time applications of the AAS + +Description of the extend and conditions for real time applications of the AAS +|[] + + + +Description of the extend and conditions for real time applications of the AAS@en +|0..1 + + + +|[Prop] + + + +RealtimeLocationSourceType +|https://admin-shell.io/idta/prop/realtimelocationsourcetype/1/0 + + + +Type or name of the source that delivers real time information for the asset's location, e.g., OMLOX +|[String] + + + + +|0..1 + + + +|[MLP] + + + +RealtimeLocationSource +|https://admin-shell.io/idta/mlp/realtimelocationsource/1/0 + + + +Information regarding a source for real time location data, e.g., URL and API documentation for DeepHub +|[] + + + +Information regarding a source for real time location data, e.g., URL and API documentation for DeepHub@en +|0..1 + + + +|=== + + + +:sectnums!: + +== Annex A. Explanations on used table formats + +=== 1. General + +The used tables in this document try to outline information as concise as possible. They do not convey all information on Submodels and SubmodelElements. For this purpose, the definitive definitions are given by a separate file in form of an AASX file of the Submodel template and its elements. + +=== 2. Tables on Submodels and SubmodelElements + +For clarity and brevity, a set of rules is used for the tables for describing Submodels and SubmodelElements. + +* The tables follow in principle the same conventions as in [5]. +* The table heads abbreviate 'cardinality' with 'card'. +* The tables often place two informations in different rows of the same table cell. In this case, the first information is marked out by sharp brackets [] form the second information. A special case are the semanticIds, which are marked out by the format: (type)(local)[idType]value. +* The types of SubmodelElements are abbreviated: + +[width="100%",cols="40%,60%",options="header"] +|=== +|SME type |SubmodelElement type +|Property |Property +|MLP |MultiLanguageProperty +|Range |Range +|File |File +|Blob |Blob +|Ref |ReferenceElement +|Rel |RelationshipElement +|SMC |SubmodelElementCollection +|=== + +* If an idShort ends with '\__00__', this indicates a suffix of the respective length (here: 2) of decimal digits, in order to make the idShort unique. A different idShort might be choosen, as long as it is unique in the parent’s context. +* The Keys of semanticId in the main section feature only idType and value, such as: https://admin-shell.io/vdi/2770/1/0/DocumentId/Id. The attribute "type" (typically "ConceptDescription" and "(local)" or "GlobalReference") need to be set accordingly; see [6]. +* If a table does not contain a column with "parent" heading, all represented attributes share the same parent. This parent is denoted in the head of the table. +* Multi-language strings are represented by the text value, followed by '@'-character and the ISO 639 language code: example@EN. +* The [valueType] is only given for Properties. + + + + +:sectnums!: + +== Bibliography + +[width="100%",cols="10%,90%", frame=none, grid=none] +|=== + +|[1] |“Recommendations for implementing the strategic initiative +INDUSTRIE 4.0”, acatech, April 2013. [Online]. Available +https://www.acatech.de/Publikation/recommendations-for-implementing-the-strategic-initiative-industrie-4-0-final-report-of-the-industrie-4-0-working-group/ + +|[2] |“Implementation Strategy Industrie 4.0: Report on the results of +the Industrie 4.0 Platform”; BITKOM e.V. / VDMA e.V., /ZVEI e.V., April +2015. [Online]. Available: +https://www.bitkom.org/noindex/Publikationen/2016/Sonstiges/Implementation-Strategy-Industrie-40/2016-01-Implementation-Strategy-Industrie40.pdf + +|[3] |“The Structure of the Administration Shell: TRILATERAL +PERSPECTIVES from France, Italy and Germany”, March 2018, [Online]. +Available: +https://www.plattform-i40.de/I40/Redaktion/EN/Downloads/Publikation/hm-2018-trilaterale-coop.html + +|[4] |“Beispiele zur Verwaltungsschale der Industrie 4.0-Komponente – +Basisteil (German)”; ZVEI e.V., Whitepaper, November 2016. [Online]. +Available: +https://www.zvei.org/presse-medien/publikationen/beispiele-zur-verwaltungsschale-der-industrie-40-komponente-basisteil/ + +|[5] |“Verwaltungsschale in der Praxis. Wie definiere ich Teilmodelle, +beispielhafte Teilmodelle und Interaktion zwischen Verwaltungsschalen +(in German)”, Version 1.0, April 2019, Plattform Industrie 4.0 in +Kooperation mit VDE GMA Fachausschuss 7.20, Federal Ministry for +Economic Affairs and Energy (BMWi), Available: +https://www.plattform-i40.de/PI40/Redaktion/DE/Downloads/Publikation/2019-verwaltungsschale-in-der-praxis.html + +|[6] |IDTA 01001-3-0: “Specification of the Asset Administration Shell; Part 1 (Version 3.0)”, March 2023, [Online]. Available: +https://industrialdigitaltwin.org/wp-content/uploads/2023/06/IDTA-01001-3-0_SpecificationAssetAdministrationShell_Part1_Metamodel.pdf + +|[7] |“Semantic interoperability: challenges in the digital +transformation age”; IEC, International Electronical Commission; 2019. +[Online]. Available: +https://basecamp.iec.ch/download/iec-white-paper-semantic-interoperability-challenges-in-the-digital-transformation-age-en/ + +|[8] |Common terms and abbreviations according to VDI FA 7.21 Wiki; Available: http://i40.iosb.fraunhofer.de/ + +|[9] |United States: US Code of Federal regulations, see https://www.ecfr.gov/current/title-22/chapter-I/subchapter-M/part-120/subpart-C/section-120.42 + +|=== + diff --git a/published/Handover Documentation/2/0/docs/antora.yml b/published/Handover Documentation/2/0/docs/antora.yml new file mode 100644 index 00000000..26a76de9 --- /dev/null +++ b/published/Handover Documentation/2/0/docs/antora.yml @@ -0,0 +1,4 @@ +name: Handover Documentation +title: 'Handover Documentation' +version: 'v2.0' +start_page: ROOT:index.adoc \ No newline at end of file diff --git a/published/Handover Documentation/2/0/docs/modules/ROOT/images/Figure_1.png b/published/Handover Documentation/2/0/docs/modules/ROOT/images/Figure_1.png new file mode 100644 index 00000000..e547d326 Binary files /dev/null and b/published/Handover Documentation/2/0/docs/modules/ROOT/images/Figure_1.png differ diff --git a/published/Handover Documentation/2/0/docs/modules/ROOT/images/Figure_10.png b/published/Handover Documentation/2/0/docs/modules/ROOT/images/Figure_10.png new file mode 100644 index 00000000..2523c614 Binary files /dev/null and b/published/Handover Documentation/2/0/docs/modules/ROOT/images/Figure_10.png differ diff --git a/published/Handover Documentation/2/0/docs/modules/ROOT/images/Figure_11.png b/published/Handover Documentation/2/0/docs/modules/ROOT/images/Figure_11.png new file mode 100644 index 00000000..08ad8498 Binary files /dev/null and b/published/Handover Documentation/2/0/docs/modules/ROOT/images/Figure_11.png differ diff --git a/published/Handover Documentation/2/0/docs/modules/ROOT/images/Figure_2.png b/published/Handover Documentation/2/0/docs/modules/ROOT/images/Figure_2.png new file mode 100644 index 00000000..c234c0b0 Binary files /dev/null and b/published/Handover Documentation/2/0/docs/modules/ROOT/images/Figure_2.png differ diff --git a/published/Handover Documentation/2/0/docs/modules/ROOT/images/Figure_3.png b/published/Handover Documentation/2/0/docs/modules/ROOT/images/Figure_3.png new file mode 100644 index 00000000..451919c2 Binary files /dev/null and b/published/Handover Documentation/2/0/docs/modules/ROOT/images/Figure_3.png differ diff --git a/published/Handover Documentation/2/0/docs/modules/ROOT/images/Figure_4.png b/published/Handover Documentation/2/0/docs/modules/ROOT/images/Figure_4.png new file mode 100644 index 00000000..0a68f4cf Binary files /dev/null and b/published/Handover Documentation/2/0/docs/modules/ROOT/images/Figure_4.png differ diff --git a/published/Handover Documentation/2/0/docs/modules/ROOT/images/Figure_5.png b/published/Handover Documentation/2/0/docs/modules/ROOT/images/Figure_5.png new file mode 100644 index 00000000..5b56e7ea Binary files /dev/null and b/published/Handover Documentation/2/0/docs/modules/ROOT/images/Figure_5.png differ diff --git a/published/Handover Documentation/2/0/docs/modules/ROOT/images/Figure_6.png b/published/Handover Documentation/2/0/docs/modules/ROOT/images/Figure_6.png new file mode 100644 index 00000000..2258f549 Binary files /dev/null and b/published/Handover Documentation/2/0/docs/modules/ROOT/images/Figure_6.png differ diff --git a/published/Handover Documentation/2/0/docs/modules/ROOT/images/Figure_7.png b/published/Handover Documentation/2/0/docs/modules/ROOT/images/Figure_7.png new file mode 100644 index 00000000..2267aa2f Binary files /dev/null and b/published/Handover Documentation/2/0/docs/modules/ROOT/images/Figure_7.png differ diff --git a/published/Handover Documentation/2/0/docs/modules/ROOT/images/Figure_8.png b/published/Handover Documentation/2/0/docs/modules/ROOT/images/Figure_8.png new file mode 100644 index 00000000..aaa6a473 Binary files /dev/null and b/published/Handover Documentation/2/0/docs/modules/ROOT/images/Figure_8.png differ diff --git a/published/Handover Documentation/2/0/docs/modules/ROOT/images/Figure_9.png b/published/Handover Documentation/2/0/docs/modules/ROOT/images/Figure_9.png new file mode 100644 index 00000000..22f0bc90 Binary files /dev/null and b/published/Handover Documentation/2/0/docs/modules/ROOT/images/Figure_9.png differ diff --git a/published/Handover Documentation/2/0/docs/modules/ROOT/images/SMT-template-cover.svg b/published/Handover Documentation/2/0/docs/modules/ROOT/images/SMT-template-cover.svg new file mode 100644 index 00000000..356c2fb6 --- /dev/null +++ b/published/Handover Documentation/2/0/docs/modules/ROOT/images/SMT-template-cover.svg @@ -0,0 +1,1266 @@ + + + +SPECIFICATIONSubmodel Template of theAsset Administration Shell diff --git a/published/Handover Documentation/2/0/docs/modules/ROOT/images/asciidoc-style-idta.css b/published/Handover Documentation/2/0/docs/modules/ROOT/images/asciidoc-style-idta.css new file mode 100644 index 00000000..cc2879f2 --- /dev/null +++ b/published/Handover Documentation/2/0/docs/modules/ROOT/images/asciidoc-style-idta.css @@ -0,0 +1,97 @@ +@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"; +@import "https://cdn.jsdelivr.net/gh/asciidoctor/asciidoctor@2.0/data/stylesheets/asciidoctor-default.css"; + +h1, h2, h3, h4, h5, h6, #toctitle, +.sidebarblock > .content > .title { + color: rgba(0, 0, 0, 0.8); +} + +#toc { + background:-color #ffffff; +} + +#toctitle { + color: #0028cd; +} + +a { + color: #17418a; +} + +a:hover, a:focus { + color: rgb(8, 24, 117); +} + +h1, h2, h3, .sidebarblock > .content > .title, h4, h5, h6 { + color: #3149cc; +} + +.subheader, .admonitionblock td.content > .title, .audioblock > .title, .exampleblock > .title, .imageblock > .title, .listingblock > .title, .literalblock > .title, .stemblock > .title, .openblock > .title, .paragraph > .title, .quoteblock > .title, table.tableblock > .title, .verseblock > .title, .videoblock > .title, .dlist > .title, .olist > .title, .ulist > .title, .qlist > .title, .hdlist > .title { + color: #303030; +} + +:not(pre):not([class^=L])>code { + background-color: #e0e0e0; +} + +table thead, table tfoot { + background: #f7f8f7; + background-color: rgb(247, 248, 247); + background-position-x: 0%; + background-position-y: 0%; + background-repeat: repeat; + background-attachment: scroll; + background-image: none; + background-size: auto; + background-origin: padding-box; + background-clip: border-box; +} + +/* Problem handling with long strings in the tables */ +/* This seems no appropriate or last resort (sliders) + table { + display: block; + width: max-content; + max-width: 100%; + overflow-x: auto; + } +*/ + +/* This seems to work: */ +table { + word-wrap: anywhere; +} + +.huge { + font-family: 'Open Sans'; + font-size: 3em; + line-height: 1.1em; +} + +.large { + font-family: 'Open Sans'; + font-size: 1.8em; + line-height: 1.1em; +} + +.normal { + font-family: 'Open Sans'; + font-size: 1em; + line-height: 1.1em; +} + +.white { + color: #ffffff; +} + +.redboxoneround { + padding: 0.3em 1em 0.3em 1em; + margin: 0.5em 0 0.5em 0; + font-family: 'Open Sans'; + font-size: 2em; + color: #ffffff; + line-height: 1.1em; + letter-spacing: 0.1em; + background-color: #fe4f0e; + border-radius: 0 0.35em 0 0; +} \ No newline at end of file diff --git a/published/Handover Documentation/2/0/docs/modules/ROOT/images/compile-html.bat b/published/Handover Documentation/2/0/docs/modules/ROOT/images/compile-html.bat new file mode 100644 index 00000000..662c550b --- /dev/null +++ b/published/Handover Documentation/2/0/docs/modules/ROOT/images/compile-html.bat @@ -0,0 +1 @@ +docker run -it -v .:/documents/ asciidoctor/docker-asciidoctor asciidoctor -r asciidoctor-diagram -a toc=left -a stylesheet=asciidoc-style-idta.css *.adoc \ No newline at end of file diff --git a/published/Handover Documentation/2/0/docs/modules/ROOT/images/compile-pdf-line-nrs.bat b/published/Handover Documentation/2/0/docs/modules/ROOT/images/compile-pdf-line-nrs.bat new file mode 100644 index 00000000..9be41708 --- /dev/null +++ b/published/Handover Documentation/2/0/docs/modules/ROOT/images/compile-pdf-line-nrs.bat @@ -0,0 +1 @@ +docker run -it -v .:/documents/ asciidoctor/docker-asciidoctor asciidoctor-pdf -r asciidoctor-diagram -r ./extended.rb -a toc=macro -a pdf-theme=my-theme.yml -a env-pdf *.adoc \ No newline at end of file diff --git a/published/Handover Documentation/2/0/docs/modules/ROOT/images/compile-pdf.bat b/published/Handover Documentation/2/0/docs/modules/ROOT/images/compile-pdf.bat new file mode 100644 index 00000000..65c255ef --- /dev/null +++ b/published/Handover Documentation/2/0/docs/modules/ROOT/images/compile-pdf.bat @@ -0,0 +1 @@ +docker run -it -v .:/documents/ asciidoctor/docker-asciidoctor asciidoctor-pdf -r asciidoctor-diagram -a toc=macro -a pdf-theme=my-theme.yml -a env-pdf *.adoc \ No newline at end of file diff --git a/published/Handover Documentation/2/0/docs/modules/ROOT/images/extended.rb b/published/Handover Documentation/2/0/docs/modules/ROOT/images/extended.rb new file mode 100644 index 00000000..757cc465 --- /dev/null +++ b/published/Handover Documentation/2/0/docs/modules/ROOT/images/extended.rb @@ -0,0 +1,27 @@ +# This file is taken from the extension examples from the asciidoctor-pdf repository. +# https://github.com/asciidoctor/asciidoctor-pdf/blob/main/docs/modules/extend/examples/pdf-converter-numbered-paragraphs.rb + + +class PDFConverterNumberedParagraphs < (Asciidoctor::Converter.for 'pdf') + register_for 'pdf' + + def init_pdf doc + doc + .find_by(context: :paragraph) {|candidate| [:document, :section].include? candidate.parent.context } + .each_with_index {|paragraph, idx| paragraph.set_attr 'number', idx + 1 } + super + end + + def convert_paragraph node + if (paragraph_number = node.attr 'number') + float do + label = %(#{paragraph_number}.#{::Prawn::Text::NBSP}) + label_width = rendered_width_of_string label + bounding_box [-label_width, cursor], width: label_width do + ink_prose label, color: 'CCCCCC', align: :right, margin: 0, single_line: true + end + end + end + super + end +end diff --git a/published/Handover Documentation/2/0/docs/modules/ROOT/images/idta-cover-logo-small.png b/published/Handover Documentation/2/0/docs/modules/ROOT/images/idta-cover-logo-small.png new file mode 100644 index 00000000..8e821f9f Binary files /dev/null and b/published/Handover Documentation/2/0/docs/modules/ROOT/images/idta-cover-logo-small.png differ diff --git a/published/Handover Documentation/2/0/docs/modules/ROOT/images/idta-smt-badge.png b/published/Handover Documentation/2/0/docs/modules/ROOT/images/idta-smt-badge.png new file mode 100644 index 00000000..ab505e50 Binary files /dev/null and b/published/Handover Documentation/2/0/docs/modules/ROOT/images/idta-smt-badge.png differ diff --git a/published/Handover Documentation/2/0/docs/modules/ROOT/images/idta-spec-badge.png b/published/Handover Documentation/2/0/docs/modules/ROOT/images/idta-spec-badge.png new file mode 100644 index 00000000..5ef5260f Binary files /dev/null and b/published/Handover Documentation/2/0/docs/modules/ROOT/images/idta-spec-badge.png differ diff --git a/published/Handover Documentation/2/0/docs/modules/ROOT/images/my-theme.yml b/published/Handover Documentation/2/0/docs/modules/ROOT/images/my-theme.yml new file mode 100644 index 00000000..cba8d6c2 --- /dev/null +++ b/published/Handover Documentation/2/0/docs/modules/ROOT/images/my-theme.yml @@ -0,0 +1,103 @@ +extends: default-for-print + +title-page: + text_align: left + margin-inner: -1cm + margin-outer: -1cm + title: + top: 8cm + font_size: 42 + font_style: bold + font_color: D9D9D9 + line_height: 1.2 + subtitle: + margin-top: 1cm + font_size: 42 + font_color: D9D9D9 + font_style: normal + line_height: 1.0 + authors: + margin-top: 1cm + font_size: 18 + font_color: D9D9D9 + font_style: normal + line_height: 1 + revision: + margin-top: 1cm + font_size: 18 + font_color: D9D9D9 + font_style: normal + line_height: 1 + background-image: image:SMT-template-cover.svg[fit=cover] + logo: + top: 21.7cm + align: right + image: image:idta-smt-badge.png[pdfwidth=48%] +page: + layout: portrait + margin: [1.5cm, 2cm, 1.5cm, 2cm] + size: A4 +base: + font-color: #333333 + font-family: Helvetica + font-size: 10 + line-height-length: 11.5 + line-height: $base-line-height-length / $base-font-size +role: + removed: + font-style: italic + text-decoration: line-through + text-decoration-color: #FF0000 + huge: + font-family: Helvetica + font-size: 24 + large: + font-family: Helvetica + font-size: 16 + normal: + font-family: Helvetica + font-size: 12 + white: + font-color: #ffffff + redboxoneround: + border-radius: [0.3cm, 0cm, 0cm, 0cm] + font-family: Helvetica + font-size: 16 + letter-spacing: $base-font-size * 1.1 + font-color: #ffffff + background-color: #fe4f0e +heading: + font-color: #3149cc + font-size: 17 + font-family: Helvetica + line-height: 1.2 + margin-bottom: 10 +link: + font-color: #17418a +list: + indent: $base-font-size * 1.2 + +table: + font-size: 10 + border-width: 0.5 + grid-width: 0.5 + border-color: #707070 + grid-color: #707070 + +pre: + font-color: #ff0000 + +code: + font-color: #505050 + font-style: bold + font-size: 11 + font-weight: 600 + +literal: + font-color: #3149cc + font-style: bold + font-size: 12 + font-weight: 800 +image: + # align: center + # problem: caption not able to center \ No newline at end of file diff --git a/published/Handover Documentation/2/0/docs/modules/ROOT/images/watch_new_unzip_and_show.ps1 b/published/Handover Documentation/2/0/docs/modules/ROOT/images/watch_new_unzip_and_show.ps1 new file mode 100644 index 00000000..46e59c47 --- /dev/null +++ b/published/Handover Documentation/2/0/docs/modules/ROOT/images/watch_new_unzip_and_show.ps1 @@ -0,0 +1,107 @@ +# from: https://stackoverflow.com/questions/62350872/powershell-file-watcher-register-objectevent-wait-for-file-to-complete-copying + +# IMPORTANT: Copy this file to the folder being watchd (typically one level above) and run + +Clear-Host +$ErrorActionPreference = [System.Management.Automation.ActionPreference]::Stop + +$fileSystemWatcherDirPath = '.' +$fileSystemWatcherFilter = '*.zip' + +$fileSystemWatcher = [System.IO.FileSystemWatcher]::new($fileSystemWatcherDirPath , $fileSystemWatcherFilter) +$fileSystemWatcher.IncludeSubdirectories = $true +$fileSystemWatcher.EnableRaisingEvents = $true +$fileSystemWatcher.NotifyFilter = [System.IO.NotifyFilters]::FileName -bor [System.IO.NotifyFilters]::DirectoryName -bor [System.IO.NotifyFilters]::LastWrite # [System.Linq.Enumerable]::Sum([System.IO.NotifyFilters].GetEnumValues()) + +# Create syncronized hashtable +# $syncdFsItemEventHashT = [hashtable]::Synchronized([hashtable]::new()) +$global:syncdFsItemEventHashT = @{} + +$fileSystemWatcherAction = { + try { + $fsItemEvent = [pscustomobject]@{ + EventIdentifier = $Event.EventIdentifier + SourceIdentifier = $Event.SourceIdentifier + TimeStamp = (Get-Date) # $Event.TimeGenerated + FullPath = $Event.SourceEventArgs.FullPath + ChangeType = $Event.SourceEventArgs.ChangeType + } + + # Collecting event in synchronized hashtable (overrides existing keys so that only the latest event details are available) + # $syncdFsItemEventHashT = @{} + Write-Host $fsItemEvent.FullPath + Write-Host $syncdFsItemEventHashT + $syncdFsItemEventHashT[$fsItemEvent.FullPath] = $fsItemEvent + } catch { + Write-Host ($_ | Format-List * | Out-String ) -ForegroundColor red + } +} + +# Script block which processes collected events and do further actions like copying for backup, etc... +# That scriptblock was initially used to test "Start-Job". Unfortunately it's not possible to access and modify the synchronized hashtable created within this scope. +$fSItemEventProcessingJob = { + $keys = [string[]]$syncdFsItemEventHashT.psbase.Keys + + foreach ($key in $keys) { + $fsEvent = $syncdFsItemEventHashT[$key] + + try { + + Write-Host "Event has TS = ", $fsEvent.TimeStamp + + if ( ( (Get-Date) - $fsEvent.TimeStamp ).TotalSeconds -gt 3) { + + Write-Host "Finally processing: ", $fsEvent.FullPath + $syncdFsItemEventHashT.Remove($key) + + # do the work + Remove-Item 'new' -Recurse -ErrorAction SilentlyContinue + Expand-Archive -Path $fsEvent.FullPath -DestinationPath new + Set-Location .\new\ + Start-Process -FilePath 'compile-html.bat' -Wait + Start-Process -FilePath @(Get-ChildItem *.html)[0] + Set-Location .. + } + + } catch { + Write-Host ($_ | Format-List * | Out-String ) -ForegroundColor red + } + } +} + +[void] (Register-ObjectEvent -InputObject $fileSystemWatcher -EventName 'Created' -SourceIdentifier 'FSCreated' -Action $fileSystemWatcherAction) +[void] (Register-ObjectEvent -InputObject $fileSystemWatcher -EventName 'Changed' -SourceIdentifier 'FSChanged' -Action $fileSystemWatcherAction) +[void] (Register-ObjectEvent -InputObject $fileSystemWatcher -EventName 'Renamed' -SourceIdentifier 'FSRenamed' -Action $fileSystemWatcherAction) +[void] (Register-ObjectEvent -InputObject $fileSystemWatcher -EventName 'Deleted' -SourceIdentifier 'FSDeleted' -Action $fileSystemWatcherAction) + +Write-Host "Watching for changes in '$fileSystemWatcherDirPath'.`r`nPress CTRL+C to exit!" +try { + do { + Wait-Event -Timeout 1 + + if ($syncdFsItemEventHashT.Count -gt 0) { + Write-Host "`r`n" + Write-Host ('-' * 50) -ForegroundColor Green + Write-Host "Collected events in hashtable queue:" -ForegroundColor Green + $syncdFsItemEventHashT.Values | Format-Table | Out-String + } + + # Process hashtable items and do something with them (like copying, ..) + .$fSItemEventProcessingJob + + # Garbage collector + [GC]::Collect() + + } while ($true) + +} finally { + # unregister + Unregister-Event -SourceIdentifier 'FSChanged' + Unregister-Event -SourceIdentifier 'FSCreated' + Unregister-Event -SourceIdentifier 'FSDeleted' + Unregister-Event -SourceIdentifier 'FSRenamed' + + # dispose + $FileSystemWatcher.Dispose() + Write-Host "`r`nEvent Handler removed." +} diff --git a/published/Handover Documentation/2/0/docs/modules/ROOT/pages/index.adoc b/published/Handover Documentation/2/0/docs/modules/ROOT/pages/index.adoc new file mode 100644 index 00000000..9a54eb8a --- /dev/null +++ b/published/Handover Documentation/2/0/docs/modules/ROOT/pages/index.adoc @@ -0,0 +1,1916 @@ + + += IDTA 02004 : Handover Documentation + +=== Imprint + +Publisher +[verse] +____ +Industrial Digital Twin Association +Lyoner Strasse 18 +60528 Frankfurt am Main +Germany +https://www.industrialdigitaltwin.org/ +____ + +=== Version history + +[cols="1,1,4"] +|=== + +|Date +|Version +|Comment + +| +|1.0 +|Used for development only. No official version published. + +| +|1.1 +|Used for development only. No official version published. + +|2023-03-01 +|1.2 +|Release of the official Submodel template published by IDTA. + +|2024-08-13 +|2.0 +|Start of IDTA review + +|2025-06-11 +|2.0 +|Release of the official Submodel template published by IDTA. + + +|=== + +:sectnums: + +:toclevels: 3 + +:xrefstyle: short + +<<< +toc::[] +<<< + +== General + +=== About this document +This document is a part of a specification series. Each part specifies the contents of a Submodel template for +the Asset Administration Shell (AAS). The AAS is described in <>, <>, <> and <>. First exemplary Submodel +contents were described in <>, while the actual format of this document was derived by the "Administration +Shell in Practice" <>. The format aims to be very concise, giving only minimal necessary information for +applying a Submodel template, while leaving deeper descriptions and specification of concepts, structures +and mapping to the respective documents <> to <>. + +The target group of the specification are developers and editors of technical documentation and manufacturer information, which describe assets in smart manufacturing by means of the Asset Administration Shell (AAS) and therefore need to create a Submodel instance with a hierarchy of SubmodelElements. This document focuses on the question which SubmodelElements shall be used for this purpuse with which semantic identification. + + +=== Scope of the Submodel +The Submodel Handover Documentation defines a standardized exchange format for information or documentation for a specific asset. This can be both type and instance information. The scope of this Submodel is to increase the interoperability between the parties that are exchanging asset documentation. These parties can be manufacturers of components or complete machines, or operators using these components or machines. In case a machine manufacturer sells a machine to a customer (operator), the manufacturer hands over the machine and its documentation in form of an AAS with the Submodel “Handover Documentation”. The documents provided can contain information required for e.g. correct design, installation, commissioning, spare parts stocking, operation, cleaning, inspection, maintenance, and repair. In addition, there are legal regulations that stipulate the existence of certain manufacturer documents, such as Communauté Européenne (CE) declarations of conformity, Atmosphères Explosives (ATEX) certificates, or material certificates. + +Besides the structure of a Submodel and the exchange format of an AAS, this Submodel standardizes the meta data that comes with the asset documentation and the classes that classify the type of the document. With these standardized meta data and classes, the asset documentation can be automatically integrated in the customer’s document management system, backend system, or any other system. + +The meta data as well as the classification classes of this Submodel are based on the VDI Guideline VDI 2770 Blatt 1 “Operation of process engineering plants – Minimum requirements for digital manufacturer information for the process industry” <>. While the classification of documents according to VDI 2770 is mandatory, additional classification classes can be added. + + +=== Relevant standards for the Submodel template +*VDI 2770 Blatt 1* + +VDI 2770 Blatt 1 <> standardizes the documentation regarding their meta data, classification, and format. The idea is that manufacturers hand over their documentation in a standardized manner, making it easier for operators to load the documentation for a component or a complete machine (both referred to in the following as asset) into their IT infrastructure and to find relevant documents during the operation phase of an asset. The central concepts of the specification are the entities “Document” and “DocumentVersion”, which are described in the Unified Modeling Language (UML) below. + +The entity "Document" describes the understanding of a document in total as a specific concept of product-related information. The entity “DocumentVersion” represents a specific instance of the “Document” within its lifecycle, e.g. a released version of the Document. + +The following diagram gives an overview on the concepts of VDI 2770. + +image::Figure_1.png[id="Figure_1", width="100.0%",title="Overview of concepts Documents and DocumentVersion of the VDI 2770 according to [7], by courtesy of VDI"] + +Taking advantage of the already formalized structures of the Asset Administration Shell and its SubmodelElements, the following concepts based on VDI 2770 Blatt 1 are relevant for the Submodel template specification. + +image::Figure_2.png[id="Figure_2", width="100.0%",title="Submodel Handover Documentation based on basic concepts of the VDI 2770 Blatt 1"] + +The Submodel “Handover Documentation” specifies a document in more detail via the DocumentID, the DocumentClassification, and the DocumentVersion with its respective characteristics. +Note: In the IDTA, there is a Submodel available for similar use case “Intelligent Information for Use”. More information can find in the *Appendix B* of this document. + + +== Submodel for Handover Documentation based on VDI 2770 Blatt 1 + +=== Approach +This Submodel template specification models the two main VDI 2770 Blatt1 concepts “Document” and “DocumentVersion” with their mandatory information elements. Multiple DocumentVersions can be assigned to each Document. The specifications for an instance of the overall Submodel, the Document, and the DocumentVersion are provided in clauses 2.4, 2.5, and 2.8. + +If a document exists in multiple languages, it shall be represented by different “Documents”. If a document features multiple languages within itself, it shall be represented by a single “DocumentVersion” with multiple associated languages. If an AAS contains more than one version of one and the same document, they can be represented by different instances of “DocumentVersion”. + +A SubmodelElementCollection (SMC) “DocumentVersion” shall contain at least one file element “DigitalFile”. According to VDI 2770, PDF/A files are required including ISO 19005-1, ISO 19005-2 and ISO 19005-3 meaning PDF/A-1, PDF/A-2 and PDF/A-3. The “DigitalFile” described above can also be provided in the Submodel via a link, which is technically supported by the file element of an AAS. Nevertheless, the legal requirements (e.g. Machinenrichlinie)footnote:[Directive 2006/42/EC of the European Parliament and of the Council of 17 May 2006 on machinery, and amending Directive 95/16/EC (recast)] +for the “DigitalFile” according to ISO 19005 and the document/information provided by a link should be identical. If multiple “DigitalFiles” with different MIME-Typesfootnote:[Multipurpose Internet Mail Extensions, see: https://www.iana.org/assignments/media-types/media-types.xhtml] are used, each of them is assumed to represent the “DocumentVersion” in total and must contain equal content. + +image::Figure_3.png[id="Figure_3", width="100.0%",title="AASX Package Explorer with Submodel “Documentation” of an example asset, featuring multiple documents, each with at least one ”DocumentVersion”"] + +For further information on the approaches of VDI 2770 Blatt 1, see <>. + +=== Association of documents to Assets and Entities +VDI 2770 Blatt 1 uses so called ObjectIds to express the association of documents with different objects. In an Asset Administration Shell (AAS), the association with the object is already given implicitly by the basic relation of the AAS to the respective asset <>. + +However, the documentation of a complex piece of equipment may include further supplier parts. These parts can be marked as separate entities within the AAS of the equipment by introducing Entity Submodel elements within the Submodel for Documentation. + +If these Entities are categorized as ‘self-managed’, they might refer to self-standing AAS for the supplier parts via the Entity attribute global AssetId. In this case, the provider of the equipment will provide two AAS, one for the equipment, and one for the supplier part. The recommendation for simple casesfootnote:[Please note: Entity elements may contain SubmodelElements such as Properties or SubmodelElemementCollection, but no self-standing Submodels. Therefore, self-managed entities shall be used for complex cases (e.g., a Submodel for Technical Data shall be provided).] is to mark included supplier parts as included ‘co-managed’ Entities. In any case, the creation of an Entity element is required. + + +image::Figure_4.png[id="Figure_4", width="90.0%",title="Association of documents to Assets and Entities"] + +ReferenceElements called “RefersTo” link the main document of an Asset, e.g., a piece of equipment, to its subordinate documents“”. These references can span multiple AAS. In this case, the AssetId shall be used as first key. For further details on ReferenceElement, see <>. + +If a “Document” relates to a dependent (self-managed or co-managed) Entity and not to the Asset of the AAS itself, a ReferenceElement called “DocumentedEntity” shall be used. + + +=== Enumeration: document classification according to VDI 2770 Blatt 1:2020 +VDI 2770 Blatt 1 defines a basic set of different classes for documents, which allows the operator of the industrial equipment to manage and retrieve information efficiently. This classification is understood as ClassificationSystem identified by the value “VDI 2770 Blatt 1:2020” within this Submodel template. For each class of documents (“DocumentClassification”), a “ClassId” and “ClassName” is given. While the latter can be given in multiple languages, EN is mandatory. The existing Document Classes according to VDI 2770 Blatt 1:2020 are listed in the table below. +[width="100%", title="DocumentClassification according to VDI 2770 Blatt 1: 2020", cols="12%,22%,24%,42%"] +|=== +s|{set:cellbgcolor:#eeeeee}ClassID +s|ClassName (EN) +s|ClassName (DE) +s|Semantic ID + +|{set:cellbgcolor:#ffffff} +01-01 +|Identification +|Identifikation +|0173-1#07-ABU484#003 + +|02-01 +|Technical specification +|Technische Spezifikation +|0173-1#07-ABU485#003 + + +|02-02 +|Drawings, plans +|Zeichnungen, Pläne +|0173-1#07-ABU486#003 + +|02-03 +|Assemblies +|Bauteile +|0173-1#07-ABU487#003 + + +|02-04 +|Certificates, declarations +|Zeugnisse, Zertifikate, Bescheinigungen +|0173-1#07-ABU488#003 + +|03-01 +|Commissioning, de-commissioning +|Montage, Demontage +|0173-1#07-ABU489#003 + + +|03-02 +|Operation +|Bedienung +|0173-1#07-ABU490#003 + +|03-03 +|General safety +|Allgemeine Sicherheit +|0173-1#07-ABU491#003 + +|03-04 +|Inspection, maintenance, testing +|Inspektion, Wartung, Prüfung +|0173-1#07-ABU492#003 + +|03-05 +|Repair +|Instandsetzung +|0173-1#07-ABU493#003 + +|03-06 +|Spare parts +|Ersatzteile +|0173-1#07-ABU494#003 + +|04-01 +|Contract documents +|Vertragsunterlagen +|0173-1#07-ABU495#003 +|=== +A “Document” can be assigned to multiple “DocumentClassifications” of one single classification system, as well as to different “DocumentClassifications” of different classification systems. The classification according to VDI 2770 Blatt 1:2020 is mandatory in the Submodel Handover Documentation. + +Further document classification systems such as IEC 61355-1:2008 are mentioned and described in <>. + + +=== Attributes of the Submodel instance +The following attributes need to be set for the Submodel instance. The table convention is explained in Annex A.2. + +The ECLASS IRDIs referenced in this Submodel are based on ECLASS Release 15. This version of the Submodel with these ECLASS IRDIs is also available in the download area of the ECLASS website: www.eclass.eu in form of the Asset.xml. The Asset.xml (Release 15) is the ECLASS file that contains Submodels. The use of these Submodels is free of charge. + + +// Table generated from [Submodel, www.example.com/ids/sm/5311_7020_9042_2173],[SubmodelElementCollection, Section_2_Submodel_for_Handover_Documentation_based_on_VDI_2770_Blatt_1],[SubmodelElementCollection, Section_2_4_Attributes_of_the_Submodel_instance],[ReferenceElement, Table_2] + + + +[width="100%", id="Table_2", title="Attributes of the Submodel instance", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}HandoverDocumentation + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}Submodel + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}0173-1#01-AHF578#003 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}- + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}The Submodel defines a set meta data for the handover of documentation from the manufacturer to the operator for industrial equipment + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[SML] + + + +Documents +|0173-1#02-ABI500#003 + + + +supplementalSemanticId: https://api.eclass-cdp.com/0173-1-02-ABI500-003 + + + + + +Information for a document identity +|[] + + + +1 elements +|1 + + + +|[SML] + + + +Entities +|https://admin-shell.io/vdi/2770/1/0/EntitiesForDocumentation + + + + + +List of Entities +|[] + + + +1 elements +|0..1 + + + +|=== + + + +[width="100%", id="Table_2", title="Attributes of the Submodel instance", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}Documents + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementList + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}0173-1#02-ABI500#003 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}HandoverDocumentation + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}Information for a document identity + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}orderRelevant=No, semanticIdListElement=[GlobalReference, 0173-1#02-ABI500#003/0173-1#01-AHF579#003], typeValueListElement=SubmodelElementCollection + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[SMC] + + + +Document +|0173-1#02-ABI500#003/0173-1#01-AHF579#003 + + + +supplementalSemanticId: 0173-1#02-ABI500#003~0/0173-1#01-AHF579#003,https://api.eclass-cdp.com/0173-1-02-ABI500-003/0173-1-01-AHF579-003 + + + + + +Each SubmodelElementCollection describes a document by standard, which is associated to the particular Asset Administration Shell +|[] + + + +4 elements +|1..* + + + +|=== + + + +[width="100%", id="Table_2", title="Attributes of the Submodel instance", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}Entities + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementList + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/vdi/2770/1/0/EntitiesForDocumentation + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}HandoverDocumentation + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}List of Entities + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}orderRelevant=No, typeValueListElement=Entity + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Ent] + + + +Entity +|https://admin-shell.io/vdi/2770/1/0/EntityForDocumentation + + + +States, that the described Entity is an important entity for documentation of the superordinate Asset of the Asset Administration Shell. Note: typically, such Entities are well-identified sub-parts of the Asset, such as supplier parts delivered to the manufacturer of the Asset. +|[] + + + + +|1..* + + + +|=== + + + + +=== SubmodelElements of Document +The SubmodelElementCollection (SMC) Document contains the information for a VDI 2770 “Document”. Such a “Document” can refer to multiple “DocumentVersions”, which are individual SubmodelElementCollections contained within the superordinate “Document” SMC. The table convention is explained in Annex A.2. + +// Table generated from [Submodel, www.example.com/ids/sm/5311_7020_9042_2173],[SubmodelElementCollection, Section_2_Submodel_for_Handover_Documentation_based_on_VDI_2770_Blatt_1],[SubmodelElementCollection, Section_2_5_SubmodelElements_of_Document],[ReferenceElement, Table_3] + + + +[width="100%", id="Table_3", title="SubmodelElements of Document", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}Document + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementCollection + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}0173-1#02-ABI500#003/0173-1#01-AHF579#003 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}Documents + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}Each SubmodelElementCollection describes a document by standard, which is associated to the particular Asset Administration Shell + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[SML] + + + +DocumentIds +|0173-1#02-ABI501#003 + + + +supplementalSemanticId: https://api.eclass-cdp.com/0173-1-02-ABI501-003 + + + + + +Set of document identifiers for the document. One ID in this collection should be used as a preferred ID +|[] + + + +1 elements +|1 + + + +|[SML] + + + +DocumentClassifications +|0173-1#02-ABI502#003 + + + +supplementalSemanticId: https://api.eclass-cdp.com/0173-1-02-ABI502-003 + + + +Set of information for describing the classification of the Document according to ClassificationSystems +|[] + + + +1 elements +|1 + + + +|[SML] + + + +DocumentVersions +|0173-1#02-ABI503#003 + + + +supplementalSemanticId: https://api.eclass-cdp.com/0173-1-02-ABI503-003 + + + +Information elements of individual Document Version entities +|[] + + + +1 elements +|1 + + + +|[SML] + + + +DocumentedEntities +|https://admin-shell.io/vdi/2770/1/0/Document/DocumentedEntities + + + + + +Documented Entities +|[] + + + +1 elements +|0..1 + + + +|=== + + + + +=== SubmodelElements of DocumentID +The SubmodelElementCollection (SMC) DocumentId identifies the Document in a given Domain. The table convention is explained in Annex A.2. + +// Table generated from [Submodel, www.example.com/ids/sm/5311_7020_9042_2173],[SubmodelElementCollection, Section_2_Submodel_for_Handover_Documentation_based_on_VDI_2770_Blatt_1],[SubmodelElementCollection, Section_2_6_SubmodelElements_of_DocumentID],[ReferenceElement, Table_4] + + + +[width="100%", id="Table_4", title="SubmodelElements of DocumentID", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}DocumentId + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementCollection + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}0173-1#02-ABI501#003/0173-1#01-AHF580#003 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}DocumentIds + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}Information about a document identification entity + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Prop] + + + +DocumentDomainId +|0173-1#02-ABH994#003 + + + +supplementalSemanticId: https://api.eclass-cdp.com/0173-1-02-ABH994-003 + + + +Identification of the domain in which the given DocumentId is unique. The domain ID can e.g., be the name or acronym of the providing organisation +|[String] + + + + +|1 + + + +|[Prop] + + + +DocumentIdentifier +|0173-1#02-AAO099#004 + + + +supplementalSemanticId: https://api.eclass-cdp.com/0173-1-02-AAO099-004 + + + +alphanumeric character sequence uniquely identifying a document +|[String] + + + + +|1 + + + +|[Prop] + + + +DocumentIsPrimary +|0173-1#02-ABH995#003 + + + +supplementalSemanticId: https://api.eclass-cdp.com/0173-1-02-ABH995-003 + + + +Flag indicating that a DocumentId within a collection of at least two DocumentId`s is the ‘primary’ identifier for the document. This is the preferred ID of the document (commonly from the point of view of the owner of the asset) +|[Boolean] + + + + +|0..1 + + + +|=== + + + + +=== SubmodelElements of DocumentClassification +The SubmodelElementCollection (SMC) “DocumentClassification” contains the information for a classification of a document according to a classification system. A Document might have multiple classifications in multiple systems. The table convention is explained in Annex A.2. + +// Table generated from [Submodel, www.example.com/ids/sm/5311_7020_9042_2173],[SubmodelElementCollection, Section_2_Submodel_for_Handover_Documentation_based_on_VDI_2770_Blatt_1],[SubmodelElementCollection, Section_2_7_SubmodelElements_of_DocumentClassification],[ReferenceElement, Table_5] + + + +[width="100%", id="Table_5", title="SubmodelElements of DocumentClassification", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}DocumentClassification + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementCollection + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}0173-1#02-ABI502#003/0173-1#01-AHF581#003 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}DocumentClassifications + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}Set of information for describing the classification of the Document according to a ClassificationSystem + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Prop] + + + +ClassId +|0173-1#02-ABH996#003 + + + +supplementalSemanticId: https://api.eclass-cdp.com/0173-1-02-ABH996-003 + + + +Unique ID of the document class within a classficationsystem +|[String] + + + + +|1 + + + +|[MLP] + + + +ClassName +|0173-1#02-ABJ219#002 + + + +supplementalSemanticId: https://api.eclass-cdp.com/0173-1-02-ABJ219-002 + + + +Name of the class in the classification system +|[] + + + + +|1 + + + +|[Prop] + + + +ClassificationSystem +|0173-1#02-ABH997#003 + + + +supplementalSemanticId: https://api.eclass-cdp.com/0173-1-02-ABH997-003 + + + +Identification of the classification system +|[String] + + + + +|1 + + + +|=== + + + + +=== SubmodelElements of DocumentVersion +The SubmodelElementCollection (SMC) DocumentVersion contains the information for a VDI 2770 DocumentVersion. The table convention is explained in Annex A.2. + +// Table generated from [Submodel, www.example.com/ids/sm/5311_7020_9042_2173],[SubmodelElementCollection, Section_2_Submodel_for_Handover_Documentation_based_on_VDI_2770_Blatt_1],[SubmodelElementCollection, Section_2_8_SubmodelElements_of_DocumentVersion],[ReferenceElement, Table_6] + + + +[width="100%", id="Table_6", title="SubmodelElements of DocumentVersion", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}DocumentVersion + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementCollection + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}0173-1#02-ABI503#003/0173-1#01-AHF582#003 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}DocumentVersions + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}Information about a document version entity + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[SML] + + + +Language +|0173-1#02-AAN468#008 + + + +supplementalSemanticId: https://api.eclass-cdp.com/0173-1-02-AAN468-008 + + + + + +Language style of the document +|[] + + + +1 elements +|1 + + + +|[Prop] + + + +Version +|0173-1#02-AAP003#005 + + + +supplementalSemanticId: https://api.eclass-cdp.com/0173-1-02-AAP003-005 + + + +Design that partly deviates from the previous +|[String] + + + + +|1 + + + +|[MLP] + + + +Title +|0173-1#02-ABG940#003 + + + +supplementalSemanticId: https://api.eclass-cdp.com/0173-1-02-ABG940-003 + + + +Name of the document +|[] + + + + +|1 + + + +|[MLP] + + + +Subtitle +|0173-1#02-ABH998#003 + + + +supplementalSemanticId: https://api.eclass-cdp.com/0173-1-02-ABH998-003 + + + +List of language-dependent subtitles of the document +|[] + + + + +|0..1 + + + +|[MLP] + + + +Description +|0173-1#02-AAN466#004 + + + +supplementalSemanticId: https://api.eclass-cdp.com/0173-1-02-AAN466-004 + + + +Plain text characterizing the content of the document +|[] + + + + +|1 + + + +|[MLP] + + + +KeyWords +|0173-1#02-ABH999#003 + + + +supplementalSemanticId: https://api.eclass-cdp.com/0173-1-02-ABH999-003 + + + +List of language-dependent keywords of the document +|[] + + + + +|0..1 + + + +|[Prop] + + + +StatusSetDate +|0173-1#02-ABI000#003 + + + +supplementalSemanticId: https://api.eclass-cdp.com/0173-1-02-ABI000-003 + + + +Date when the document status was set +|[Date] + + + + +|1 + + + +|[Prop] + + + +StatusValue +|0173-1#02-ABI001#003 + + + +supplementalSemanticId: https://api.eclass-cdp.com/0173-1-02-ABI001-003 + + + +Each document version represents a point in time in the document life cycle. This status value refers to the milestones in the document life cycle. The following two values should be used for the application of this guideline: InReview (under review), Released (released) +|[String] + + + + +|1 + + + +|[Prop] + + + +OrganizationShortName +|https://api.eclass-cdp.com/0173-1-02-ABI002-003 + + + +Short name of the organization +|[String] + + + + +|1 + + + +|[Prop] + + + +OrganizationOfficialName +|0173-1#02-ABI004#003 + + + +supplementalSemanticId: https://api.eclass-cdp.com/0173-1-02-ABI004-003 + + + +Official name of the organization of the author of the document +|[String] + + + + +|1 + + + +|[SML] + + + +RefersToEntities +|0173-1#02-ABK288#002 + + + +supplementalSemanticId: https://api.eclass-cdp.com/0173-1-02-ABK288-002 + + + + + +Forms a generic refers to-relationship to another document or document version. They have a loose relationship +|[] + + + +1 elements +|0..1 + + + +|[SML] + + + +BasedOnReferences +|0173-1#02-ABK289#002 + + + +supplementalSemanticId: https://api.eclass-cdp.com/0173-1-02-ABK289-002 + + + + + +Forms a based on-relationship to another document or document version. Typically states, that the content of the document bases on another document (e.g. specification requirements). Both have a strong relationship +|[] + + + +1 elements +|0..1 + + + +|[SML] + + + +TranslationOfEntities +|0173-1#02-ABK290#002 + + + +supplementalSemanticId: https://api.eclass-cdp.com/0173-1-02-ABK290-002 + + + + + +Forms a translation of-relationship to another document or document version. Both have a strong relationship +|[] + + + +1 elements +|0..1 + + + +|[SML] + + + +DigitalFiles +|0173-1#02-ABK126#002 + + + +supplementalSemanticId: https://api.eclass-cdp.com/0173-1-02-ABK126-002 + + + + + +MIME-Type, file name and file contents given by the file SubmodelElement +|[] + + + +1 elements +|1 + + + +|[File] + + + +PreviewFile +|0173-1#02-ABK127#002 + + + +supplementalSemanticId: https://api.eclass-cdp.com/0173-1-02-ABK127-002 + + + +Provides a preview image of the Document Version, e.g. first page, in a commonly used image format and low resolution +|[] + + + + +|0..1 + + + +|=== + + + +[width="100%", id="Table_6", title="SubmodelElements of DocumentVersion", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}Language + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementList + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}0173-1#02-AAN468#008 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}DocumentVersion + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}Language style of the document + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}orderRelevant=No, typeValueListElement=Property + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Prop] + + + + +|0173-1#02-AAN468#008 + + + + + +Language of document +|[String] + + + +en +|1..* + + + +|=== + + + +[width="100%", id="Table_6", title="SubmodelElements of DocumentVersion", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}RefersToEntities + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementList + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}0173-1#02-ABK288#002 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}DocumentVersion + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}Forms a generic refers to-relationship to another document or document version. They have a loose relationship + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}orderRelevant=No, typeValueListElement=ReferenceElement + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Ref] + + + +RefersToEntity +|0173-1#02-ABK288#002 + + + + + +Forms a generic refers to-relationship to another document or document version. They have a loose relationship +|[] + + + + +|1..* + + + +|=== + + + +[width="100%", id="Table_6", title="SubmodelElements of DocumentVersion", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}BasedOnReferences + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementList + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}0173-1#02-ABK289#002 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}DocumentVersion + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}Forms a based on-relationship to another document or document version. Typically states, that the content of the document bases on another document (e.g. specification requirements). Both have a strong relationship + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}orderRelevant=No, typeValueListElement=ReferenceElement + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Ref] + + + +BasedOnReference +|0173-1#02-ABK289#002 + + + + + +Forms a based on-relationship to another document or document version. Typically states, that the content of the document bases on another document (e.g. specification requirements). Both have a strong relationship +|[] + + + + +|1..* + + + +|=== + + + +[width="100%", id="Table_6", title="SubmodelElements of DocumentVersion", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}TranslationOfEntities + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementList + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}0173-1#02-ABK290#002 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}DocumentVersion + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}Forms a translation of-relationship to another document or document version. Both have a strong relationship + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}orderRelevant=No, typeValueListElement=ReferenceElement + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Ref] + + + +TranslationOfEntity +|0173-1#02-ABK290#002 + + + + + +Forms a translation of-relationship to another document or document version. Both have a strong relationship +|[] + + + + +|1..* + + + +|=== + + + +[width="100%", id="Table_6", title="SubmodelElements of DocumentVersion", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}DigitalFiles + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementList + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}0173-1#02-ABK126#002 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}DocumentVersion + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}MIME-Type, file name and file contents given by the file SubmodelElement + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}orderRelevant=No, typeValueListElement=File + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[File] + + + +DigitalFile +|0173-1#02-ABK126#002 + + + + + +MIME-Type, file name and file contents given by the file SubmodelElement +|[] + + + + +|1..* + + + +|=== + + + + +=== SubmodelElements of DocumentEntities + +// Table generated from [Submodel, www.example.com/ids/sm/5311_7020_9042_2173],[SubmodelElementCollection, Section_2_Submodel_for_Handover_Documentation_based_on_VDI_2770_Blatt_1],[SubmodelElementCollection, Section_2_9_SubmodelElements_of_DocumentEntities],[ReferenceElement, Table_6] + + + +[width="100%", id="Table_6", title="SubmodelElements of DocumentVersion", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}DocumentedEntities + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementList + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/vdi/2770/1/0/Document/DocumentedEntities + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}Document + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}Documented Entities + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}orderRelevant=No, typeValueListElement=ReferenceElement + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Ref] + + + +DocumentedEntity +|https://admin-shell.io/vdi/2770/1/0/Document/DocumentedEntity + + + +Reference for the documented entities +|[] + + + + +|1..* + + + +|=== + + + +:sectnums!: + +== Annex A. Explanations of used table formats + +=== 1. General + +The tables used in this document try to outline information as concise as possible. They do not convey all information on Submodels and SubmodelElements. The definitive definitions are given by a separate file in form of an AASX file of the Submodel template and its elements. + +=== 2. Tables on Submodels and SubmodelElements + +For clarity and brevity, a set of rules is used for the tables describing Submodels and SubmodelElements. + + * In principle, the tables follow the same conventions as in <>. + * The table heads abbreviate 'cardinality' with 'card'. + * The tables often place two informations in different rows of the same table cell. In this case, the first information is marked out by sharp brackets [] form the second information. A special case are the semanticIds, which are marked out by the format: (type)(local)[idType]value. + * The types of SubmodelElements are abbreviated: + +[width="100%",cols="40%,60%",options="header"] +|=== +|{set:cellbgcolor:#eeeeee}SME type |SubmodelElement type +|{set:cellbgcolor:#ffffff}Property |Property +|MLP |MultiLanguageProperty +|Range |Range +|File |File +|Blob |Blob +|Ref |ReferenceElement +|Rel |RelationshipElement +|SMC |SubmodelElementCollection +|SML |SubmodelElementList + +|=== + + * If an idShort ends with '++__00__++', this indicates a suffix of the respective length (here: 2) of decimal digits to make the idShort unique. A different idShort might be chosen, as long as it is unique in the parent’s context. + * The Keys of semanticId in the main section feature only idType and value, such as [IRI]https://admin-shell.io/vdi/2770/1/0/DocumentId/Id. The attributes “type” and “local” (typically “ConceptDescription” and “(local)” or “GlobalReference” and (no-local)”) need to be set accordingly; see <>. + * If a table does not contain a column with "parent" heading, all represented attributes share the same parent. This parent is denoted in the head of the table. + * Multi-language strings are represented by the text value, followed by '@'-character and the ISO 639 language code: example@EN. + * The [valueType] is only given for Properties. + + + + +:sectnums!: + +== Annex B. How does the Submodel "Handover Documentation" relates to the Submodel "Intelligent Information for use + +The Submodel „Handover Documentation“ is specified on document level. It contains all documents which are existing and meant for exchange with other parties: + + +_Table 1: DocumentClassification according to VDI 2770 Blatt 1: 2020_ + +[width="100%",cols="12%,22%,24%,42%"] +|=== +s|{set:cellbgcolor:#eeeeee}ClassID +s|ClassName (EN) +s|ClassName (DE) +s|Semantic ID + +|{set:cellbgcolor:#ffffff} +01-01 +|Identification +|Identifikation +|0173-1#07-ABU484#003 + +|02-01 +|Technical specification +|Technische Spezifikation +|0173-1#07-ABU485#003 + + +|02-02 +|Drawings, plans +|Zeichnungen, Pläne +|0173-1#07-ABU486#003 + +|02-03 +|Assemblies +|Bauteile +|0173-1#07-ABU487#003 + + +|02-04 +|Certificates, declarations +|Zeugnisse, Zertifikate, Bescheinigungen +|0173-1#07-ABU488#003 + +|03-01 +|Commissioning, de-commissioning +|Montage, Demontage +|0173-1#07-ABU489#003 + + +|03-02 +|Operation +|Bedienung +|0173-1#07-ABU490#003 + +|03-03 +|General safety +|Allgemeine Sicherheit +|0173-1#07-ABU491#003 + +|03-04 +|Inspection, maintenance, testing +|Inspektion, Wartung, Prüfung +|0173-1#07-ABU492#003 + +|03-05 +|Repair +|Instandsetzung +|0173-1#07-ABU493#003 + +|03-06 +|Spare parts +|Ersatzteile +|0173-1#07-ABU494#003 + +|04-01 +|Contract documents +|Vertragsunterlagen +|0173-1#07-ABU495#003 +|=== + +:sectnums!: + +The VDI 2770 is followed as an integrative part of the Submodel „Handover Documentation“. + +Now, the Submodel „Intelligent Information for Use“ addresses the documents 03, i.e. 03-01, 03-02, 03-03, 03-04, 03-05 and 03-06, but is a specialization of the Handover Documentation in that respect that detailed topics and information units are tagged and can be integrated in knowledge graphs for intelligent retrieval. It does not deal with all the other documents of the Submodel „Handover Documentation”. + +The Submodel „Intelligent Information for Use“ is relying on the „Handover Documentation, detailing that in Topics using the iiRDS Metadata Schema, allowing detailed content retrieval out of the parts 03-xx of the Handover Documentation. iiRDS itself maintains joint working groups with VDI 2770 to guarantee smooth transfer. The same is done between Submodel „Handover Documentation“ and Submodel „Intelligent Information for Use“, though. + + + + + + + +:sectnums!: + +== Annex C. Changes to the Submodel template + +This annex lists the changes from version to version of the Submodel, together with major changes in the overall document. Non-backward compatible changes (Nc) are marked as such. + +Nc="x" means non-backward compatible; if no value is added in the table, then the change is backward compatible. + +Nc="(x)" means that the change made was implicitly contained or stated in the document before and is now being formalized. Therefore, the change is considered to be backward compatible. + +Three tables are introduced to explain the changes: + + 1. changes with respect to previous version, + 2. new elements in metamodel w.r.t previous version, + 3. new, changed, or removed constraints w.r.t previous version. + +If there are no changes the corresponding tables are omitted. + + +=== Changes Version 1.2 to Version 2.0 + +Changes in the ducument structure: + + * NEW: Appended Annex B + * NEW: Appended Annex C + +[width="100%",title="List of changes",cols="15%,15%,70%",options="header"] +|=== +s|{set:cellbgcolor:#eeeeee}Nr. +s|Nc. +s|Version 2.0 changes w.r.t Version 1.2 +|{set:cellbgcolor:#ffffff}1 +|(x) +|Minor text changes in chapter 1.2 & Table 2 + +|2 +|x +|ALL ECLASS IRDIs are updated with ECLASS 15 IRDIs. + +|3 +|(x) +|UML is updated + +|4 +|x +|AASX file is migrated to V 3.01 + +|5 +|x +|Addition and correction of SML/SMC elements + +|6 +|x +|Property DocumentVersionId changed to Version with new SemanticId + +|7 +|x +|Property Summary changed to Description with new SemanticId. + +|8 +|x +|Semantic definitions in ECLASS for Preview and Digital File are adapted to this specification of the IDTA. Details see table 6. + +|9 +|x +|ValueID was changed to DocumetIdentifier. + + +|=== + + + + + +:sectnums!: +[[Anker_D]] +== Annex D. VDI 2770 Blatt 1 Metamodel + +=== 3. General + +This chapter provides further information on approach and realization of Submodel information according to VDI 2770 Blatt 1. + +=== 4. Tables on Submodels and SubmodelElements + +VDI 2770 Blatt 1 was developed to simplify documentation handover in the process industry according to the specific requirements and general conditions of this industry. The assets addressed are complex, often expensive, and have a long lifespan. The documentation of these assets may be complex and may include legal and technical requirements. + +The VDI 2770 working group focused on two main aspects: the structure of the handover documentation, and specifications for digital files and their meta data. The most import normative specifications are: + + * Documents shall be classified at least according to the classification system provided by VDI 2770. + * To ensure long-term access, the file format PDF/A is a key demand. + * Meta data shall conform to a VDI 2770 information model. + * XML and ZIP are used for data exchange. Meta data and documents are disclosed as so-called containers. + +The overall documentation of an asset may be the sum of multiple handover tasks. VDI 2770 only represents documentations for an object at a single point in time. The defined containers are not indented to be updated. Instead, the container formats provide complete meta data for documents that can be processed in business information systems. Each consumer may process this data in a different manner. + +The information model of VDI 2770 Blatt 1 is based on IEC 82045-2. It distinguishes between documents and document versions. Hence, associations between objects and documents are quite stable, regardless of the current document version. + +A documentation is summarized by a main document according to IEC 62023. + +VDI 2770 does not address technical properties or details of the object. Identification numbers and identifiers are used to refer to objects. +A container format is specified for data exchange. This format is, however, not relevant for the Submodel template defined. + +VDI 2770 contains normative definitions regarding object identification. The guideline demands that object identifiers that are used for the nameplate of an object shall be included in the meta data of the documentation. Especially, a serial ID and/or a product ID is required. To address this requirement, we refer to the AAS Submodel template “ZVEI Digital Nameplate for industrial equipment” <>. + +Furthermore, VDI 2770 demands fundamental information about the manufacturer or supplier of an object. To address this requirement, we refer to the AAS Submodel template “Generic Frame for Technical Data for Industrial Equipment in Manufacturing” <>. + +=== 5. Information model of VDI 2770 Blatt 1 + +The information model of VDI 2770 Blatt 1 consists of 13 entities. The following diagram of the metamodel is published with permission of the editor. + + + +image::Figure_5.png[id="Figure_5", width="100.0%",title="UML information model of documentation meta data according to VDI 2770 [7]"] + +:sectnums!: + +=== 6. Mappings + +The structure of a SMC Document is almost identical to the VDI 2770 guideline, but + + * uses a simplified document ID, + * uses Entity and ReferenceElement for asset associations, + * uses MultiLanguageProperty type instead of VDI 2770 TranslateableString type, + * asset / object identification properties may be provided by other AAS submodels. + +The following mapping figure depicts the differences between the AAS and VDI 2770 Document entity. Dropped properties are shown in grey. + + + + +image::Figure_6.png[id="Figure_6", width="100.0%",title="Mapping between AAS and VDI 2770 Document entity, 1: document ID with simplified document domain, 2: using Entity and ReferenceElement for asset / object associations."] + +Document IDs are not globally unique by default. A document ID may be unique within a document domain. This domain is described by a domain ID as well as a responsible party. In the Submodel template, the document ID is a simplified tuple of document domain ID and document ID. + +The following mapping diagram depicts the differences between the AAS DocumentID and the VDI 2770 entities. Dropped properties are shown in grey. + + + + + +image::Figure_7.png[id="Figure_7", width="100.0%",title="Mapping between AAS and VDI 2770 Blatt 1 DocumentId"] + +Compared to VDI 2770, the DocumentVersion of this Submodel template has some structural differences: + + * document relationship types are modelled as references, + * describing information for documents (like title or keywords) are properties of the DocumentVersion, + * lifecycle status information has been simplified including information on the author. + +Furthermore, file management approaches differ between VDI 2770 and the AAS metamodel. + +The following mapping diagram depicts the differences. Dropped properties are shown in grey. + + + + + +image::Figure_8.png[id="Figure_8", width="100.0%",title="Mapping between AAS und VDI 2270 DocumentVersion, 1: three relation properties instead of generic relation model element, 2: describing information contained in document version, 3: different file handling approach, 4: simplified document status (only status and date), 5: simplified roles (only author)"] + +VDI 2770 defines an entity called DocumentDescription to aggregate describing document meta data for a document version in one language. This kind of information grouping is modelled in this Submodel using constraints. The following mapping diagram depicts the differences. Dropped properties are shown in grey. + + + + +image::Figure_9.png[id="Figure_9", width="100.0%",title="Mapping between AAS and VDI 2770 document descriptions"] + +This Submodel template uses simplified document lifecycle meta data. The parties involved in the document lifecycle are simplified. The following mapping diagram depicts the differences. Dropped properties are shown in grey. + +image::Figure_10.png[id="Figure_10", width="100.0%",title="Mapping between AAS and VDI 2770 document lifecycle"] + +To document object identification meta data, the additional application of the AAS Submodel “ZVEI Digital Nameplate for industrial equipment” [8] is recommended. In VDI 2770, an object may have a list of identification numbers, like a reference designation code, a serial-ID, a product ID. Different types of IDs are supported, e.g. a numeric value or a URL according to IEC 61406 (Identification Link). The most important IDs can be documented using the ZVEI Digital Nameplate Submodel (see the following figure). + +image::Figure_11.png[id="Figure_11", width="100.0%",title="Mapping between AAS and VDI 2770 object identifiers"] + +:sectnums!: +[[Anker_E]] +== Annex E. Further classifications + +=== 7. Document classification according to IEC 61355 + +The following table shows a selection of document classes according to "IEC 61355-1 Classification and designation of documents for plants, systems and equipment". <> + +The value of "DocumentClassificationSystem" shall be set to "IEC 61355-1:2008" to describe the classification (see section 2.7). The value of "DocumentClassId" shall be set to a two-letter, upper-case code. The full range of two-letter codes of IEC 61355-1:2008 may be used. + +[width="100%", title="Document classification according to IEC 61355", cols="16%,40%,44%"] +|=== +s|{set:cellbgcolor:#eeeeee}Doc.Class.ID +s|DocumentClassName (DE) +s|DokumentClassName (En) + +|{set:cellbgcolor:#eeeeee}A +|Dokumentationsbeschreibende Dokumente +|Documentation describing documents + +|{set:cellbgcolor:#ffffff}AA +|Verwaltungstechnische Dokumente +|Administrative documents + +|AB +|Listen (Dokumente betreffend) +|Lists (regarding documents) + +|AC +|Erläuternde Dokumente (Dokument betreffend) +|Explanatory documents (regarding documents) + +|{set:cellbgcolor:#eeeeee}B +|Managementdokumente +|Management documents + +|{set:cellbgcolor:#ffffff}BB +|Berichte +|Reports + +|BC +|Schriftwechsel +|Correspondence + +|BD +|Projektleitungsdokumente +|Project control documents + +|BE +|Ressourcenplanungsdokumente +|Resource planning documents + +|BF +|Versand-, Lager- und Transportdokumente +|Dispatch, storage and transport documents + +|BG +|Standortplanungs- und Standortorganisationsdokumente +|Site planning and site organization documents + +|BH +|Dokumente zum Änderungswesen +|Documents regarding changes + +|BS +|Objektschutzdokumente +|Security documents + +|BT +|Schulungsdokumente +|Training specific documents + +|{set:cellbgcolor:#eeeeee}C +|Vertragliche und nicht-technische Dokumente +|Contractual and non-technical documents + +|{set:cellbgcolor:#ffffff}CA +|Anfrage-, Kalkulations- und Angebotsdokumente +|Inquiry, calculation and offer documents + +|CB +|Genehmigungsdokumente +|Approval documents + +|CC +|Vertragliche Dokumente +|Contractual documents + +|CD +|Bestell- und Lieferdokumente +|Order and delivery documents + +|CE +|Rechnungsdokumente +|Invoice documents + +|CF +|Versicherungsdokumente +|Insurance documents + +|CG +|Gewährleistungsdokumente +|Warranty documents + +|CH +|Gutachten +|Expertises + +|{set:cellbgcolor:#eeeeee}D +|Dokumente mit allgemeiner technischer Information +|General technical information documents + +|{set:cellbgcolor:#ffffff}DA +|Datenblätter +|Data sheets + +|DB +|Erläuternde Dokumente +|Explanatory documents + +|DC +|Anleitungen und Handbücher +|Instructions and manuals + +|DD +|Technische Berichte +|Technical reports + +|DE +|Kataloge, Werbeschriften +|Catalogues Advertising documents + +|DF +|Technische Veröffentlichungen +|Technical publications + +|{set:cellbgcolor:#eeeeee}E +|Dokumente für technische Anforderungen und Auslegung +|Technical requirement and dimensioning documents + +|{set:cellbgcolor:#ffffff}EA +|Dokumente über gesetzliche Anforderungen +|Legal requirement documents + +|EB +|Normen und Richtlinien +|Standards and regulations + +|EC +|Technische Spezifikations- / Anforderungsdokumente +|Technical specification / requirement documents + +|ED +|Dimensionierungsdokumente +|Dimensioning documents + +|{set:cellbgcolor:#eeeeee}F +|Funktionsbeschreibende Dokumente +|Function describing documents + +|{set:cellbgcolor:#ffffff}FA +|Funktionsübersichtsdokumente +|Functional overview documents + +|FB +|Fließschemata +|Flow diagrams + +|FC +|Dokumente der MMS-Gestaltung (Mensch-Machine-Schnittstelle) +|MMI layout documents (MMI = man-machine interface) + +|FE +|Funktionsbeschreibungen +|Function descriptions + +|FF +|Funktionsschaltpläne +|Function diagrams + +|FP +|Signalbeschreibungen +|Signal descriptions + +|FQ +|Einstellwertdokumente +|Setting value documents + +|FS +|Schaltkreisdokumente +|Circuitry documents + +|FT +|Softwarespezifische Dokumente +|Software specific documents + +|{set:cellbgcolor:#eeeeee}L +|Ortsbeschreibende Dokumente +|Location documents + +|{set:cellbgcolor:#ffffff}LA +|Erschließungs- und Vermessungsdokumente +|Exploitation and survey documents + +|LB +|Erdbau- und Fundamentbaudokumente +|Earthwork and foundation work documents + +|LC +|Rohbaudokumente +|Building carcass documents + +|LD +|Dokumente, die Orte an Standorten beschreiben +|On-site location documents + +|LH +|Orte in Gebäuden (Schiffen, Flugzeugen, etc.) beschreibende Dokumente +|In-building location documents (also applied for ships, aircraft, etc.) + +|LU +|Orte in/auf Einrichtungen beschreibende Dokumente +|In/on-equipment location documents + +|{set:cellbgcolor:#eeeeee}M +|Verbindungsbeschreibende Dokumente +|Connection describing documents + +|{set:cellbgcolor:#ffffff}MA +|Verbindungsbezogene Dokumente +|Connection documents + +|MB +|Verkabelungs- und Rohrleitungsdokumente +|Cabling or piping documents + +|{set:cellbgcolor:#eeeeee}P +|Objektlisten +|Object listings + +|{set:cellbgcolor:#ffffff}PA +|Materiallisten +|Material lists + +|PB +|Teilelisten +|Parts lists + +|PC +|Stücklisten +|Item lists + +|PD +|Produktlisten und Produkttypenlisten +|Product lists and product type lists + +|PF +|Funktionslisten +|Function lists + +|PL +|Ortslisten +|Location lists + +|{set:cellbgcolor:#eeeeee}Q +|Qualitätsmanagementdokumente und sicherheitsbeschreibende Dokumente +|Quality management documents; safety-describing documents + +|{set:cellbgcolor:#ffffff}QA +|Qualitätsmanagementdokumente +|Quality management documents + +|QB +|Sicherheitsbeschreibende Dokumente +|Safety-describing documents + +|QC +|Qualitätsnachweisdokumente +|Quality verifying documents + +|{set:cellbgcolor:#eeeeee}T +|Dokumente zur Beschreibung geometrischer Formen +|Geometry-related documents + +|{set:cellbgcolor:#ffffff}TA +|Entwurfszeichnung +|Planning drawings + +|TB +|Konstruktionszeichnungen +|Construction drawings + +|TC +|Fertigungs- und Errichtungszeichnungen +|Manufacturing and erection drawings + +|TL +|Anordnungszeichnung +|Arrangement documents + +|{set:cellbgcolor:#eeeeee}W +|Betriebliche Protokolle und Aufzeichnungen +|Operation records + +|{set:cellbgcolor:#ffffff}WA +|Einstellwertdokumente +|Set point documents + +|WT +|Logbücher +|Logbooks + +|=== + + +:sectnums!: + +== Bibliography + +[width="100%",cols="10%,90%", frame=none, grid=none] +|=== + +|[1] [[Link1]] |“Recommendations for implementing the strategic initiative INDUSTRIE 4.0”, acatech, April 2013. [Online]. Available https://www.acatech.de/Publikation/recommendations-for-implementing-the-strategic-initiative-industrie-4-0-final-report-of-the-industrie-4-0-working-group/ + +|[2] [[Link2]] |“Implementation Strategy Industrie 4.0: Report on the results of the Industrie 4.0 Platform”; BITKOM e.V. / VDMA e.V., /ZVEI e.V., April 2015. [Online]. Available: https://www.bitkom.org/noindex/Publikationen/2016/Sonstiges/Implementation-Strategy-Industrie-40/2016-01-Implementation-Strategy-Industrie40.pdf + +|[3] [[Link3]] |“The Structure of the Administration Shell: TRILATERAL PERSPECTIVES from France, Italy and Germany”, March 2018. [Online]. Available: https://www.plattform-i40.de/I40/Redaktion/EN/Downloads/Publikation/hm-2018-trilaterale-coop.html + +|[4] [[Link4]] |“Beispiele zur Verwaltungsschale der Industrie 4.0-Komponente – Basisteil (German)”; ZVEI e.V., Whitepaper, November 2016. [Online]. Available: https://www.zvei.org/presse-medien/publikationen/beispiele-zur-verwaltungsschale-der-industrie-40-komponente-basisteil/ + +|[5] [[Link5]] |“Verwaltungsschale in der Praxis. Wie definiere ich Teilmodelle, beispielhafte Teilmodelle und Interaktion zwischen Verwaltungsschalen (in German)”, Version 1.0, April 2019, Plattform Industrie 4.0 in Kooperation mit VDE GMA Fachausschuss 7.20, Federal Ministry for Economic Affairs and Energy (BMWi). Available: https://www.plattform-i40.de/PI40/Redaktion/DE/Downloads/Publikation/2019-verwaltungsschale-in-der-praxis.html + +|[6] [[Link6]] |“Details of the Asset Administration Shell; Part 1 - The exchange of information between partners in the value chain of Industrie 4.0 (Version 3.0RC01)”, November 2020 [Online]. Available: https://industrialdigitaltwin.org/wp-content/uploads/2024/06/IDTA-01001-3-0-1_SpecificationAssetAdministrationShell_Part1_Metamodel.pdf[Asset Administration Shell Specification - Part 1: Metamodel (industrialdigitaltwin.org)] + +|[7] [[Link7]] |VDI 2770 Blatt 1: 2020-04 Betrieb verfahrenstechnischer Anlagen; Mindestanforderungen an digitale Herstellerinformationen für die Prozessindustrie; Grundlagen. Berlin: Beuth-Verlag. +“Operation of process engineering plants - Minimum requirements for digital manufacturer information of process industry - Fundamentals” (EN). Available: https://www.beuth.de/en/technical-rule/vdi-2770-blatt-1/319538792 + + +|[8] [[Link8]] |"Submodel Templates of the Asset Administration Shell - ZVEI Digital Nameplate for industrial equipment (Version 1.0)"; Plattform Industrie 4.0 with ZVEI; November 2020. [Online]. Available: https://www.plattform-i40.de/PI40/Redaktion/DE/Downloads/Publikation/Submodel_Templates-Asset_Administration_Shell-digital_nameplate.html + +|[9] [[Link9]] |"Submodel Templates of the Asset Administration Shell - Generic Frame for Technical Data for Industrial Equipment in Manufacturing (Version 1.1)"; Plattform Industrie 4.0 with ZVEI; November 2020. [Online]. Available: https://www.plattform-i40.de/PI40/Redaktion/DE/Downloads/Publikation/Submodel_Templates-Asset_Administration_Shell-Technical_Data.html + +|[10] [[Link10]] |"IEC 61355 - Collection of standardized and established document kinds“. Available: https://std.iec.ch/iec61355/iec61355.nsf/$enhome?OpenForm + + + + + + + +|=== + diff --git a/published/Sizing of Power Drive Trains/1/0/docs/antora.yml b/published/Sizing of Power Drive Trains/1/0/docs/antora.yml new file mode 100644 index 00000000..89fb8dbe --- /dev/null +++ b/published/Sizing of Power Drive Trains/1/0/docs/antora.yml @@ -0,0 +1,4 @@ +name: Sizing of Power Drive Trains +title: 'Sizing of Power Drive Trains' +version: 'v1.0' +start_page: ROOT:index.adoc \ No newline at end of file diff --git a/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/Figure_1.png b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/Figure_1.png new file mode 100644 index 00000000..a746ea66 Binary files /dev/null and b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/Figure_1.png differ diff --git a/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/Figure_2.png b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/Figure_2.png new file mode 100644 index 00000000..461b4512 Binary files /dev/null and b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/Figure_2.png differ diff --git a/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/Figure_3.png b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/Figure_3.png new file mode 100644 index 00000000..567f0bb1 Binary files /dev/null and b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/Figure_3.png differ diff --git a/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/Figure_4.png b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/Figure_4.png new file mode 100644 index 00000000..2721a97b Binary files /dev/null and b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/Figure_4.png differ diff --git a/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/Figure_5.png b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/Figure_5.png new file mode 100644 index 00000000..bdbf6cdd Binary files /dev/null and b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/Figure_5.png differ diff --git a/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/Figure_6.png b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/Figure_6.png new file mode 100644 index 00000000..b34fb336 Binary files /dev/null and b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/Figure_6.png differ diff --git a/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/Figure_7.png b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/Figure_7.png new file mode 100644 index 00000000..918c64b3 Binary files /dev/null and b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/Figure_7.png differ diff --git a/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/SMT-template-cover.svg b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/SMT-template-cover.svg new file mode 100644 index 00000000..356c2fb6 --- /dev/null +++ b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/SMT-template-cover.svg @@ -0,0 +1,1266 @@ + + + +SPECIFICATIONSubmodel Template of theAsset Administration Shell diff --git a/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/asciidoc-style-idta.css b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/asciidoc-style-idta.css new file mode 100644 index 00000000..cc2879f2 --- /dev/null +++ b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/asciidoc-style-idta.css @@ -0,0 +1,97 @@ +@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"; +@import "https://cdn.jsdelivr.net/gh/asciidoctor/asciidoctor@2.0/data/stylesheets/asciidoctor-default.css"; + +h1, h2, h3, h4, h5, h6, #toctitle, +.sidebarblock > .content > .title { + color: rgba(0, 0, 0, 0.8); +} + +#toc { + background:-color #ffffff; +} + +#toctitle { + color: #0028cd; +} + +a { + color: #17418a; +} + +a:hover, a:focus { + color: rgb(8, 24, 117); +} + +h1, h2, h3, .sidebarblock > .content > .title, h4, h5, h6 { + color: #3149cc; +} + +.subheader, .admonitionblock td.content > .title, .audioblock > .title, .exampleblock > .title, .imageblock > .title, .listingblock > .title, .literalblock > .title, .stemblock > .title, .openblock > .title, .paragraph > .title, .quoteblock > .title, table.tableblock > .title, .verseblock > .title, .videoblock > .title, .dlist > .title, .olist > .title, .ulist > .title, .qlist > .title, .hdlist > .title { + color: #303030; +} + +:not(pre):not([class^=L])>code { + background-color: #e0e0e0; +} + +table thead, table tfoot { + background: #f7f8f7; + background-color: rgb(247, 248, 247); + background-position-x: 0%; + background-position-y: 0%; + background-repeat: repeat; + background-attachment: scroll; + background-image: none; + background-size: auto; + background-origin: padding-box; + background-clip: border-box; +} + +/* Problem handling with long strings in the tables */ +/* This seems no appropriate or last resort (sliders) + table { + display: block; + width: max-content; + max-width: 100%; + overflow-x: auto; + } +*/ + +/* This seems to work: */ +table { + word-wrap: anywhere; +} + +.huge { + font-family: 'Open Sans'; + font-size: 3em; + line-height: 1.1em; +} + +.large { + font-family: 'Open Sans'; + font-size: 1.8em; + line-height: 1.1em; +} + +.normal { + font-family: 'Open Sans'; + font-size: 1em; + line-height: 1.1em; +} + +.white { + color: #ffffff; +} + +.redboxoneround { + padding: 0.3em 1em 0.3em 1em; + margin: 0.5em 0 0.5em 0; + font-family: 'Open Sans'; + font-size: 2em; + color: #ffffff; + line-height: 1.1em; + letter-spacing: 0.1em; + background-color: #fe4f0e; + border-radius: 0 0.35em 0 0; +} \ No newline at end of file diff --git a/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/compile-html.bat b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/compile-html.bat new file mode 100644 index 00000000..662c550b --- /dev/null +++ b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/compile-html.bat @@ -0,0 +1 @@ +docker run -it -v .:/documents/ asciidoctor/docker-asciidoctor asciidoctor -r asciidoctor-diagram -a toc=left -a stylesheet=asciidoc-style-idta.css *.adoc \ No newline at end of file diff --git a/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/compile-pdf-line-nrs.bat b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/compile-pdf-line-nrs.bat new file mode 100644 index 00000000..9be41708 --- /dev/null +++ b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/compile-pdf-line-nrs.bat @@ -0,0 +1 @@ +docker run -it -v .:/documents/ asciidoctor/docker-asciidoctor asciidoctor-pdf -r asciidoctor-diagram -r ./extended.rb -a toc=macro -a pdf-theme=my-theme.yml -a env-pdf *.adoc \ No newline at end of file diff --git a/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/compile-pdf.bat b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/compile-pdf.bat new file mode 100644 index 00000000..65c255ef --- /dev/null +++ b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/compile-pdf.bat @@ -0,0 +1 @@ +docker run -it -v .:/documents/ asciidoctor/docker-asciidoctor asciidoctor-pdf -r asciidoctor-diagram -a toc=macro -a pdf-theme=my-theme.yml -a env-pdf *.adoc \ No newline at end of file diff --git a/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/extended.rb b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/extended.rb new file mode 100644 index 00000000..757cc465 --- /dev/null +++ b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/extended.rb @@ -0,0 +1,27 @@ +# This file is taken from the extension examples from the asciidoctor-pdf repository. +# https://github.com/asciidoctor/asciidoctor-pdf/blob/main/docs/modules/extend/examples/pdf-converter-numbered-paragraphs.rb + + +class PDFConverterNumberedParagraphs < (Asciidoctor::Converter.for 'pdf') + register_for 'pdf' + + def init_pdf doc + doc + .find_by(context: :paragraph) {|candidate| [:document, :section].include? candidate.parent.context } + .each_with_index {|paragraph, idx| paragraph.set_attr 'number', idx + 1 } + super + end + + def convert_paragraph node + if (paragraph_number = node.attr 'number') + float do + label = %(#{paragraph_number}.#{::Prawn::Text::NBSP}) + label_width = rendered_width_of_string label + bounding_box [-label_width, cursor], width: label_width do + ink_prose label, color: 'CCCCCC', align: :right, margin: 0, single_line: true + end + end + end + super + end +end diff --git a/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/idta-cover-logo-small.png b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/idta-cover-logo-small.png new file mode 100644 index 00000000..8e821f9f Binary files /dev/null and b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/idta-cover-logo-small.png differ diff --git a/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/idta-smt-badge.png b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/idta-smt-badge.png new file mode 100644 index 00000000..ab505e50 Binary files /dev/null and b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/idta-smt-badge.png differ diff --git a/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/idta-spec-badge.png b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/idta-spec-badge.png new file mode 100644 index 00000000..5ef5260f Binary files /dev/null and b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/idta-spec-badge.png differ diff --git a/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/my-theme.yml b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/my-theme.yml new file mode 100644 index 00000000..cba8d6c2 --- /dev/null +++ b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/my-theme.yml @@ -0,0 +1,103 @@ +extends: default-for-print + +title-page: + text_align: left + margin-inner: -1cm + margin-outer: -1cm + title: + top: 8cm + font_size: 42 + font_style: bold + font_color: D9D9D9 + line_height: 1.2 + subtitle: + margin-top: 1cm + font_size: 42 + font_color: D9D9D9 + font_style: normal + line_height: 1.0 + authors: + margin-top: 1cm + font_size: 18 + font_color: D9D9D9 + font_style: normal + line_height: 1 + revision: + margin-top: 1cm + font_size: 18 + font_color: D9D9D9 + font_style: normal + line_height: 1 + background-image: image:SMT-template-cover.svg[fit=cover] + logo: + top: 21.7cm + align: right + image: image:idta-smt-badge.png[pdfwidth=48%] +page: + layout: portrait + margin: [1.5cm, 2cm, 1.5cm, 2cm] + size: A4 +base: + font-color: #333333 + font-family: Helvetica + font-size: 10 + line-height-length: 11.5 + line-height: $base-line-height-length / $base-font-size +role: + removed: + font-style: italic + text-decoration: line-through + text-decoration-color: #FF0000 + huge: + font-family: Helvetica + font-size: 24 + large: + font-family: Helvetica + font-size: 16 + normal: + font-family: Helvetica + font-size: 12 + white: + font-color: #ffffff + redboxoneround: + border-radius: [0.3cm, 0cm, 0cm, 0cm] + font-family: Helvetica + font-size: 16 + letter-spacing: $base-font-size * 1.1 + font-color: #ffffff + background-color: #fe4f0e +heading: + font-color: #3149cc + font-size: 17 + font-family: Helvetica + line-height: 1.2 + margin-bottom: 10 +link: + font-color: #17418a +list: + indent: $base-font-size * 1.2 + +table: + font-size: 10 + border-width: 0.5 + grid-width: 0.5 + border-color: #707070 + grid-color: #707070 + +pre: + font-color: #ff0000 + +code: + font-color: #505050 + font-style: bold + font-size: 11 + font-weight: 600 + +literal: + font-color: #3149cc + font-style: bold + font-size: 12 + font-weight: 800 +image: + # align: center + # problem: caption not able to center \ No newline at end of file diff --git a/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/watch_new_unzip_and_show.ps1 b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/watch_new_unzip_and_show.ps1 new file mode 100644 index 00000000..46e59c47 --- /dev/null +++ b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/images/watch_new_unzip_and_show.ps1 @@ -0,0 +1,107 @@ +# from: https://stackoverflow.com/questions/62350872/powershell-file-watcher-register-objectevent-wait-for-file-to-complete-copying + +# IMPORTANT: Copy this file to the folder being watchd (typically one level above) and run + +Clear-Host +$ErrorActionPreference = [System.Management.Automation.ActionPreference]::Stop + +$fileSystemWatcherDirPath = '.' +$fileSystemWatcherFilter = '*.zip' + +$fileSystemWatcher = [System.IO.FileSystemWatcher]::new($fileSystemWatcherDirPath , $fileSystemWatcherFilter) +$fileSystemWatcher.IncludeSubdirectories = $true +$fileSystemWatcher.EnableRaisingEvents = $true +$fileSystemWatcher.NotifyFilter = [System.IO.NotifyFilters]::FileName -bor [System.IO.NotifyFilters]::DirectoryName -bor [System.IO.NotifyFilters]::LastWrite # [System.Linq.Enumerable]::Sum([System.IO.NotifyFilters].GetEnumValues()) + +# Create syncronized hashtable +# $syncdFsItemEventHashT = [hashtable]::Synchronized([hashtable]::new()) +$global:syncdFsItemEventHashT = @{} + +$fileSystemWatcherAction = { + try { + $fsItemEvent = [pscustomobject]@{ + EventIdentifier = $Event.EventIdentifier + SourceIdentifier = $Event.SourceIdentifier + TimeStamp = (Get-Date) # $Event.TimeGenerated + FullPath = $Event.SourceEventArgs.FullPath + ChangeType = $Event.SourceEventArgs.ChangeType + } + + # Collecting event in synchronized hashtable (overrides existing keys so that only the latest event details are available) + # $syncdFsItemEventHashT = @{} + Write-Host $fsItemEvent.FullPath + Write-Host $syncdFsItemEventHashT + $syncdFsItemEventHashT[$fsItemEvent.FullPath] = $fsItemEvent + } catch { + Write-Host ($_ | Format-List * | Out-String ) -ForegroundColor red + } +} + +# Script block which processes collected events and do further actions like copying for backup, etc... +# That scriptblock was initially used to test "Start-Job". Unfortunately it's not possible to access and modify the synchronized hashtable created within this scope. +$fSItemEventProcessingJob = { + $keys = [string[]]$syncdFsItemEventHashT.psbase.Keys + + foreach ($key in $keys) { + $fsEvent = $syncdFsItemEventHashT[$key] + + try { + + Write-Host "Event has TS = ", $fsEvent.TimeStamp + + if ( ( (Get-Date) - $fsEvent.TimeStamp ).TotalSeconds -gt 3) { + + Write-Host "Finally processing: ", $fsEvent.FullPath + $syncdFsItemEventHashT.Remove($key) + + # do the work + Remove-Item 'new' -Recurse -ErrorAction SilentlyContinue + Expand-Archive -Path $fsEvent.FullPath -DestinationPath new + Set-Location .\new\ + Start-Process -FilePath 'compile-html.bat' -Wait + Start-Process -FilePath @(Get-ChildItem *.html)[0] + Set-Location .. + } + + } catch { + Write-Host ($_ | Format-List * | Out-String ) -ForegroundColor red + } + } +} + +[void] (Register-ObjectEvent -InputObject $fileSystemWatcher -EventName 'Created' -SourceIdentifier 'FSCreated' -Action $fileSystemWatcherAction) +[void] (Register-ObjectEvent -InputObject $fileSystemWatcher -EventName 'Changed' -SourceIdentifier 'FSChanged' -Action $fileSystemWatcherAction) +[void] (Register-ObjectEvent -InputObject $fileSystemWatcher -EventName 'Renamed' -SourceIdentifier 'FSRenamed' -Action $fileSystemWatcherAction) +[void] (Register-ObjectEvent -InputObject $fileSystemWatcher -EventName 'Deleted' -SourceIdentifier 'FSDeleted' -Action $fileSystemWatcherAction) + +Write-Host "Watching for changes in '$fileSystemWatcherDirPath'.`r`nPress CTRL+C to exit!" +try { + do { + Wait-Event -Timeout 1 + + if ($syncdFsItemEventHashT.Count -gt 0) { + Write-Host "`r`n" + Write-Host ('-' * 50) -ForegroundColor Green + Write-Host "Collected events in hashtable queue:" -ForegroundColor Green + $syncdFsItemEventHashT.Values | Format-Table | Out-String + } + + # Process hashtable items and do something with them (like copying, ..) + .$fSItemEventProcessingJob + + # Garbage collector + [GC]::Collect() + + } while ($true) + +} finally { + # unregister + Unregister-Event -SourceIdentifier 'FSChanged' + Unregister-Event -SourceIdentifier 'FSCreated' + Unregister-Event -SourceIdentifier 'FSDeleted' + Unregister-Event -SourceIdentifier 'FSRenamed' + + # dispose + $FileSystemWatcher.Dispose() + Write-Host "`r`nEvent Handler removed." +} diff --git a/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/pages/index.adoc b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/pages/index.adoc new file mode 100644 index 00000000..a441e0f8 --- /dev/null +++ b/published/Sizing of Power Drive Trains/1/0/docs/modules/ROOT/pages/index.adoc @@ -0,0 +1,4486 @@ + + += IDTA 02021-1-0 Sizing of Power Drive Trains + +=== Imprint + +Publisher +[verse] +____ +Industrial Digital Twin Association +Lyoner Strasse 18 +60528 Frankfurt am Main +Germany +https://www.industrialdigitaltwin.org/ +____ + +=== Version history + +[cols="1,1,4"] +|=== + +|Date +|Version +|Comment + +|19.01.2024 +|1.0 +|Release of the official Submodel template published by IDTA. + +|=== + +:sectnums: + +:toclevels: 3 + +:xrefstyle: short + +<<< +toc::[] +<<< + +== General + +=== About this document +This document is a part of a specification series. Each part specifies the contents of a Submodel template for +the Asset Administration Shell (AAS). The AAS is described in [1], [2], [3] and [6]. First exemplary Submodel +contents were described in [4], while the actual format of this document was derived by the "Administration +Shell in Practice" [5]. The format aims to be very concise, giving only minimal necessary information for +applying a Submodel template, while leaving deeper descriptions and specification of concepts, structures +and mapping to the respective documents [1] to [6]. + +The target group of the specification are developers and editors of technical documentation and +manufacturer information, which are describing assets in smart manufacturing by means of the Asset +Administration Shell (AAS) and therefore need to create a Submodel instance with a hierarchy of +SubmodelElements. This document especially details on the question, which SubmodelElements with which +semantic identification shall be used for this purpose. + + +=== Scope of the Submodel +The Submodel template aims at interoperable provision of information, especially information for sizing +electrical drive systems in industrial automation. For this purpose, the essential components drive, motor, +gearbox, transformation as well as their additional components are described and the parameters necessary +for the calculation are considered. Mechanical and electrical aspects are considered in the drive design. The +Submodel specification addresses machine and plant manufacturers, manufacturers of drive compontents +and developers of sizing tools that exchange information for the use case of drive design. The objective of +the drive design is to select suitable components based on movement patterns and system requirements. + +=== Relevant standards for the Submodel template +- link:https://www.automationml.org/wp-content/uploads/2021/06/AR-Drive-Configurations-v1_0_0.zip[AutomationML, “Application Recommendation – Drive Configurations (M-CAD aspects)”] +- Work In Progress: v2_0_0 “Application Recommendation – Drive Configurations (M-CAD aspects)” +- VDI 2143-1 „Bewegungsgesetze für Kurvengetriebe; Theoretische Grundlagen“ +- link:https://www.zvei.org/fileadmin/user_upload/Presse_und_Medien/Publikationen/2022/Mai/Diskussionspapier_Digital_Engineering/Diskussionspapier_Digital_Engineering_final.pdf[ZVEI, Discussion Paper – Electrical Drive Design with the Digital Twin] + + + +==== AutomationML integration +The data exchange format AutomationML which is standardising in the IEC 62714 standard is a neutral, free,and XML-based data format. It has been developed in order to support the data exchange betweenengineering tools in a heterogeneous engineering tool landscape. As AutomationML is the leading format fordata exchange in the engineering phase and AAS to be seen as the medium to transport data acrossdifferent phases of the lifecycle, the existing AutomationML model shall be used and integrated into the AAS.With this only data required in other phases than engineering shall be “published” in the AAS. All other datashall remain in the AutomationML file. There are options to integrate the AutomationML model in the AAS,which are not yet published. These options will be part of specification in further versions. + +=== Use cases, requirements and design decisions +The Submodel template specification addresses machine and plant manufacturers, manufacturers of drive +compontents and developer of sizing tools that exchange information for the use case of drive design. The +objective of the drive design is to select suitable components based on movement patterns and system +requirements. The Submodel itself can be assigned to a design project, a drive axis or even individual +components of a drive system. The Leading Picture (Figure 1) defines the scope within which the use cases +of the Submodel can be classified. + +image::Figure_1.png[id="Figure_1", width="100.0%",title="Leading Picture for Use Cases"] + +Figure 2 and Table 1 shows the target picture of how, with the help of digital twins, the information, e.g. in the +development of a machine, is created step by step in the value network around the drive sizing and which +other AAS Submodels should play a role. + +image::Figure_2.png[id="Figure_2", width="100.0%",title="Scenario of a sizing process with AAS"] + +Due to the large number of use cases an their scope, the use cases were prioritized according Table 1. + +[width="100%", title="List of Use Cases", cols="5%,20%,60%,10%"] +|=== +s|No. s|Title s|Description s|Spec Version +|UC1 +|Sharing of Application requirements along the toolchain +|Customers can define system requirements, operating conditions, and planned motion sequences, which allows sizing tools to calculate and filter components. +|1.0 +|UC2 +|Retrieving the sizing file/project" in any life cycle phase of the asset +|Embedding of the sizing file / project: Contact information, the sizing file and versions of the sizing tool are referenced in order to be able to retrieve the design of an asset in the engineering and later use phases. +|1.0 +|UC3 +|Sharing of Transformation mechanism descriptions in the life cycle phase of the asset +|Applications and transformation mechanisms are described in order to be able to document the sizing relevant parameters. +|1.0 +|UC4 +|Sharing Sizing results in the life cycle phase of the asset +|Sizing results are described in a uniform manner so that they can be reused in engineering and in the further use of assets. +|1.0 +|UC5 +|Exchange Bill of material for further ordering processes and toolchain +|The parts list of all drive components is created and linked to their respective sizing results +|1.0 +|UC6 +|Component data can be shared +|Sizing tools can retrieve standardized component data that is used to calculate. Dataflow fom component supplier to sizing tool. +|Later versions +|UC7 +|Comparison of different Variants +|Collection of variants in environmental conditions, axis configurations, … +|Later Versions +|UC8 +|Modeling of multi-axis systems +|Handover and integration of the main properties from the modeling of multi-axis systems possible in AutomationML. +|Later Versions +|=== + +== Sizing of Power Drive Trains + +=== Approach +The Submodel template specification was created by the ZVEI e. V. working group "Industrie 4.0 Drive +Technology", AutomationML e.V and the Industrial Digital Twin Association e.V. For this Submodel template +specification, the sizing tools of different providers and their data formats were compared. From this, crossvendor characteristics were derived. In addition, the existing Automation ML and AAS Submodels were +examined and evaluated for use in the context of data exchange in the sizing process. + +=== Explanations and definitions +The PowerDriveTrainSizing Submodel consists of four structuring sections that are used within the sizing +process. The Submodel itself can be assigned to a sizing project, a drive axis, or even individual components +of a drive system. In future versions of the specification, further sections are planned in which more in-depth +connections and relationships can be modeled. +Major components that are described: + +- Sizing Project: Identifying characteristics of the sizing project with reference to the sizing project file. +- Application Requirements: +* Motion and load profile: The specified motion sequence and the calculated motion, taking into account the workload and customer specifications. +* Environmental: Environmental conditions in which the drive train is to be operated. +* System Requirements: The features required by the customer in the selection of individual components and in the consideration of the overall system. +* UsageProfile: Usage profiles to make the TCO life cycle assessment +- Transformation mechanisms: Mechanisms for transmitting the force in the drive task, such as belt or rack and pinion applications. +- SizingResult: +* Bill of Material: Simple list for ordering the individual components. +* Utilization Rates: Technical data of the drive components and their utilization rates in relation to the requirements in the motion profile. +* Messages and Text statements: Interpretative notes and general texts + +image::Figure_3.png[id="Figure_3", width="100.0%",title="UML Diagram of SMT PowerDriveTrainSizing"] + + +==== Sizing Project Information +For Use Case 1, the sizing project file is to be integrated including the metadata that must be attached to a +sizing documentation. This includes the project name, contact details and the name of the sizing tool and the +versions used. + +The sizing project file with the reference to the sizing tool and the creation and modification timestamps can +also be included in the asset administration shell. + +Notice - the sizing project may be in a proprietary data format. Preferred standard for the engineering phase +is the Automation ML File Format. + +Notice - Further information, such as the contact details of the persons involved in the design or approval +workflows are feasible. + +image::Figure_4.png[id="Figure_4", width="100.0%",title="UML Diagram of SizingProjectInformation"] + + +==== Application Requirements and Motion patterns +The application requirements section contains the customer's specifications for the drive task. Customer +requirements are divided into the sections motion pattern, environmental conditions, overall system +requirements and operation patterns. + +image::Figure_5.png[id="Figure_5", width="100.0%",title="UML Diagram of ApplicationRequirements"] + +The basis for selecting the optimal drive system is the motion and load patterns that needs to be met. The +motion pattern consists of individual motion sections that specify the travel distance, the travel time and the +forces. Motion patterns are differentiated by linear and rotative motion. + +Table 2: Linear and Rotative Motion Parameters +[width="100%", title="Linear and Rotative Motion Parameters", cols="50%,50%"] +|=== +s|Linear Motion (Translation) +s|Rotative Motion (Rotation) +|Time [s] +|Time [s] +|Position [m] +|AngularPosition [rad] +|LinearVelocity [m/s] +|AngularVelocity [rad/s] +|LinearAcceleration [m/s²] +|AngularAcceleration [rad/s²] +|LinearJerk [m/𝑠𝑠³ +|] AngularJerk [rad/𝑠𝑠³] +|LoadSideForce [N] + +(can be static or variable) +|LeverArmRadialForce [m] + +(static) +|LoadMass [kg] + +(can be static or variable) +|MomentOfInertiaOfLoad [kg m2] + +(static) +|CompensationForce [N] + +(can be static or variable) +|AxialForce [N] + +(can be static or variable) +|FrictionCoefficient [unitless] + +(static) +|RadialForce [N] + +(can be static or variable) +|FrictionForce [N] + +(can be static or variable) +|Friction Torque [N] + +(can be static or variable) +|CounterMass [kg] + +(static) +|LoadTorque [N] + +(can be static or variable) +|=== +A motion pattern consists of one or more sections within which motion sequences can be defined and +passed as time series. + +To be compatible with existing systems, the motion profile is to be imported as CSV. The comma-separated +column headings and order are based on the characteristics and units specified in the MetadataRecord. Line +1 is therefore skipped during import. + +Definitions for the CSV files: + +- Line 1 as heading consisting of "idShort + [Unit]", from line 2 the values start +- As separator between the columns ";" +- Float numbers +- Decimal separator "." + +The section of the *environmental conditions* contains all requirements for the drive system, which are +based on the operating conditions. In addition to the properties defined in this specification, further properties +can be added by the User. + +The *overall system requirements* refer to the characteristics of the drive system, in particular its interfaces +to the power supply, mechanical integration or cooling. In addition to the properties defined in this +specification, further properties can be added by the User. + +Notice - The current specification assumes a single axis. for multiple axes, the system requirements, if +different, would also need to be described multiple times. + +==== Transformation mechanisms +A transformation mechanism (application) is used, for example, to generate linear output motions through +rotational drive motions. For the optimum sizing of the drive system, data of the application must be +determined. The working group compared some common mechanisms from different sizing tools. More +mechanisms will follow. The descriptive characteristics also represent the common denominator for a basic +interpretation. Vendor specific extensions through additional properties are given. All applications are listed +in the submodel template - note that only one application mechanism can be selected in the sizing project +instance. + +image::Figure_6.png[id="Figure_6", width="100.0%",title="UML Diagram of TransformationMechanism"] + + +==== Sizing Results +The sizing results section contains the result data related to the overall system and the individual +components. In particular, the specification shows the sizing results of the overall system and the relevant +individual components (such as drive, motor, gearbox). Further components, such as add-on parts and +accessories, can be inserted in the "SizingResultOther" section. + + +image::Figure_7.png[id="Figure_7", width="100.0%",title="UML Diagram of SizingResult"] + +Notice - The AutomationML file for the sizing project contains a complete list of relationships. In the AAS +Submodel, only the mechanical attachment is to be represented. + +=== Submodel Specification PowerDriveTrainSizing + +// Table generated from [Submodel, www.example.com/ids/sm/5311_7020_9042_2173],[SubmodelElementCollection, Section_2_Approaches],[SubmodelElementCollection, Section_2_3_Submodel_specifics],[ReferenceElement, Table_Submodel_Specification_PowerDriveTrainSizing] + + + +[width="100%", id="Table_Submodel_Specification_PowerDriveTrainSizing", title="Submodel Specification PowerDriveTrainSizing", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}PowerDriveTrainSizing + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}Submodel + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/PowerDriveTrainSizing/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}- + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}Submodel containing customer specifications for motion and load profile, limitations and requirements of an industrial motion application. + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[SMC] + + + +SizingProjectInformation +|https://admin-shell.io/idta/PowerDriveTrainSizing/SizingProjectInformation1/0 + + + +Descriptive information that characterizes and contextualizes the project itself +|[] + + + +10 elements +|1 + + + +|[SMC] + + + +ApplicationRequirements +|https://admin-shell.io/idta/PowerDriveTrainSizing/ApplicationRequirements/1/0 + + + +Technical and environmental requirements from the customer which have to be fulfilled by the entire power drive train and its components. +|[] + + + +4 elements +|1 + + + +|[SMC] + + + +TransformationMechanism +|https://admin-shell.io/idta/PowerDriveTrainSizing/TransformationMechanism/1/0 + + + +Devices used to convert one form of input energy or motion into another form. This can include the conversion of rotary motion to linear motion, the amplification of torque, or other mechanical conversions + +All application mechanisms are listed in the submodel template - note that only one application mechanism can be selected in the design project instance. +|[] + + + +10 elements +|0..1 + + + +|[SMC] + + + +SizingResult +|https://admin-shell.io/idta/PowerDriveTrainSizing/SizingResult/1/0 + + + +Insights resulting from the process of designing a drive system. This can include selecting the right components, calculating torques, speeds, power requirements, sizing motors, gearboxes and other elements +|[] + + + +5 elements +|0..1 + + + +|=== + + + + +==== Submodel Elements of SizingProjectInformation + +// Table generated from [Submodel, www.example.com/ids/sm/5311_7020_9042_2173],[SubmodelElementCollection, Section_2_Approaches],[SubmodelElementCollection, Section_2_3_Submodel_specifics],[SubmodelElementCollection, Section_2_3_1_Submodel_Elements_of_SizingProjectInformation],[ReferenceElement, Table_SizingProjectInformation] + + + +[width="100%", id="Table_SizingProjectInformation", title="Submodel Elements of SizingProjectInformation", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}SizingProjectInformation + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementCollection + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/PowerDriveTrainSizing/SizingProjectInformation1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}PowerDriveTrainSizing + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee} + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Prop] + + + +ClientName +|https://admin-shell.io/idta/PowerDriveTrainSizing/ClientName/1/0 + + + +Designation for a person or organization for which the design project was created +|[String] + + + + +|1 + + + +|[Prop] + + + +SizingProjectName +|https://admin-shell.io/idta/PowerDriveTrainSizing/SizingProjectName/1/0 + + + +Meaningful name for labeling of the sizing project +|[String] + + + + +|1 + + + +|[Prop] + + + +SizingProjectAxisReference +|https://admin-shell.io/idta/PowerDriveTrainSizing/SizingProjectAxisReference/1/0 + + + +Unique identification number or identifier assigned to a specific axis within the sizing project +|[String] + + + + +|0..1 + + + +|[MLP] + + + +SizingProjectDescription +|https://admin-shell.io/idta/PowerDriveTrainSizing/SizingProjectDescription/1/0 + + + +Short description of the project, power drive train or application (short text) in common language +|[] + + + +Short description of the project, power drive train or application (short text) in common language@en +|0..1 + + + +|[File] + + + +SizingProjectLink +|https://admin-shell.io/idta/PowerDriveTrainSizing/SizingProjectLink/1/0 + + + +Resource for storing data of a sizing application, identified primarily by its file name. +|[] + + + + +|1..* + + + +|[Prop] + + + +SizingToolName +|https://admin-shell.io/idta/PowerDriveTrainSizing/SizingToolName/1/0 + + + +Name or title of a computer program or application software. This name identifies the specific software with the help of which the sizing was performed +|[String] + + + + +|1 + + + +|[Prop] + + + +DateCreated +|https://admin-shell.io/idta/PowerDriveTrainSizing/DateCreated/1/0 + + + +The exact date and time that this file was created or generated on a computer system. This date indicates when the file was first created or captured on the system +|[DateTime] + + + + +|1 + + + +|[Prop] + + + +DateChanged +|https://admin-shell.io/idta/PowerDriveTrainSizing/DateChanged/1/0 + + + +Exact date and time when the file was last edited, modified, or updated. This date indicates when the last modifications were made to the file +|[DateTime] + + + + +|1 + + + +|[SMC] + + + +ContactInformation +|https://admin-shell.io/zvei/nameplate/1/0/ContactInformations/ContactInformation + + + + +|[] + + + +0 elements +|1..* + + + +|[Prop] + + + +AmlDriveConfigVersion +|https://admin-shell.io/idta/PowerDriveTrainSizing/AmlDriveConfigVersion/1/0 + + + +Used version of AML Application Reccomendation Drive Configurations with the help of which the sizing was performed. +|[String] + + + + +|0..1 + + + +|=== + + + + +==== Submodel Elements of ApplicationRequirements + +// Table generated from [Submodel, www.example.com/ids/sm/5311_7020_9042_2173],[SubmodelElementCollection, Section_2_Approaches],[SubmodelElementCollection, Section_2_3_Submodel_specifics],[SubmodelElementCollection, Section_2_3_2_Submodel_Elements_of_ApplicationRequirements],[ReferenceElement, Table_ApplicationRequirements] + + + +[width="100%", id="Table_ApplicationRequirements", title="Submodel Elements of ApplicationRequirements", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}ApplicationRequirements + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementCollection + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/PowerDriveTrainSizing/ApplicationRequirements/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}PowerDriveTrainSizing + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee} + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[SMC] + + + +MotionPattern +|https://admin-shell.io/idta/PowerDriveTrainSizing/MotionPattern/1/0 + + + +The motion profile represents trajectories moving along different points. +|[] + + + +2 elements +|0..1 + + + +|[SMC] + + + +Environmental +|https://admin-shell.io/idta/PowerDriveTrainSizing/EnvironmentalRequirements/1/0 + + + +Conditions and prerequisites necessary for the proper functioning, installation or use of the system +|[] + + + +5 elements +|0..1 + + + +|[SMC] + + + +OverallSystemRequirements +|https://admin-shell.io/idta/PowerDriveTrainSizing/OverallSystemRequirements/1/0 + + + +basic criteria and specifications that apply to the installation, configuration, and operation of the system. These requirements typically include minimum specifications for hardware, software, security requirements, and other basic aspects necessary for the application to function smoothly +|[] + + + +9 elements +|0..1 + + + +|[SMC] + + + +UsageProfile +|https://admin-shell.io/idta/PowerDriveTrainSizing/UsageProfile/1/0 + + + +Characteristic behavior patterns with which the system or facility is used over the course of a day, week, or year +|[] + + + +3 elements +|0..1 + + + +|=== + + + + +===== Submodel Elements of MotionPattern +===== 2.3.2.1 Submodel Elements of MotionPattern + +// Table generated from [Submodel, www.example.com/ids/sm/5311_7020_9042_2173],[SubmodelElementCollection, Section_2_Approaches],[SubmodelElementCollection, Section_2_3_Submodel_specifics],[SubmodelElementCollection, Section_2_3_2_Submodel_Elements_of_ApplicationRequirements],[SubmodelElementCollection, Section_2_3_2_1_Submodel_Elements_of_MotionPattern],[ReferenceElement, Table_Submodel_Elements_of_MotionPattern] + + + +[width="100%", id="Table_Submodel_Elements_of_MotionPattern", title="Submodel Elements of MotionPattern", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}MotionPattern + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementCollection + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/PowerDriveTrainSizing/MotionPattern/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}ApplicationRequirements + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee} + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Prop] + + + +MotionPatternName +|https://admin-shell.io/idta/PowerDriveTrainSizing/MotionPatternName/1/0 + + + +Designation that is assigned to a specific movement pattern or movement sequence +|[String] + + + + +|0..1 + + + +|[SMC] + + + +MotionPatternSections +|https://admin-shell.io/idta/PowerDriveTrainSizing/MotionPatternSections/1/0 + + + +Part of a motion profile, each of which represents a specific motion characteristic +|[] + + + +2 elements +|1 + + + +|=== + + + + +===== Submodel Elements of MotionPatternSections +===== 2.3.2.2 Submodel Elements of MotionPatternSections + +// Table generated from [Submodel, www.example.com/ids/sm/5311_7020_9042_2173],[SubmodelElementCollection, Section_2_Approaches],[SubmodelElementCollection, Section_2_3_Submodel_specifics],[SubmodelElementCollection, Section_2_3_2_Submodel_Elements_of_ApplicationRequirements],[SubmodelElementCollection, Section_2_3_2_2_Submodel_Elements_of_MotionPatternSections],[ReferenceElement, Table_Submodel_Elements_of_MotionPatternSections] + + + +[width="100%", id="Table_Submodel_Elements_of_MotionPatternSections", title="Submodel Elements of MotionPatternSections", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}MotionPatternSections + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementCollection + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/PowerDriveTrainSizing/MotionPatternSections/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}MotionPattern + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee} + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[SMC] + + + +RotativeSection +|https://admin-shell.io/idta/PowerDriveTrainSizing/RotativeMotionPatternSection/1/0 + + + +Part of a motion profile that concerns a rotating motion +|[] + + + +9 elements +|0..* + + + +|[SMC] + + + +LinearSection +|https://admin-shell.io/idta/PowerDriveTrainSizing/LinearMotionPatternSection/1/0 + + + +Part of a motion profile that concerns a linear motion +|[] + + + +8 elements +|0..* + + + +|=== + + + + +===== Submodel Elements of RotativeSection +===== 2.3.2.3 Submodel Elements of RotativeSection + +// Table generated from [Submodel, www.example.com/ids/sm/5311_7020_9042_2173],[SubmodelElementCollection, Section_2_Approaches],[SubmodelElementCollection, Section_2_3_Submodel_specifics],[SubmodelElementCollection, Section_2_3_2_Submodel_Elements_of_ApplicationRequirements],[SubmodelElementCollection, Section_2_3_2_3_Submodel_Elements_of_RotativeSection],[ReferenceElement, Table_Submodel_Elements_of_RotativeSection] + + + +[width="100%", id="Table_Submodel_Elements_of_RotativeSection", title="Submodel Elements of RotativeSection", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}RotativeSection + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementCollection + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/PowerDriveTrainSizing/RotativeMotionPatternSection/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}MotionPatternSections + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee} + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Prop] + + + +FrictionTorque +|https://admin-shell.io/idta/PowerDriveTrainSizing/FrictionTorque/1/0 + + + +the restraining torque that acts between two objects in contact with each other +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +LeverArmAxialForce +|https://admin-shell.io/idta/PowerDriveTrainSizing/LeverArmAxialForce/1/0 + + + +distance between the point of axial force application and the axis of rotation +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +AxialForce +|https://admin-shell.io/idta/PowerDriveTrainSizing/AxialForce/1/0 + + + +outer force on the rotating object parallel to the rotation axis +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +LeverArmRadialForce +|https://admin-shell.io/idta/PowerDriveTrainSizing/LeverArmRadialForce/1/0 + + + +Abstand zwischen Angriffspunkt der Radialkraft und Flansch, bezogen auf das Flanschkoordinatensystem +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +RadialForce +|https://admin-shell.io/idta/PowerDriveTrainSizing/RadialForce/1/0 + + + +outer force on the rotating object orthogonal to the rotation axis +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +MomentOfInertiaOfLoad +|https://admin-shell.io/idta/PowerDriveTrainSizing/MomentOfInertiaOfLoad/1/0 + + + +Attempt of the object to be moved to maintain its state of motion +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +LoadTorque +|https://admin-shell.io/idta/PowerDriveTrainSizing/LoadTorque/1/0 + + + +torque acting on the rotating mass from the outside. Positive values act in the direction of increasing angular positions in the angular position system +|[Long] + + + + +|0..1 + + + +|[SMC] + + + +MetadataRotativeMotionFile +|https://admin-shell.io/idta/PowerDriveTrainSizing/MetadataRotativeMotionFile/1/0 + + + +descriptive attributes that are included in a CSV file in addition to the actual time series data. This metadata forms the columns of the CSV and provides information about the content of the time series data, the units of the measured quantities and other relevant details +|[] + + + +9 elements +|1 + + + +|[File] + + + +MotionSectionFile +|https://admin-shell.io/idta/PowerDriveTrainSizing/MotionSectionFile/1/0 + + + +Sequence of data points in sequential order over a period of time within a paged data file +|[] + + + + +|0..1 + + + +|=== + + + + +===== Submodel Elements of MetadataRotativeMotionFile +===== 2.3.2.4 Submodel Elements of MetadataRotativeMotionFile + +// Table generated from [Submodel, www.example.com/ids/sm/5311_7020_9042_2173],[SubmodelElementCollection, Section_2_Approaches],[SubmodelElementCollection, Section_2_3_Submodel_specifics],[SubmodelElementCollection, Section_2_3_2_Submodel_Elements_of_ApplicationRequirements],[SubmodelElementCollection, Section_2_3_2_4_Submodel_Elements_of_MetadataRotativeMotionFile],[ReferenceElement, Table_Submodel_Elements_of_MetadataRotativeMotionFile] + + + +[width="100%", id="Table_Submodel_Elements_of_MetadataRotativeMotionFile", title="Submodel Elements of MetadataRotativeMotionFile", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}MetadataRotativeMotionFile + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementCollection + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/PowerDriveTrainSizing/MetadataRotativeMotionFile/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}RotativeSection + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee} + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Prop] + + + +Time +|https://admin-shell.io/idta/TimeSeries/RelativePointInTime/1/1 + + + +Definierter Zeitpunkt innerhalb eines Zeitbereichs, gemessen vom Startzeitpunkt des Zeitbereichs +|[Long] + + + + +|1 + + + +|[Prop] + + + +AngularPosition +|https://admin-shell.io/idta/PowerDriveTrainSizing/AngularPosition/1/0 + + + +Verdrehung gegenüber dem Ursprung des Winkellagesystems +|[Long] + + + + +|1 + + + +|[Prop] + + + +AngularVelocity +|https://admin-shell.io/idta/PowerDriveTrainSizing/AngularVelocity/1/0 + + + +temporal rate of change of the angular position in the angular position system. Positive values describe an angular change with increasing angular position +|[Long] + + + + +|1 + + + +|[Prop] + + + +AngularAcceleration +|https://admin-shell.io/idta/PowerDriveTrainSizing/AngularAcceleration/1/0 + + + +temporal rate of change in the angular velocity in the angular position system. Positive values describe a change in angular velocity with increasing angular position +|[Long] + + + + +|1 + + + +|[Prop] + + + +AngularJerk +|https://admin-shell.io/idta/PowerDriveTrainSizing/AngularJerk/1/0 + + + +instantaneous time rate of change of angular acceleration of a object +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +FrictionTorque +|https://admin-shell.io/idta/PowerDriveTrainSizing/FrictionTorque/1/0 + + + +the restraining torque that acts between two objects in contact with each other +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +AxialForce +|https://admin-shell.io/idta/PowerDriveTrainSizing/AxialForce/1/0 + + + +outer force on the rotating object parallel to the rotation axis +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +RadialForce +|https://admin-shell.io/idta/PowerDriveTrainSizing/RadialForce/1/0 + + + +outer force on the rotating object orthogonal to the rotation axis +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +LoadTorque +|https://admin-shell.io/idta/PowerDriveTrainSizing/LoadTorque/1/0 + + + +torque acting on the rotating mass from the outside. Positive values act in the direction of increasing angular positions in the angular position system +|[Long] + + + + +|0..1 + + + +|=== + + + + +===== Submodel Elements of LinearSection +===== 2.3.2.5 Submodel Elements of LinearSection + +// Table generated from [Submodel, www.example.com/ids/sm/5311_7020_9042_2173],[SubmodelElementCollection, Section_2_Approaches],[SubmodelElementCollection, Section_2_3_Submodel_specifics],[SubmodelElementCollection, Section_2_3_2_Submodel_Elements_of_ApplicationRequirements],[SubmodelElementCollection, Section_2_3_2_5_Submodel_Elements_of_LinearSection],[ReferenceElement, Table_Submodel_Elements_of_LinearSection] + + + +[width="100%", id="Table_Submodel_Elements_of_LinearSection", title="Submodel Elements of LinearSection", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}LinearSection + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementCollection + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/PowerDriveTrainSizing/LinearMotionPatternSection/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}MotionPatternSections + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee} + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Prop] + + + +FrictionCoefficient +|https://admin-shell.io/idta/PowerDriveTrainSizing/FrictionCoefficient/1/0 + + + +Ratio between the frictional force and the contact force between two objects +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +FrictionForce +|https://admin-shell.io/idta/PowerDriveTrainSizing/FrictionForce/1/0 + + + +The restraining force that acts between two objects in contact +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +CompensationForce +|https://admin-shell.io/idta/PowerDriveTrainSizing/CompensationForce/1/0 + + + +Force to compensate permanently acting forces +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +LoadMass +|https://admin-shell.io/idta/PowerDriveTrainSizing/LoadMass/1/0 + + + +mass of the object to be moved +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +LoadSideForce +|https://admin-shell.io/idta/PowerDriveTrainSizing/LoadSideForce/1/0 + + + +force acting on the moving mass from the outside +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +CounterMass +|https://admin-shell.io/idta/PowerDriveTrainSizing/CounterMass/1/0 + + + +mass whose weight force compensates permanently acting forces +|[Long] + + + + +|0..1 + + + +|[SMC] + + + +MetadataLinearMotionFile +|https://admin-shell.io/idta/PowerDriveTrainSizing/MetadataLinearMotionFile/1/0 + + + +descriptive attributes that are included in a CSV file in addition to the actual time series data. This metadata forms the columns of the CSV and provides information about the content of the time series data, the units of the measured quantities and other relevant details +|[] + + + +7 elements +|1 + + + +|[File] + + + +MotionSectionFile +|https://admin-shell.io/idta/PowerDriveTrainSizing/MotionSectionFile/1/0 + + + +Sequence of data points in sequential order over a period of time within a paged data file +|[] + + + + +|0..1 + + + +|=== + + + + +===== Submodel Elements of MetadataLinearMotionFile +===== 2.3.2.6 Submodel Elements of MetadataLinearMotionFile + +// Table generated from [Submodel, www.example.com/ids/sm/5311_7020_9042_2173],[SubmodelElementCollection, Section_2_Approaches],[SubmodelElementCollection, Section_2_3_Submodel_specifics],[SubmodelElementCollection, Section_2_3_2_Submodel_Elements_of_ApplicationRequirements],[SubmodelElementCollection, Section_2_3_2_6_Submodel_Elements_of_MetadataLinearMotionFile],[ReferenceElement, Table_Submodel_Elements_of_MetadataLinearMotionFile] + + + +[width="100%", id="Table_Submodel_Elements_of_MetadataLinearMotionFile", title="Submodel Elements of MetadataLinearMotionFile", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}MetadataLinearMotionFile + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementCollection + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/PowerDriveTrainSizing/MetadataLinearMotionFile/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}LinearSection + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee} + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Prop] + + + +Time +|https://admin-shell.io/idta/TimeSeries/RelativePointInTime/1/1 + + + +Definierter Zeitpunkt innerhalb eines Zeitbereichs, gemessen vom Startzeitpunkt des Zeitbereichs +|[Long] + + + + +|1 + + + +|[Prop] + + + +Position +|https://admin-shell.io/idta/PowerDriveTrainSizing/Position/1/0 + + + +defined value of the location related to the zero point of the coordinate system +|[Long] + + + + +|1 + + + +|[Prop] + + + +LinearVelocity +|https://admin-shell.io/idta/PowerDriveTrainSizing/LinearVelocity/1/0 + + + +temporal rate of change of position in the position coordinate system. Positive values describe a change in position with increasing position values +|[Long] + + + + +|1 + + + +|[Prop] + + + +LinearAcceleration +|https://admin-shell.io/idta/PowerDriveTrainSizing/LinearAcceleration/1/0 + + + +temporal rate of change of velocity in the position coordinate system. Positive values describe a change in velocity with increasing velocity values +|[Long] + + + + +|1 + + + +|[Prop] + + + +LinearJerk +|https://admin-shell.io/idta/PowerDriveTrainSizing/LinearJerk/1/0 + + + +largest temporal rate of change of the acceleration +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +FrictionForce +|https://admin-shell.io/idta/PowerDriveTrainSizing/FrictionForce/1/0 + + + +The restraining force that acts between two objects in contact +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +LoadSideForce +|https://admin-shell.io/idta/PowerDriveTrainSizing/LoadSideForce/1/0 + + + +force acting on the moving mass from the outside +|[Long] + + + + +|0..1 + + + +|=== + + + + +===== Submodel Elements of Environmental +===== 2.3.2.7 Submodel Elements of Environmental + +// Table generated from [Submodel, www.example.com/ids/sm/5311_7020_9042_2173],[SubmodelElementCollection, Section_2_Approaches],[SubmodelElementCollection, Section_2_3_Submodel_specifics],[SubmodelElementCollection, Section_2_3_2_Submodel_Elements_of_ApplicationRequirements],[SubmodelElementCollection, Section_2_3_2_7_Submodel_Elements_of_Environmental],[ReferenceElement, Table_Submodel_Elements_of_Environmental] + + + +[width="100%", id="Table_Submodel_Elements_of_Environmental", title="Submodel Elements of Environmental", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}Environmental + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementCollection + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/PowerDriveTrainSizing/EnvironmentalRequirements/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}ApplicationRequirements + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee} + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Prop] + + + +InstallationAltitude +|0173-1#02-AAZ614#003 + + + +Altitude above sea level on which a device or installation is installed +|[String] + + + + +|0..1 + + + +|[Prop] + + + +Atex2Gas +|0173-1#02-AAR865#004 + + + +Information whether device is tested and approved according to ATEX II / Gas +|[String] + + + + +|0..1 + + + +|[Prop] + + + +Atex2Dust +|0173-1#02-AAR866#004 + + + +Information whether device is tested and approved according to ATEX II / dust +|[String] + + + + +|0..1 + + + +|[Range] + + + +AmbientTemperatureController +|https://admin-shell.io/idta/PowerDriveTrainSizing/AmbientTemperatureController/1/0 + + + +Temperature in the outer area of the motor and gear during operation. +|[] + + + +min .. max +|0..1 + + + +|[Range] + + + +AmbientTemperatureMotor +|https://admin-shell.io/idta/PowerDriveTrainSizing/AmbientTemperatureMotor/1/0 + + + +Temperature in the outer area of the motor and gear during operation. +|[] + + + +min .. max +|0..1 + + + +|=== + + + + +===== Submodel Elements of OverallSystemRequirements +===== 2.3.2.8 Submodel Elements of OverallSystemRequirements + +// Table generated from [Submodel, www.example.com/ids/sm/5311_7020_9042_2173],[SubmodelElementCollection, Section_2_Approaches],[SubmodelElementCollection, Section_2_3_Submodel_specifics],[SubmodelElementCollection, Section_2_3_2_Submodel_Elements_of_ApplicationRequirements],[SubmodelElementCollection, Section_2_3_2_8_Submodel_Elements_of_OverallSystemRequirements],[ReferenceElement, Table_Submodel_Elements_of_OverallSystemRequirements] + + + +[width="100%", id="Table_Submodel_Elements_of_OverallSystemRequirements", title="Submodel Elements of OverallSystemRequirements", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}OverallSystemRequirements + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementCollection + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/PowerDriveTrainSizing/OverallSystemRequirements/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}ApplicationRequirements + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee} + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Prop] + + + +DcLinkCoupling +|https://admin-shell.io/idta/PowerDriveTrainSizing/DcLinkCoupling/1/0 + + + +Statement whether there is a connection between the DC links or not +|[String] + + + +false +|0..1 + + + +|[Prop] + + + +BrakePresent +|0173-1#02-BAE085#007 + + + + +|[String] + + + +true +|0..1 + + + +|[Prop] + + + +MainsConnection +|0173-1#02-ABF822#003 + + + + +|[String] + + + +230 VAC +|0..1 + + + +|[Prop] + + + +MountingType +|0173-1#02-AAH167#006 + + + +information on the type of fixation of an object +|[String] + + + +Flansch +|0..1 + + + +|[Prop] + + + +MinSwitchingFrequency +|0173-1#02-AAN329#003 + + + +lowest switching frequency for which the device is designed to operate +|[String] + + + + +|0..1 + + + +|[Prop] + + + +CoolingType +|0173-1#02-BAE122#007 + + + + +|[String] + + + +Air-air heat exchanger +|0..1 + + + +|[Prop] + + + +ProtectionType +|0173-1#02-BAG342#007 + + + +Summary of the various IP protection degrees to achieve a limited selected for search features +|[String] + + + +IP67 +|0..1 + + + +|[Prop] + + + +CertificateApproval +|0173-1#02-BAB392#018 + + + + +|[String] + + + + +|0..1 + + + +|[Prop] + + + +SafetyIntegrityLevel +|0173-1#02-ABH715#002 + + + + + +safety integrity level (SIL) according to IEC 61508 +|[String] + + + + +|0..1 + + + +|=== + + + + +===== Submodel Elements of UsageProfile +===== 2.3.2.9 Submodel Elements of UsageProfile + +// Table generated from [Submodel, www.example.com/ids/sm/5311_7020_9042_2173],[SubmodelElementCollection, Section_2_Approaches],[SubmodelElementCollection, Section_2_3_Submodel_specifics],[SubmodelElementCollection, Section_2_3_2_Submodel_Elements_of_ApplicationRequirements],[SubmodelElementCollection, Section_2_3_2_9_Submodel_Elements_of_UsageProfile],[ReferenceElement, Table_Submodel_Elements_of_UsageProfile] + + + +[width="100%", id="Table_Submodel_Elements_of_UsageProfile", title="Submodel Elements of UsageProfile", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}UsageProfile + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementCollection + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/PowerDriveTrainSizing/UsageProfile/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}ApplicationRequirements + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee} + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Prop] + + + +CyclesPerMinute +|https://admin-shell.io/idta/PowerDriveTrainSizing/CyclesPerMinute/1/0 + + + +Number of complete repetitions of the motion profile in one minute +|[Integer] + + + + +|1 + + + +|[Prop] + + + +OperatingHoursPerDay +|https://admin-shell.io/idta/PowerDriveTrainSizing/OperatingHoursPerDay/1/0 + + + +Hours during which the plant, in particular the drive system, is in operation during a single day +|[Long] + + + + +|1 + + + +|[Prop] + + + +OperatingDaysPerYear +|https://admin-shell.io/idta/PowerDriveTrainSizing/OperatingDaysPerYear/1/0 + + + +Days during which the plant, in particular the drive system, is in operation during a year +|[Long] + + + + +|1 + + + +|=== + + + + +==== Submodel Elements of TransformationMechanism + +// Table generated from [Submodel, www.example.com/ids/sm/5311_7020_9042_2173],[SubmodelElementCollection, Section_2_Approaches],[SubmodelElementCollection, Section_2_3_Submodel_specifics],[SubmodelElementCollection, Section_2_3_3_Submodel_Elements_of_TransformationMechanism],[ReferenceElement, Table_Submodel_Elements_of_TransformationMechanism] + + + +[width="100%", id="Table_Submodel_Elements_of_TransformationMechanism", title="Submodel Elements of TransformationMechanism", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}TransformationMechanism + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementCollection + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/PowerDriveTrainSizing/TransformationMechanism/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}PowerDriveTrainSizing + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}All application mechanisms are listed in the submodel template - note that only one application mechanism can be selected in the design project instance. + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Ent] + + + +Fan +|https://admin-shell.io/idta/PowerDriveTrainSizing/Fan/1/0 + + + + +|[] + + + + +|0..1 + + + +|[Ent] + + + +Pump +|https://admin-shell.io/idta/PowerDriveTrainSizing/Pump/1/0 + + + + +|[] + + + + +|0..1 + + + +|[Ent] + + + +RotraryTable +|https://admin-shell.io/idta/PowerDriveTrainSizing/RotraryTable/1/0 + + + + +|[] + + + + +|0..1 + + + +|[Ent] + + + +ChainConveyor +|https://admin-shell.io/idta/PowerDriveTrainSizing/ChainConveyor/1/0 + + + + +|[] + + + + +|0..1 + + + +|[Ent] + + + +BeltConveyor +|https://admin-shell.io/idta/PowerDriveTrainSizing/BeltConveyor/1/0 + + + + +|[] + + + + +|0..1 + + + +|[Ent] + + + +RollerConveyor +|https://admin-shell.io/idta/PowerDriveTrainSizing/RollerConveyor/1/0 + + + + +|[] + + + + +|0..1 + + + +|[Ent] + + + +BeltDrive +|https://admin-shell.io/idta/PowerDriveTrainSizing/BeltDrive/1/0 + + + + +|[] + + + + +|0..1 + + + +|[Ent] + + + +TravelingDrive +|https://admin-shell.io/idta/PowerDriveTrainSizing/TravelingDrive/1/0 + + + + +|[] + + + + +|0..1 + + + +|[Ent] + + + +RackDrive +|https://admin-shell.io/idta/PowerDriveTrainSizing/RackDrive/1/0 + + + + +|[] + + + + +|0..1 + + + +|[Ent] + + + +SpindleDrive +|https://admin-shell.io/idta/PowerDriveTrainSizing/SpindleDrive/1/0 + + + + +|[] + + + + +|0..1 + + + +|=== + + + + +===== Submodel Elements of Fan +===== 2.3.3.1 Submodel Elements of Fan + +// Table generated from [Submodel, www.example.com/ids/sm/5311_7020_9042_2173],[SubmodelElementCollection, Section_2_Approaches],[SubmodelElementCollection, Section_2_3_Submodel_specifics],[SubmodelElementCollection, Section_2_3_3_Submodel_Elements_of_TransformationMechanism],[SubmodelElementCollection, Section_2_3_3_1_Submodel_Elements_of_Fan],[ReferenceElement, Table_Submodel_Elements_of_Fan] + + + +[width="100%", id="Table_Submodel_Elements_of_Fan", title="Submodel Elements of Fan", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}Fan + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}Entity + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/PowerDriveTrainSizing/Fan/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}TransformationMechanism + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee} + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Prop] + + + +Efficiency +|https://admin-shell.io/idta/PowerDriveTrainSizing/Efficiency/1/0 + + + +Ratio between the actual useful power or work performed by the device and the energy or power supplied. It expresses how efficiently the device converts the energy into the desired work, taking into account losses and friction +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +InertiaMotorSide +|https://admin-shell.io/idta/PowerDriveTrainSizing/InertiaMotorSide/1/0 + + + +additional mass or inertia added on the side of a drive system or motor. This additional mass can be caused by various factors, such as the own rotor inertia (including pinion), heavier gears or mechanical loads added to the drive system +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +LeverArmAxialForce +|https://admin-shell.io/idta/PowerDriveTrainSizing/LeverArmAxialForce/1/0 + + + +distance between the point of axial force application and the axis of rotation +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +LeverArmRadialForce +|https://admin-shell.io/idta/PowerDriveTrainSizing/LeverArmRadialForce/1/0 + + + +Abstand zwischen Angriffspunkt der Radialkraft und Flansch, bezogen auf das Flanschkoordinatensystem +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +NoLoadTorque +|https://admin-shell.io/idta/PowerDriveTrainSizing/NoLoadTorque/1/0 + + + +The minimum torque required to set the application in motion without overcoming an external load +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +InclinationAngle +|https://admin-shell.io/idta/PowerDriveTrainSizing/InclinationAngle/1/0 + + + +Angle at which a linear application is inclined with respect to the horizontal +|[Long] + + + + +|0..1 + + + +|=== + + + + +===== Submodel Elements of Pump +===== 2.3.3.2 Submodel Elements of Pump + +// Table generated from [Submodel, www.example.com/ids/sm/5311_7020_9042_2173],[SubmodelElementCollection, Section_2_Approaches],[SubmodelElementCollection, Section_2_3_Submodel_specifics],[SubmodelElementCollection, Section_2_3_3_Submodel_Elements_of_TransformationMechanism],[SubmodelElementCollection, Section_2_3_3_2_Submodel_Elements_of_Pump],[ReferenceElement, Table_Submodel_Elements_of_Pump] + + + +[width="100%", id="Table_Submodel_Elements_of_Pump", title="Submodel Elements of Pump", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}Pump + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}Entity + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/PowerDriveTrainSizing/Pump/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}TransformationMechanism + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee} + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Prop] + + + +Efficiency +|https://admin-shell.io/idta/PowerDriveTrainSizing/Efficiency/1/0 + + + +Ratio between the actual useful power or work performed by the device and the energy or power supplied. It expresses how efficiently the device converts the energy into the desired work, taking into account losses and friction +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +InertiaMotorSide +|https://admin-shell.io/idta/PowerDriveTrainSizing/InertiaMotorSide/1/0 + + + +additional mass or inertia added on the side of a drive system or motor. This additional mass can be caused by various factors, such as the own rotor inertia (including pinion), heavier gears or mechanical loads added to the drive system +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +LeverArmAxialForce +|https://admin-shell.io/idta/PowerDriveTrainSizing/LeverArmAxialForce/1/0 + + + +distance between the point of axial force application and the axis of rotation +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +LeverArmRadialForce +|https://admin-shell.io/idta/PowerDriveTrainSizing/LeverArmRadialForce/1/0 + + + +Abstand zwischen Angriffspunkt der Radialkraft und Flansch, bezogen auf das Flanschkoordinatensystem +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +NoLoadTorque +|https://admin-shell.io/idta/PowerDriveTrainSizing/NoLoadTorque/1/0 + + + +The minimum torque required to set the application in motion without overcoming an external load +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +InclinationAngle +|https://admin-shell.io/idta/PowerDriveTrainSizing/InclinationAngle/1/0 + + + +Angle at which a linear application is inclined with respect to the horizontal +|[Long] + + + + +|0..1 + + + +|=== + + + + +===== Submodel Elements of RotraryTable +===== 2.3.3.3 Submodel Elements of RotraryTable + +// Table generated from [Submodel, www.example.com/ids/sm/5311_7020_9042_2173],[SubmodelElementCollection, Section_2_Approaches],[SubmodelElementCollection, Section_2_3_Submodel_specifics],[SubmodelElementCollection, Section_2_3_3_Submodel_Elements_of_TransformationMechanism],[SubmodelElementCollection, Section_2_3_3_3_Submodel_Elements_of_RotraryTable],[ReferenceElement, Table_Submodel_Elements_of_RotraryTable] + + + +[width="100%", id="Table_Submodel_Elements_of_RotraryTable", title="Submodel Elements of RotraryTable", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}RotraryTable + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}Entity + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/PowerDriveTrainSizing/RotraryTable/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}TransformationMechanism + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee} + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Prop] + + + +Efficiency +|https://admin-shell.io/idta/PowerDriveTrainSizing/Efficiency/1/0 + + + +Ratio between the actual useful power or work performed by the device and the energy or power supplied. It expresses how efficiently the device converts the energy into the desired work, taking into account losses and friction +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +InertiaMotorSide +|https://admin-shell.io/idta/PowerDriveTrainSizing/InertiaMotorSide/1/0 + + + +additional mass or inertia added on the side of a drive system or motor. This additional mass can be caused by various factors, such as the own rotor inertia (including pinion), heavier gears or mechanical loads added to the drive system +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +LeverArmAxialForce +|https://admin-shell.io/idta/PowerDriveTrainSizing/LeverArmAxialForce/1/0 + + + +distance between the point of axial force application and the axis of rotation +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +LeverArmRadialForce +|https://admin-shell.io/idta/PowerDriveTrainSizing/LeverArmRadialForce/1/0 + + + +Abstand zwischen Angriffspunkt der Radialkraft und Flansch, bezogen auf das Flanschkoordinatensystem +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +NoLoadTorque +|https://admin-shell.io/idta/PowerDriveTrainSizing/NoLoadTorque/1/0 + + + +The minimum torque required to set the application in motion without overcoming an external load +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +InclinationAngle +|https://admin-shell.io/idta/PowerDriveTrainSizing/InclinationAngle/1/0 + + + +Angle at which a linear application is inclined with respect to the horizontal +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +StaticEccentricity +|https://admin-shell.io/idta/PowerDriveTrainSizing/StaticEccentricity/1/0 + + + +Distance between the table's center of rotation and the point bearing the payload. Static, not variable via the motion profile. +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +CentroidAngle +|https://admin-shell.io/idta/PowerDriveTrainSizing/CentroidAngle/1/0 + + + +The center angle refers to the angle describing the center of a circle. In the context of a rotary table, the center angle refers to the angle by which a rotary table has been rotated relative to a reference position. It is used to determine the exact position of the table. (Positive angle to start movement) +|[Long] + + + + +|0..1 + + + +|=== + + + + +===== Elements of ChainConveyor +===== 2.3.3.4 Submodel Elements of ChainConveyor + +// Table generated from [Submodel, www.example.com/ids/sm/5311_7020_9042_2173],[SubmodelElementCollection, Section_2_Approaches],[SubmodelElementCollection, Section_2_3_Submodel_specifics],[SubmodelElementCollection, Section_2_3_3_Submodel_Elements_of_TransformationMechanism],[SubmodelElementCollection, Section_2_3_3_4_Submodel_Elements_of_ChainConveyor],[ReferenceElement, Table_Submodel_Elements_of_ChainConveyor] + + + +[width="100%", id="Table_Submodel_Elements_of_ChainConveyor", title="Submodel Elements of ChainConveyor", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}ChainConveyor + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}Entity + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/PowerDriveTrainSizing/ChainConveyor/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}TransformationMechanism + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee} + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Prop] + + + +Efficiency +|https://admin-shell.io/idta/PowerDriveTrainSizing/Efficiency/1/0 + + + +Ratio between the actual useful power or work performed by the device and the energy or power supplied. It expresses how efficiently the device converts the energy into the desired work, taking into account losses and friction +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +InertiaMotorSide +|https://admin-shell.io/idta/PowerDriveTrainSizing/InertiaMotorSide/1/0 + + + +additional mass or inertia added on the side of a drive system or motor. This additional mass can be caused by various factors, such as the own rotor inertia (including pinion), heavier gears or mechanical loads added to the drive system +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +LeverArmAxialForce +|https://admin-shell.io/idta/PowerDriveTrainSizing/LeverArmAxialForce/1/0 + + + +distance between the point of axial force application and the axis of rotation +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +LeverArmRadialForce +|https://admin-shell.io/idta/PowerDriveTrainSizing/LeverArmRadialForce/1/0 + + + +Abstand zwischen Angriffspunkt der Radialkraft und Flansch, bezogen auf das Flanschkoordinatensystem +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +NoLoadTorque +|https://admin-shell.io/idta/PowerDriveTrainSizing/NoLoadTorque/1/0 + + + +The minimum torque required to set the application in motion without overcoming an external load +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +InclinationAngle +|https://admin-shell.io/idta/PowerDriveTrainSizing/InclinationAngle/1/0 + + + +Angle at which a linear application is inclined with respect to the horizontal +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +FrictionCoefficient +|https://admin-shell.io/idta/PowerDriveTrainSizing/FrictionCoefficient/1/0 + + + +Ratio between the frictional force and the contact force between two objects +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +FeedConstant +|https://admin-shell.io/idta/PowerDriveTrainSizing/FeedConstant/1/0 + + + +Parameter in technical systems that describes the relationship between a single rotary motion and the resulting linear motion or feed motion +|[Long] + + + + +|0..1 + + + +|=== + + + + +===== Submodel Elements of BeltConveyor +===== 2.3.3.5 Submodel Elements of BeltConveyor + +// Table generated from [Submodel, www.example.com/ids/sm/5311_7020_9042_2173],[SubmodelElementCollection, Section_2_Approaches],[SubmodelElementCollection, Section_2_3_Submodel_specifics],[SubmodelElementCollection, Section_2_3_3_Submodel_Elements_of_TransformationMechanism],[SubmodelElementCollection, Section_2_3_3_5_Submodel_Elements_of_BeltConveyor],[ReferenceElement, Table_Submodel_Elements_of_BeltConveyor] + + + +[width="100%", id="Table_Submodel_Elements_of_BeltConveyor", title="Submodel Elements of BeltConveyor", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}BeltConveyor + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}Entity + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/PowerDriveTrainSizing/BeltConveyor/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}TransformationMechanism + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee} + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Prop] + + + +Efficiency +|https://admin-shell.io/idta/PowerDriveTrainSizing/Efficiency/1/0 + + + +Ratio between the actual useful power or work performed by the device and the energy or power supplied. It expresses how efficiently the device converts the energy into the desired work, taking into account losses and friction +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +InertiaMotorSide +|https://admin-shell.io/idta/PowerDriveTrainSizing/InertiaMotorSide/1/0 + + + +additional mass or inertia added on the side of a drive system or motor. This additional mass can be caused by various factors, such as the own rotor inertia (including pinion), heavier gears or mechanical loads added to the drive system +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +LeverArmAxialForce +|https://admin-shell.io/idta/PowerDriveTrainSizing/LeverArmAxialForce/1/0 + + + +distance between the point of axial force application and the axis of rotation +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +LeverArmRadialForce +|https://admin-shell.io/idta/PowerDriveTrainSizing/LeverArmRadialForce/1/0 + + + +Abstand zwischen Angriffspunkt der Radialkraft und Flansch, bezogen auf das Flanschkoordinatensystem +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +NoLoadTorque +|https://admin-shell.io/idta/PowerDriveTrainSizing/NoLoadTorque/1/0 + + + +The minimum torque required to set the application in motion without overcoming an external load +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +InclinationAngle +|https://admin-shell.io/idta/PowerDriveTrainSizing/InclinationAngle/1/0 + + + +Angle at which a linear application is inclined with respect to the horizontal +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +FrictionCoefficient +|https://admin-shell.io/idta/PowerDriveTrainSizing/FrictionCoefficient/1/0 + + + +Ratio between the frictional force and the contact force between two objects +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +FeedConstant +|https://admin-shell.io/idta/PowerDriveTrainSizing/FeedConstant/1/0 + + + +Parameter in technical systems that describes the relationship between a single rotary motion and the resulting linear motion or feed motion +|[Long] + + + + +|0..1 + + + +|=== + + + + +===== Submodel Elements of RollerConveyor +===== 2.3.3.6 Submodel Elements of RollerConveyor + +// Table generated from [Submodel, www.example.com/ids/sm/5311_7020_9042_2173],[SubmodelElementCollection, Section_2_Approaches],[SubmodelElementCollection, Section_2_3_Submodel_specifics],[SubmodelElementCollection, Section_2_3_3_Submodel_Elements_of_TransformationMechanism],[SubmodelElementCollection, Section_2_3_3_6_Submodel_Elements_of_RollerConveyor],[ReferenceElement, Table_Submodel_Elements_of_RollerConveyor] + + + +[width="100%", id="Table_Submodel_Elements_of_RollerConveyor", title="Submodel Elements of RollerConveyor", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}RollerConveyor + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}Entity + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/PowerDriveTrainSizing/RollerConveyor/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}TransformationMechanism + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee} + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Prop] + + + +Efficiency +|https://admin-shell.io/idta/PowerDriveTrainSizing/Efficiency/1/0 + + + +Ratio between the actual useful power or work performed by the device and the energy or power supplied. It expresses how efficiently the device converts the energy into the desired work, taking into account losses and friction +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +InertiaMotorSide +|https://admin-shell.io/idta/PowerDriveTrainSizing/InertiaMotorSide/1/0 + + + +additional mass or inertia added on the side of a drive system or motor. This additional mass can be caused by various factors, such as the own rotor inertia (including pinion), heavier gears or mechanical loads added to the drive system +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +LeverArmAxialForce +|https://admin-shell.io/idta/PowerDriveTrainSizing/LeverArmAxialForce/1/0 + + + +distance between the point of axial force application and the axis of rotation +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +LeverArmRadialForce +|https://admin-shell.io/idta/PowerDriveTrainSizing/LeverArmRadialForce/1/0 + + + +Abstand zwischen Angriffspunkt der Radialkraft und Flansch, bezogen auf das Flanschkoordinatensystem +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +NoLoadTorque +|https://admin-shell.io/idta/PowerDriveTrainSizing/NoLoadTorque/1/0 + + + +The minimum torque required to set the application in motion without overcoming an external load +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +InclinationAngle +|https://admin-shell.io/idta/PowerDriveTrainSizing/InclinationAngle/1/0 + + + +Angle at which a linear application is inclined with respect to the horizontal +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +FrictionCoefficient +|https://admin-shell.io/idta/PowerDriveTrainSizing/FrictionCoefficient/1/0 + + + +Ratio between the frictional force and the contact force between two objects +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +FeedConstant +|https://admin-shell.io/idta/PowerDriveTrainSizing/FeedConstant/1/0 + + + +Parameter in technical systems that describes the relationship between a single rotary motion and the resulting linear motion or feed motion +|[Long] + + + + +|0..1 + + + +|=== + + + + +===== Submodel Elements of BeltDrive +===== 2.3.3.7 Submodel Elements of BeltDrive + +// Table generated from [Submodel, www.example.com/ids/sm/5311_7020_9042_2173],[SubmodelElementCollection, Section_2_Approaches],[SubmodelElementCollection, Section_2_3_Submodel_specifics],[SubmodelElementCollection, Section_2_3_3_Submodel_Elements_of_TransformationMechanism],[SubmodelElementCollection, Section_2_3_3_7_Submodel_Elements_of_BeltDrive],[ReferenceElement, Table_Submodel_Elements_of_BeltDrive] + + + +[width="100%", id="Table_Submodel_Elements_of_BeltDrive", title="Submodel Elements of BeltDrive", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}BeltDrive + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}Entity + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/PowerDriveTrainSizing/BeltDrive/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}TransformationMechanism + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee} + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Prop] + + + +Efficiency +|https://admin-shell.io/idta/PowerDriveTrainSizing/Efficiency/1/0 + + + +Ratio between the actual useful power or work performed by the device and the energy or power supplied. It expresses how efficiently the device converts the energy into the desired work, taking into account losses and friction +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +InertiaMotorSide +|https://admin-shell.io/idta/PowerDriveTrainSizing/InertiaMotorSide/1/0 + + + +additional mass or inertia added on the side of a drive system or motor. This additional mass can be caused by various factors, such as the own rotor inertia (including pinion), heavier gears or mechanical loads added to the drive system +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +LeverArmAxialForce +|https://admin-shell.io/idta/PowerDriveTrainSizing/LeverArmAxialForce/1/0 + + + +distance between the point of axial force application and the axis of rotation +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +LeverArmRadialForce +|https://admin-shell.io/idta/PowerDriveTrainSizing/LeverArmRadialForce/1/0 + + + +Abstand zwischen Angriffspunkt der Radialkraft und Flansch, bezogen auf das Flanschkoordinatensystem +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +NoLoadTorque +|https://admin-shell.io/idta/PowerDriveTrainSizing/NoLoadTorque/1/0 + + + +The minimum torque required to set the application in motion without overcoming an external load +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +InclinationAngle +|https://admin-shell.io/idta/PowerDriveTrainSizing/InclinationAngle/1/0 + + + +Angle at which a linear application is inclined with respect to the horizontal +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +FrictionCoefficient +|https://admin-shell.io/idta/PowerDriveTrainSizing/FrictionCoefficient/1/0 + + + +Ratio between the frictional force and the contact force between two objects +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +FeedConstant +|https://admin-shell.io/idta/PowerDriveTrainSizing/FeedConstant/1/0 + + + +Parameter in technical systems that describes the relationship between a single rotary motion and the resulting linear motion or feed motion +|[Long] + + + + +|0..1 + + + +|=== + + + + +===== Submodel Elements of TravelingDrive +===== 2.3.3.8 Submodel Elements of TravelingDrive + +// Table generated from [Submodel, www.example.com/ids/sm/5311_7020_9042_2173],[SubmodelElementCollection, Section_2_Approaches],[SubmodelElementCollection, Section_2_3_Submodel_specifics],[SubmodelElementCollection, Section_2_3_3_Submodel_Elements_of_TransformationMechanism],[SubmodelElementCollection, Section_2_3_3_8_Submodel_Elements_of_TravelingDrive],[ReferenceElement, Table_Submodel_Elements_of_TravelingDrive] + + + +[width="100%", id="Table_Submodel_Elements_of_TravelingDrive", title="Submodel Elements of TravelingDrive", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}TravelingDrive + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}Entity + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/PowerDriveTrainSizing/TravelingDrive/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}TransformationMechanism + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee} + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Prop] + + + +Efficiency +|https://admin-shell.io/idta/PowerDriveTrainSizing/Efficiency/1/0 + + + +Ratio between the actual useful power or work performed by the device and the energy or power supplied. It expresses how efficiently the device converts the energy into the desired work, taking into account losses and friction +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +InertiaMotorSide +|https://admin-shell.io/idta/PowerDriveTrainSizing/InertiaMotorSide/1/0 + + + +additional mass or inertia added on the side of a drive system or motor. This additional mass can be caused by various factors, such as the own rotor inertia (including pinion), heavier gears or mechanical loads added to the drive system +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +LeverArmAxialForce +|https://admin-shell.io/idta/PowerDriveTrainSizing/LeverArmAxialForce/1/0 + + + +distance between the point of axial force application and the axis of rotation +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +LeverArmRadialForce +|https://admin-shell.io/idta/PowerDriveTrainSizing/LeverArmRadialForce/1/0 + + + +Abstand zwischen Angriffspunkt der Radialkraft und Flansch, bezogen auf das Flanschkoordinatensystem +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +NoLoadTorque +|https://admin-shell.io/idta/PowerDriveTrainSizing/NoLoadTorque/1/0 + + + +The minimum torque required to set the application in motion without overcoming an external load +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +InclinationAngle +|https://admin-shell.io/idta/PowerDriveTrainSizing/InclinationAngle/1/0 + + + +Angle at which a linear application is inclined with respect to the horizontal +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +FrictionCoefficient +|https://admin-shell.io/idta/PowerDriveTrainSizing/FrictionCoefficient/1/0 + + + +Ratio between the frictional force and the contact force between two objects +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +FeedConstant +|https://admin-shell.io/idta/PowerDriveTrainSizing/FeedConstant/1/0 + + + +Parameter in technical systems that describes the relationship between a single rotary motion and the resulting linear motion or feed motion +|[Long] + + + + +|0..1 + + + +|=== + + + + +===== Submodel Elements of RackDrive +===== 2.3.3.9 Submodel Elements of RackDrive + +// Table generated from [Submodel, www.example.com/ids/sm/5311_7020_9042_2173],[SubmodelElementCollection, Section_2_Approaches],[SubmodelElementCollection, Section_2_3_Submodel_specifics],[SubmodelElementCollection, Section_2_3_3_Submodel_Elements_of_TransformationMechanism],[SubmodelElementCollection, Section_2_3_3_9_Submodel_Elements_of_RackDrive],[ReferenceElement, Table_Submodel_Elements_of_RackDrive] + + + +[width="100%", id="Table_Submodel_Elements_of_RackDrive", title="Submodel Elements of RackDrive", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}RackDrive + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}Entity + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/PowerDriveTrainSizing/RackDrive/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}TransformationMechanism + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee} + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Prop] + + + +Efficiency +|https://admin-shell.io/idta/PowerDriveTrainSizing/Efficiency/1/0 + + + +Ratio between the actual useful power or work performed by the device and the energy or power supplied. It expresses how efficiently the device converts the energy into the desired work, taking into account losses and friction +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +InertiaMotorSide +|https://admin-shell.io/idta/PowerDriveTrainSizing/InertiaMotorSide/1/0 + + + +additional mass or inertia added on the side of a drive system or motor. This additional mass can be caused by various factors, such as the own rotor inertia (including pinion), heavier gears or mechanical loads added to the drive system +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +LeverArmAxialForce +|https://admin-shell.io/idta/PowerDriveTrainSizing/LeverArmAxialForce/1/0 + + + +distance between the point of axial force application and the axis of rotation +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +LeverArmRadialForce +|https://admin-shell.io/idta/PowerDriveTrainSizing/LeverArmRadialForce/1/0 + + + +Abstand zwischen Angriffspunkt der Radialkraft und Flansch, bezogen auf das Flanschkoordinatensystem +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +NoLoadTorque +|https://admin-shell.io/idta/PowerDriveTrainSizing/NoLoadTorque/1/0 + + + +The minimum torque required to set the application in motion without overcoming an external load +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +InclinationAngle +|https://admin-shell.io/idta/PowerDriveTrainSizing/InclinationAngle/1/0 + + + +Angle at which a linear application is inclined with respect to the horizontal +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +FrictionCoefficient +|https://admin-shell.io/idta/PowerDriveTrainSizing/FrictionCoefficient/1/0 + + + +Ratio between the frictional force and the contact force between two objects +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +FeedConstant +|https://admin-shell.io/idta/PowerDriveTrainSizing/FeedConstant/1/0 + + + +Parameter in technical systems that describes the relationship between a single rotary motion and the resulting linear motion or feed motion +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +DiameterPinion +|https://admin-shell.io/idta/PowerDriveTrainSizing/DiameterPinion/1/0 + + + +Distance from one edge to the opposite edge of the tooth wheel, measured through the center +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +HelixAngle +|https://admin-shell.io/idta/PowerDriveTrainSizing/HelixAngle/1/0 + + + +The helix angle determines the direction of the teeth. The helix angle is measured between the axis and the tooth. If the helix angle = 0°, the teeth are straight. If the helix angle > 0°, the teeth are helical +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +MovingPart +|https://admin-shell.io/idta/PowerDriveTrainSizing/RackMovingPart/1/0 + + + +The part that acts in a linear motion along the teeth +|[Long] + + + + +|0..1 + + + +|=== + + + + +===== Submodel Elements of SpindleDrive +===== 2.3.3.10 Submodel Elements of SpindleDrive + +// Table generated from [Submodel, www.example.com/ids/sm/5311_7020_9042_2173],[SubmodelElementCollection, Section_2_Approaches],[SubmodelElementCollection, Section_2_3_Submodel_specifics],[SubmodelElementCollection, Section_2_3_3_Submodel_Elements_of_TransformationMechanism],[SubmodelElementCollection, Section_2_3_3_10_Submodel_Elements_of_SpindleDrive],[ReferenceElement, Table_Submodel_Elements_of_SpindleDrive] + + + +[width="100%", id="Table_Submodel_Elements_of_SpindleDrive", title="Submodel Elements of SpindleDrive", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}SpindleDrive + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}Entity + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/PowerDriveTrainSizing/SpindleDrive/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}TransformationMechanism + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee} + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Prop] + + + +Efficiency +|https://admin-shell.io/idta/PowerDriveTrainSizing/Efficiency/1/0 + + + +Ratio between the actual useful power or work performed by the device and the energy or power supplied. It expresses how efficiently the device converts the energy into the desired work, taking into account losses and friction +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +InertiaMotorSide +|https://admin-shell.io/idta/PowerDriveTrainSizing/InertiaMotorSide/1/0 + + + +additional mass or inertia added on the side of a drive system or motor. This additional mass can be caused by various factors, such as the own rotor inertia (including pinion), heavier gears or mechanical loads added to the drive system +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +LeverArmAxialForce +|https://admin-shell.io/idta/PowerDriveTrainSizing/LeverArmAxialForce/1/0 + + + +distance between the point of axial force application and the axis of rotation +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +LeverArmRadialForce +|https://admin-shell.io/idta/PowerDriveTrainSizing/LeverArmRadialForce/1/0 + + + +Abstand zwischen Angriffspunkt der Radialkraft und Flansch, bezogen auf das Flanschkoordinatensystem +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +NoLoadTorque +|https://admin-shell.io/idta/PowerDriveTrainSizing/NoLoadTorque/1/0 + + + +The minimum torque required to set the application in motion without overcoming an external load +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +InclinationAngle +|https://admin-shell.io/idta/PowerDriveTrainSizing/InclinationAngle/1/0 + + + +Angle at which a linear application is inclined with respect to the horizontal +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +FrictionCoefficient +|https://admin-shell.io/idta/PowerDriveTrainSizing/FrictionCoefficient/1/0 + + + +Ratio between the frictional force and the contact force between two objects +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +FeedConstant +|https://admin-shell.io/idta/PowerDriveTrainSizing/FeedConstant/1/0 + + + +Parameter in technical systems that describes the relationship between a single rotary motion and the resulting linear motion or feed motion +|[Long] + + + + +|0..1 + + + +|=== + + + + +==== Submodel Elements of SizingResult + +// Table generated from [Submodel, www.example.com/ids/sm/5311_7020_9042_2173],[SubmodelElementCollection, Section_2_Approaches],[SubmodelElementCollection, Section_2_3_Submodel_specifics],[SubmodelElementCollection, Section_2_3_4_Submodel_Elements_of_SizingResult],[ReferenceElement, Table_Submodel_Elements_of_SizingResult] + + + +[width="100%", id="Table_Submodel_Elements_of_SizingResult", title="Submodel Elements of SizingResult", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}SizingResult + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementCollection + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/PowerDriveTrainSizing/SizingResult/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}PowerDriveTrainSizing + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee} + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Ent] + + + +OverallSystem +|https://admin-shell.io/idta/PowerDriveTrainSizing/OverallSystem/1/0 + + + +Drive unit created in the design that consists of all components or parts that work together in the drive design to perform the drive task +|[] + + + + +|0..1 + + + +|[Ent] + + + +MainComponent +|https://admin-shell.io/idta/PowerDriveTrainSizing/MainComponent/1/0 + + + +Device determined in the design that is used to control the actuator. The drive controller monitors and regulates the flow of energy to a drive system to control speed, torque, position, or other performance parameters according to requirements +|[] + + + + +|0..* + + + +|[Ent] + + + +OtherComponent +|https://admin-shell.io/idta/PowerDriveTrainSizing/OtherComponent/1/0 + + + +Additional parts or elements identified in the design that are present in a system, device or installation in addition to the main components +|[] + + + + +|0..* + + + +|[SMC] + + + +Messages +|https://admin-shell.io/idta/PowerDriveTrainSizing/Messages/1/0 + + + +Messages and notes on the sizing and its results +|[] + + + +1 elements +|1 + + + +|[MLP] + + + +TextStatement +|https://admin-shell.io/idta/PowerDriveTrainSizing/TextStatement/1/0 + + + +Declaration of the design service provider in text form, e.g. scope of validity of the statements, areas of application, conditions of use of the sizing result +|[] + + + +Declaration of the design service provider in text form, e.g. scope of validity of the statements, areas of application, conditions of use of the sizing result@en +|0..1 + + + +|=== + + + + +===== Submodel Elements of OverallSystem +===== 2.3.4.1 Submodel Elements of OverallSystem + +// Table generated from [Submodel, www.example.com/ids/sm/5311_7020_9042_2173],[SubmodelElementCollection, Section_2_Approaches],[SubmodelElementCollection, Section_2_3_Submodel_specifics],[SubmodelElementCollection, Section_2_3_4_Submodel_Elements_of_SizingResult],[SubmodelElementCollection, Section_2_3_4_1_Submodel_Elements_of_OverallSystem],[ReferenceElement, Table_Submodel_Elements_of_OverallSystem] + + + +[width="100%", id="Table_Submodel_Elements_of_OverallSystem", title="Submodel Elements of OverallSystem", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}OverallSystem + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}Entity + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/PowerDriveTrainSizing/OverallSystem/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}SizingResult + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee} + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Prop] + + + +ManufacturerName +|0173-1#02-AAO677#002 + + + + +|[String] + + + + +|0..1 + + + +|[Prop] + + + +ManufacturerArticleNumber +|0173-1#02-AAO676#003 + + + + +|[String] + + + +- +|0..1 + + + +|[MLP] + + + +ManufacturerProductDesignation +|0173-1#02-AAW338#001 + + + + +|[] + + + +ManufacturerProductDesignation@en +|0..1 + + + +|[Prop] + + + +ManufacturerOrderCode +| 0173-1#02-AAO227#002 + + + + +|[String] + + + + +|0..1 + + + +|[Prop] + + + +ExternalMomentOfInertia +|https://admin-shell.io/idta/PowerDriveTrainSizing/ExternalMomentOfInertia/1/0 + + + +Moment of inertia of the parts outside the drive. It describes the resistance of these parts to changes in their rotational speed and influences the energy required to accelerate or decelerate the system +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +InternalMomentOfIntertia +|https://admin-shell.io/idta/PowerDriveTrainSizing/InternalMomentOfInertia/1/0 + + + +Moment of inertia of the moving parts within the drive, such as a motor or gearbox. It describes the resistance of these parts to changes in their rotational speed and affects the energy required to accelerate or decelerate the system +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +MassInertiaRatio +|https://admin-shell.io/idta/PowerDriveTrainSizing/MassInertiaRatio/1/0 + + + +The mass inertia ratio λ is the ratio of external mass inertia (application side) to internal mass inertia (motor and gearbox side). It is an important parameter for the controllability of an application. The more different the mass moments of inertia are and the larger λ becomes, the less precisely dynamic processes can be controlled. +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +DecelerationForEmergencyStop +|https://admin-shell.io/idta/PowerDriveTrainSizing/DecelerationForEmergencyStop/1/0 + + + +Rate (in revolutions per minute per second) at which the speed of a rotating system is reduced when an emergency stop is activated. This parameter is important to describe the rate at which the system is brought to a stop after an emergency stop is triggered to ensure the safety of people and equipment +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +CurrentForEmergencyStop +|https://admin-shell.io/idta/PowerDriveTrainSizing/CurrentForEmergencyStop/1/0 + + + +electrical current required for the operation of an emergency stop system +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +DisplacementDuringEmergencyStop +|https://admin-shell.io/idta/PowerDriveTrainSizing/DisplacementDuringEmergencyStop/1/0 + + + +Displacement of mechanical components or parts in a machine or plant caused by the triggering of an emergency stop signal +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +EnergyConsumtionPerCycle +|https://admin-shell.io/idta/PowerDriveTrainSizing/EnergyConsumtionPerCycle/1/0 + + + +Energy consumed during a single operating cycle of a system, machine or device. +|[Long] + + + + +|0..1 + + + +|=== + + + + +===== Submodel Elements of MainComponent +===== 2.3.4.2 Submodel Elements of MainComponent + +// Table generated from [Submodel, www.example.com/ids/sm/5311_7020_9042_2173],[SubmodelElementCollection, Section_2_Approaches],[SubmodelElementCollection, Section_2_3_Submodel_specifics],[SubmodelElementCollection, Section_2_3_4_Submodel_Elements_of_SizingResult],[SubmodelElementCollection, Section_2_3_4_2_Submodel_Elements_of_MainComponent],[ReferenceElement, Table_Submodel_Elements_of_MainComponent] + + + +[width="100%", id="Table_Submodel_Elements_of_MainComponent", title="Submodel Elements of MainComponent", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}MainComponent + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}Entity + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/PowerDriveTrainSizing/MainComponent/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}SizingResult + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee} + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Prop] + + + +MainComponentType +|https://admin-shell.io/idta/PowerDriveTrainSizing/MainComponentType/1/0 + + + +The kind of main component in the drive train, such as a motor, gearbox or drive controller +|[String] + + + + +|1..* + + + +|[Prop] + + + +ManufacturerName +|0173-1#02-AAO677#002 + + + + +|[String] + + + + +|1 + + + +|[Prop] + + + +ManufacturerArticleNumber +|0173-1#02-AAO676#003 + + + + +|[String] + + + +5001xxxx-xx-x +|1 + + + +|[MLP] + + + +ManufacturerProductDesignation +|0173-1#02-AAW338#001 + + + + +|[] + + + + +|0..1 + + + +|[Prop] + + + +ManufacturerOrderCode +| 0173-1#02-AAO227#002 + + + + +|[String] + + + + +|1 + + + +|[Prop] + + + +MaxCurrentUtilizationPercentage +|https://admin-shell.io/idta/PowerDriveTrainSizing/MaxCurrentUtilizationPercentage/1/0 + + + +The maximum calculated effective peak current within the motion profile based on the technical specification of the component +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +MaxCurrentUtilization +|https://admin-shell.io/idta/PowerDriveTrainSizing/MaxCurrentUtilization/1/0 + + + +The maximum calculated effective peak current within the motion profile +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +MaxThermalUtilizationPercentage +|https://admin-shell.io/idta/PowerDriveTrainSizing/MaxThermalUtilizationPercentage/1/0 + + + +The calculated maximum thermal utilization of the component based on its specification +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +MaxThermalUtilization +|https://admin-shell.io/idta/PowerDriveTrainSizing/MaxThermalUtilization/1/0 + + + +The calculated maximum thermal utilization of the component +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +AveragePowerLosses +|https://admin-shell.io/idta/PowerDriveTrainSizing/AveragePowerLosses/1/0 + + + +The average electrical power loss in watts for the component within the motion profile +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +AverageRegenerativePowerDcLink +|https://admin-shell.io/idta/PowerDriveTrainSizing/AverageRegenerativePowerDcLink/1/0 + + + +The power averaged over the motion profile that flows back to the system DC link +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +MaxRegenerativePowerDcLink +|https://admin-shell.io/idta/PowerDriveTrainSizing/MaxRegenerativePowerDcLink/1/0 + + + +The power maximum over the motion profile that flows back to the system DC link +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +AverageFeedInPowerDcLink +|https://admin-shell.io/idta/PowerDriveTrainSizing/AverageFeedInPowerDcLink/1/0 + + + + +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +AverageFeedInPowerMains +|https://admin-shell.io/idta/PowerDriveTrainSizing/AverageFeedInPowerMains/1/0 + + + +The average power fed into the power grid over the motion profile +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +MaxFeedInPowerMains +|https://admin-shell.io/idta/PowerDriveTrainSizing/MaxFeedInPowerMains/1/0 + + + +The maximum power fed into the power grid within the motion profile +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +ContinuousCurrent +|https://admin-shell.io/idta/PowerDriveTrainSizing/ContinuousCurrent/1/0 + + + +Maximum permissible continuous current that the drive controller can supply to the connected electric motor without causing overload or damage +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +RmsOfPower +|https://admin-shell.io/idta/PowerDriveTrainSizing/RmsOfPower/1/0 + + + +Average of the power over the motion profile, taking into account the fluctuations +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +MaxTorqueUtilizationPercentage +|https://admin-shell.io/idta/PowerDriveTrainSizing/MaxTorqueUtilizationPercentage/1/0 + + + +The maximum torque utilization of the component calculated during the motion profile based on its permissible specification +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +MaxTorqueUtilization +|https://admin-shell.io/idta/PowerDriveTrainSizing/MaxTorqueUtilization/1/0 + + + +The maximum torque utilization of the component calculated during the motion profile +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +MaxRotationSpeedUtilizationPercentage +|https://admin-shell.io/idta/PowerDriveTrainSizing/MaxRotationSpeedUtilizationPercentage/1/0 + + + +The maximum speed utilization of the component calculated during the motion profile based on its permissible specification +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +MaxRotationSpeedUtilization +|https://admin-shell.io/idta/PowerDriveTrainSizing/MaxRotationSpeedUtilization/1/0 + + + +The maximum speed utilization of the component calculated during the motion profile +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +EffectiveUtilization +|https://admin-shell.io/idta/PowerDriveTrainSizing/EffectiveUtilization/1/0 + + + +Degree to which the motor is actually used to perform mechanical work compared to its maximum capacity. It is the ratio between the power actually produced and the maximum possible power of the engine +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +CalculatedServiceLife +|https://admin-shell.io/idta/PowerDriveTrainSizing/CalculatedServiceLife/1/0 + + + +Time in which a technical system, device or object can be used without the replacement of core components or complete failure under the operating conditions which were calculated in the engineering +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +MassInertiaRatio +|https://admin-shell.io/idta/PowerDriveTrainSizing/MassInertiaRatio/1/0 + + + +The mass inertia ratio λ is the ratio of external mass inertia (application side) to internal mass inertia (motor and gearbox side). It is an important parameter for the controllability of an application. The more different the mass moments of inertia are and the larger λ becomes, the less precisely dynamic processes can be controlled. +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +FrequencyAtMaxSpeed +|https://admin-shell.io/idta/PowerDriveTrainSizing/FrequencyAtMaxSpeed/1/0 + + + +Specifies how many times the shaft of the motor rotates completely per second when the motor is operated at its maximum output +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +PowerInRegenerativeOperation +|https://admin-shell.io/idta/PowerDriveTrainSizing/PowerInRegenerativeOperation/1/0 + + + +electrical energy generated by a motor over the motion profile when it operates as a generator and converts mechanical energy into electrical energy +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +PowerInMotorOperation +|https://admin-shell.io/idta/PowerDriveTrainSizing/PowerInMotorOperation/1/0 + + + +electrical energy used by a motor over the motion profile when it converts electrical energy into mechanical energy +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +RmsOfMotorTorque +|https://admin-shell.io/idta/PowerDriveTrainSizing/RmsOfMotorTorque/1/0 + + + +average value of the torque of a motor over the motion profile. This value takes into account both positive and negative fluctuations of the torque during a complete cycle and thus gives a more stable idea of the average torque output of the motor +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +EnergyConsumtionPerCycle +|https://admin-shell.io/idta/PowerDriveTrainSizing/EnergyConsumtionPerCycle/1/0 + + + +Energy consumed during a single operating cycle of a system, machine or device. +|[Long] + + + + +|0..1 + + + +|=== + + + + +===== Submodel Elements of OtherComponent +===== 2.3.4.3 Submodel Elements of OtherComponent + +// Table generated from [Submodel, www.example.com/ids/sm/5311_7020_9042_2173],[SubmodelElementCollection, Section_2_Approaches],[SubmodelElementCollection, Section_2_3_Submodel_specifics],[SubmodelElementCollection, Section_2_3_4_Submodel_Elements_of_SizingResult],[SubmodelElementCollection, Section_2_3_4_3_Submodel_Elements_of_OtherComponent],[ReferenceElement, Table_Submodel_Elements_of_OtherComponent] + + + +[width="100%", id="Table_Submodel_Elements_of_OtherComponent", title="Submodel Elements of OtherComponent", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}OtherComponent + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}Entity + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/PowerDriveTrainSizing/OtherComponent/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}SizingResult + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee} + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Prop] + + + +ManufacturerName +|0173-1#02-AAO677#002 + + + + +|[String] + + + +Machine Builder GmbH +|0..1 + + + +|[Prop] + + + +ManufacturerArticleNumber +|0173-1#02-AAO676#003 + + + + +|[String] + + + +- +|0..1 + + + +|[MLP] + + + +ManufacturerProductDesignation +|0173-1#02-AAW338#001 + + + + +|[] + + + +ManufacturerProductDesignation@en +|0..1 + + + +|[Prop] + + + +ManufacturerOrderCode +| 0173-1#02-AAO227#002 + + + + +|[String] + + + + +|0..1 + + + +|[Prop] + + + +QuantityOfParts +|https://admin-shell.io/idta/PowerDriveTrainSizing/QuantityOfParts/1/0 + + + +Total number of separate components or parts that make up a particular item, product, or system +|[Integer] + + + + +|0..1 + + + +|[Prop] + + + +BulkCount +|https://admin-shell.io/idta/HierarchicalStructures/BulkCount/1/0 + + + + +|[UnsignedLong] + + + + +|0..1 + + + +|[Prop] + + + +EnergyConsumtionPerCycle +|https://admin-shell.io/idta/PowerDriveTrainSizing/EnergyConsumtionPerCycle/1/0 + + + +Energy consumed during a single operating cycle of a system, machine or device. +|[Long] + + + + +|0..1 + + + +|=== + + + + +===== Submodel Elements of Messages +===== 2.3.4.4 Submodel Elements of Messages + +// Table generated from [Submodel, www.example.com/ids/sm/5311_7020_9042_2173],[SubmodelElementCollection, Section_2_Approaches],[SubmodelElementCollection, Section_2_3_Submodel_specifics],[SubmodelElementCollection, Section_2_3_4_Submodel_Elements_of_SizingResult],[SubmodelElementCollection, Section_2_3_4_4_Submodel_Elements_of_Messages],[ReferenceElement, Table_Submodel_Elements_of_Messages] + + + +[width="100%", id="Table_Submodel_Elements_of_Messages", title="Submodel Elements of Messages", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}Messages + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementCollection + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/PowerDriveTrainSizing/Messages/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}SizingResult + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee} + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[SMC] + + + +Message +|https://admin-shell.io/idta/PowerDriveTrainSizing/Message/1/0 + + + +Message or information transmitted by the sizing tool +|[] + + + +2 elements +|0..* + + + +|=== + + + + +===== Submodel Elements of Message +===== 2.3.4.5 Submodel Elements of Message + +// Table generated from [Submodel, www.example.com/ids/sm/5311_7020_9042_2173],[SubmodelElementCollection, Section_2_Approaches],[SubmodelElementCollection, Section_2_3_Submodel_specifics],[SubmodelElementCollection, Section_2_3_4_Submodel_Elements_of_SizingResult],[SubmodelElementCollection, Section_2_3_4_5_Submodel_Elements_of_Message],[ReferenceElement, Table_Submodel_Elements_of_Message] + + + +[width="100%", id="Table_Submodel_Elements_of_Message", title="Submodel Elements of Message", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}Message + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementCollection + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/PowerDriveTrainSizing/Message/1/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}Messages + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee} + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Prop] + + + +CriticalityOfMessage +|https://admin-shell.io/idta/PowerDriveTrainSizing/CriticalityOfMessage/1/0 + + + +marker for the criticality of the message with respect to the sizing result. E. g. trough symbol, color or code +|[String] + + + + +|1 + + + +|[MLP] + + + +MessageText +|https://admin-shell.io/idta/PowerDriveTrainSizing/MessageText/1/0 + + + +Content of a message transmitted in written form. The content is specific to the sizing tool and manufacturer +|[] + + + +Content of a message transmitted in written form. The content is specific to the sizing tool and manufacturer@en +|1 + + + +|=== + + + +:sectnums!: + +== Annex A. Explanations on used table formats + +=== 1. General + +The used tables in this document try to outline information as concise as possible. They do not convey all information on Submodels and SubmodelElements. For this purpose, the definitive definitions are given by a separate file in form of an AASX file of the Submodel template and its elements. + +=== 2. Tables on Submodels and SubmodelElements + +For clarity and brevity, a set of rules is used for the tables for describing Submodels and SubmodelElements. + +* The tables follow in principle the same conventions as in [5]. +* The table heads abbreviate 'cardinality' with 'card'. +* The tables often place two informations in different rows of the same table cell. In this case, the first information is marked out by sharp brackets [] form the second information. A special case are the semanticIds, which are marked out by the format: (type)(local)[idType]value. +* The types of SubmodelElements are abbreviated: + +[width="100%",cols="40%,60%",options="header"] +|=== +|SME type |SubmodelElement type +|Property |Property +|MLP |MultiLanguageProperty +|Range |Range +|File |File +|Blob |Blob +|Ref |ReferenceElement +|Rel |RelationshipElement +|SMC |SubmodelElementCollection +|=== + +* If an idShort ends with '\__00__', this indicates a suffix of the respective length (here: 2) of decimal digits, in order to make the idShort unique. A different idShort might be choosen, as long as it is unique in the parent’s context. +* The Keys of semanticId in the main section feature only idType and value, such as: https://admin-shell.io/vdi/2770/1/0/DocumentId/Id. The attribute "type" (typically "ConceptDescription" and "(local)" or "GlobalReference") need to be set accordingly; see [6]. +* If a table does not contain a column with "parent" heading, all represented attributes share the same parent. This parent is denoted in the head of the table. +* Multi-language strings are represented by the text value, followed by '@'-character and the ISO 639 language code: example@EN. +* The [valueType] is only given for Properties. + + + + +:sectnums!: + +== Bibliography + +[width="100%",cols="10%,90%", frame=none, grid=none] +|=== + +|[1] |“Recommendations for implementing the strategic initiative +INDUSTRIE 4.0”, acatech, April 2013. [Online]. Available +https://www.acatech.de/Publikation/recommendations-for-implementing-the-strategic-initiative-industrie-4-0-final-report-of-the-industrie-4-0-working-group/ + +|[2] |“Implementation Strategy Industrie 4.0: Report on the results of +the Industrie 4.0 Platform”; BITKOM e.V. / VDMA e.V., /ZVEI e.V., April +2015. [Online]. Available: +https://www.bitkom.org/noindex/Publikationen/2016/Sonstiges/Implementation-Strategy-Industrie-40/2016-01-Implementation-Strategy-Industrie40.pdf + +|[3] |“The Structure of the Administration Shell: TRILATERAL +PERSPECTIVES from France, Italy and Germany”, March 2018, [Online]. +Available: +https://www.plattform-i40.de/I40/Redaktion/EN/Downloads/Publikation/hm-2018-trilaterale-coop.html + +|[4] |“Beispiele zur Verwaltungsschale der Industrie 4.0-Komponente – +Basisteil (German)”; ZVEI e.V., Whitepaper, November 2016. [Online]. +Available: +https://www.zvei.org/presse-medien/publikationen/beispiele-zur-verwaltungsschale-der-industrie-40-komponente-basisteil/ + +|[5] |“Verwaltungsschale in der Praxis. Wie definiere ich Teilmodelle, +beispielhafte Teilmodelle und Interaktion zwischen Verwaltungsschalen +(in German)”, Version 1.0, April 2019, Plattform Industrie 4.0 in +Kooperation mit VDE GMA Fachausschuss 7.20, Federal Ministry for +Economic Affairs and Energy (BMWi), Available: +https://www.plattform-i40.de/PI40/Redaktion/DE/Downloads/Publikation/2019-verwaltungsschale-in-der-praxis.html + +|[6] |IDTA 01001-3-0: “Specification of the Asset Administration Shell; Part 1 (Version 3.0)”, March 2023, [Online]. Available: +https://industrialdigitaltwin.org/wp-content/uploads/2023/06/IDTA-01001-3-0_SpecificationAssetAdministrationShell_Part1_Metamodel.pdf + +|[7] |“Semantic interoperability: challenges in the digital +transformation age”; IEC, International Electronical Commission; 2019. +[Online]. Available: +https://basecamp.iec.ch/download/iec-white-paper-semantic-interoperability-challenges-in-the-digital-transformation-age-en/ + +|[8] |Common terms and abbreviations according to VDI FA 7.21 Wiki; Available: http://i40.iosb.fraunhofer.de/ + +|[9] |United States: US Code of Federal regulations, see https://www.ecfr.gov/current/title-22/chapter-I/subchapter-M/part-120/subpart-C/section-120.42 + +|=== diff --git a/published/Time Series Data/1/1/docs/antora.yml b/published/Time Series Data/1/1/docs/antora.yml new file mode 100644 index 00000000..f5c25f85 --- /dev/null +++ b/published/Time Series Data/1/1/docs/antora.yml @@ -0,0 +1,4 @@ +name: Time Series Data +title: 'Time Series Data' +version: 'v1.1' +start_page: ROOT:index.adoc \ No newline at end of file diff --git a/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_1.png b/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_1.png new file mode 100644 index 00000000..84b78e68 Binary files /dev/null and b/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_1.png differ diff --git a/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_10.png b/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_10.png new file mode 100644 index 00000000..448f34d8 Binary files /dev/null and b/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_10.png differ diff --git a/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_11.png b/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_11.png new file mode 100644 index 00000000..c511940e Binary files /dev/null and b/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_11.png differ diff --git a/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_2.png b/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_2.png new file mode 100644 index 00000000..a7f32dd4 Binary files /dev/null and b/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_2.png differ diff --git a/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_3.png b/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_3.png new file mode 100644 index 00000000..ab3bbe41 Binary files /dev/null and b/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_3.png differ diff --git a/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_4.png b/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_4.png new file mode 100644 index 00000000..190f0203 Binary files /dev/null and b/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_4.png differ diff --git a/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_5.png b/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_5.png new file mode 100644 index 00000000..b573860a Binary files /dev/null and b/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_5.png differ diff --git a/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_6.png b/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_6.png new file mode 100644 index 00000000..b98149a1 Binary files /dev/null and b/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_6.png differ diff --git a/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_7.png b/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_7.png new file mode 100644 index 00000000..5deac20f Binary files /dev/null and b/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_7.png differ diff --git a/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_8.jpg b/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_8.jpg new file mode 100644 index 00000000..9420c8d1 Binary files /dev/null and b/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_8.jpg differ diff --git a/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_8_1.png b/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_8_1.png new file mode 100644 index 00000000..be41c0f7 Binary files /dev/null and b/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_8_1.png differ diff --git a/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_8_2.png b/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_8_2.png new file mode 100644 index 00000000..6bec634f Binary files /dev/null and b/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_8_2.png differ diff --git a/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_8_3.png b/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_8_3.png new file mode 100644 index 00000000..ba3760f7 Binary files /dev/null and b/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_8_3.png differ diff --git a/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_9.png b/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_9.png new file mode 100644 index 00000000..14fdb507 Binary files /dev/null and b/published/Time Series Data/1/1/docs/modules/ROOT/images/Figure_9.png differ diff --git a/published/Time Series Data/1/1/docs/modules/ROOT/images/SMT-template-cover.svg b/published/Time Series Data/1/1/docs/modules/ROOT/images/SMT-template-cover.svg new file mode 100644 index 00000000..356c2fb6 --- /dev/null +++ b/published/Time Series Data/1/1/docs/modules/ROOT/images/SMT-template-cover.svg @@ -0,0 +1,1266 @@ + + + +SPECIFICATIONSubmodel Template of theAsset Administration Shell diff --git a/published/Time Series Data/1/1/docs/modules/ROOT/images/asciidoc-style-idta.css b/published/Time Series Data/1/1/docs/modules/ROOT/images/asciidoc-style-idta.css new file mode 100644 index 00000000..cc2879f2 --- /dev/null +++ b/published/Time Series Data/1/1/docs/modules/ROOT/images/asciidoc-style-idta.css @@ -0,0 +1,97 @@ +@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"; +@import "https://cdn.jsdelivr.net/gh/asciidoctor/asciidoctor@2.0/data/stylesheets/asciidoctor-default.css"; + +h1, h2, h3, h4, h5, h6, #toctitle, +.sidebarblock > .content > .title { + color: rgba(0, 0, 0, 0.8); +} + +#toc { + background:-color #ffffff; +} + +#toctitle { + color: #0028cd; +} + +a { + color: #17418a; +} + +a:hover, a:focus { + color: rgb(8, 24, 117); +} + +h1, h2, h3, .sidebarblock > .content > .title, h4, h5, h6 { + color: #3149cc; +} + +.subheader, .admonitionblock td.content > .title, .audioblock > .title, .exampleblock > .title, .imageblock > .title, .listingblock > .title, .literalblock > .title, .stemblock > .title, .openblock > .title, .paragraph > .title, .quoteblock > .title, table.tableblock > .title, .verseblock > .title, .videoblock > .title, .dlist > .title, .olist > .title, .ulist > .title, .qlist > .title, .hdlist > .title { + color: #303030; +} + +:not(pre):not([class^=L])>code { + background-color: #e0e0e0; +} + +table thead, table tfoot { + background: #f7f8f7; + background-color: rgb(247, 248, 247); + background-position-x: 0%; + background-position-y: 0%; + background-repeat: repeat; + background-attachment: scroll; + background-image: none; + background-size: auto; + background-origin: padding-box; + background-clip: border-box; +} + +/* Problem handling with long strings in the tables */ +/* This seems no appropriate or last resort (sliders) + table { + display: block; + width: max-content; + max-width: 100%; + overflow-x: auto; + } +*/ + +/* This seems to work: */ +table { + word-wrap: anywhere; +} + +.huge { + font-family: 'Open Sans'; + font-size: 3em; + line-height: 1.1em; +} + +.large { + font-family: 'Open Sans'; + font-size: 1.8em; + line-height: 1.1em; +} + +.normal { + font-family: 'Open Sans'; + font-size: 1em; + line-height: 1.1em; +} + +.white { + color: #ffffff; +} + +.redboxoneround { + padding: 0.3em 1em 0.3em 1em; + margin: 0.5em 0 0.5em 0; + font-family: 'Open Sans'; + font-size: 2em; + color: #ffffff; + line-height: 1.1em; + letter-spacing: 0.1em; + background-color: #fe4f0e; + border-radius: 0 0.35em 0 0; +} \ No newline at end of file diff --git a/published/Time Series Data/1/1/docs/modules/ROOT/images/compile-html.bat b/published/Time Series Data/1/1/docs/modules/ROOT/images/compile-html.bat new file mode 100644 index 00000000..662c550b --- /dev/null +++ b/published/Time Series Data/1/1/docs/modules/ROOT/images/compile-html.bat @@ -0,0 +1 @@ +docker run -it -v .:/documents/ asciidoctor/docker-asciidoctor asciidoctor -r asciidoctor-diagram -a toc=left -a stylesheet=asciidoc-style-idta.css *.adoc \ No newline at end of file diff --git a/published/Time Series Data/1/1/docs/modules/ROOT/images/compile-pdf-line-nrs.bat b/published/Time Series Data/1/1/docs/modules/ROOT/images/compile-pdf-line-nrs.bat new file mode 100644 index 00000000..9be41708 --- /dev/null +++ b/published/Time Series Data/1/1/docs/modules/ROOT/images/compile-pdf-line-nrs.bat @@ -0,0 +1 @@ +docker run -it -v .:/documents/ asciidoctor/docker-asciidoctor asciidoctor-pdf -r asciidoctor-diagram -r ./extended.rb -a toc=macro -a pdf-theme=my-theme.yml -a env-pdf *.adoc \ No newline at end of file diff --git a/published/Time Series Data/1/1/docs/modules/ROOT/images/compile-pdf.bat b/published/Time Series Data/1/1/docs/modules/ROOT/images/compile-pdf.bat new file mode 100644 index 00000000..65c255ef --- /dev/null +++ b/published/Time Series Data/1/1/docs/modules/ROOT/images/compile-pdf.bat @@ -0,0 +1 @@ +docker run -it -v .:/documents/ asciidoctor/docker-asciidoctor asciidoctor-pdf -r asciidoctor-diagram -a toc=macro -a pdf-theme=my-theme.yml -a env-pdf *.adoc \ No newline at end of file diff --git a/published/Time Series Data/1/1/docs/modules/ROOT/images/extended.rb b/published/Time Series Data/1/1/docs/modules/ROOT/images/extended.rb new file mode 100644 index 00000000..757cc465 --- /dev/null +++ b/published/Time Series Data/1/1/docs/modules/ROOT/images/extended.rb @@ -0,0 +1,27 @@ +# This file is taken from the extension examples from the asciidoctor-pdf repository. +# https://github.com/asciidoctor/asciidoctor-pdf/blob/main/docs/modules/extend/examples/pdf-converter-numbered-paragraphs.rb + + +class PDFConverterNumberedParagraphs < (Asciidoctor::Converter.for 'pdf') + register_for 'pdf' + + def init_pdf doc + doc + .find_by(context: :paragraph) {|candidate| [:document, :section].include? candidate.parent.context } + .each_with_index {|paragraph, idx| paragraph.set_attr 'number', idx + 1 } + super + end + + def convert_paragraph node + if (paragraph_number = node.attr 'number') + float do + label = %(#{paragraph_number}.#{::Prawn::Text::NBSP}) + label_width = rendered_width_of_string label + bounding_box [-label_width, cursor], width: label_width do + ink_prose label, color: 'CCCCCC', align: :right, margin: 0, single_line: true + end + end + end + super + end +end diff --git a/published/Time Series Data/1/1/docs/modules/ROOT/images/idta-cover-logo-small.png b/published/Time Series Data/1/1/docs/modules/ROOT/images/idta-cover-logo-small.png new file mode 100644 index 00000000..8e821f9f Binary files /dev/null and b/published/Time Series Data/1/1/docs/modules/ROOT/images/idta-cover-logo-small.png differ diff --git a/published/Time Series Data/1/1/docs/modules/ROOT/images/idta-smt-badge.png b/published/Time Series Data/1/1/docs/modules/ROOT/images/idta-smt-badge.png new file mode 100644 index 00000000..ab505e50 Binary files /dev/null and b/published/Time Series Data/1/1/docs/modules/ROOT/images/idta-smt-badge.png differ diff --git a/published/Time Series Data/1/1/docs/modules/ROOT/images/idta-spec-badge.png b/published/Time Series Data/1/1/docs/modules/ROOT/images/idta-spec-badge.png new file mode 100644 index 00000000..5ef5260f Binary files /dev/null and b/published/Time Series Data/1/1/docs/modules/ROOT/images/idta-spec-badge.png differ diff --git a/published/Time Series Data/1/1/docs/modules/ROOT/images/my-theme.yml b/published/Time Series Data/1/1/docs/modules/ROOT/images/my-theme.yml new file mode 100644 index 00000000..cba8d6c2 --- /dev/null +++ b/published/Time Series Data/1/1/docs/modules/ROOT/images/my-theme.yml @@ -0,0 +1,103 @@ +extends: default-for-print + +title-page: + text_align: left + margin-inner: -1cm + margin-outer: -1cm + title: + top: 8cm + font_size: 42 + font_style: bold + font_color: D9D9D9 + line_height: 1.2 + subtitle: + margin-top: 1cm + font_size: 42 + font_color: D9D9D9 + font_style: normal + line_height: 1.0 + authors: + margin-top: 1cm + font_size: 18 + font_color: D9D9D9 + font_style: normal + line_height: 1 + revision: + margin-top: 1cm + font_size: 18 + font_color: D9D9D9 + font_style: normal + line_height: 1 + background-image: image:SMT-template-cover.svg[fit=cover] + logo: + top: 21.7cm + align: right + image: image:idta-smt-badge.png[pdfwidth=48%] +page: + layout: portrait + margin: [1.5cm, 2cm, 1.5cm, 2cm] + size: A4 +base: + font-color: #333333 + font-family: Helvetica + font-size: 10 + line-height-length: 11.5 + line-height: $base-line-height-length / $base-font-size +role: + removed: + font-style: italic + text-decoration: line-through + text-decoration-color: #FF0000 + huge: + font-family: Helvetica + font-size: 24 + large: + font-family: Helvetica + font-size: 16 + normal: + font-family: Helvetica + font-size: 12 + white: + font-color: #ffffff + redboxoneround: + border-radius: [0.3cm, 0cm, 0cm, 0cm] + font-family: Helvetica + font-size: 16 + letter-spacing: $base-font-size * 1.1 + font-color: #ffffff + background-color: #fe4f0e +heading: + font-color: #3149cc + font-size: 17 + font-family: Helvetica + line-height: 1.2 + margin-bottom: 10 +link: + font-color: #17418a +list: + indent: $base-font-size * 1.2 + +table: + font-size: 10 + border-width: 0.5 + grid-width: 0.5 + border-color: #707070 + grid-color: #707070 + +pre: + font-color: #ff0000 + +code: + font-color: #505050 + font-style: bold + font-size: 11 + font-weight: 600 + +literal: + font-color: #3149cc + font-style: bold + font-size: 12 + font-weight: 800 +image: + # align: center + # problem: caption not able to center \ No newline at end of file diff --git a/published/Time Series Data/1/1/docs/modules/ROOT/images/watch_new_unzip_and_show.ps1 b/published/Time Series Data/1/1/docs/modules/ROOT/images/watch_new_unzip_and_show.ps1 new file mode 100644 index 00000000..46e59c47 --- /dev/null +++ b/published/Time Series Data/1/1/docs/modules/ROOT/images/watch_new_unzip_and_show.ps1 @@ -0,0 +1,107 @@ +# from: https://stackoverflow.com/questions/62350872/powershell-file-watcher-register-objectevent-wait-for-file-to-complete-copying + +# IMPORTANT: Copy this file to the folder being watchd (typically one level above) and run + +Clear-Host +$ErrorActionPreference = [System.Management.Automation.ActionPreference]::Stop + +$fileSystemWatcherDirPath = '.' +$fileSystemWatcherFilter = '*.zip' + +$fileSystemWatcher = [System.IO.FileSystemWatcher]::new($fileSystemWatcherDirPath , $fileSystemWatcherFilter) +$fileSystemWatcher.IncludeSubdirectories = $true +$fileSystemWatcher.EnableRaisingEvents = $true +$fileSystemWatcher.NotifyFilter = [System.IO.NotifyFilters]::FileName -bor [System.IO.NotifyFilters]::DirectoryName -bor [System.IO.NotifyFilters]::LastWrite # [System.Linq.Enumerable]::Sum([System.IO.NotifyFilters].GetEnumValues()) + +# Create syncronized hashtable +# $syncdFsItemEventHashT = [hashtable]::Synchronized([hashtable]::new()) +$global:syncdFsItemEventHashT = @{} + +$fileSystemWatcherAction = { + try { + $fsItemEvent = [pscustomobject]@{ + EventIdentifier = $Event.EventIdentifier + SourceIdentifier = $Event.SourceIdentifier + TimeStamp = (Get-Date) # $Event.TimeGenerated + FullPath = $Event.SourceEventArgs.FullPath + ChangeType = $Event.SourceEventArgs.ChangeType + } + + # Collecting event in synchronized hashtable (overrides existing keys so that only the latest event details are available) + # $syncdFsItemEventHashT = @{} + Write-Host $fsItemEvent.FullPath + Write-Host $syncdFsItemEventHashT + $syncdFsItemEventHashT[$fsItemEvent.FullPath] = $fsItemEvent + } catch { + Write-Host ($_ | Format-List * | Out-String ) -ForegroundColor red + } +} + +# Script block which processes collected events and do further actions like copying for backup, etc... +# That scriptblock was initially used to test "Start-Job". Unfortunately it's not possible to access and modify the synchronized hashtable created within this scope. +$fSItemEventProcessingJob = { + $keys = [string[]]$syncdFsItemEventHashT.psbase.Keys + + foreach ($key in $keys) { + $fsEvent = $syncdFsItemEventHashT[$key] + + try { + + Write-Host "Event has TS = ", $fsEvent.TimeStamp + + if ( ( (Get-Date) - $fsEvent.TimeStamp ).TotalSeconds -gt 3) { + + Write-Host "Finally processing: ", $fsEvent.FullPath + $syncdFsItemEventHashT.Remove($key) + + # do the work + Remove-Item 'new' -Recurse -ErrorAction SilentlyContinue + Expand-Archive -Path $fsEvent.FullPath -DestinationPath new + Set-Location .\new\ + Start-Process -FilePath 'compile-html.bat' -Wait + Start-Process -FilePath @(Get-ChildItem *.html)[0] + Set-Location .. + } + + } catch { + Write-Host ($_ | Format-List * | Out-String ) -ForegroundColor red + } + } +} + +[void] (Register-ObjectEvent -InputObject $fileSystemWatcher -EventName 'Created' -SourceIdentifier 'FSCreated' -Action $fileSystemWatcherAction) +[void] (Register-ObjectEvent -InputObject $fileSystemWatcher -EventName 'Changed' -SourceIdentifier 'FSChanged' -Action $fileSystemWatcherAction) +[void] (Register-ObjectEvent -InputObject $fileSystemWatcher -EventName 'Renamed' -SourceIdentifier 'FSRenamed' -Action $fileSystemWatcherAction) +[void] (Register-ObjectEvent -InputObject $fileSystemWatcher -EventName 'Deleted' -SourceIdentifier 'FSDeleted' -Action $fileSystemWatcherAction) + +Write-Host "Watching for changes in '$fileSystemWatcherDirPath'.`r`nPress CTRL+C to exit!" +try { + do { + Wait-Event -Timeout 1 + + if ($syncdFsItemEventHashT.Count -gt 0) { + Write-Host "`r`n" + Write-Host ('-' * 50) -ForegroundColor Green + Write-Host "Collected events in hashtable queue:" -ForegroundColor Green + $syncdFsItemEventHashT.Values | Format-Table | Out-String + } + + # Process hashtable items and do something with them (like copying, ..) + .$fSItemEventProcessingJob + + # Garbage collector + [GC]::Collect() + + } while ($true) + +} finally { + # unregister + Unregister-Event -SourceIdentifier 'FSChanged' + Unregister-Event -SourceIdentifier 'FSCreated' + Unregister-Event -SourceIdentifier 'FSDeleted' + Unregister-Event -SourceIdentifier 'FSRenamed' + + # dispose + $FileSystemWatcher.Dispose() + Write-Host "`r`nEvent Handler removed." +} diff --git a/published/Time Series Data/1/1/docs/modules/ROOT/pages/index.adoc b/published/Time Series Data/1/1/docs/modules/ROOT/pages/index.adoc new file mode 100644 index 00000000..79686376 --- /dev/null +++ b/published/Time Series Data/1/1/docs/modules/ROOT/pages/index.adoc @@ -0,0 +1,1527 @@ + + += IDTA 02008-2-0 : Time Series Data + +=== Imprint + +Publisher +[verse] +____ +Industrial Digital Twin Association +Lyoner Strasse 18 +60528 Frankfurt am Main +Germany +https://www.industrialdigitaltwin.org/ +____ + +=== Version history + +[cols="1,1,4"] +|=== + +|Date +|Version +|Comment + +|2021-11-01 +|1.0 +|Used for development only. No official version published. + +|2023-03-01 +|1.1 +|Release of the official Submodel template published by IDTA. + +|2024-04-06 +|2.0 +|Changes in: + +- Timestamp: Only One Timestamp is Mandatory + +- Merge of LinkedSegment to ExternalSegment + +|=== + +:sectnums: + +:toclevels: 3 + +:xrefstyle: short + +<<< +toc::[] +<<< + +== General + + +=== About this document +This document is a part of a specification series. Each part specifies the contents of a Submodel template for the Asset Administration Shell (AAS). +The AAS is described in [1], [2], [3] and [6]. First exemplary Submodel contents were described in [4], while the actual format of this document was derived by the "Administration Shell in Practice" [5]. +The format aims to be very concise, giving only minimal necessary information for applying a Submodel template, while leaving deeper descriptions and specification of concepts, structures and mapping to the respective documents [1] to [6]. + +=== Scope of the Submodel +In Industrie 4.0, the ubiquity of data sources and sensors and low costs of storage has resulted in increasing amounts of time series data being captured – not only during the operational phase of an asset. A time series is a series of data points in time order over a period of time. Time Series can represent raw data, but can also represent main characteristics, textual descriptions or events in a concise way. This Submodel template aims at an interoperable description of time series data in industrial automation for the complete asset lifecycle. The focus of this Submodel template is on the semantic information of time series data. The Submodel claims to integrate time series data within the AAS itself, but also from external data sources. Figure 1 shows the use cases, such as sensor data from real and virtual sensors, and their technical storage options inside or outside the AAS that were taken into account in the creation of this specification. + +image::Figure_1.png[id="Figure_1", width="80.0%",title="Scope and use cases for time series data"] + + +=== Relevant standards for the Submodel template +- ISO 8601 “Data elements and interchange formats – Information interchange – Representation of dates and times” was integrated for definition of time scales and time stamps +- JSON Time Series Format [7] was considered to add structure and metadata. +- ECLASS & IEC CDD was included to use semantic IDs for properties and qualifiers. +- ISO/IEC 18014-1:2008 Information technology -- Security techniques -- Time-stamping services is referenced to make a boundary with this specification regarding the time synchronization of various data sources. +- IEEE/IEC 61588-2021“Precision Clock Synchronization Protocol for Networked Measurement and Control Systems” [8] is referenced to make a boundary with this specification regarding the time synchronization of various data sources. +- OPC Foundation: OPC Unified Architecture Part 11“Historical Access” has been considered to provide the outlook on the methods for querying time series. + + +=== Use cases and requirements +In creating this specification, the following use cases were contributed by participants. +General requirements were derived from the use cases and design decisions were made. + + +==== Time series data with passive AAS and passive Assets +The cold chain of an adhesive must be maintained from production to consumption. For this purpose, multiple distributed sensors monitor the ambient temperature and store this data in the AAS of the adhesive. +Regardless of whether the data is synchronized continuously or at specific time intervals, a consistent time series for the asset is available throughout the entire lifecycle and across different stakeholders. For this use case a passive AAS whithout computing capacity is sufficient. + + +image::Figure_2.png[id="Figure_2", width="80.0%",title="Use case of time series data along the value chain of an adhesive"] + + +==== Time Series Data within the engineering phase of an Asset +In the design of power drive systems, information on the motion sequence is exchanged between different partners. User defined timestamps (for instance acceleration time in seconds) are usually used to describe motion sequences. The following example shows a motion sequence of a rotary table in a sizing tool during the engineering phase of a machine. + +image::Figure_3.png[id="Figure_3", width="80.0%",title="Use case of time series data in engineering – Motion Profiles"] + + +==== Time Series Data during usage phase – smart Sensor +This example gives an overview of how sensor telemetry data is stored in a file (e. g.CSV or BLOB in JSON Encoding). In this example a temperature Sensor and a 3-axis acceleration sensor was used to record a period of 5 seconds. + +Note - In the example data set, an ISO 8601-compliant timestamp ending with "Z" was selected to indicate that the time is given in Coordinated Universal Time (UTC). Without "Z", this normally means that the time is given in a specific time zone, e.g. "2024-04-09T12:30:00+02:00" (for the time zone UTC+02:00). + +.Use case of time series data during usage - smart Sensor +[cols="1,2,2,3,3,3"] +|=== +|Index +|timestamp +|Temperature (°C) +|RMS of Acceleration x-axis (m/s2) +|RMS of Acceleration y-axis (m/s2) +|RMS of Acceleration z-axis (m/s2) +|0 |2020-01-22T16:38:09Z |23.400 |0.60 |0.65 |0.90 +|1 +|2020-01-22T16:38:10Z +|23.415 +|0.61 +|0.80 +|1.00 +|2 +|2020-01-22T16:38:11Z +|23.420 +|0.62 +|0.85 +|0.90 +|3 +|2020-01-22T16:38:12Z +|23.405 +|1.60 +|5.00 +|1.25 +|4 +|2020-01-22T16:38:13Z +|23.405 +|5.65 +|6.15 +|1.20 +|5 +|2020-01-22T16:38:14Z +|23.390 +|6.00 +|6.50 +|2.05 +|=== + +== Submodel Template Time Series Data + +=== Approach + +This Submodel represents an approach for the semantic description of time series along the entire asset life cycle in the AAS. Since there are many optimized database systems for time series data, this specification defines the integration of external data sources, as well as the storage of time series in the AAS itself. Furthermore, operations are specified with which time series data can be queried and inserted. + +*Time Series Data throughout the asset lifecycle* + +The Time Series Data Submodel can cover different phases of a product life cycle. As shown in Figure 4, the usage of Time Series Data Submodel starts during the Engineering Phases (Development of a type). During this phase, the Template of Time Series Data Submodel is created based on the Metadata of the corresponding product “type”. The focus of the Time Series Data Submodel, however, is after the product is instantiated and starts to store the record data that the product is generating. +Note – an asset type can also have a Submodel-instance with type-related time series data containing segments and records, e. g. time series from simulations or calculations during the design phases. + + +image::Figure_4.png[id="Figure_4", width="100.0%",title="AAS Time Series Data Submodel within the product life cycle"] + +==== Generic Structure of Time Series +A time series consists of data points in time order. Timestamped data is the most basic type of time series that associates values with points in time. An example of time series is shown in Table 2. + + +image::Figure_5.png[id="Figure_5", width="100.0%",title="Time series structure designations"] + +A *timestamp* is used to assign a time to a data point or event. *Data points* (variables) can be measurement data, events, or even textual descriptions. *Segments* (subsequences) of a time series divide a time series into logical sections, which can be labelled and be described by further semantics. +For an interoperable exchange of time series data *structure*, *timestamps*, *data points* and *operations* are defined in more detail in chapter 2.2. This specification focuses on these core elements of a time series. Depending on the application and technology used, the times series model should be extended by further properties and qualifier. + + +=== Definitions within the Submodel template specification + +==== Notions of Time +A timestamp is used to assign various events and data to a unique point in time. The ISO 8601 standard can be used for an unambiguous and well-defined method of presenting date, time of day, date and time, time intervals and recurring time intervals. For a common interpretation of the timestamp, it is also indicated with its time scale. In contrast to these international specified time scales are relative time measurements - e.g., with a stopwatch - where the zero point can be arbitrary because of the mere measurement of a time difference. For these time series the ISO 8601 timestamp is not appropriate and user-defined time formats and values are used (see Figure 5). + + +image::Figure_6.png[id="Figure_6", width="100.0%",title=" Classification of time specifications"] + +To describe the timeline of a custom time scale, the time unit such as hours, minutes, seconds, milliseconds, or microseconds must be determined. Due to the SI (Système International) base unit, seconds are the preferred time unit in this specification. In addition, it must be determined whether these are time points or durations. A time point is one point on the time axis, whereas duration describe the length of a time interval. Time intervals are limited by two points in time. +Usually and if not explicitly stated, time points refer to the starting point of the time scale, whereas time durations build on each other (see Figure 6). To clearly identify the measurement model (absolute or incremental), this can be done via a qualifier. +Note – data points (variables) of a measurement series can also be absolute or incremental. + +image::Figure_7.png[id="Figure_7", width="100.0%",title=" Classification of time specifications"] + +Based on these explanations, the requirement for the following AAS Submodel Elements were determined: + +- *Time* <> with its corresponding semantic ID for eg. TAI, UTC or custom time scales: +* *UtcTime* <> +* *Time* << ConceptDescription >> in seconds, due to the SI base unit +* *MeasurementModelQualifier* <> with value list [absolute, incremental] + +Note – Other timestamp formats and scales, such as Unix Time, Ephemeris Time (ET) or Barycentric Dynamical Time (TBD) can be defined as Concept Description with corresponding semantic IDs. + +Note – A time series can contain several timestamps, for example a timestamp from the sensor and a timestamp from superior instances or in different timescales. Within the time series, there is only one primary timestamp with idShort "time". + +*Data points and Segments* + +*Data points* (variables) can be measurement data, events, or even textual descriptions. A data point has several values X~1~, X~2~, X~3~, X~n~ with correspondending units (e. g. °C, m/s2, rpm, V, A, …). Depending on the number of data points, a time series can have simple or complex structures (e. g. X~1~, Y~1~, Z~1~, X~2~, Y~2~, Z~2~, X~3~, Y~3~, Z~3~, X~n~, Y~n~, Z~n~,). + +This specification does not define semantic IDs of time series variables. The semantic IDs of the data points depend on the measured variables and their applications and should be chosen accordingly. + +*Record IDs* - Within a time series timestamps and associated values are linked in a record via by an Identifier (ID). The record ID must be unique within a time series. For simple time series, the record ID could be handled like an index of integers and start with 0. For mass data and harmonizations from distributed data sources, the ID in the form of a GUID is more appropriate. + +A time series *segment* is a subsequence of values from the variables within a time series. Different techniques for segmentation during data processing and analysis can be used. A segment has a name, a description, the number of records, a start time, and an end time. Other information such as the sampling rate, the sampling interval or additional user-defined properties may be contained. In addition, the status of a time series segment can be important for users, in the meaning that the segment is completed (status = completed) or is still subject to ongoing changes (status = in progress). For this requirement, a last updated property can also be set. + +Note - Sampling rate refers to the number of samples per second. It is usually measured in hertz (Hz) and is often expressed as a frequency. For example, a sampling rate of 44.1 kHz means that 44,100 samples are taken per second. The sampling interval refers to the time between successive records. It is usually measured in seconds and is the inverse of the sampling rate. For example, if the sampling rate is 44.1 kHz, the sampling interval is approximately 22.68 microseconds (1/44100 seconds). + +In practice, not every time series can be seamlessly integrated into the internal schema of the AAS time series SMT. This may be due to different data formats, storage requirements or the dynamics of the data source. To meet this challenge, the SMT offers the option of using an "external segment". These flexible structures make it possible to access data stored outside the primary data model, whether in external files or via third-party APIs. + +External segments therefore act as bridges or references to external data sources that are not stored directly in the internal data model. They can be implemented in different ways, such as + +- References to external files (e.g. CSV, JSON, XML), +- URLs to APIs that provide access to dynamic data sources, + +This specification defines three types of time series segments (Internal, Linked and External), which can be used according to the requirements of the use cases. Table 1 provides an overview of these. + +[title=" Types of time series segments",cols="1,2,2,2"] +|=== +| +a| image::Figure_8_1.png[] +a| image::Figure_8_2.png[] +a| image::Figure_8_3.png[] +| |InternalSegment +2+| ExternalSegment +|Description +|InternalSegments allow an I4.0 application (defined in [7]) to manage the Time Series Data structure and content directly in the AAS. +|API Endpoint allow an I4.0 application to read out the endpoint and query to an external system to manage time series without the AAS. +|File allow an I4.0 application to find a data or BLOB file within which time series data is stored. +|Suitable for +a| +- Few data points +- handover of data points +- Permissions managed within the AAS +a| +* Brownfield integration +* Mass data +* Permissions managed in external system +* dynamic time series without continuous update of AAS +a| +* Brownfield integration +* Static time Series +* Handover of time Series +* Few accesses +|Implications +|dynamic time series require continuous updating of the AAS + + +|I4.0 application must be able to work with endpoint and query +Data semantics and payload separated from each other +|I4.0 application must be able to handle different file formats +Data semantics and payload separated from each other + +|=== +The metadata record contains all datapoint-properties of the time series in addition to the timestamp and is identical to the internal record. However, it does not contain any property values. To ensure the integrity and usability of time series data in external segments and their formats such as external data files (e.g. CSV, Excelö) or structured data formats from APIs (e.g. JSON, XML), it is crucial that the records and properties defined in the metadata match the column headings in data files or the key values in JSON objects exactly. + +*Qualifier* (e. g. from ECLASS, IEC CDD or OPC UA) can be used to express further semantics in conjunction with a defined data element type or a defined data value. Therefore, Qualifier can be used in all those cases where existing definitions of data element types are not sufficiently specified. + +Possible relevant qualifiers for time series data are: + +- ValueQualityQualifier (IEC CDD 0112/2///61360_4#ADA350) [good, bad, uncertain]: The quality of the data values can be of value in a time series analysis. This allows bad data values to be omitted from aggregations or calculations. +- ValueOriginQualifier (IEC CDD 0112/2///61360_4#AAF582) [calculated, estimated, measured, set]: Information about the type of data collection or generation for the value provided. +- ValueProcessingQualifier (IEC CDD 0112/2///61360_4#AAF583#002) [arithmetic mean, median, root mean square, …]: Information about the method of preprocessing the value provided. +- MeasurementModelQualifier (defined in this Submodel specification) [absolute, incremental]: Information about whether there is an absolute measurement, or whether the value is to be seen as additive to the previous measurement. + +Note - The scope of a qualifier depends on its application. For example, the ValueOriginQualifier can be applied to a single data element, to an entire record, or to the data element in the metadata collection. + + +==== AAS Modelling of Time Series +The preceding considerations and definitions are applied to the Time Series Submodel in Figure 8. + +image::Figure_8.jpg[id="Figure_8", width="100.0%",title="Time Series Data UML Diagram"] + + +image::Figure_9.png[id="Figure_9", width="100.0%",title="Time Series Data UML Diagram"] + +*The metadata record* contains all datapoint-properties of the time series in addition to +the timestamp and is identical to the internal record. However, it does not contain any property values. To +ensure the integrity and usability of time series data in external segments and their formats such as external +data files (e.g. CSV, Excel) or structured data formats from APIs (e.g. JSON, XML), it is crucial that the +records and properties defined in the metadata match the column headings in data files or the key values in +JSON objects exactly. + +*Qualifiers* (e.g. from ECLASS, IEC CDD or OPC UA) can be used to express further semantics in +conjunction With a defined data element type or a defined data value. Therefore, Qualifier can be used in all +those cases where existing definitions of data element types are not sufficiently specified. + +Possible relevant qualifiers for time series data are: + +- ValueQualityQualifier (IEC CDD 0112/2///61360_4#ADA350) [good, Bad, uncertain]: The quality of the data values can be of value in a time series analysis. This allows bad data values to be omitted from aggregations or calculations. +- ValueOriginQualifier (IEC CDD 0112/2///61360_4#AAF582) [calculated, estimated, measured, set]: Information about the type of data collection or generation for the value provided. +- ValueProcessingQualifier (IEC CDD 0112/2///61360_4#AAF583#002) [arithmetic mean, median, root mean square, ...l: Information about the method of preprocessing the value provided. +- MeasurementModelQualifier (defined in this Submodel specification) [absolute, incremental]: Information + +=== Relevant information + +// Table generated from [Submodel, www.example.com/ids/sm/7485_0121_2042_6700],[SubmodelElementCollection, Section_2_Approaches],[SubmodelElementCollection, Section_2_3_Submodel_Template_of_Time_Series_Data],[ReferenceElement, Table_Submodel] + + + +[width="100%", id="Table_Submodel", title="Table for elements of Submodel itself", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}TimeSeries + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}Submodel + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/TimeSeries/2/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}- + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}Contains time series data and references to time series data to discover and semantically describe them along the asset lifecycle. + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[SMC] + + + +Metadata +|https://admin-shell.io/idta/TimeSeries/Metadata/2/0 + + + +A set of data describing and providing information about the time series +|[] + + + +3 elements +|1 + + + +|[SMC] + + + +Segments +|https://admin-shell.io/idta/TimeSeries/Segments/2/0 + + + +Contains segments of a time series +|[] + + + +2 elements +|1 + + + +|=== + + + +Note – see 2.6 “Outlook on Time Series Operations – not normative yet” for further SMEs in TimeSeries Submodel + +// Table generated from [Submodel, www.example.com/ids/sm/7485_0121_2042_6700],[SubmodelElementCollection, Section_2_Approaches],[SubmodelElementCollection, Section_2_3_Submodel_Template_of_Time_Series_Data],[ReferenceElement, Table_Specification_of_SMC_Metadata] + + + +[width="100%", id="Table_Specification_of_SMC_Metadata", title="Specification of SMC Metadata", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}Metadata + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementCollection + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/TimeSeries/Metadata/2/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}TimeSeries + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee} + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[MLP] + + + +Name +|https://admin-shell.io/idta/TimeSeries/Metadata/Name/2/0 + + + +Meaningful name for labeling +|[] + + + + +|1 + + + +|[MLP] + + + +Description +|https://admin-shell.io/idta/TimeSeries/Metadata/Description/2/0 + + + +Short description of the time series +|[] + + + + +|0..1 + + + +|[SMC] + + + +Record +|https://admin-shell.io/idta/TimeSeries/Record/2/0 + + + +A time series record is unique by its ID within the time series and contains the timestamps and variable values referenced to the ID. Similar to a row in a table +|[] + + + +5 elements +|1 + + + +|=== + + + + +// Table generated from [Submodel, www.example.com/ids/sm/7485_0121_2042_6700],[SubmodelElementCollection, Section_2_Approaches],[SubmodelElementCollection, Section_2_3_Submodel_Template_of_Time_Series_Data],[ReferenceElement, Table_Specification_of_SMC_Record] + + + +[width="100%", id="Table_Specification_of_SMC_Record", title="Specification of SMC Record", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}Record + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementCollection + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/TimeSeries/Record/2/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}Metadata + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee} + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[Prop] + + + +Time +|https://admin-shell.io/idta/TimeSeries/RelativePointInTime/2/0 + + + +Point of Time in seconds. Time points refer to the start time of the time series segment. +|[Long] + + + + +|1 + + + +|[Prop] + + + +AnyFurtherTimeStamp +| + + + + +|[String] + + + + +| + + + +|[Prop] + + + +sampleAccelerationX +|https://sample.com/AccelerationX/2/0 + + + + +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +sampleAccelerationY +|https://sample.com/AccelerationY/2/0 + + + + +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +sampleAccelerationZ +|https://sample.com/AccelerationZ/2/0 + + + + +|[Long] + + + + +|0..1 + + + +|=== + + + + +// Table generated from [Submodel, www.example.com/ids/sm/7485_0121_2042_6700],[SubmodelElementCollection, Section_2_Approaches],[SubmodelElementCollection, Section_2_3_Submodel_Template_of_Time_Series_Data],[ReferenceElement, Table_Specification_of_SMC_Segments] + + + +[width="100%", id="Table_Specification_of_SMC_Segments", title="Specification of SMC Segments", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}Segments + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementCollection + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/TimeSeries/Segments/2/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}TimeSeries + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee} + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[SMC] + + + +ExternalSegment +|https://admin-shell.io/idta/TimeSeries/Segments/ExternalSegment/2/0 + + + +Reference to a file of data points in sequential order over a period of time +|[] + + + +14 elements +|0..* + + + +|[SMC] + + + +InternalSegment +|https://admin-shell.io/idta/TimeSeries/Segments/InternalSegment/2/0 + + + +Grouped sequence of data points in successive order over a specified period of time +|[] + + + +11 elements +|0..* + + + +|=== + + + + +// Table generated from [Submodel, www.example.com/ids/sm/7485_0121_2042_6700],[SubmodelElementCollection, Section_2_Approaches],[SubmodelElementCollection, Section_2_3_Submodel_Template_of_Time_Series_Data],[ReferenceElement, Table_Specification_of_SMC_Internal_Segment] + + + +[width="100%", id="Table_Specification_of_SMC_Internal_Segment", title="Specification of SMC InternalSegment", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}InternalSegment + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementCollection + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/TimeSeries/Segments/InternalSegment/2/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}Segments + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee} + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[MLP] + + + +Name +|https://admin-shell.io/idta/TimeSeries/Segment/Name/2/0 + + + +Meaningful name for labeling. +|[] + + + + +|0..1 + + + +|[MLP] + + + +Description +|https://admin-shell.io/idta/TimeSeries/Segment/Description/2/0 + + + +Short description of the time series segment. +|[] + + + + +|0..1 + + + +|[Prop] + + + +RecordCount +|https://admin-shell.io/idta/TimeSeries/Segment/RecordCount/2/0 + + + +Indicates how many records are present in a segment. +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +StartTime +|https://admin-shell.io/idta/TimeSeries/Segment/StartTime/2/0 + + + +Contains the first recorded timestamp of the time series segment and thus represents the beginning of a time series. Time format and scale corresponds to that of the time series. +|[String] + + + + +|0..1 + + + +|[Prop] + + + +EndTime +|https://admin-shell.io/idta/TimeSeries/Segment/EndTime/2/0 + + + +Contains the last recorded timestamp of the time series segment and thus represents the end of a time series. Time format and scale corresponds to that of the time series. +|[String] + + + + +|0..1 + + + +|[Prop] + + + +Duration +|https://admin-shell.io/idta/TimeSeries/Segment/Duration/2/0 + + + +Period covered by the segment, represented according to ISO 8601 by the format P[n]Y[n]M[n]DT[n]H[n]M[n]S +|[String] + + + + +|0..1 + + + +|[Prop] + + + +SamplingInterval +|https://admin-shell.io/idta/TimeSeries/Segment/SamplingInterval/2/0 + + + +The time period between two time series records (Length of cycle). +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +SamplingRate +|https://admin-shell.io/idta/TimeSeries/Segment/SamplingRate/2/0 + + + +Defines the number of samples per second for a regular time series in Hz. +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +State +|https://admin-shell.io/idta/TimeSeries/Segment/State/2/0 + + + +State of the time series related to its progress +|[String] + + + + +|0..1 + + + +|[Prop] + + + +LastUpdate +|https://admin-shell.io/idta/TimeSeries/Segment/LastUpdate/2/0 + + + +Time of the last chance +|[String] + + + + +|0..1 + + + +|[SML] + + + +Records +|https://admin-shell.io/idta/TimeSeries/Records/2/0 + + + +Group of data points in successive order over a specified period of time +|[] + + + +0 elements +| + + + +|=== + + + + +// Table generated from [Submodel, www.example.com/ids/sm/7485_0121_2042_6700],[SubmodelElementCollection, Section_2_Approaches],[SubmodelElementCollection, Section_2_3_Submodel_Template_of_Time_Series_Data],[ReferenceElement, Table_Specification_of_SMC_External_Segment] + + + +[width="100%", id="Table_Specification_of_SMC_External_Segment", title="Specification of SMC ExternalSegment", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+s|{set:cellbgcolor:#eeeeee}ExternalSegment + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee}SubmodelElementCollection + +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee}https://admin-shell.io/idta/TimeSeries/Segments/ExternalSegment/2/0 + +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee}Segments + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee} + +s|{set:cellbgcolor:#0029cc} [white]#Element details:# +3+|{set:cellbgcolor:#eeeeee}- + +|{set:cellbgcolor:#0029cc} [white]#[SME type] + + + +idShort# +| [white]#semanticId + + + +Description@en# +| [white]#[valueType] + + + +example# +| [white]#card.# + + + +|{set:cellbgcolor:#eeeeee}[MLP] + + + +Name +|https://admin-shell.io/idta/TimeSeries/Segment/Name/2/0 + + + +Meaningful name for labeling. +|[] + + + + +|0..1 + + + +|[MLP] + + + +Description +|https://admin-shell.io/idta/TimeSeries/Segment/Description/2/0 + + + +Short description of the time series segment. +|[] + + + + +|0..1 + + + +|[Prop] + + + +RecordCount +|https://admin-shell.io/idta/TimeSeries/Segment/RecordCount/2/0 + + + +Indicates how many records are present in a segment. +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +StartTime +|https://admin-shell.io/idta/TimeSeries/Segment/StartTime/2/0 + + + +Contains the first recorded timestamp of the time series segment and thus represents the beginning of a time series. Time format and scale corresponds to that of the time series. +|[String] + + + + +|0..1 + + + +|[Prop] + + + +EndTime +|https://admin-shell.io/idta/TimeSeries/Segment/EndTime/2/0 + + + + +|[String] + + + + +|0..1 + + + +|[Prop] + + + +Duration +|https://admin-shell.io/idta/TimeSeries/Segment/Duration/2/0 + + + +Period covered by the segment, represented according to ISO 8601 by the format P[n]Y[n]M[n]DT[n]H[n]M[n]S +|[String] + + + + +|0..1 + + + +|[Prop] + + + +SamplingInterval +|https://admin-shell.io/idta/TimeSeries/Segment/SamplingInterval/2/0 + + + +The time period between two time series records (Length of cycle). +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +SamplingRate +|https://admin-shell.io/idta/TimeSeries/Segment/SamplingRate/2/0 + + + +Defines the number of samples per second for a regular time series in Hz. +|[Long] + + + + +|0..1 + + + +|[Prop] + + + +State +|https://admin-shell.io/idta/TimeSeries/Segment/State/2/0 + + + +State of the time series related to its progress +|[String] + + + + +|0..1 + + + +|[Prop] + + + +LastUpdate +|https://admin-shell.io/idta/TimeSeries/Segment/LastUpdate/2/0 + + + +Time of the last chance +|[String] + + + + +|0..1 + + + +|[File] + + + +File +|https://admin-shell.io/idta/TimeSeries/File/2/0 + + + +Sequence of data points in sequential order over a period of time within a paged data file +|[] + + + + +|0..1 + + + +|[Prop] + + + +Endpoint +|https://admin-shell.io/idta/TimeSeries/Endpoint/2/0 + + + +Specifies a location of a resource on an API server through which time series can be requested +|[String] + + + + +|0..1 + + + +|[Prop] + + + +Query +|https://admin-shell.io/idta/TimeSeries/Query/2/0 + + + +generic query component to read time series data from an API +|[String] + + + + +|0..1 + + + +|[Blob] + + + +Blob +| + + + + +|[] + + + +0 bytes +|0..1 + + + +|=== + + + + +=== Example Timestamp definitions +[width="100%", title="Example Timestamp definitions", cols="15%,55%,30%"] +|=== +s|{set:cellbgcolor:#eeeeee} [SME type] 001 +s|semanticId = [idType]value +s|[valueType] +s|{set:cellbgcolor:#0029cc}idShort +s|Description@en +s|example +| +[{set:cellbgcolor:#ffffff}[Property] +UtcTime +| +[IRI] https://admin-shell.io/idta/TimeSeries/UtcTime/1/1 +or [IRDI] 0112/2///61360_4#ADA387#001 +preferredName @de: Zeitstempel UTC +preferredName @en: Timestamp UTC +definition @de: Zeitstempel nach ISO 8601 auf der Zeitskala der koordinierten Weltzeit (UTC). +definition@en: Timestamp according to ISO 8601 on the timescale ccordinated universal time (UTC). +| +[xs:dateTimeTIMESTSAMP] + +2020-09-19T14:40:38.318 +| +[Property] +TaiTime +| +[IRI] https://admin-shell.io/idta/TimeSeries/TaiTime/1/1 +or [IRDI] 0112/2///61360_4#ADA386#001 +preferredName @de: Zeitstempel TAI +preferredName @en: Timestamp TAI +definition @de: Zeitstempel nach ISO 8601 auf der Zeitskala internationale Atomzeit (TAI). +definition@en: Timestamp according to ISO 8601 on the timescale international atomic time (TAI). +| +[xs:dateTimeTIMESTSAMP] + +2020-09-19T14:40:38.318 +| +[Property] +RelativeTimePoint +| +[IRI] https://admin-shell.io/idta/TimeSeries/RelativeTimePoint/1/1 +preferredName @de: Zeitstempel +preferredName @en: Timestamp +definition @de: Zeitpunktangabe in Sekunden. Zeitpunkte referenzieren auf die Startzeit des Zeitreihensegments. +definition@en: Point of Time in seconds. Time points refer to the start time of the time series segment. +| +[REAL_MEASURE] + +5 s +| +[Property] +RelativeTimeDuration +| +[IRI] [IRI] https://admin-shell.io/idta/TimeSeries/RelativeTimeDuration/1/1 +or [IRDI] 0112/2///61360_4#AAE028#001 +preferredName @de: Zeitdauer +preferredName @en: Timeduration +definition @de: Angabe der zeitlichen Dauer in Sekunden (Anzahl der Sekunden). Zeitdauern referenzieren auf den jeweils vorangegangenen Eintrag im Zeitreihensegment. +definition@en: Time duration specification in seconds (number of seconds). Time durations refer to the previous entry in the time series segment. +| +[REAL_MEASURE] + +5 s +|=== + + + + +=== Example qualifiers +[width="100%", title="Example Qualifiers", cols="15%,55%,30%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#Qualifier/type# +s| [white]#Qualifier/semanticId# +s| [white]#Qualifier/value# +| +[{set:cellbgcolor:#ffffff}[Property] +ValueQualityQualifier +| +[IRDI] 0112/2///61360_4#ADA350 +qualifier that specifies the quality of the value of a data element type +Notice - The quality of the data values can be of value in a time series analysis. This allows bad data values to be omitted from aggregations or calculations. +| +0112/2///61360_7#CTA052 - good +0112/2///61360_7#CTA053 - bad +0112/2///61360_7#CTA054 - uncertain +0112/2///61360_7#CTA000 - others +| +ValueOriginQualifier +| +[IRDI] 0112/2///61360_4#AAF582 +qualifier that specifies the type of data capturing or generation for the provided value +Notice - Information about the type of data collection or generation for the value provided. +| +0112/2///61360_7#CTA004 - calculated +0112/2///61360_7#CTA005 - estimated +0112/2///61360_7#CTA006 - measured +0112/2///61360_7#CTA007 - set +0112/2///61360_7#CTA000 - others +| +ValueProcessingQualifier +| +[IRDI] 0112/2///61360_4#AAF583#002qualifier that specifies a method of selecting or computing a representative value from more than one valueNotice - Information about the method of preprocessing the value provided. +| +0112/2///61360_7#CTA008 - arithmetic mean +0112/2///61360_7#CTA009 - geometric mean +0112/2///61360_7#CTA010 - harmonic mean +0112/2///61360_7#CTA011 - median +0112/2///61360_7#CTA012 - mode +0112/2///61360_7#CTA013 - root mean square +0112/2///61360_7#CTA014 - weighted arithmetic mean +0112/2///61360_7#CTA015 - weighted geometric mean +0112/2///61360_7#CTA000 - others +| +[Qualifier] +MeasurementModelQualifier +| +[IRI] https://admin-shell.io/idta/TimeSeries/Qualifier/MeasurementModel/1/1 +qualifier that specifies whether there is an absolute measurement, or whether the value is to be seen as additive to the previous measurement +Notice - Information about whether there is an absolute measurement, or it must be considered additive. +| +https://admin-shell.io/idta/TimeSeries/Qualifier/MeasurementModel/Absolute/1/1 - absolute +https://admin-shell.io/idta/TimeSeries/Qualifier/MeasurementModel/Incremental/1/1 - incremental +|=== + +=== Outlook on Time Series Operations – not normative yet +The defined Submodel offers more flexibility due to the different modeling approaches for time series segments, but this can lead to limitations in interoperability. I4.0 applications (defined in [7]) that access time series data may have to deal with proprietary systems and data formats (Figure 9). + +image::Figure_10.png[id="Figure_10", width="100.0%",title="Data access without operations"] + +Asset Administration Shells and Submodels offer Operations to specify a generic way to describe functional interfaces. This allows implementations of the AAS/SM to provide, as in this case, convenience operations or additional business functionality. + +In our case we would like to simplify the identification of the data of interest: + +* ReadSegments, ReadRecords provide access to physically existing data by filtering Segments / Records by time range. +* DeriveSegment perform additional computation by rearranging / aggregating existing data to meet the use case needs. + +Since Operations may operate in many Segments, we decided to model them directly on the entry point of the time series Submodel. This additionally simplifies access since no navigation to child elements is required. Implementations should hide the complexity of combining data from different source aka. Segment types (Internal, Linked, External). + +This approach enables I4.0 applications to access Time Series Data interoperably, regardless of storage location and format. However, the mapping and access must be programmed in the AAS for this (see Figure 10). + + +image::Figure_11.png[id="Figure_11", width="100.0%",title="Data access with operations"] + +[width="100%", id="Table_Submodel", title="Outlook on Submodel Template TimeSeries with Operations", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+|{set:cellbgcolor:#eeeeee}TimeSeries + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee} Submodel +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee} [IRI] https://admin-shell.io/idta/TimeSeries/1/1 +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee} + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}@de: Enthält Zeitreihendaten und Referenzen auf Zeitreihendaten, um diese entlang des Asset Lebenszyklus aufzufinden und semantisch zu beschreiben. + +@en: Contains time series data and references to time series data to discover and semantically describe them along the asset lifecycle. +s|{set:cellbgcolor:#bfbfbf} [blue]#[SME type]# +s|{set:cellbgcolor:#bfbfbf} [blue]#semanticId = [idType]value# +s|{set:cellbgcolor:#bfbfbf} [blue]#[valueType]# +s|{set:cellbgcolor:#bfbfbf} [blue]#card.# + +s|{set:cellbgcolor:#0029cc} [white]#idShort# +s|{set:cellbgcolor:#0029cc} [white]#Description@en# +s|{set:cellbgcolor:#0029cc} [white]#example# +s|{set:cellbgcolor:#0029cc} +s|[white]#[SMC] +Metadata# +|{set:cellbgcolor:#eeeeee}[IRI] https://admin-shell.io/idta/TimeSeries/Metadata/1/1 +preferredName @de: Zeitreihen Metadaten + +preferredName @en: time series metadata + +definition @de: Eine Reihe von Daten, welche die Zeitreihe beschreiben und über sie Auskunft geben + +definition @en: A set of data describing and providing information about the time series +|n/a +|1 +s|{set:cellbgcolor:#0029cc} [white]#[SMC] +Segments# +|{set:cellbgcolor:#eeeeee}[IRI] https://admin-shell.io/idta/TimeSeries/Segments/1/1 +preferredName @de: Zeitreihensegmente + +preferredName @en: time series segments + +definition @de: Enthält Segmente einer Zeitreihe + +definition @en: Contains segments of a time series +|n/a +|1 +s|{set:cellbgcolor:#0029cc} [white]#[Opr] +DeriveSegments# +|{set:cellbgcolor:#eeeeee}[IRI] https://admin-shell.io/idta/TimeSeries/DeriveSegments/1/1 + +Computes a Segment containig all the Records from all Segments of the given timespan. Optionally, the Records can be aggregated in different ways to reduce the amount of data. +|n/a +|0..1 +s|{set:cellbgcolor:#0029cc} [white]#[Opr] +ReadRecords# +|{set:cellbgcolor:#eeeeee}[IRI] https://admin-shell.io/idta/TimeSeries/ReadRecords/1/1 +|n/a +|0..1 +s|{set:cellbgcolor:#0029cc} [white]#[Opr] +ReadSegments# +|{set:cellbgcolor:#eeeeee}[IRI] https://admin-shell.io/idta/TimeSeries/ReadSegments/1/1 +|n/a +|0..1 +|=== +[width="100%", id="Table_Submodel", title="Outlook on Submodel Template TimeSeries with Operations", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+|{set:cellbgcolor:#eeeeee}DeriveSegment + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee} Operation +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee} [IRI] https://admin-shell.io/idta/TimeSeries/DeriveSegment/1/1 +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee} Submodel TimeSeries + +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee}@de: Berechnet ein Segment, das alle Datensätze aus allen Segmenten der angegebenen Zeitspanne enthält. Optional können die Datensätze auf verschiedene Arten aggregiert werden, um die Datenmenge zu reduzieren. + +@en: Computes a Segment containig all the Records from all Segments of the given timespan. Optionally, the Records can be aggregated in different ways to reduce the amount of data. + +s|{set:cellbgcolor:#bfbfbf} [blue]#[Variable kind / Variable value type]# +s|{set:cellbgcolor:#bfbfbf} [blue]#semanticId = [idType]value# +s|{set:cellbgcolor:#bfbfbf} [blue]#[valueType]# +s|{set:cellbgcolor:#bfbfbf} [blue]#card.# + +s|{set:cellbgcolor:#0029cc} [white]#idShort# +s|{set:cellbgcolor:#0029cc} [white]#Description@en# +s|{set:cellbgcolor:#0029cc} [white]#example# +s|{set:cellbgcolor:#0029cc} +s|[white]#[IN / Range] +Timespan# +|{set:cellbgcolor:#eeeeee} +[IRI] https://admin-shell.io/idta/TimeSeries/Timespan/1/1 + +preferredName @de: Zeitspanne + +preferredName @en: Timespan + +@de: Der valueType der übergebenen Zeitspanne muss mit dem valueType der Time Properties der Segemente übereinstimmen. + +@en: The valueType of the given timespan must match the valueType of the time properties of the segments. + +|n/a +|1 +s|{set:cellbgcolor:#0029cc} [white]#[IN / Property] +SamplingInterval# +|{set:cellbgcolor:#eeeeee} +[IRI] https://admin-shell.io/idta/TimeSeries/Segment/SamplingInterval/1/1 + +Note: A different semantic ID is to be used to select the appropriate scale and format (eg. min, s, ms, Hz, …). + +preferredName @de: Abtastintervall + +preferredName @en: Sampling Interval + +definition @de: Der zeitliche Abstand zwischen zwei Datenpunkten (Länge eines Zyklus). + +definition @en: The time period between two time series records (Length of cycle). + +|long + +5 Hz +|0..1 +s|{set:cellbgcolor:#0029cc} [white]#[IN / Property] +AggregationMethod# + +|{set:cellbgcolor:#eeeeee} +[IRI] https://admin-shell.io/idta/TimeSeries/AggregationMethod/1/1 + +@de: Methode zur Aggregation der Daten. Muss zusammen mit SampleInterval übergeben werden. + +@en: Method to aggregate data. Only valid in combination with SamplingInterval. + +Value List: + +- Max (Selects the largest data points) +- Min (Selects the smallest data points) +- Avg (Averages the data points) +- Sum (Adds the data points together) +- Count (The number of raw data points in the set) + +Note – for documentation and further value lists see http://opentsdb.net/docs/build/html/user_guide/query/aggregators.html + + +|n/a +|0..1 +s|{set:cellbgcolor:#0029cc} [white]#[OUT / SMC] +Segment# +|{set:cellbgcolor:#eeeeee} +[IRI] https://admin-shell.io/idta/TimeSeries/Segments/InternalSegment/1/1 + +Note – Record IDs must be unique across segments. +|n/a +|1 +s|{set:cellbgcolor:#0029cc} [white]#[Opr] +|=== +[width="100%", id="Table_Submodel", title="Outlook on Submodel Template TimeSeries with Operations", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+|{set:cellbgcolor:#eeeeee}ReadRecords + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee} Operation +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee} [IRI] https://admin-shell.io/idta/TimeSeries/ReadRecords/1/1 +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee} +Submodel TimeSeries +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee} +@de: Liefert alle Records über alle Segmente, die innerhalb der übergebenen Zeitspanne liegen. Etwaige Unterschiede bzgl. Abtastrate, Zeitintervallen, etc. werden nicht berücksichtigt. + +@en: Returns all records of all segments that are within the given time span. Any differences in sampling rate, time intervals, etc. are not considered. + +s|{set:cellbgcolor:#bfbfbf} [blue]#[Variable kind / Variable value type]# +s|{set:cellbgcolor:#bfbfbf} [blue]#semanticId = [idType]value# +s|{set:cellbgcolor:#bfbfbf} [blue]#[valueType]# +s|{set:cellbgcolor:#bfbfbf} [blue]#card.# + +s|{set:cellbgcolor:#0029cc} [white]#idShort# +s|{set:cellbgcolor:#0029cc} [white]#Description@en# +s|{set:cellbgcolor:#0029cc} [white]#example# +s|{set:cellbgcolor:#0029cc} +s|[white]#[IN / Range] +Timespan# +|{set:cellbgcolor:#eeeeee} +[IRI] +https://admin-shell.io/idta/TimeSeries/Timespan/1/1 + +preferredName @de: Zeitspanne + +preferredName @en: Timespan + +@de: Der valueType der übergebenen Zeitspanne muss mit dem valueType der Time Properties der Records übereinstimmen. + +@en: The valueType of the given timespan must match the valueType of the time properties of the Records. + +|n/a +|1 +s|{set:cellbgcolor:#0029cc} [white]#[OUT] +Records# +|{set:cellbgcolor:#eeeeee} +[IRI] https://admin-shell.io/idta/TimeSeries/Records/1/1 + +@de: Records, die innerhalb der übergebenen Zeitspanne liegen. + +@en: Segments that overlap with the passed period. + +|n/a +|0..* +|=== +[width="100%", id="Table_Submodel", title="Outlook on Submodel Template TimeSeries with Operations", cols="15%,55%,15%,15%"] +|=== +s|{set:cellbgcolor:#0029cc} [white]#idShort:# +3+|{set:cellbgcolor:#eeeeee}ReadSegments + +s|{set:cellbgcolor:#0029cc} [white]#Class:# +3+|{set:cellbgcolor:#eeeeee} Operation +s|{set:cellbgcolor:#0029cc} [white]#semanticId:# +3+|{set:cellbgcolor:#eeeeee} [IRI] https://admin-shell.io/idta/TimeSeries/ReadSegments/1/1 +s|{set:cellbgcolor:#0029cc} [white]#Parent:# +3+|{set:cellbgcolor:#eeeeee} +Submodel TimeSeries +s|{set:cellbgcolor:#0029cc} [white]#Explanation:# +3+|{set:cellbgcolor:#eeeeee} +@de: Liefert alle Segmente, deren Zeitspanne sich mit der übergebenen Periode überschneiden, ohne die enthaltenen Records zu filtern. Getroffene Segmente werden komplett zurückgegeben. + +@en: Returns all segments whose timespan overlaps the given period without filtering the records contained. Hit segments are returned in full. + +s|{set:cellbgcolor:#bfbfbf} [blue]#[Variable kind / Variable value type]# +s|{set:cellbgcolor:#bfbfbf} [blue]#semanticId = [idType]value# +s|{set:cellbgcolor:#bfbfbf} [blue]#[valueType]# +s|{set:cellbgcolor:#bfbfbf} [blue]#card.# + +s|{set:cellbgcolor:#0029cc} [white]#idShort# +s|{set:cellbgcolor:#0029cc} [white]#Description@en# +s|{set:cellbgcolor:#0029cc} [white]#example# +s|{set:cellbgcolor:#0029cc} +s|[white]#[IN / Range] +Timespan# +|{set:cellbgcolor:#eeeeee} +[IRI] https://admin-shell.io/idta/TimeSeries/Timespan/1/1 + +preferredName @de: Zeitspanne + +preferredName @en: Timespan + +@de: Der valueType der übergebenen Zeitspanne muss mit dem valueType der Time Properties der Segemente übereinstimmen. + +@en: The valueType of the given timespan must match the valueType of the time properties of the Segments. + +|n/a +|1 +s|{set:cellbgcolor:#0029cc} [white]#[OUT / SMC] +Segments# +|{set:cellbgcolor:#eeeeee} +[IRI] https://admin-shell.io/idta/TimeSeries/Segments/1/1 + +preferredName @de: Segments + +preferredName @en: Segments + +@de: Enthält Segmente, die sich zumindest teilweise mit der übergebenen Periode überschneiden. + +@en: Contains segments that at least partially overlap with the passed period. +|n/a +|0..* +|=== +:sectnums!: + +== Annex A. Explanations on used table formats + +=== 1. General + +The used tables in this document try to outline information as concise as possible. They do not convey all information on Submodels and SubmodelElements. For this purpose, the definitive definitions are given by a separate file in form of an AASX file of the Submodel template and its elements. + +=== 2. Tables on Submodels and SubmodelElements + +For clarity and brevity, a set of rules is used for the tables for describing Submodels and SubmodelElements. + +* The tables follow in principle the same conventions as in [5]. +* The table heads abbreviate 'cardinality' with 'card'. +* The tables often place two informations in different rows of the same table cell. In this case, the first information is marked out by sharp brackets [] form the second information. A special case are the semanticIds, which are marked out by the format: (type)(local)[idType]value. +* The types of SubmodelElements are abbreviated: + +[width="100%",cols="40%,60%",options="header"] +|=== +|SME type |SubmodelElement type +|Property |Property +|MLP |MultiLanguageProperty +|Range |Range +|File |File +|Blob |Blob +|Ref |ReferenceElement +|Rel |RelationshipElement +|SMC |SubmodelElementCollection +|=== + +* If an idShort ends with '\__00__', this indicates a suffix of the respective length (here: 2) of decimal digits, in order to make the idShort unique. A different idShort might be choosen, as long as it is unique in the parent’s context. +* The Keys of semanticId in the main section feature only idType and value, such as: https://admin-shell.io/vdi/2770/1/0/DocumentId/Id. The attribute "type" (typically "ConceptDescription" and "(local)" or "GlobalReference") need to be set accordingly; see [6]. +* If a table does not contain a column with "parent" heading, all represented attributes share the same parent. This parent is denoted in the head of the table. +* Multi-language strings are represented by the text value, followed by '@'-character and the ISO 639 language code: example@EN. +* The [valueType] is only given for Properties. + + + + +:sectnums!: + +== Bibliography + +[width="100%",cols="10%,90%", frame=none, grid=none] +|=== + +|[1] |“Recommendations for implementing the strategic initiative +INDUSTRIE 4.0”, acatech, April 2013. [Online]. Available +https://www.acatech.de/Publikation/recommendations-for-implementing-the-strategic-initiative-industrie-4-0-final-report-of-the-industrie-4-0-working-group/ + +|[2] |“Implementation Strategy Industrie 4.0: Report on the results of +the Industrie 4.0 Platform”; BITKOM e.V. / VDMA e.V., /ZVEI e.V., April +2015. [Online]. Available: +https://www.bitkom.org/noindex/Publikationen/2016/Sonstiges/Implementation-Strategy-Industrie-40/2016-01-Implementation-Strategy-Industrie40.pdf + +|[3] |“The Structure of the Administration Shell: TRILATERAL +PERSPECTIVES from France, Italy and Germany”, March 2018, [Online]. +Available: +https://www.plattform-i40.de/I40/Redaktion/EN/Downloads/Publikation/hm-2018-trilaterale-coop.html + +|[4] |“Beispiele zur Verwaltungsschale der Industrie 4.0-Komponente – +Basisteil (German)”; ZVEI e.V., Whitepaper, November 2016. [Online]. +Available: +https://www.zvei.org/presse-medien/publikationen/beispiele-zur-verwaltungsschale-der-industrie-40-komponente-basisteil/ + +|[5] |“Verwaltungsschale in der Praxis. Wie definiere ich Teilmodelle, +beispielhafte Teilmodelle und Interaktion zwischen Verwaltungsschalen +(in German)”, Version 1.0, April 2019, Plattform Industrie 4.0 in +Kooperation mit VDE GMA Fachausschuss 7.20, Federal Ministry for +Economic Affairs and Energy (BMWi), Available: +https://www.plattform-i40.de/PI40/Redaktion/DE/Downloads/Publikation/2019-verwaltungsschale-in-der-praxis.html + +|[6] |IDTA 01001-3-0: “Specification of the Asset Administration Shell; Part 1 (Version 3.0)”, March 2023, [Online]. Available: +https://industrialdigitaltwin.org/wp-content/uploads/2023/06/IDTA-01001-3-0_SpecificationAssetAdministrationShell_Part1_Metamodel.pdf + +|[7] |“Semantic interoperability: challenges in the digital +transformation age”; IEC, International Electronical Commission; 2019. +[Online]. Available: +https://basecamp.iec.ch/download/iec-white-paper-semantic-interoperability-challenges-in-the-digital-transformation-age-en/ + +|[8] |Common terms and abbreviations according to VDI FA 7.21 Wiki; Available: http://i40.iosb.fraunhofer.de/ + +|[9] |United States: US Code of Federal regulations, see https://www.ecfr.gov/current/title-22/chapter-I/subchapter-M/part-120/subpart-C/section-120.42 + +|=== +