From f22f3db221bd35298acf371ccd1e09077579d75c Mon Sep 17 00:00:00 2001 From: Alberto Abella Date: Tue, 9 Apr 2024 19:19:54 +0200 Subject: [PATCH] updated I4SubmodelElementProperty/doc/spec_ES.md --- I4SubmodelElementProperty/doc/spec_ES.md | 706 +++++++++++++++++++++++ 1 file changed, 706 insertions(+) create mode 100644 I4SubmodelElementProperty/doc/spec_ES.md diff --git a/I4SubmodelElementProperty/doc/spec_ES.md b/I4SubmodelElementProperty/doc/spec_ES.md new file mode 100644 index 0000000..a6b540d --- /dev/null +++ b/I4SubmodelElementProperty/doc/spec_ES.md @@ -0,0 +1,706 @@ + +[![Smart Data Models](https://smartdatamodels.org/wp-content/uploads/2022/01/SmartDataModels_logo.png "Logo")](https://smartdatamodels.org) + Entidad: I4SubmodelElementProperty +================================== + + [Licencia abierta](https://github.com/smart-data-models//dataModel.AAS/blob/master/I4SubmodelElementProperty/LICENSE.md) + [documento generado automáticamente](https://docs.google.com/presentation/d/e/2PACX-1vTs-Ng5dIAwkg91oTTUdt8ua7woBXhPnwavZ0FxgR8BsAI_Ek3C5q97Nd94HS8KhP-r_quD4H0fgyt3/pub?start=false&loop=false&delayms=3000#slide=id.gb715ace035_0_60) + + + Descripción global: **Basado en IDTA-01001-3-0, asigna un RAMI4.0 SubmodelElement genérico que representa una PROPIEDAD o atributo de un AAS referenciado. Norma RAMI4.0** + versión: 0.0.1 + + + + ## Lista de propiedades + + [*] Si no hay un tipo en un atributo es porque puede tener varios tipos o diferentes formatos/patrones. +- `address[object]`: La dirección postal . Model: [https://schema.org/address](https://schema.org/address) - `addressCountry[string]`: El país. Por ejemplo, España . Model: [https://schema.org/addressCountry](https://schema.org/addressCountry) + - `addressLocality[string]`: La localidad en la que se encuentra la dirección postal, y que está en la región . Model: [https://schema.org/addressLocality](https://schema.org/addressLocality) + - `addressRegion[string]`: La región en la que se encuentra la localidad, y que está en el país . Model: [https://schema.org/addressRegion](https://schema.org/addressRegion) + - `district[string]`: Un distrito es un tipo de división administrativa que, en algunos países, gestiona el gobierno local + - `postOfficeBoxNumber[string]`: El número del apartado de correos para las direcciones de apartados postales. Por ejemplo, 03578 . Model: [https://schema.org/postOfficeBoxNumber](https://schema.org/postOfficeBoxNumber) + - `postalCode[string]`: El código postal. Por ejemplo, 24004 . Model: [https://schema.org/https://schema.org/postalCode](https://schema.org/https://schema.org/postalCode) + - `streetAddress[string]`: La dirección . Model: [https://schema.org/streetAddress](https://schema.org/streetAddress) + - `streetNr[string]`: Número que identifica una propiedad específica en una vía pública +- `alternateName[string]`: Un nombre alternativo para este artículo - `areaServed[string]`: La zona geográfica en la que se presta un servicio o se ofrece un artículo . Model: [https://schema.org/Text](https://schema.org/Text) - `category[string]`: La categoría es un valor que proporciona información adicional sobre la clase del elemento. - `constraints[array]`: Restricciones que indican qué valores pueden tomarse simultáneamente. Especificación de la Shell de Administración de Activos RAMI4.0. Versión 3.0RC02 - `dataProvider[string]`: Una secuencia de caracteres que identifica al proveedor de la entidad de datos armonizada - `dateCreated[date-time]`: Fecha de creación de la entidad. Normalmente será asignada por la plataforma de almacenamiento - `dateModified[date-time]`: Marca de tiempo de la última modificación de la entidad. Suele ser asignada por la plataforma de almacenamiento - `description[string]`: Descripción de este artículo - `descriptions[array]`: Para añadir conocimientos detallados sobre el Elemento en distintas lenguas - `hasDataSpecification[array]`: Elemento que puede ampliarse utilizando plantillas de especificación de datos. Un modelo de especificación de datos define un conjunto de atributos adicionales que un elemento puede o debe tener. Especificación RAMI4.0 - `id[*]`: Identificador único de la entidad - `idShort[string]`: Short id es el nombre (corto) del SubmodelElement dentro del entorno RAMI40 - `kind[string]`: Para distinguir entre "tipo" e "instancia", se utiliza el término "clase". - `location[*]`: Referencia Geojson al elemento. Puede ser Point, LineString, Polygon, MultiPoint, MultiLineString o MultiPolygon. - `modelType[object]`: Para distinguir entre "tipo" e "instancia", se utiliza el término "clase". - `name[string]`: Propiedad del elemento. Normalmente se establece -Operación- para este tipo +- `name[string]`: El nombre de este artículo - `owner[array]`: Una lista que contiene una secuencia de caracteres codificada en JSON que hace referencia a los identificadores únicos de los propietarios. - `refI4AASId[string]`: Hace referencia al Shell raíz de la Administración de Activos al que pertenece este SubmodelElement - `refI4AssetId[string]`: Hace referencia al Activo raíz al que pertenece este SubmodelElement - `refI4SubmodelId[string]`: Hace referencia al Submodel raíz al que pertenece este SubmodelElement - `seeAlso[*]`: lista de uri que apuntan a recursos adicionales sobre el artículo - `semanticId[object]`: Remite a una fuente de información externa, que explica la formulación del elemento del submodelo - `keys[array]`: Conjunto de claves vinculadas al sematicID del modelo en un objeto +- `source[string]`: Secuencia de caracteres que indica la fuente original de los datos de la entidad en forma de URL. Se recomienda que sea el nombre de dominio completo del proveedor de origen o la URL del objeto de origen. - `type[string]`: Tiene que ser de tipo Entidad NGSI RAMI4.0 I4SubmodelElementProperty para representar un componente de operación de submodelo digital AAS RAMI4.0 - `value[['integer', 'string', 'number']]`: El valor dado en formato cadena/entero - `valueId[string]`: ID del elemento de los elementos del submodelo - `valueType[object]`: Propiedad: tipo de valor utilizado en formato de cadena - `dataObjectType[object]`: Propiedad del elemento. string, integer, float, num etc. se utilizan set para este tipo + + + Propiedades requeridas +- `id` - `type` + + + + ## Descripción de las propiedades del modelo de datos + Ordenados alfabéticamente (pulse para más detalles) + + +
full yaml details + ```yaml +I4SubmodelElementProperty: + description: 'Based on IDTA-01001-3-0, maps a generic RAMI4.0 SubmodelElement representing a PROPERTY or attribute of a referenced AAS. RAMI4.0 Standard' + properties: + address: + description: The mailing address + properties: + addressCountry: + description: 'The country. For example, Spain' + type: string + x-ngsi: + model: https://schema.org/addressCountry + type: Property + addressLocality: + description: 'The locality in which the street address is, and which is in the region' + type: string + x-ngsi: + model: https://schema.org/addressLocality + type: Property + addressRegion: + description: 'The region in which the locality is, and which is in the country' + type: string + x-ngsi: + model: https://schema.org/addressRegion + type: Property + district: + description: 'A district is a type of administrative division that, in some countries, is managed by the local government' + type: string + x-ngsi: + type: Property + postOfficeBoxNumber: + description: 'The post office box number for PO box addresses. For example, 03578' + type: string + x-ngsi: + model: https://schema.org/postOfficeBoxNumber + type: Property + postalCode: + description: 'The postal code. For example, 24004' + type: string + x-ngsi: + model: https://schema.org/https://schema.org/postalCode + type: Property + streetAddress: + description: The street address + type: string + x-ngsi: + model: https://schema.org/streetAddress + type: Property + streetNr: + description: Number identifying a specific property on a public street + type: string + x-ngsi: + type: Property + type: object + x-ngsi: + model: https://schema.org/address + type: Property + alternateName: + description: An alternative name for this item + type: string + x-ngsi: + type: Property + areaServed: + description: The geographic area where a service or offered item is provided + type: string + x-ngsi: + model: https://schema.org/Text + type: Property + category: + description: The category is a value that gives further meta information w.r.t. to the class of the element + type: string + x-ngsi: + type: Property + constraints: + description: Constraints which tells which values can be taken simultaneously. RAMI4.0 Asset Administration Shell specification. Version 3.0RC02 + items: + properties: + type: + description: 'Link, url, constraint ID (AAS Version 3.0RC02) or description of the constrain to be applied' + type: string + x-ngsi: + type: Property + type: object + type: array + x-ngsi: + type: Property + dataProvider: + description: A sequence of characters identifying the provider of the harmonised data entity + type: string + x-ngsi: + type: Property + dateCreated: + description: Entity creation timestamp. This will usually be allocated by the storage platform + format: date-time + type: string + x-ngsi: + type: Property + dateModified: + description: Timestamp of the last modification of the entity. This will usually be allocated by the storage platform + format: date-time + type: string + x-ngsi: + type: Property + description: + description: A description of this item + type: string + x-ngsi: + type: Property + descriptions: + description: For adding detailed knowledge about the Element in different languages + items: + properties: + language: + description: Substring identifying the language. Acronym according to ISO 639-1 + type: string + x-ngsi: + type: Property + text: + description: The Description text is filled here + type: string + x-ngsi: + type: Property + type: object + type: array + x-ngsi: + type: Property + hasDataSpecification: + description: Element that can be extended by using data specification templates. A data specification template defines a named set of additional attributes an element may or shall have. RAMI4.0 specification + items: + description: Every element of the data specification + properties: + type: + description: 'Link, url or description of the specified data. DataSpecification template conformant to IEC61360' + type: string + x-ngsi: + type: Property + type: object + x-ngsi: + type: Property + type: array + x-ngsi: + type: Property + id: + anyOf: + - description: Identifier format of any NGSI entity + maxLength: 256 + minLength: 1 + pattern: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$ + type: string + x-ngsi: + type: Property + - description: Identifier format of any NGSI entity + format: uri + type: string + x-ngsi: + type: Property + description: Unique identifier of the entity + x-ngsi: + type: Property + idShort: + description: Short id is the (short) name of the SubmodelElement within RAMI40 environment + type: string + x-ngsi: + type: Property + kind: + description: 'For the distinction of ''type'' and ''instance'', the term ''kind'' is used' + type: string + x-ngsi: + type: Property + location: + description: 'Geojson reference to the item. It can be Point, LineString, Polygon, MultiPoint, MultiLineString or MultiPolygon' + oneOf: + - description: Geojson reference to the item. Point + properties: + bbox: + items: + type: number + minItems: 4 + type: array + coordinates: + items: + type: number + minItems: 2 + type: array + type: + enum: + - Point + type: string + required: + - type + - coordinates + title: GeoJSON Point + type: object + x-ngsi: + type: GeoProperty + - description: Geojson reference to the item. LineString + properties: + bbox: + items: + type: number + minItems: 4 + type: array + coordinates: + items: + items: + type: number + minItems: 2 + type: array + minItems: 2 + type: array + type: + enum: + - LineString + type: string + required: + - type + - coordinates + title: GeoJSON LineString + type: object + x-ngsi: + type: GeoProperty + - description: Geojson reference to the item. Polygon + properties: + bbox: + items: + type: number + minItems: 4 + type: array + coordinates: + items: + items: + items: + type: number + minItems: 2 + type: array + minItems: 4 + type: array + type: array + type: + enum: + - Polygon + type: string + required: + - type + - coordinates + title: GeoJSON Polygon + type: object + x-ngsi: + type: GeoProperty + - description: Geojson reference to the item. MultiPoint + properties: + bbox: + items: + type: number + minItems: 4 + type: array + coordinates: + items: + items: + type: number + minItems: 2 + type: array + type: array + type: + enum: + - MultiPoint + type: string + required: + - type + - coordinates + title: GeoJSON MultiPoint + type: object + x-ngsi: + type: GeoProperty + - description: Geojson reference to the item. MultiLineString + properties: + bbox: + items: + type: number + minItems: 4 + type: array + coordinates: + items: + items: + items: + type: number + minItems: 2 + type: array + minItems: 2 + type: array + type: array + type: + enum: + - MultiLineString + type: string + required: + - type + - coordinates + title: GeoJSON MultiLineString + type: object + x-ngsi: + type: GeoProperty + - description: Geojson reference to the item. MultiLineString + properties: + bbox: + items: + type: number + minItems: 4 + type: array + coordinates: + items: + items: + items: + items: + type: number + minItems: 2 + type: array + minItems: 4 + type: array + type: array + type: array + type: + enum: + - MultiPolygon + type: string + required: + - type + - coordinates + title: GeoJSON MultiPolygon + type: object + x-ngsi: + type: GeoProperty + x-ngsi: + type: GeoProperty + modelType: + description: 'For the distinction of ''type'' and ''instance'', the term ''kind'' is used' + properties: + name: + description: Property of the item. Usually -Operation- is set for this type + type: string + x-ngsi: + type: Property + type: object + x-ngsi: + type: Property + name: + description: The name of this item + type: string + x-ngsi: + type: Property + owner: + description: A List containing a JSON encoded sequence of characters referencing the unique Ids of the owner(s) + items: + anyOf: + - description: Identifier format of any NGSI entity + maxLength: 256 + minLength: 1 + pattern: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$ + type: string + x-ngsi: + type: Property + - description: Identifier format of any NGSI entity + format: uri + type: string + x-ngsi: + type: Property + description: Unique identifier of the entity + x-ngsi: + type: Property + type: array + x-ngsi: + type: Property + refI4AASId: + description: References the root Asset Administration Shell which this SubmodelElement belongs to + type: string + x-ngsi: + type: Relationship + refI4AssetId: + description: References the root Asset which this SubmodelElement belongs to + type: string + x-ngsi: + type: Relationship + refI4SubmodelId: + description: References the root Submodel which this SubmodelElement belongs to + type: string + x-ngsi: + type: Relationship + seeAlso: + description: list of uri pointing to additional resources about the item + oneOf: + - items: + format: uri + type: string + minItems: 1 + type: array + - format: uri + type: string + x-ngsi: + type: Property + semanticId: + description: 'It refers to an external information source, which explains the formulation of the submodel element' + properties: + keys: + description: Set of keys linked to the sematicID of the model in an object + items: + description: Every object containing the keys + properties: + idType: + description: References the ID of the type + type: string + x-ngsi: + type: Property + index: + description: Integer value of the item + type: number + x-ngsi: + type: Property + local: + description: Describes a local or not item + type: boolean + x-ngsi: + type: Property + value: + description: Describes/includes the corresponding value + type: string + x-ngsi: + type: Property + type: object + x-ngsi: + type: Property + type: array + x-ngsi: + type: Property + type: object + x-ngsi: + type: Property + source: + description: 'A sequence of characters giving the original source of the entity data as a URL. Recommended to be the fully qualified domain name of the source provider, or the URL to the source object' + type: string + x-ngsi: + type: Property + type: + description: It has to be RAMI4.0 I4SubmodelElementProperty NGSI Entity type to represent a RAMI4.0 AAS Digital Twin Submodel Operation component + enum: + - I4SubmodelElementProperty + type: string + x-ngsi: + type: Property + value: + description: Property.The given value in string/integer format + type: + - integer + - string + - number + valueId: + description: ID of the item of the submodel elements + type: string + x-ngsi: + type: Property + valueType: + description: Property.The value type used in string format + properties: + dataObjectType: + description: 'Property of the item. string, integer, float, num etc. are used set for this type' + properties: + name: + description: Name of the property + type: string + x-ngsi: + type: Property + type: object + x-ngsi: + type: Property + type: object + required: + - id + - type + type: object + x-derived-from: https://industrialdigitaltwin.org/en/wp-content/uploads/sites/2/2023/04/IDTA-01001-3-0_SpecificationAssetAdministrationShell_Part1_Metamodel.pdf + x-disclaimer: 'Redistribution and use in source and binary forms, with or without modification, are permitted provided that the license conditions are met. Copyleft (c) 2024 Contributors to Smart Data Models Program' + x-license-url: https://github.com/smart-data-models/dataModel.AAS/blob/master/I4SubmodelElementProperty/LICENSE.md + x-model-schema: https://smart-data-models.github.io/dataModel.AAS/I4SubmodelElementProperty/schema.json + x-model-tags: Corosect + x-version: 0.0.1 +``` +
+ + + + + ## Ejemplo de carga útil + #### I4SubmodelElementProperty NGSI-v2 key-values Ejemplo + He aquí un ejemplo de un I4SubmodelElementProperty en formato JSON-LD como key-values. Esto es compatible con NGSI-v2 cuando se utiliza `options=keyValues` y devuelve los datos de contexto de una entidad individual. +
show/hide example + ```json + { + "id": "urn:ngsi-v2:RAMI40:I4SubmodelElementProperty:AssetConditionMonitoring:MRobotStatus:AASMRobotVI", + "type": "I4SubmodelElementProperty", + "category": "PARAMETER", + "constraints": [], + "descriptions": [ + { + "language": "en", + "text": "Telling about the overall status of the robot" + } + ], + "hasDataSpecification": [], + "idShort": "MRobotStatus", + "kind": "Instance", + "modelType": { + "name": "Property" + }, + "refI4AASId": "urn:ngsi-v2:RAMI40:I4AAS:MRobotVI:AASMRobotVI", + "refI4AssetId": "urn:ngsi-v2:RAMI40:I4Asset:MRobotVI:AASMRobotVI", + "refI4SubmodelId": "urn:ngsi-v2:RAMI40:I4Submodel:AssetConditionMonitoring:AASMRobotVI", + "semanticId": { + "keys": [ + { + "type": "ConceptDescription", + "local": true, + "value": "0173-1#02-ABC132#001", + "index": 0, + "idType": "IRDI" + } + ] + }, + "value": 21, + "valueId": "ref033X", + "valueType": { + "dataObjectType": { + "name": "string" + } + } +} +``` +
+ #### I4SubmodelElementProperty NGSI-v2 normalizado Ejemplo + He aquí un ejemplo de un I4SubmodelElementProperty en formato JSON-LD normalizado. Esto es compatible con NGSI-v2 cuando no se utilizan opciones y devuelve los datos de contexto de una entidad individual. +
show/hide example + ```json + { + "id": "urn:ngsi-v2:RAMI40:I4SubmodelElementProperty:OperationalData:VIResults:AASMRobotVI", + "type": "I4SubmodelElementProperty", + "idShort": { + "type": "Text", + "value": "VIResults", + "metadata": {} + }, + "refI4AASId": { + "type": "Text", + "value": "urn:ngsi-v2:RAMI40:I4AAS:MRobotVI:AASMRobotVI", + "metadata": {} + }, + "refI4AssetId": { + "type": "Text", + "value": "urn:ngsi-v2:RAMI40:I4Asset:MRobotVI:AASMRobotVI", + "metadata": {} + }, + "refI4SubmodelId": { + "type": "Text", + "value": "urn:ngsi-v2:RAMI40:I4Submodel:OperationalData:AASMRobotVI", + "metadata": {} + }, + "value": { + "type": "Text", + "value": { + "Egg percentage": 14.385, + "Crate_ID": 1 + }, + "metadata": {} + } +} +``` +
+ #### I4SubmodelElementProperty NGSI-LD key-values Ejemplo + He aquí un ejemplo de un I4SubmodelElementProperty en formato JSON-LD como key-values. Esto es compatible con NGSI-LD cuando se utiliza `options=keyValues` y devuelve los datos de contexto de una entidad individual. +
show/hide example + ```json + { + "id": "urn:ngsi-v2:RAMI40:I4SubmodelElementProperty:AssetConditionMonitoring:MRobotStatus:AASMRobotVI", + "type": "I4SubmodelElementProperty", + "category": "PARAMETER", + "constraints": [], + "descriptions": [ + { + "language": "en", + "text": "Telling about the overall status of the robot" + } + ], + "hasDataSpecification": [], + "idShort": "MRobotStatus", + "kind": "Instance", + "modelType": { + "name": "Property" + }, + "refI4AASId": "urn:ngsi-v2:RAMI40:I4AAS:MRobotVI:AASMRobotVI", + "refI4AssetId": "urn:ngsi-v2:RAMI40:I4Asset:MRobotVI:AASMRobotVI", + "refI4SubmodelId": "urn:ngsi-v2:RAMI40:I4Submodel:AssetConditionMonitoring:AASMRobotVI", + "semanticId": { + "keys": [ + { + "type": "ConceptDescription", + "local": true, + "value": "0173-1#02-ABC132#001", + "index": 0, + "idType": "IRDI" + } + ] + }, + "value": 21, + "valueId": "ref033X", + "valueType": { + "dataObjectType": { + "name": "string" + } + }, + "@context": [ + "https://smart-data-models.github.io/dataModel.AAS/context.jsonld" + ] +} +``` +
+ #### I4SubmodelElementProperty NGSI-LD normalizado Ejemplo + He aquí un ejemplo de un I4SubmodelElementProperty en formato JSON-LD normalizado. Esto es compatible con NGSI-LD cuando no se utilizan opciones y devuelve los datos de contexto de una entidad individual. +
show/hide example + ```json + { + "id": "urn:ngsi-v2:RAMI40:I4SubmodelElementProperty:OperationalData:VIResults:AASMRobotVI", + "type": "I4SubmodelElementProperty", + "idShort": { + "type": "Property", + "value": "VIResults" + }, + "refI4AASId": { + "type": "Property", + "value": "urn:ngsi-v2:RAMI40:I4AAS:MRobotVI:AASMRobotVI" + }, + "refI4AssetId": { + "type": "Property", + "value": "urn:ngsi-v2:RAMI40:I4Asset:MRobotVI:AASMRobotVI" + }, + "refI4SubmodelId": { + "type": "Property", + "value": "urn:ngsi-v2:RAMI40:I4Submodel:OperationalData:AASMRobotVI" + }, + "value": { + "type": "Property", + "value": { + "Egg percentage": 14.385, + "Crate_ID": 1 + } + }, + "@context": [ + "https://smart-data-models.github.io/dataModel.AAS/context.jsonld" + ] +} +``` +
+ + + + Consulte [FAQ 10](https://smartdatamodels.org/index.php/faqs/) para obtener una respuesta sobre cómo tratar las unidades de magnitud. + + +--- + [Smart Data Models](https://smartdatamodels.org) +++ [Contribution Manual](https://bit.ly/contribution_manual) +++ [About](https://bit.ly/Introduction_SDM)