From 581ddf9b79352ac5dbfc68d9848b14ea8ae8e862 Mon Sep 17 00:00:00 2001 From: Nico Braunisch Date: Sun, 22 Mar 2026 17:32:01 +0100 Subject: [PATCH 01/20] Add Identfier for AID/AIMC --- .../Asset Interface Description/1/2/README.md | 244 ++++++++++++++++++ idta/Asset Interface Description/README.md | 32 +++ idta/README.md | 1 + 3 files changed, 277 insertions(+) create mode 100644 idta/Asset Interface Description/1/2/README.md create mode 100644 idta/Asset Interface Description/README.md diff --git a/idta/Asset Interface Description/1/2/README.md b/idta/Asset Interface Description/1/2/README.md new file mode 100644 index 0000000..d55d7f3 --- /dev/null +++ b/idta/Asset Interface Description/1/2/README.md @@ -0,0 +1,244 @@ +# Asset Interfaces Description – Identifiers + +This Submodel specifies an information model and a common representation for describing the interface(s) of an asset service or asset related service. Based on this information, it is possible to initiate a connection to such kind of service and start to request or subscribe to served datapoints, and/or perform operations + + + +## Introduction + +The Asset Interfaces Description (AID) in version 1.2 supports the description of interfaces based on following specific protocols: +* Modbus +* HTTP +* MQTT +* OPC UA +* BACnet +Informative, the IO-Link protocol that is bridged to REST/HTTP and PROFINET is introduced in AID 1.2 in Annex B. Any other protocols and interfaces will be addressed in upcoming versions of the AID. +The W3C Web of Things Thing Description (WoT TD) as an open, royalty-free standard is considered as a baseline for the content and structure of the definition of this Submodel template. The protocol-specific information is taken from the official WoT bindings that are maintained by the W3C or other SDOs like the OPC Foundation (e.g., OPC 10101 for OPC UA Binding). +In addition to the protocol specific information provided by the AID, it also provides the ability to reference external descriptors such as GSD, GSDML, IO Device Description, native WoT TD (as a supplement) etc. These external descriptor is not restricted to the protocols currently defined in AID. +As a complement to the AID, an Asset Interfaces Mapping Configuration (AIMC) Submodel can be used to map the received data from the asset services to a specific place within an AAS (e.g. an application specific Submodel to monitor data). The principle scope and use of the AID Submodel in combination with an AIMC + + + +## Status: `Accepted` +The sub-namespace for Asset Interface Description and its identifiers have been finalized in the Taskforce `Asset Interface Description`. + +## Versions: [1.2](3/3) +This version is the third version to be officially published by IDTA Document `IDTA 02017 Asset Interfaces Description`. + + +## Interface (SMC) +This SubmodelElementCollection holds the information for EndpointMetadata, InteractionMetadata and ExternalDescriptor. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/Interface + +### title (Property) +Provides a human-readable title. +https://www.w3.org/2019/wot/td#title + +### created (Property) +Provides creation timestamp. +http://purl.org/dc/terms/created + +### modified (Property) +Provides modification timestamp. +http://purl.org/dc/terms/modified + +### support (Property) +Contact information. +https://www.w3.org/2019/wot/td#support + +### EndpointMetadata (SMC) +Metadata of the interface endpoint. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/EndpointMetadata + +### InteractionMetadata (SMC) +Metadata describing datapoints and functions. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/InteractionMetadata + +### ExternalDescriptor (SMC) +Descriptor file references. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/ExternalDescriptor + +--- + +## EndpointMetadata (SMC) +Holds information about the endpoint. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/EndpointMetadata + +### base (Property) +Defines base URI. +https://www.w3.org/2019/wot/td#baseURI + +### contentType (Property) +Defines content type. +https://www.w3.org/2019/wot/hypermedia#forContentType + +### security (SML) +Security configuration. +https://www.w3.org/2019/wot/td#hasSecurityConfiguration + +### modv_mostSignificantByte (Property) +Modbus byte order. +https://www.w3.org/2019/wot/modbus#hasMostSignificantByte + +### modv_mostSignificantWord (Property) +Modbus word order. +https://www.w3.org/2019/wot/modbus#hasMostSignificantWord + +### securityDefinitions (SMC) +Security scheme definitions. +https://www.w3.org/2019/wot/td#definesSecurityScheme + +--- + +## InteractionMetadata (SMC) +Defines interaction affordances. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/InteractionMetadata + +### properties (SMC) +Datapoint definitions. +https://www.w3.org/2019/wot/td#PropertyAffordance + +### actions (SMC) +Function definitions. +https://www.w3.org/2019/wot/td#ActionAffordance + +### events (SMC) +Event definitions. +https://www.w3.org/2019/wot/td#EventAffordance + +--- + +## properties (SMC) +Collection of interaction properties. +https://www.w3.org/2019/wot/td#hasPropertyAffordance + +--- + +## property_name (SMC) +Defines datapoint characteristics. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/PropertyDefinition + +### key (Property) +Optional key. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/key + +### title (Property) +Human-readable title. +https://www.w3.org/2019/wot/td#title + +### observable (Property) +Observation indicator. +https://www.w3.org/2019/wot/td#isObservable + +### forms (SMC) +Resource locations. +https://www.w3.org/2019/wot/td#hasForm + +### type (Property) +Datatype indicator. +https://www.w3.org/1999/02/22-rdf-syntax-ns#type + +### const (Property) +Constant value. +https://www.w3.org/2019/wot/json-schema#const + +### enum (SML) +Restricted value list. +https://www.w3.org/2019/wot/json-schema#enum + +### default (Property) +Default value. +https://www.w3.org/2019/wot/json-schema#default + +### unit (Property) +Measurement unit. +https://schema.org/unitCode + +### min_max (Range) +Numeric limits. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/minMaxRange + +### lengthRange (Range) +String length range. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/lengthRange + +### itemsRange (Range) +Array length limits. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/itemsRange + +### items (SMC) +Array item schema. +https://www.w3.org/2019/wot/json-schema#items + +### valueSemantics (Ref) +Semantic meaning. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/valueSemantics + +--- + +## ExternalDescriptor (SMC) +Reference to external descriptors. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/ExternalDescriptor + +### descriptorName (File) +Descriptor filename. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/externalDescriptorName + +--- + +## IO-Link specific identifiers + +### hasMethod (Property) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/hasMethod + +### hasPayloadDataType (Property) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/hasPayloadDataType + +### hasAccessRights (Property) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/hasAccessRights + +### byteOffset (Property) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/byteOffset + +### byteLength (Property) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/byteLength + +### bitOffset (Property) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/bitOffset + +### bitLength (Property) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/bitLength + +### hasPayloadMapping (SML) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/hasPayloadMapping + +### referenceToProperty (Ref) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/referenceToProperty + +### hasEnumeratedValues (SML) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/hasEnumeratedValues + +### enumeratedValue (SMC) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/enumeratedValue + +### encodedPayload (Property) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/encodedPayload + +### decodedPayload (Property) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/decodedPayload + +--- + +## Interface supplementalSemanticIds + +### SNMP +https://admin-shell.io/idta/AssetInterfacesDescription/1/2/SNMP + +### CAN +https://admin-shell.io/idta/AssetInterfacesDescription/1/2/CAN + +## Contact + +This sub-namespace is proposed by [IDTA Working Group Nameplate for Asset Interface Description](https://github.com/admin-shell-io/submodel-templates/tree/main/published/Asset%20Interfaces%20Description). +See also [IDTA Registered AAS Submodel Templates](https://industrialdigitaltwin.org/content-hub/teilmodelle#:~:text=Software%20Nameplate) or contact via email the [IDTA project manager for submodel templates](mailto:sudip.adhikari@idtwin.org) or [chair of the working group](mailto:sebastian.kaebisch@siemens.com). + diff --git a/idta/Asset Interface Description/README.md b/idta/Asset Interface Description/README.md new file mode 100644 index 0000000..593dab2 --- /dev/null +++ b/idta/Asset Interface Description/README.md @@ -0,0 +1,32 @@ +# Asset Inferface Description + + +This Submodel specifies an information model and a common representation for describing the interface(s) of an asset service or asset related service. Based on this information, it is possible to initiate a connection to such kind of service and start to request or subscribe to served datapoints, and/or perform operations + + + +## Introduction + +The Asset Interfaces Description (AID) in version 1.2 supports the description of interfaces based on following specific protocols: +* Modbus +* HTTP +* MQTT +* OPC UA +* BACnet +Informative, the IO-Link protocol that is bridged to REST/HTTP and PROFINET is introduced in AID 1.2 in Annex B. Any other protocols and interfaces will be addressed in upcoming versions of the AID. +The W3C Web of Things Thing Description (WoT TD) as an open, royalty-free standard is considered as a baseline for the content and structure of the definition of this Submodel template. The protocol-specific information is taken from the official WoT bindings that are maintained by the W3C or other SDOs like the OPC Foundation (e.g., OPC 10101 for OPC UA Binding). +In addition to the protocol specific information provided by the AID, it also provides the ability to reference external descriptors such as GSD, GSDML, IO Device Description, native WoT TD (as a supplement) etc. These external descriptor is not restricted to the protocols currently defined in AID. +As a complement to the AID, an Asset Interfaces Mapping Configuration (AIMC) Submodel can be used to map the received data from the asset services to a specific place within an AAS (e.g. an application specific Submodel to monitor data). The principle scope and use of the AID Submodel in combination with an AIMC + + + +## Status: `Accepted` +The sub-namespace for Asset Interface Description and its identifiers have been finalized in the Taskforce `Asset Interface Description`. + +## Versions: [1.2](3/3) +This version is the third version to be officially published by IDTA Document `IDTA 02017 Asset Interfaces Description`. + +## Contact + +This sub-namespace is proposed by [IDTA Working Group Nameplate for Asset Interface Description](https://github.com/admin-shell-io/submodel-templates/tree/main/published/Asset%20Interfaces%20Description). +See also [IDTA Registered AAS Submodel Templates](https://industrialdigitaltwin.org/content-hub/teilmodelle#:~:text=Software%20Nameplate) or contact via email the [IDTA project manager for submodel templates](mailto:sudip.adhikari@idtwin.org) or [chair of the working group](mailto:sebastian.kaebisch@siemens.com). diff --git a/idta/README.md b/idta/README.md index 55cd8f8..9f8e9cf 100644 --- a/idta/README.md +++ b/idta/README.md @@ -8,6 +8,7 @@ This sub-namespace collects the identifiers defined in working groups of the IDT - [Provision of simulation models](SimulationModels) - [Nameplate for Software in Manufacturing](SoftwareNameplate) - [Inspection Documents of Steel Products](InspectionDocumentsOfSteelProducts) +- [Asset Inferface Description](Asset Inferface Description) ## Contact This sub-namespace is proposed by [IDTA Working Groups](https://github.com/admin-shell-io/submodel-templates). See also [IDTA Registered AAS Submodel Templates](https://industrialdigitaltwin.org/content-hub/teilmodelle) or contact via email the [IDTA project manager for submodel templates](mailto:sudip.adhikari@idtwin.org). From 461ad34f038e925275d2e88c6c204fd18059ee52 Mon Sep 17 00:00:00 2001 From: Nico Braunisch Date: Sun, 22 Mar 2026 17:33:01 +0100 Subject: [PATCH 02/20] Update README with IO-Link and AIMC details Added information about the IO-Link protocol and its integration with REST/HTTP and PROFINET, along with details on external descriptors and the Asset Interfaces Mapping Configuration (AIMC) Submodel. --- idta/Asset Interface Description/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/idta/Asset Interface Description/README.md b/idta/Asset Interface Description/README.md index 593dab2..38fe619 100644 --- a/idta/Asset Interface Description/README.md +++ b/idta/Asset Interface Description/README.md @@ -13,6 +13,7 @@ The Asset Interfaces Description (AID) in version 1.2 supports the description o * MQTT * OPC UA * BACnet + Informative, the IO-Link protocol that is bridged to REST/HTTP and PROFINET is introduced in AID 1.2 in Annex B. Any other protocols and interfaces will be addressed in upcoming versions of the AID. The W3C Web of Things Thing Description (WoT TD) as an open, royalty-free standard is considered as a baseline for the content and structure of the definition of this Submodel template. The protocol-specific information is taken from the official WoT bindings that are maintained by the W3C or other SDOs like the OPC Foundation (e.g., OPC 10101 for OPC UA Binding). In addition to the protocol specific information provided by the AID, it also provides the ability to reference external descriptors such as GSD, GSDML, IO Device Description, native WoT TD (as a supplement) etc. These external descriptor is not restricted to the protocols currently defined in AID. From c8c12459d7a2977ac1ce6d2010d2e3a38531683f Mon Sep 17 00:00:00 2001 From: Nico Braunisch Date: Sun, 22 Mar 2026 17:34:20 +0100 Subject: [PATCH 03/20] Fix grammar and clarity in README.md Corrected grammatical errors and improved clarity in the README. --- idta/Asset Interface Description/1/2/README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/idta/Asset Interface Description/1/2/README.md b/idta/Asset Interface Description/1/2/README.md index d55d7f3..c612450 100644 --- a/idta/Asset Interface Description/1/2/README.md +++ b/idta/Asset Interface Description/1/2/README.md @@ -1,21 +1,22 @@ # Asset Interfaces Description – Identifiers -This Submodel specifies an information model and a common representation for describing the interface(s) of an asset service or asset related service. Based on this information, it is possible to initiate a connection to such kind of service and start to request or subscribe to served datapoints, and/or perform operations +This Submodel specifies an information model and a common representation for describing the interface(s) of an asset service or asset-related service. Based on this information, it is possible to initiate a connection to such a service and start to request or subscribe to served datapoints, and/or perform operations ## Introduction -The Asset Interfaces Description (AID) in version 1.2 supports the description of interfaces based on following specific protocols: +The Asset Interfaces Description (AID) in version 1.2 supports the description of interfaces based on the following specific protocols: * Modbus * HTTP * MQTT * OPC UA * BACnet + Informative, the IO-Link protocol that is bridged to REST/HTTP and PROFINET is introduced in AID 1.2 in Annex B. Any other protocols and interfaces will be addressed in upcoming versions of the AID. The W3C Web of Things Thing Description (WoT TD) as an open, royalty-free standard is considered as a baseline for the content and structure of the definition of this Submodel template. The protocol-specific information is taken from the official WoT bindings that are maintained by the W3C or other SDOs like the OPC Foundation (e.g., OPC 10101 for OPC UA Binding). -In addition to the protocol specific information provided by the AID, it also provides the ability to reference external descriptors such as GSD, GSDML, IO Device Description, native WoT TD (as a supplement) etc. These external descriptor is not restricted to the protocols currently defined in AID. -As a complement to the AID, an Asset Interfaces Mapping Configuration (AIMC) Submodel can be used to map the received data from the asset services to a specific place within an AAS (e.g. an application specific Submodel to monitor data). The principle scope and use of the AID Submodel in combination with an AIMC +In addition to the protocol-specific information provided by the AID, it also provides the ability to reference external descriptors such as GSD, GSDML, IO Device Description, native WoT TD (as a supplement), etc. These external descriptors are not restricted to the protocols currently defined in AID. +As a complement to the AID, an Asset Interfaces Mapping Configuration (AIMC) Submodel can be used to map the received data from the asset services to a specific place within an AAS (e.g., an application-specific Submodel to monitor data). The principal scope and use of the AID Submodel in combination with an AIMC From 49e798bc6699f919e7d0781a730f7a858c742509 Mon Sep 17 00:00:00 2001 From: Nico Braunisch Date: Sun, 22 Mar 2026 17:35:10 +0100 Subject: [PATCH 04/20] Fix typo in Asset Interface Description link Fix link --- idta/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/idta/README.md b/idta/README.md index 9f8e9cf..69642c5 100644 --- a/idta/README.md +++ b/idta/README.md @@ -8,7 +8,7 @@ This sub-namespace collects the identifiers defined in working groups of the IDT - [Provision of simulation models](SimulationModels) - [Nameplate for Software in Manufacturing](SoftwareNameplate) - [Inspection Documents of Steel Products](InspectionDocumentsOfSteelProducts) -- [Asset Inferface Description](Asset Inferface Description) +- [Asset Inferface Description](AssetInferfaceDescription) ## Contact This sub-namespace is proposed by [IDTA Working Groups](https://github.com/admin-shell-io/submodel-templates). See also [IDTA Registered AAS Submodel Templates](https://industrialdigitaltwin.org/content-hub/teilmodelle) or contact via email the [IDTA project manager for submodel templates](mailto:sudip.adhikari@idtwin.org). From f3b0fe50ca67f6fcce8d65620d29376104e2c743 Mon Sep 17 00:00:00 2001 From: Nico Braunisch Date: Sun, 22 Mar 2026 17:37:57 +0100 Subject: [PATCH 05/20] Fix Pluaral S --- .../Asset Interface Description/1/2/README.md | 245 ------------------ idta/Asset Interface Description/README.md | 33 --- idta/README.md | 2 +- 3 files changed, 1 insertion(+), 279 deletions(-) delete mode 100644 idta/Asset Interface Description/1/2/README.md delete mode 100644 idta/Asset Interface Description/README.md diff --git a/idta/Asset Interface Description/1/2/README.md b/idta/Asset Interface Description/1/2/README.md deleted file mode 100644 index c612450..0000000 --- a/idta/Asset Interface Description/1/2/README.md +++ /dev/null @@ -1,245 +0,0 @@ -# Asset Interfaces Description – Identifiers - -This Submodel specifies an information model and a common representation for describing the interface(s) of an asset service or asset-related service. Based on this information, it is possible to initiate a connection to such a service and start to request or subscribe to served datapoints, and/or perform operations - - - -## Introduction - -The Asset Interfaces Description (AID) in version 1.2 supports the description of interfaces based on the following specific protocols: -* Modbus -* HTTP -* MQTT -* OPC UA -* BACnet - -Informative, the IO-Link protocol that is bridged to REST/HTTP and PROFINET is introduced in AID 1.2 in Annex B. Any other protocols and interfaces will be addressed in upcoming versions of the AID. -The W3C Web of Things Thing Description (WoT TD) as an open, royalty-free standard is considered as a baseline for the content and structure of the definition of this Submodel template. The protocol-specific information is taken from the official WoT bindings that are maintained by the W3C or other SDOs like the OPC Foundation (e.g., OPC 10101 for OPC UA Binding). -In addition to the protocol-specific information provided by the AID, it also provides the ability to reference external descriptors such as GSD, GSDML, IO Device Description, native WoT TD (as a supplement), etc. These external descriptors are not restricted to the protocols currently defined in AID. -As a complement to the AID, an Asset Interfaces Mapping Configuration (AIMC) Submodel can be used to map the received data from the asset services to a specific place within an AAS (e.g., an application-specific Submodel to monitor data). The principal scope and use of the AID Submodel in combination with an AIMC - - - -## Status: `Accepted` -The sub-namespace for Asset Interface Description and its identifiers have been finalized in the Taskforce `Asset Interface Description`. - -## Versions: [1.2](3/3) -This version is the third version to be officially published by IDTA Document `IDTA 02017 Asset Interfaces Description`. - - -## Interface (SMC) -This SubmodelElementCollection holds the information for EndpointMetadata, InteractionMetadata and ExternalDescriptor. -https://admin-shell.io/idta/AssetInterfacesDescription/1/0/Interface - -### title (Property) -Provides a human-readable title. -https://www.w3.org/2019/wot/td#title - -### created (Property) -Provides creation timestamp. -http://purl.org/dc/terms/created - -### modified (Property) -Provides modification timestamp. -http://purl.org/dc/terms/modified - -### support (Property) -Contact information. -https://www.w3.org/2019/wot/td#support - -### EndpointMetadata (SMC) -Metadata of the interface endpoint. -https://admin-shell.io/idta/AssetInterfacesDescription/1/0/EndpointMetadata - -### InteractionMetadata (SMC) -Metadata describing datapoints and functions. -https://admin-shell.io/idta/AssetInterfacesDescription/1/0/InteractionMetadata - -### ExternalDescriptor (SMC) -Descriptor file references. -https://admin-shell.io/idta/AssetInterfacesDescription/1/0/ExternalDescriptor - ---- - -## EndpointMetadata (SMC) -Holds information about the endpoint. -https://admin-shell.io/idta/AssetInterfacesDescription/1/0/EndpointMetadata - -### base (Property) -Defines base URI. -https://www.w3.org/2019/wot/td#baseURI - -### contentType (Property) -Defines content type. -https://www.w3.org/2019/wot/hypermedia#forContentType - -### security (SML) -Security configuration. -https://www.w3.org/2019/wot/td#hasSecurityConfiguration - -### modv_mostSignificantByte (Property) -Modbus byte order. -https://www.w3.org/2019/wot/modbus#hasMostSignificantByte - -### modv_mostSignificantWord (Property) -Modbus word order. -https://www.w3.org/2019/wot/modbus#hasMostSignificantWord - -### securityDefinitions (SMC) -Security scheme definitions. -https://www.w3.org/2019/wot/td#definesSecurityScheme - ---- - -## InteractionMetadata (SMC) -Defines interaction affordances. -https://admin-shell.io/idta/AssetInterfacesDescription/1/0/InteractionMetadata - -### properties (SMC) -Datapoint definitions. -https://www.w3.org/2019/wot/td#PropertyAffordance - -### actions (SMC) -Function definitions. -https://www.w3.org/2019/wot/td#ActionAffordance - -### events (SMC) -Event definitions. -https://www.w3.org/2019/wot/td#EventAffordance - ---- - -## properties (SMC) -Collection of interaction properties. -https://www.w3.org/2019/wot/td#hasPropertyAffordance - ---- - -## property_name (SMC) -Defines datapoint characteristics. -https://admin-shell.io/idta/AssetInterfacesDescription/1/0/PropertyDefinition - -### key (Property) -Optional key. -https://admin-shell.io/idta/AssetInterfacesDescription/1/0/key - -### title (Property) -Human-readable title. -https://www.w3.org/2019/wot/td#title - -### observable (Property) -Observation indicator. -https://www.w3.org/2019/wot/td#isObservable - -### forms (SMC) -Resource locations. -https://www.w3.org/2019/wot/td#hasForm - -### type (Property) -Datatype indicator. -https://www.w3.org/1999/02/22-rdf-syntax-ns#type - -### const (Property) -Constant value. -https://www.w3.org/2019/wot/json-schema#const - -### enum (SML) -Restricted value list. -https://www.w3.org/2019/wot/json-schema#enum - -### default (Property) -Default value. -https://www.w3.org/2019/wot/json-schema#default - -### unit (Property) -Measurement unit. -https://schema.org/unitCode - -### min_max (Range) -Numeric limits. -https://admin-shell.io/idta/AssetInterfacesDescription/1/0/minMaxRange - -### lengthRange (Range) -String length range. -https://admin-shell.io/idta/AssetInterfacesDescription/1/0/lengthRange - -### itemsRange (Range) -Array length limits. -https://admin-shell.io/idta/AssetInterfacesDescription/1/0/itemsRange - -### items (SMC) -Array item schema. -https://www.w3.org/2019/wot/json-schema#items - -### valueSemantics (Ref) -Semantic meaning. -https://admin-shell.io/idta/AssetInterfacesDescription/1/0/valueSemantics - ---- - -## ExternalDescriptor (SMC) -Reference to external descriptors. -https://admin-shell.io/idta/AssetInterfacesDescription/1/0/ExternalDescriptor - -### descriptorName (File) -Descriptor filename. -https://admin-shell.io/idta/AssetInterfacesDescription/1/0/externalDescriptorName - ---- - -## IO-Link specific identifiers - -### hasMethod (Property) -https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/hasMethod - -### hasPayloadDataType (Property) -https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/hasPayloadDataType - -### hasAccessRights (Property) -https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/hasAccessRights - -### byteOffset (Property) -https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/byteOffset - -### byteLength (Property) -https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/byteLength - -### bitOffset (Property) -https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/bitOffset - -### bitLength (Property) -https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/bitLength - -### hasPayloadMapping (SML) -https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/hasPayloadMapping - -### referenceToProperty (Ref) -https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/referenceToProperty - -### hasEnumeratedValues (SML) -https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/hasEnumeratedValues - -### enumeratedValue (SMC) -https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/enumeratedValue - -### encodedPayload (Property) -https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/encodedPayload - -### decodedPayload (Property) -https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/decodedPayload - ---- - -## Interface supplementalSemanticIds - -### SNMP -https://admin-shell.io/idta/AssetInterfacesDescription/1/2/SNMP - -### CAN -https://admin-shell.io/idta/AssetInterfacesDescription/1/2/CAN - -## Contact - -This sub-namespace is proposed by [IDTA Working Group Nameplate for Asset Interface Description](https://github.com/admin-shell-io/submodel-templates/tree/main/published/Asset%20Interfaces%20Description). -See also [IDTA Registered AAS Submodel Templates](https://industrialdigitaltwin.org/content-hub/teilmodelle#:~:text=Software%20Nameplate) or contact via email the [IDTA project manager for submodel templates](mailto:sudip.adhikari@idtwin.org) or [chair of the working group](mailto:sebastian.kaebisch@siemens.com). - diff --git a/idta/Asset Interface Description/README.md b/idta/Asset Interface Description/README.md deleted file mode 100644 index 38fe619..0000000 --- a/idta/Asset Interface Description/README.md +++ /dev/null @@ -1,33 +0,0 @@ -# Asset Inferface Description - - -This Submodel specifies an information model and a common representation for describing the interface(s) of an asset service or asset related service. Based on this information, it is possible to initiate a connection to such kind of service and start to request or subscribe to served datapoints, and/or perform operations - - - -## Introduction - -The Asset Interfaces Description (AID) in version 1.2 supports the description of interfaces based on following specific protocols: -* Modbus -* HTTP -* MQTT -* OPC UA -* BACnet - -Informative, the IO-Link protocol that is bridged to REST/HTTP and PROFINET is introduced in AID 1.2 in Annex B. Any other protocols and interfaces will be addressed in upcoming versions of the AID. -The W3C Web of Things Thing Description (WoT TD) as an open, royalty-free standard is considered as a baseline for the content and structure of the definition of this Submodel template. The protocol-specific information is taken from the official WoT bindings that are maintained by the W3C or other SDOs like the OPC Foundation (e.g., OPC 10101 for OPC UA Binding). -In addition to the protocol specific information provided by the AID, it also provides the ability to reference external descriptors such as GSD, GSDML, IO Device Description, native WoT TD (as a supplement) etc. These external descriptor is not restricted to the protocols currently defined in AID. -As a complement to the AID, an Asset Interfaces Mapping Configuration (AIMC) Submodel can be used to map the received data from the asset services to a specific place within an AAS (e.g. an application specific Submodel to monitor data). The principle scope and use of the AID Submodel in combination with an AIMC - - - -## Status: `Accepted` -The sub-namespace for Asset Interface Description and its identifiers have been finalized in the Taskforce `Asset Interface Description`. - -## Versions: [1.2](3/3) -This version is the third version to be officially published by IDTA Document `IDTA 02017 Asset Interfaces Description`. - -## Contact - -This sub-namespace is proposed by [IDTA Working Group Nameplate for Asset Interface Description](https://github.com/admin-shell-io/submodel-templates/tree/main/published/Asset%20Interfaces%20Description). -See also [IDTA Registered AAS Submodel Templates](https://industrialdigitaltwin.org/content-hub/teilmodelle#:~:text=Software%20Nameplate) or contact via email the [IDTA project manager for submodel templates](mailto:sudip.adhikari@idtwin.org) or [chair of the working group](mailto:sebastian.kaebisch@siemens.com). diff --git a/idta/README.md b/idta/README.md index 69642c5..0eae7c6 100644 --- a/idta/README.md +++ b/idta/README.md @@ -8,7 +8,7 @@ This sub-namespace collects the identifiers defined in working groups of the IDT - [Provision of simulation models](SimulationModels) - [Nameplate for Software in Manufacturing](SoftwareNameplate) - [Inspection Documents of Steel Products](InspectionDocumentsOfSteelProducts) -- [Asset Inferface Description](AssetInferfaceDescription) +- [Asset Inferface Description](AssetInferfacesDescription) ## Contact This sub-namespace is proposed by [IDTA Working Groups](https://github.com/admin-shell-io/submodel-templates). See also [IDTA Registered AAS Submodel Templates](https://industrialdigitaltwin.org/content-hub/teilmodelle) or contact via email the [IDTA project manager for submodel templates](mailto:sudip.adhikari@idtwin.org). From 55ad8eaac59e4a0210969fb91b9555ad69f70cd2 Mon Sep 17 00:00:00 2001 From: Nico Braunisch Date: Sun, 22 Mar 2026 17:38:37 +0100 Subject: [PATCH 06/20] Fix Pluaral S by Adding folder --- .../1/2/README.md | 245 ++++++++++++++++++ idta/Asset Interfaces Description/README.md | 33 +++ 2 files changed, 278 insertions(+) create mode 100644 idta/Asset Interfaces Description/1/2/README.md create mode 100644 idta/Asset Interfaces Description/README.md diff --git a/idta/Asset Interfaces Description/1/2/README.md b/idta/Asset Interfaces Description/1/2/README.md new file mode 100644 index 0000000..c612450 --- /dev/null +++ b/idta/Asset Interfaces Description/1/2/README.md @@ -0,0 +1,245 @@ +# Asset Interfaces Description – Identifiers + +This Submodel specifies an information model and a common representation for describing the interface(s) of an asset service or asset-related service. Based on this information, it is possible to initiate a connection to such a service and start to request or subscribe to served datapoints, and/or perform operations + + + +## Introduction + +The Asset Interfaces Description (AID) in version 1.2 supports the description of interfaces based on the following specific protocols: +* Modbus +* HTTP +* MQTT +* OPC UA +* BACnet + +Informative, the IO-Link protocol that is bridged to REST/HTTP and PROFINET is introduced in AID 1.2 in Annex B. Any other protocols and interfaces will be addressed in upcoming versions of the AID. +The W3C Web of Things Thing Description (WoT TD) as an open, royalty-free standard is considered as a baseline for the content and structure of the definition of this Submodel template. The protocol-specific information is taken from the official WoT bindings that are maintained by the W3C or other SDOs like the OPC Foundation (e.g., OPC 10101 for OPC UA Binding). +In addition to the protocol-specific information provided by the AID, it also provides the ability to reference external descriptors such as GSD, GSDML, IO Device Description, native WoT TD (as a supplement), etc. These external descriptors are not restricted to the protocols currently defined in AID. +As a complement to the AID, an Asset Interfaces Mapping Configuration (AIMC) Submodel can be used to map the received data from the asset services to a specific place within an AAS (e.g., an application-specific Submodel to monitor data). The principal scope and use of the AID Submodel in combination with an AIMC + + + +## Status: `Accepted` +The sub-namespace for Asset Interface Description and its identifiers have been finalized in the Taskforce `Asset Interface Description`. + +## Versions: [1.2](3/3) +This version is the third version to be officially published by IDTA Document `IDTA 02017 Asset Interfaces Description`. + + +## Interface (SMC) +This SubmodelElementCollection holds the information for EndpointMetadata, InteractionMetadata and ExternalDescriptor. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/Interface + +### title (Property) +Provides a human-readable title. +https://www.w3.org/2019/wot/td#title + +### created (Property) +Provides creation timestamp. +http://purl.org/dc/terms/created + +### modified (Property) +Provides modification timestamp. +http://purl.org/dc/terms/modified + +### support (Property) +Contact information. +https://www.w3.org/2019/wot/td#support + +### EndpointMetadata (SMC) +Metadata of the interface endpoint. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/EndpointMetadata + +### InteractionMetadata (SMC) +Metadata describing datapoints and functions. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/InteractionMetadata + +### ExternalDescriptor (SMC) +Descriptor file references. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/ExternalDescriptor + +--- + +## EndpointMetadata (SMC) +Holds information about the endpoint. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/EndpointMetadata + +### base (Property) +Defines base URI. +https://www.w3.org/2019/wot/td#baseURI + +### contentType (Property) +Defines content type. +https://www.w3.org/2019/wot/hypermedia#forContentType + +### security (SML) +Security configuration. +https://www.w3.org/2019/wot/td#hasSecurityConfiguration + +### modv_mostSignificantByte (Property) +Modbus byte order. +https://www.w3.org/2019/wot/modbus#hasMostSignificantByte + +### modv_mostSignificantWord (Property) +Modbus word order. +https://www.w3.org/2019/wot/modbus#hasMostSignificantWord + +### securityDefinitions (SMC) +Security scheme definitions. +https://www.w3.org/2019/wot/td#definesSecurityScheme + +--- + +## InteractionMetadata (SMC) +Defines interaction affordances. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/InteractionMetadata + +### properties (SMC) +Datapoint definitions. +https://www.w3.org/2019/wot/td#PropertyAffordance + +### actions (SMC) +Function definitions. +https://www.w3.org/2019/wot/td#ActionAffordance + +### events (SMC) +Event definitions. +https://www.w3.org/2019/wot/td#EventAffordance + +--- + +## properties (SMC) +Collection of interaction properties. +https://www.w3.org/2019/wot/td#hasPropertyAffordance + +--- + +## property_name (SMC) +Defines datapoint characteristics. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/PropertyDefinition + +### key (Property) +Optional key. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/key + +### title (Property) +Human-readable title. +https://www.w3.org/2019/wot/td#title + +### observable (Property) +Observation indicator. +https://www.w3.org/2019/wot/td#isObservable + +### forms (SMC) +Resource locations. +https://www.w3.org/2019/wot/td#hasForm + +### type (Property) +Datatype indicator. +https://www.w3.org/1999/02/22-rdf-syntax-ns#type + +### const (Property) +Constant value. +https://www.w3.org/2019/wot/json-schema#const + +### enum (SML) +Restricted value list. +https://www.w3.org/2019/wot/json-schema#enum + +### default (Property) +Default value. +https://www.w3.org/2019/wot/json-schema#default + +### unit (Property) +Measurement unit. +https://schema.org/unitCode + +### min_max (Range) +Numeric limits. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/minMaxRange + +### lengthRange (Range) +String length range. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/lengthRange + +### itemsRange (Range) +Array length limits. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/itemsRange + +### items (SMC) +Array item schema. +https://www.w3.org/2019/wot/json-schema#items + +### valueSemantics (Ref) +Semantic meaning. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/valueSemantics + +--- + +## ExternalDescriptor (SMC) +Reference to external descriptors. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/ExternalDescriptor + +### descriptorName (File) +Descriptor filename. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/externalDescriptorName + +--- + +## IO-Link specific identifiers + +### hasMethod (Property) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/hasMethod + +### hasPayloadDataType (Property) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/hasPayloadDataType + +### hasAccessRights (Property) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/hasAccessRights + +### byteOffset (Property) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/byteOffset + +### byteLength (Property) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/byteLength + +### bitOffset (Property) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/bitOffset + +### bitLength (Property) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/bitLength + +### hasPayloadMapping (SML) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/hasPayloadMapping + +### referenceToProperty (Ref) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/referenceToProperty + +### hasEnumeratedValues (SML) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/hasEnumeratedValues + +### enumeratedValue (SMC) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/enumeratedValue + +### encodedPayload (Property) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/encodedPayload + +### decodedPayload (Property) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/decodedPayload + +--- + +## Interface supplementalSemanticIds + +### SNMP +https://admin-shell.io/idta/AssetInterfacesDescription/1/2/SNMP + +### CAN +https://admin-shell.io/idta/AssetInterfacesDescription/1/2/CAN + +## Contact + +This sub-namespace is proposed by [IDTA Working Group Nameplate for Asset Interface Description](https://github.com/admin-shell-io/submodel-templates/tree/main/published/Asset%20Interfaces%20Description). +See also [IDTA Registered AAS Submodel Templates](https://industrialdigitaltwin.org/content-hub/teilmodelle#:~:text=Software%20Nameplate) or contact via email the [IDTA project manager for submodel templates](mailto:sudip.adhikari@idtwin.org) or [chair of the working group](mailto:sebastian.kaebisch@siemens.com). + diff --git a/idta/Asset Interfaces Description/README.md b/idta/Asset Interfaces Description/README.md new file mode 100644 index 0000000..d553a7c --- /dev/null +++ b/idta/Asset Interfaces Description/README.md @@ -0,0 +1,33 @@ +# Asset Inferfaces Description + + +This Submodel specifies an information model and a common representation for describing the interface(s) of an asset service or asset related service. Based on this information, it is possible to initiate a connection to such kind of service and start to request or subscribe to served datapoints, and/or perform operations + + + +## Introduction + +The Asset Interfaces Description (AID) in version 1.2 supports the description of interfaces based on following specific protocols: +* Modbus +* HTTP +* MQTT +* OPC UA +* BACnet + +Informative, the IO-Link protocol that is bridged to REST/HTTP and PROFINET is introduced in AID 1.2 in Annex B. Any other protocols and interfaces will be addressed in upcoming versions of the AID. +The W3C Web of Things Thing Description (WoT TD) as an open, royalty-free standard is considered as a baseline for the content and structure of the definition of this Submodel template. The protocol-specific information is taken from the official WoT bindings that are maintained by the W3C or other SDOs like the OPC Foundation (e.g., OPC 10101 for OPC UA Binding). +In addition to the protocol specific information provided by the AID, it also provides the ability to reference external descriptors such as GSD, GSDML, IO Device Description, native WoT TD (as a supplement) etc. These external descriptor is not restricted to the protocols currently defined in AID. +As a complement to the AID, an Asset Interfaces Mapping Configuration (AIMC) Submodel can be used to map the received data from the asset services to a specific place within an AAS (e.g. an application specific Submodel to monitor data). The principle scope and use of the AID Submodel in combination with an AIMC + + + +## Status: `Accepted` +The sub-namespace for Asset Interface Description and its identifiers have been finalized in the Taskforce `Asset Interface Description`. + +## Versions: [1.2](3/3) +This version is the third version to be officially published by IDTA Document `IDTA 02017 Asset Interfaces Description`. + +## Contact + +This sub-namespace is proposed by [IDTA Working Group Nameplate for Asset Interface Description](https://github.com/admin-shell-io/submodel-templates/tree/main/published/Asset%20Interfaces%20Description). +See also [IDTA Registered AAS Submodel Templates](https://industrialdigitaltwin.org/content-hub/teilmodelle#:~:text=Software%20Nameplate) or contact via email the [IDTA project manager for submodel templates](mailto:sudip.adhikari@idtwin.org) or [chair of the working group](mailto:sebastian.kaebisch@siemens.com). From ea23a1fa895d1bab338f1cdf393d3e26b7a11b92 Mon Sep 17 00:00:00 2001 From: Nico Braunisch Date: Sun, 22 Mar 2026 17:54:45 +0100 Subject: [PATCH 07/20] Add CAN specific identifiers to README Added CAN specific identifiers section with properties for offset, length, and value offset. --- idta/Asset Interfaces Description/1/2/README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/idta/Asset Interfaces Description/1/2/README.md b/idta/Asset Interfaces Description/1/2/README.md index c612450..4a68c3a 100644 --- a/idta/Asset Interfaces Description/1/2/README.md +++ b/idta/Asset Interfaces Description/1/2/README.md @@ -230,6 +230,21 @@ https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/decodedPayloa --- +## CAN specific identifiers + +### canv_offset (Property) +Offset to indicate the beginning of a data point in the message payload. Must be in the range [0, 63]. +https://admin-shell.io/idta/AssetInterfacesDescription/1/2/CAN/offset + +### canv_length (Property) +Length of the data point in the message payload. Must be in the range [1, 64]. +https://admin-shell.io/idta/AssetInterfacesDescription/1/2/CAN/length + +### canv_valueOffset (Property) +A constant to add to the decoded data point in order to restore its actual value. “valueType” must match the "property_name.type" field. +https://admin-shell.io/idta/AssetInterfacesDescription/1/2/CAN/value-offset + + ## Interface supplementalSemanticIds ### SNMP From 09db96c64efdbe634956d8f0d275d32ec55b8884 Mon Sep 17 00:00:00 2001 From: Nico Braunisch Date: Sun, 22 Mar 2026 17:57:12 +0100 Subject: [PATCH 08/20] Fix typo in Asset Interfaces Description link --- idta/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/idta/README.md b/idta/README.md index 0eae7c6..a2e76b3 100644 --- a/idta/README.md +++ b/idta/README.md @@ -8,7 +8,7 @@ This sub-namespace collects the identifiers defined in working groups of the IDT - [Provision of simulation models](SimulationModels) - [Nameplate for Software in Manufacturing](SoftwareNameplate) - [Inspection Documents of Steel Products](InspectionDocumentsOfSteelProducts) -- [Asset Inferface Description](AssetInferfacesDescription) +- [Asset Interfaces Description](AssetInterfacesDescription) ## Contact This sub-namespace is proposed by [IDTA Working Groups](https://github.com/admin-shell-io/submodel-templates). See also [IDTA Registered AAS Submodel Templates](https://industrialdigitaltwin.org/content-hub/teilmodelle) or contact via email the [IDTA project manager for submodel templates](mailto:sudip.adhikari@idtwin.org). From dbce5a95f4310f1ea32a6842875ffdadda98b7c7 Mon Sep 17 00:00:00 2001 From: Nico Braunisch Date: Sun, 22 Mar 2026 17:58:50 +0100 Subject: [PATCH 09/20] Fix folder name --- .../1/2/README.md | 0 .../README.md | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename idta/{Asset Interfaces Description => AssetInterfacesDescription}/1/2/README.md (100%) rename idta/{Asset Interfaces Description => AssetInterfacesDescription}/README.md (100%) diff --git a/idta/Asset Interfaces Description/1/2/README.md b/idta/AssetInterfacesDescription/1/2/README.md similarity index 100% rename from idta/Asset Interfaces Description/1/2/README.md rename to idta/AssetInterfacesDescription/1/2/README.md diff --git a/idta/Asset Interfaces Description/README.md b/idta/AssetInterfacesDescription/README.md similarity index 100% rename from idta/Asset Interfaces Description/README.md rename to idta/AssetInterfacesDescription/README.md From 752bc15f5b398813ad4f807e3ec25039b0a3dcba Mon Sep 17 00:00:00 2001 From: Nico Braunisch Date: Sun, 22 Mar 2026 18:08:00 +0100 Subject: [PATCH 10/20] Split IDs in version 1.0, 1.1 and 1.2 --- idta/AssetInterfacesDescription/1/0/README.md | 193 ++++++++++++++++ idta/AssetInterfacesDescription/1/1/README.md | 76 +++++++ idta/AssetInterfacesDescription/1/2/README.md | 214 +----------------- 3 files changed, 277 insertions(+), 206 deletions(-) create mode 100644 idta/AssetInterfacesDescription/1/0/README.md create mode 100644 idta/AssetInterfacesDescription/1/1/README.md diff --git a/idta/AssetInterfacesDescription/1/0/README.md b/idta/AssetInterfacesDescription/1/0/README.md new file mode 100644 index 0000000..92822b7 --- /dev/null +++ b/idta/AssetInterfacesDescription/1/0/README.md @@ -0,0 +1,193 @@ +# Asset Interfaces Description – Identifiers + +This Submodel specifies an information model and a common representation for describing the interface(s) of an asset service or asset-related service. Based on this information, it is possible to initiate a connection to such a service and start to request or subscribe to served datapoints, and/or perform operations + + + +## Introduction + +The Asset Interfaces Description (AID) in version 1.0 supports the description of interfaces based on the following specific protocols: +* Modbus +* HTTP +* MQTT +* OPC UA +* BACnet + +Informative, the IO-Link protocol that is bridged to REST/HTTP and PROFINET is introduced in AID 1.2 in Annex B. Any other protocols and interfaces will be addressed in upcoming versions of the AID. +The W3C Web of Things Thing Description (WoT TD) as an open, royalty-free standard is considered as a baseline for the content and structure of the definition of this Submodel template. The protocol-specific information is taken from the official WoT bindings that are maintained by the W3C or other SDOs like the OPC Foundation (e.g., OPC 10101 for OPC UA Binding). +In addition to the protocol-specific information provided by the AID, it also provides the ability to reference external descriptors such as GSD, GSDML, IO Device Description, native WoT TD (as a supplement), etc. These external descriptors are not restricted to the protocols currently defined in AID. +As a complement to the AID, an Asset Interfaces Mapping Configuration (AIMC) Submodel can be used to map the received data from the asset services to a specific place within an AAS (e.g., an application-specific Submodel to monitor data). The principal scope and use of the AID Submodel in combination with an AIMC + + + +## Status: `Accepted` +The sub-namespace for Asset Interface Description and its identifiers have been finalized in the Taskforce `Asset Interface Description`. + +## Versions: [1.0](1/3) +This version is the third version to be officially published by IDTA Document `IDTA 02017 Asset Interfaces Description`. + + +## Interface (SMC) +This SubmodelElementCollection holds the information for EndpointMetadata, InteractionMetadata and ExternalDescriptor. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/Interface + +### title (Property) +Provides a human-readable title. +https://www.w3.org/2019/wot/td#title + +### created (Property) +Provides creation timestamp. +http://purl.org/dc/terms/created + +### modified (Property) +Provides modification timestamp. +http://purl.org/dc/terms/modified + +### support (Property) +Contact information. +https://www.w3.org/2019/wot/td#support + +### EndpointMetadata (SMC) +Metadata of the interface endpoint. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/EndpointMetadata + +### InteractionMetadata (SMC) +Metadata describing datapoints and functions. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/InteractionMetadata + +### ExternalDescriptor (SMC) +Descriptor file references. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/ExternalDescriptor + +--- + +## EndpointMetadata (SMC) +Holds information about the endpoint. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/EndpointMetadata + +### base (Property) +Defines base URI. +https://www.w3.org/2019/wot/td#baseURI + +### contentType (Property) +Defines content type. +https://www.w3.org/2019/wot/hypermedia#forContentType + +### security (SML) +Security configuration. +https://www.w3.org/2019/wot/td#hasSecurityConfiguration + +### modv_mostSignificantByte (Property) +Modbus byte order. +https://www.w3.org/2019/wot/modbus#hasMostSignificantByte + +### modv_mostSignificantWord (Property) +Modbus word order. +https://www.w3.org/2019/wot/modbus#hasMostSignificantWord + +### securityDefinitions (SMC) +Security scheme definitions. +https://www.w3.org/2019/wot/td#definesSecurityScheme + +--- + +## InteractionMetadata (SMC) +Defines interaction affordances. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/InteractionMetadata + +### properties (SMC) +Datapoint definitions. +https://www.w3.org/2019/wot/td#PropertyAffordance + +### actions (SMC) +Function definitions. +https://www.w3.org/2019/wot/td#ActionAffordance + +### events (SMC) +Event definitions. +https://www.w3.org/2019/wot/td#EventAffordance + +--- + +## properties (SMC) +Collection of interaction properties. +https://www.w3.org/2019/wot/td#hasPropertyAffordance + +--- + +## property_name (SMC) +Defines datapoint characteristics. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/PropertyDefinition + +### key (Property) +Optional key. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/key + +### title (Property) +Human-readable title. +https://www.w3.org/2019/wot/td#title + +### observable (Property) +Observation indicator. +https://www.w3.org/2019/wot/td#isObservable + +### forms (SMC) +Resource locations. +https://www.w3.org/2019/wot/td#hasForm + +### type (Property) +Datatype indicator. +https://www.w3.org/1999/02/22-rdf-syntax-ns#type + +### const (Property) +Constant value. +https://www.w3.org/2019/wot/json-schema#const + +### enum (SML) +Restricted value list. +https://www.w3.org/2019/wot/json-schema#enum + +### default (Property) +Default value. +https://www.w3.org/2019/wot/json-schema#default + +### unit (Property) +Measurement unit. +https://schema.org/unitCode + +### min_max (Range) +Numeric limits. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/minMaxRange + +### lengthRange (Range) +String length range. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/lengthRange + +### itemsRange (Range) +Array length limits. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/itemsRange + +### items (SMC) +Array item schema. +https://www.w3.org/2019/wot/json-schema#items + +### valueSemantics (Ref) +Semantic meaning. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/valueSemantics + +--- + +## ExternalDescriptor (SMC) +Reference to external descriptors. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/ExternalDescriptor + +### descriptorName (File) +Descriptor filename. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/externalDescriptorName + + +## Contact + +This sub-namespace is proposed by [IDTA Working Group Nameplate for Asset Interface Description](https://github.com/admin-shell-io/submodel-templates/tree/main/published/Asset%20Interfaces%20Description). +See also [IDTA Registered AAS Submodel Templates](https://industrialdigitaltwin.org/content-hub/teilmodelle#:~:text=Software%20Nameplate) or contact via email the [IDTA project manager for submodel templates](mailto:sudip.adhikari@idtwin.org) or [chair of the working group](mailto:sebastian.kaebisch@siemens.com). + diff --git a/idta/AssetInterfacesDescription/1/1/README.md b/idta/AssetInterfacesDescription/1/1/README.md new file mode 100644 index 0000000..f32095c --- /dev/null +++ b/idta/AssetInterfacesDescription/1/1/README.md @@ -0,0 +1,76 @@ +# Asset Interfaces Description – Identifiers + +This Submodel specifies an information model and a common representation for describing the interface(s) of an asset service or asset-related service. Based on this information, it is possible to initiate a connection to such a service and start to request or subscribe to served datapoints, and/or perform operations + + + +## Introduction + +The Asset Interfaces Description (AID) in version 1.2 supports the description of interfaces based on the following specific protocols: +* Modbus +* HTTP +* MQTT +* OPC UA +* BACnet + +Informative, the IO-Link protocol that is bridged to REST/HTTP and PROFINET is introduced in AID 1.2 in Annex B. Any other protocols and interfaces will be addressed in upcoming versions of the AID. +The W3C Web of Things Thing Description (WoT TD) as an open, royalty-free standard is considered as a baseline for the content and structure of the definition of this Submodel template. The protocol-specific information is taken from the official WoT bindings that are maintained by the W3C or other SDOs like the OPC Foundation (e.g., OPC 10101 for OPC UA Binding). +In addition to the protocol-specific information provided by the AID, it also provides the ability to reference external descriptors such as GSD, GSDML, IO Device Description, native WoT TD (as a supplement), etc. These external descriptors are not restricted to the protocols currently defined in AID. +As a complement to the AID, an Asset Interfaces Mapping Configuration (AIMC) Submodel can be used to map the received data from the asset services to a specific place within an AAS (e.g., an application-specific Submodel to monitor data). The principal scope and use of the AID Submodel in combination with an AIMC + + + +## Status: `Accepted` +The sub-namespace for Asset Interface Description and its identifiers have been finalized in the Taskforce `Asset Interface Description`. + +## Versions: [1.2](3/3) +This version is the third version to be officially published by IDTA Document `IDTA 02017 Asset Interfaces Description`. + + +## IO-Link specific identifiers + +### hasMethod (Property) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/hasMethod + +### hasPayloadDataType (Property) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/hasPayloadDataType + +### hasAccessRights (Property) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/hasAccessRights + +### byteOffset (Property) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/byteOffset + +### byteLength (Property) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/byteLength + +### bitOffset (Property) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/bitOffset + +### bitLength (Property) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/bitLength + +### hasPayloadMapping (SML) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/hasPayloadMapping + +### referenceToProperty (Ref) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/referenceToProperty + +### hasEnumeratedValues (SML) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/hasEnumeratedValues + +### enumeratedValue (SMC) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/enumeratedValue + +### encodedPayload (Property) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/encodedPayload + +### decodedPayload (Property) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/decodedPayload + + +## Contact + +This sub-namespace is proposed by [IDTA Working Group Nameplate for Asset Interface Description](https://github.com/admin-shell-io/submodel-templates/tree/main/published/Asset%20Interfaces%20Description). +See also [IDTA Registered AAS Submodel Templates](https://industrialdigitaltwin.org/content-hub/teilmodelle#:~:text=Software%20Nameplate) or contact via email the [IDTA project manager for submodel templates](mailto:sudip.adhikari@idtwin.org) or [chair of the working group](mailto:sebastian.kaebisch@siemens.com). + diff --git a/idta/AssetInterfacesDescription/1/2/README.md b/idta/AssetInterfacesDescription/1/2/README.md index 4a68c3a..be5b011 100644 --- a/idta/AssetInterfacesDescription/1/2/README.md +++ b/idta/AssetInterfacesDescription/1/2/README.md @@ -26,211 +26,15 @@ The sub-namespace for Asset Interface Description and its identifiers have been ## Versions: [1.2](3/3) This version is the third version to be officially published by IDTA Document `IDTA 02017 Asset Interfaces Description`. +## SNMP (SMC) +SNMP Specifi Indenifier -## Interface (SMC) -This SubmodelElementCollection holds the information for EndpointMetadata, InteractionMetadata and ExternalDescriptor. -https://admin-shell.io/idta/AssetInterfacesDescription/1/0/Interface - -### title (Property) -Provides a human-readable title. -https://www.w3.org/2019/wot/td#title - -### created (Property) -Provides creation timestamp. -http://purl.org/dc/terms/created - -### modified (Property) -Provides modification timestamp. -http://purl.org/dc/terms/modified - -### support (Property) -Contact information. -https://www.w3.org/2019/wot/td#support - -### EndpointMetadata (SMC) -Metadata of the interface endpoint. -https://admin-shell.io/idta/AssetInterfacesDescription/1/0/EndpointMetadata - -### InteractionMetadata (SMC) -Metadata describing datapoints and functions. -https://admin-shell.io/idta/AssetInterfacesDescription/1/0/InteractionMetadata - -### ExternalDescriptor (SMC) -Descriptor file references. -https://admin-shell.io/idta/AssetInterfacesDescription/1/0/ExternalDescriptor - ---- - -## EndpointMetadata (SMC) -Holds information about the endpoint. -https://admin-shell.io/idta/AssetInterfacesDescription/1/0/EndpointMetadata - -### base (Property) -Defines base URI. -https://www.w3.org/2019/wot/td#baseURI - -### contentType (Property) -Defines content type. -https://www.w3.org/2019/wot/hypermedia#forContentType - -### security (SML) -Security configuration. -https://www.w3.org/2019/wot/td#hasSecurityConfiguration - -### modv_mostSignificantByte (Property) -Modbus byte order. -https://www.w3.org/2019/wot/modbus#hasMostSignificantByte - -### modv_mostSignificantWord (Property) -Modbus word order. -https://www.w3.org/2019/wot/modbus#hasMostSignificantWord - -### securityDefinitions (SMC) -Security scheme definitions. -https://www.w3.org/2019/wot/td#definesSecurityScheme - ---- - -## InteractionMetadata (SMC) -Defines interaction affordances. -https://admin-shell.io/idta/AssetInterfacesDescription/1/0/InteractionMetadata - -### properties (SMC) -Datapoint definitions. -https://www.w3.org/2019/wot/td#PropertyAffordance - -### actions (SMC) -Function definitions. -https://www.w3.org/2019/wot/td#ActionAffordance - -### events (SMC) -Event definitions. -https://www.w3.org/2019/wot/td#EventAffordance - ---- - -## properties (SMC) -Collection of interaction properties. -https://www.w3.org/2019/wot/td#hasPropertyAffordance - ---- - -## property_name (SMC) -Defines datapoint characteristics. -https://admin-shell.io/idta/AssetInterfacesDescription/1/0/PropertyDefinition - -### key (Property) -Optional key. -https://admin-shell.io/idta/AssetInterfacesDescription/1/0/key - -### title (Property) -Human-readable title. -https://www.w3.org/2019/wot/td#title - -### observable (Property) -Observation indicator. -https://www.w3.org/2019/wot/td#isObservable - -### forms (SMC) -Resource locations. -https://www.w3.org/2019/wot/td#hasForm - -### type (Property) -Datatype indicator. -https://www.w3.org/1999/02/22-rdf-syntax-ns#type - -### const (Property) -Constant value. -https://www.w3.org/2019/wot/json-schema#const - -### enum (SML) -Restricted value list. -https://www.w3.org/2019/wot/json-schema#enum - -### default (Property) -Default value. -https://www.w3.org/2019/wot/json-schema#default - -### unit (Property) -Measurement unit. -https://schema.org/unitCode - -### min_max (Range) -Numeric limits. -https://admin-shell.io/idta/AssetInterfacesDescription/1/0/minMaxRange - -### lengthRange (Range) -String length range. -https://admin-shell.io/idta/AssetInterfacesDescription/1/0/lengthRange - -### itemsRange (Range) -Array length limits. -https://admin-shell.io/idta/AssetInterfacesDescription/1/0/itemsRange - -### items (SMC) -Array item schema. -https://www.w3.org/2019/wot/json-schema#items - -### valueSemantics (Ref) -Semantic meaning. -https://admin-shell.io/idta/AssetInterfacesDescription/1/0/valueSemantics - ---- - -## ExternalDescriptor (SMC) -Reference to external descriptors. -https://admin-shell.io/idta/AssetInterfacesDescription/1/0/ExternalDescriptor - -### descriptorName (File) -Descriptor filename. -https://admin-shell.io/idta/AssetInterfacesDescription/1/0/externalDescriptorName - ---- - -## IO-Link specific identifiers - -### hasMethod (Property) -https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/hasMethod - -### hasPayloadDataType (Property) -https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/hasPayloadDataType - -### hasAccessRights (Property) -https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/hasAccessRights - -### byteOffset (Property) -https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/byteOffset - -### byteLength (Property) -https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/byteLength - -### bitOffset (Property) -https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/bitOffset - -### bitLength (Property) -https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/bitLength - -### hasPayloadMapping (SML) -https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/hasPayloadMapping - -### referenceToProperty (Ref) -https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/referenceToProperty - -### hasEnumeratedValues (SML) -https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/hasEnumeratedValues - -### enumeratedValue (SMC) -https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/enumeratedValue - -### encodedPayload (Property) -https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/encodedPayload - -### decodedPayload (Property) -https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/decodedPayload +https://admin-shell.io/idta/AssetInterfacesDescription/1/2/SNMP ---- +## CAN (SMC) -## CAN specific identifiers +CAN specific identifiers +https://admin-shell.io/idta/AssetInterfacesDescription/1/2/CAN ### canv_offset (Property) Offset to indicate the beginning of a data point in the message payload. Must be in the range [0, 63]. @@ -247,11 +51,9 @@ https://admin-shell.io/idta/AssetInterfacesDescription/1/2/CAN/value-offset ## Interface supplementalSemanticIds -### SNMP -https://admin-shell.io/idta/AssetInterfacesDescription/1/2/SNMP -### CAN -https://admin-shell.io/idta/AssetInterfacesDescription/1/2/CAN + + ## Contact From 0589771ecdad030a0fbc8dedf94fa0f20c28b1f0 Mon Sep 17 00:00:00 2001 From: Nico Braunisch Date: Sun, 22 Mar 2026 18:08:52 +0100 Subject: [PATCH 11/20] Fix link to version in README.md --- idta/AssetInterfacesDescription/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/idta/AssetInterfacesDescription/README.md b/idta/AssetInterfacesDescription/README.md index d553a7c..ce26c35 100644 --- a/idta/AssetInterfacesDescription/README.md +++ b/idta/AssetInterfacesDescription/README.md @@ -24,7 +24,7 @@ As a complement to the AID, an Asset Interfaces Mapping Configuration (AIMC) Sub ## Status: `Accepted` The sub-namespace for Asset Interface Description and its identifiers have been finalized in the Taskforce `Asset Interface Description`. -## Versions: [1.2](3/3) +## Versions: [1.2](1/2) This version is the third version to be officially published by IDTA Document `IDTA 02017 Asset Interfaces Description`. ## Contact From 5826aa2ed574514a1c538996c2fbbafe1df18b59 Mon Sep 17 00:00:00 2001 From: Nico Braunisch Date: Sun, 22 Mar 2026 18:09:55 +0100 Subject: [PATCH 12/20] Change version number in README.md Updated version number from 1.2 to 1.1 in README.md. --- idta/AssetInterfacesDescription/1/1/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/idta/AssetInterfacesDescription/1/1/README.md b/idta/AssetInterfacesDescription/1/1/README.md index f32095c..93f3131 100644 --- a/idta/AssetInterfacesDescription/1/1/README.md +++ b/idta/AssetInterfacesDescription/1/1/README.md @@ -23,7 +23,7 @@ As a complement to the AID, an Asset Interfaces Mapping Configuration (AIMC) Sub ## Status: `Accepted` The sub-namespace for Asset Interface Description and its identifiers have been finalized in the Taskforce `Asset Interface Description`. -## Versions: [1.2](3/3) +## Versions: 1.1 This version is the third version to be officially published by IDTA Document `IDTA 02017 Asset Interfaces Description`. From 04b34f9d2130d55b23e03d37c56ec9cfffe4c0a5 Mon Sep 17 00:00:00 2001 From: Nico Braunisch Date: Sun, 22 Mar 2026 18:10:20 +0100 Subject: [PATCH 13/20] Update version formatting in README.md Removed markdown link formatting from version number. --- idta/AssetInterfacesDescription/1/0/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/idta/AssetInterfacesDescription/1/0/README.md b/idta/AssetInterfacesDescription/1/0/README.md index 92822b7..f6dbed0 100644 --- a/idta/AssetInterfacesDescription/1/0/README.md +++ b/idta/AssetInterfacesDescription/1/0/README.md @@ -23,7 +23,7 @@ As a complement to the AID, an Asset Interfaces Mapping Configuration (AIMC) Sub ## Status: `Accepted` The sub-namespace for Asset Interface Description and its identifiers have been finalized in the Taskforce `Asset Interface Description`. -## Versions: [1.0](1/3) +## Versions: 1.0 This version is the third version to be officially published by IDTA Document `IDTA 02017 Asset Interfaces Description`. From 493e28ce18ad3ba4765e046c71b74d79effebe96 Mon Sep 17 00:00:00 2001 From: Nico Braunisch Date: Sun, 22 Mar 2026 18:11:22 +0100 Subject: [PATCH 14/20] Fix formatting and wording in README.md --- idta/AssetInterfacesDescription/1/2/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/idta/AssetInterfacesDescription/1/2/README.md b/idta/AssetInterfacesDescription/1/2/README.md index be5b011..777327f 100644 --- a/idta/AssetInterfacesDescription/1/2/README.md +++ b/idta/AssetInterfacesDescription/1/2/README.md @@ -23,11 +23,11 @@ As a complement to the AID, an Asset Interfaces Mapping Configuration (AIMC) Sub ## Status: `Accepted` The sub-namespace for Asset Interface Description and its identifiers have been finalized in the Taskforce `Asset Interface Description`. -## Versions: [1.2](3/3) +## Versions: 1.2 This version is the third version to be officially published by IDTA Document `IDTA 02017 Asset Interfaces Description`. ## SNMP (SMC) -SNMP Specifi Indenifier +SNMP Specific Identifier https://admin-shell.io/idta/AssetInterfacesDescription/1/2/SNMP From 91e9ce225b1f027c34940db98c46cd10dd6b14fe Mon Sep 17 00:00:00 2001 From: Nico Braunisch Date: Sun, 22 Mar 2026 18:13:29 +0100 Subject: [PATCH 15/20] Update README to include new protocols Added IO-Link, SNMP, and CAN to the list of protocols. --- idta/AssetInterfacesDescription/README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/idta/AssetInterfacesDescription/README.md b/idta/AssetInterfacesDescription/README.md index ce26c35..dc41b95 100644 --- a/idta/AssetInterfacesDescription/README.md +++ b/idta/AssetInterfacesDescription/README.md @@ -13,6 +13,9 @@ The Asset Interfaces Description (AID) in version 1.2 supports the description o * MQTT * OPC UA * BACnet +* IO-Link +* SNMP +* CAN Informative, the IO-Link protocol that is bridged to REST/HTTP and PROFINET is introduced in AID 1.2 in Annex B. Any other protocols and interfaces will be addressed in upcoming versions of the AID. The W3C Web of Things Thing Description (WoT TD) as an open, royalty-free standard is considered as a baseline for the content and structure of the definition of this Submodel template. The protocol-specific information is taken from the official WoT bindings that are maintained by the W3C or other SDOs like the OPC Foundation (e.g., OPC 10101 for OPC UA Binding). From 8dbbdd21168db67cdd770d4c628002ad99c9b489 Mon Sep 17 00:00:00 2001 From: Nico Braunisch Date: Sun, 22 Mar 2026 18:13:58 +0100 Subject: [PATCH 16/20] Add IO-Link protocol to README Added IO-Link to the list of supported protocols in the README. --- idta/AssetInterfacesDescription/1/1/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/idta/AssetInterfacesDescription/1/1/README.md b/idta/AssetInterfacesDescription/1/1/README.md index 93f3131..9d10bd9 100644 --- a/idta/AssetInterfacesDescription/1/1/README.md +++ b/idta/AssetInterfacesDescription/1/1/README.md @@ -12,6 +12,7 @@ The Asset Interfaces Description (AID) in version 1.2 supports the description o * MQTT * OPC UA * BACnet +* IO-Link Informative, the IO-Link protocol that is bridged to REST/HTTP and PROFINET is introduced in AID 1.2 in Annex B. Any other protocols and interfaces will be addressed in upcoming versions of the AID. The W3C Web of Things Thing Description (WoT TD) as an open, royalty-free standard is considered as a baseline for the content and structure of the definition of this Submodel template. The protocol-specific information is taken from the official WoT bindings that are maintained by the W3C or other SDOs like the OPC Foundation (e.g., OPC 10101 for OPC UA Binding). From 261ff96a533911bd3d7fd3066692f847b1af3a40 Mon Sep 17 00:00:00 2001 From: Nico Braunisch Date: Sun, 22 Mar 2026 18:15:34 +0100 Subject: [PATCH 17/20] Update README.md --- idta/AssetInterfacesDescription/1/2/README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/idta/AssetInterfacesDescription/1/2/README.md b/idta/AssetInterfacesDescription/1/2/README.md index 777327f..5cb1d98 100644 --- a/idta/AssetInterfacesDescription/1/2/README.md +++ b/idta/AssetInterfacesDescription/1/2/README.md @@ -12,6 +12,9 @@ The Asset Interfaces Description (AID) in version 1.2 supports the description o * MQTT * OPC UA * BACnet +* IO-Link +* SNMP +* CAN Informative, the IO-Link protocol that is bridged to REST/HTTP and PROFINET is introduced in AID 1.2 in Annex B. Any other protocols and interfaces will be addressed in upcoming versions of the AID. The W3C Web of Things Thing Description (WoT TD) as an open, royalty-free standard is considered as a baseline for the content and structure of the definition of this Submodel template. The protocol-specific information is taken from the official WoT bindings that are maintained by the W3C or other SDOs like the OPC Foundation (e.g., OPC 10101 for OPC UA Binding). From 0cc53ad14f5b63848574d79219ffdbb399765947 Mon Sep 17 00:00:00 2001 From: Nico Braunisch Date: Sun, 22 Mar 2026 18:16:22 +0100 Subject: [PATCH 18/20] Update version description in README.md --- idta/AssetInterfacesDescription/1/1/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/idta/AssetInterfacesDescription/1/1/README.md b/idta/AssetInterfacesDescription/1/1/README.md index 9d10bd9..03ecf4a 100644 --- a/idta/AssetInterfacesDescription/1/1/README.md +++ b/idta/AssetInterfacesDescription/1/1/README.md @@ -25,7 +25,7 @@ As a complement to the AID, an Asset Interfaces Mapping Configuration (AIMC) Sub The sub-namespace for Asset Interface Description and its identifiers have been finalized in the Taskforce `Asset Interface Description`. ## Versions: 1.1 -This version is the third version to be officially published by IDTA Document `IDTA 02017 Asset Interfaces Description`. +This version is the second version to be officially published by IDTA Document `IDTA 02017 Asset Interfaces Description`. ## IO-Link specific identifiers From a7f458f49db8e19e95415198f78c4025ffe5cb5b Mon Sep 17 00:00:00 2001 From: Nico Braunisch Date: Sun, 22 Mar 2026 18:16:45 +0100 Subject: [PATCH 19/20] Update version description in README.md --- idta/AssetInterfacesDescription/1/0/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/idta/AssetInterfacesDescription/1/0/README.md b/idta/AssetInterfacesDescription/1/0/README.md index f6dbed0..116ada7 100644 --- a/idta/AssetInterfacesDescription/1/0/README.md +++ b/idta/AssetInterfacesDescription/1/0/README.md @@ -24,7 +24,7 @@ As a complement to the AID, an Asset Interfaces Mapping Configuration (AIMC) Sub The sub-namespace for Asset Interface Description and its identifiers have been finalized in the Taskforce `Asset Interface Description`. ## Versions: 1.0 -This version is the third version to be officially published by IDTA Document `IDTA 02017 Asset Interfaces Description`. +This version is the first version to be officially published by IDTA Document `IDTA 02017 Asset Interfaces Description`. ## Interface (SMC) From c7ca23e47efd3bbf61bd2054518a3ebbaf090367 Mon Sep 17 00:00:00 2001 From: Nico Braunisch Date: Sun, 22 Mar 2026 18:20:44 +0100 Subject: [PATCH 20/20] Keep latest version --- idta/AssetInterfacesDescription/1/1/README.md | 157 ++++++++++++++ idta/AssetInterfacesDescription/1/2/README.md | 201 ++++++++++++++++++ 2 files changed, 358 insertions(+) diff --git a/idta/AssetInterfacesDescription/1/1/README.md b/idta/AssetInterfacesDescription/1/1/README.md index 03ecf4a..ebe56b8 100644 --- a/idta/AssetInterfacesDescription/1/1/README.md +++ b/idta/AssetInterfacesDescription/1/1/README.md @@ -27,6 +27,163 @@ The sub-namespace for Asset Interface Description and its identifiers have been ## Versions: 1.1 This version is the second version to be officially published by IDTA Document `IDTA 02017 Asset Interfaces Description`. +## Interface (SMC) +This SubmodelElementCollection holds the information for EndpointMetadata, InteractionMetadata and ExternalDescriptor. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/Interface + +### title (Property) +Provides a human-readable title. +https://www.w3.org/2019/wot/td#title + +### created (Property) +Provides creation timestamp. +http://purl.org/dc/terms/created + +### modified (Property) +Provides modification timestamp. +http://purl.org/dc/terms/modified + +### support (Property) +Contact information. +https://www.w3.org/2019/wot/td#support + +### EndpointMetadata (SMC) +Metadata of the interface endpoint. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/EndpointMetadata + +### InteractionMetadata (SMC) +Metadata describing datapoints and functions. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/InteractionMetadata + +### ExternalDescriptor (SMC) +Descriptor file references. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/ExternalDescriptor + +--- + +## EndpointMetadata (SMC) +Holds information about the endpoint. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/EndpointMetadata + +### base (Property) +Defines base URI. +https://www.w3.org/2019/wot/td#baseURI + +### contentType (Property) +Defines content type. +https://www.w3.org/2019/wot/hypermedia#forContentType + +### security (SML) +Security configuration. +https://www.w3.org/2019/wot/td#hasSecurityConfiguration + +### modv_mostSignificantByte (Property) +Modbus byte order. +https://www.w3.org/2019/wot/modbus#hasMostSignificantByte + +### modv_mostSignificantWord (Property) +Modbus word order. +https://www.w3.org/2019/wot/modbus#hasMostSignificantWord + +### securityDefinitions (SMC) +Security scheme definitions. +https://www.w3.org/2019/wot/td#definesSecurityScheme + +--- + +## InteractionMetadata (SMC) +Defines interaction affordances. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/InteractionMetadata + +### properties (SMC) +Datapoint definitions. +https://www.w3.org/2019/wot/td#PropertyAffordance + +### actions (SMC) +Function definitions. +https://www.w3.org/2019/wot/td#ActionAffordance + +### events (SMC) +Event definitions. +https://www.w3.org/2019/wot/td#EventAffordance + +--- + +## properties (SMC) +Collection of interaction properties. +https://www.w3.org/2019/wot/td#hasPropertyAffordance + +--- + +## property_name (SMC) +Defines datapoint characteristics. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/PropertyDefinition + +### key (Property) +Optional key. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/key + +### title (Property) +Human-readable title. +https://www.w3.org/2019/wot/td#title + +### observable (Property) +Observation indicator. +https://www.w3.org/2019/wot/td#isObservable + +### forms (SMC) +Resource locations. +https://www.w3.org/2019/wot/td#hasForm + +### type (Property) +Datatype indicator. +https://www.w3.org/1999/02/22-rdf-syntax-ns#type + +### const (Property) +Constant value. +https://www.w3.org/2019/wot/json-schema#const + +### enum (SML) +Restricted value list. +https://www.w3.org/2019/wot/json-schema#enum + +### default (Property) +Default value. +https://www.w3.org/2019/wot/json-schema#default + +### unit (Property) +Measurement unit. +https://schema.org/unitCode + +### min_max (Range) +Numeric limits. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/minMaxRange + +### lengthRange (Range) +String length range. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/lengthRange + +### itemsRange (Range) +Array length limits. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/itemsRange + +### items (SMC) +Array item schema. +https://www.w3.org/2019/wot/json-schema#items + +### valueSemantics (Ref) +Semantic meaning. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/valueSemantics + +--- + +## ExternalDescriptor (SMC) +Reference to external descriptors. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/ExternalDescriptor + +### descriptorName (File) +Descriptor filename. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/externalDescriptorName ## IO-Link specific identifiers diff --git a/idta/AssetInterfacesDescription/1/2/README.md b/idta/AssetInterfacesDescription/1/2/README.md index 5cb1d98..ed0c796 100644 --- a/idta/AssetInterfacesDescription/1/2/README.md +++ b/idta/AssetInterfacesDescription/1/2/README.md @@ -29,6 +29,207 @@ The sub-namespace for Asset Interface Description and its identifiers have been ## Versions: 1.2 This version is the third version to be officially published by IDTA Document `IDTA 02017 Asset Interfaces Description`. +## Interface (SMC) +This SubmodelElementCollection holds the information for EndpointMetadata, InteractionMetadata and ExternalDescriptor. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/Interface + +### title (Property) +Provides a human-readable title. +https://www.w3.org/2019/wot/td#title + +### created (Property) +Provides creation timestamp. +http://purl.org/dc/terms/created + +### modified (Property) +Provides modification timestamp. +http://purl.org/dc/terms/modified + +### support (Property) +Contact information. +https://www.w3.org/2019/wot/td#support + +### EndpointMetadata (SMC) +Metadata of the interface endpoint. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/EndpointMetadata + +### InteractionMetadata (SMC) +Metadata describing datapoints and functions. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/InteractionMetadata + +### ExternalDescriptor (SMC) +Descriptor file references. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/ExternalDescriptor + +--- + +## EndpointMetadata (SMC) +Holds information about the endpoint. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/EndpointMetadata + +### base (Property) +Defines base URI. +https://www.w3.org/2019/wot/td#baseURI + +### contentType (Property) +Defines content type. +https://www.w3.org/2019/wot/hypermedia#forContentType + +### security (SML) +Security configuration. +https://www.w3.org/2019/wot/td#hasSecurityConfiguration + +### modv_mostSignificantByte (Property) +Modbus byte order. +https://www.w3.org/2019/wot/modbus#hasMostSignificantByte + +### modv_mostSignificantWord (Property) +Modbus word order. +https://www.w3.org/2019/wot/modbus#hasMostSignificantWord + +### securityDefinitions (SMC) +Security scheme definitions. +https://www.w3.org/2019/wot/td#definesSecurityScheme + +--- + +## InteractionMetadata (SMC) +Defines interaction affordances. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/InteractionMetadata + +### properties (SMC) +Datapoint definitions. +https://www.w3.org/2019/wot/td#PropertyAffordance + +### actions (SMC) +Function definitions. +https://www.w3.org/2019/wot/td#ActionAffordance + +### events (SMC) +Event definitions. +https://www.w3.org/2019/wot/td#EventAffordance + +--- + +## properties (SMC) +Collection of interaction properties. +https://www.w3.org/2019/wot/td#hasPropertyAffordance + +--- + +## property_name (SMC) +Defines datapoint characteristics. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/PropertyDefinition + +### key (Property) +Optional key. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/key + +### title (Property) +Human-readable title. +https://www.w3.org/2019/wot/td#title + +### observable (Property) +Observation indicator. +https://www.w3.org/2019/wot/td#isObservable + +### forms (SMC) +Resource locations. +https://www.w3.org/2019/wot/td#hasForm + +### type (Property) +Datatype indicator. +https://www.w3.org/1999/02/22-rdf-syntax-ns#type + +### const (Property) +Constant value. +https://www.w3.org/2019/wot/json-schema#const + +### enum (SML) +Restricted value list. +https://www.w3.org/2019/wot/json-schema#enum + +### default (Property) +Default value. +https://www.w3.org/2019/wot/json-schema#default + +### unit (Property) +Measurement unit. +https://schema.org/unitCode + +### min_max (Range) +Numeric limits. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/minMaxRange + +### lengthRange (Range) +String length range. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/lengthRange + +### itemsRange (Range) +Array length limits. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/itemsRange + +### items (SMC) +Array item schema. +https://www.w3.org/2019/wot/json-schema#items + +### valueSemantics (Ref) +Semantic meaning. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/valueSemantics + +--- + +## ExternalDescriptor (SMC) +Reference to external descriptors. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/ExternalDescriptor + +### descriptorName (File) +Descriptor filename. +https://admin-shell.io/idta/AssetInterfacesDescription/1/0/externalDescriptorName + +## IO-Link specific identifiers + +### hasMethod (Property) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/hasMethod + +### hasPayloadDataType (Property) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/hasPayloadDataType + +### hasAccessRights (Property) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/hasAccessRights + +### byteOffset (Property) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/byteOffset + +### byteLength (Property) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/byteLength + +### bitOffset (Property) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/bitOffset + +### bitLength (Property) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/bitLength + +### hasPayloadMapping (SML) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/hasPayloadMapping + +### referenceToProperty (Ref) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/referenceToProperty + +### hasEnumeratedValues (SML) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/hasEnumeratedValues + +### enumeratedValue (SMC) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/enumeratedValue + +### encodedPayload (Property) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/encodedPayload + +### decodedPayload (Property) +https://admin-shell.io/idta/AssetInterfacesDescription/1/1/IO-Link/decodedPayload + + + ## SNMP (SMC) SNMP Specific Identifier