Skip to content

spec_ES.md

Latest commit

 

History

History
716 lines (660 loc) · 27.9 KB

spec_ES.md

File metadata and controls

716 lines (660 loc) · 27.9 KB
Raw

Smart Data Models

Entidad: FlowInstrument

Licencia abierta

documento generado automáticamente

Descripción global: Un instrumento de flujo lee y muestra el valor de una propiedad particular de un sistema en un punto, o muestra la diferencia en el valor de una propiedad entre dos puntos. La instrumentación suele tener por objeto determinar el valor de la propiedad en un momento dado. La finalidad de un instrumento no es registrar o integrar los valores a lo largo del tiempo (aunque pueden estar conectados a dispositivos de registro que realicen dicha función). Esta entidad contempla todas las formas de instrumentos de flujo mecánicos (termómetros, manómetros, etc.) y eléctricos (amperímetros, voltímetros, etc.).

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
  • 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
  • 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
  • hasManufacturer[string]: Relación que identifica al fabricante de una entidad (por ejemplo, un dispositivo). Se espera que el valor sea una cadena o una cadena con etiqueta de idioma
  • hasModel[string]: Relación que identifica el modelo de una entidad (por ejemplo, un dispositivo). Se espera que el valor sea una cadena o una cadena con etiqueta de idioma
  • id[*]: Identificador único de la entidad
  • isContainedInBuildingSpace[*]: Entidad utilizada para definir los espacios físicos del edificio. Un espacio del edificio contiene dispositivos u objetos del edificio. (Espacio del edificio)
  • isContainedInPhysicalObject[*]: Cualquier Objeto que tiene una región espacial propia. (Definición extraída de la ontología DUL) (PhysicalObject)
  • isSubSystemOf[array]: Referencia al sistema o sistemas de los que forma parte este objeto físico.
  • location[*]: Referencia Geojson al elemento. Puede ser Point, LineString, Polygon, MultiPoint, MultiLineString o MultiPolygon.
  • 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.
  • seeAlso[*]: lista de uri que apuntan a recursos adicionales sobre el artículo
  • 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]: Debe ser igual a FlowInstrument.

Propiedades requeridas

  • id
  • type

Descripción de las propiedades del modelo de datos

Ordenados alfabéticamente (pulse para más detalles)

full yaml details 
FlowInstrument:      
  description: 'A flow instrument reads and displays the value of a particular property of a system at a point, or displays the difference in the value of a property between two points.  Instrumentation is typically for the purpose of determining the value of the property at a point in time. It is not the purpose of an instrument to record or integrate the values over time (although they may be connected to recording devices that do perform such a function). This entity provides for all forms of mechanical flow instrument (thermometers, pressure gauges etc.) and electrical flow instruments (ammeters, voltmeters etc.)'      
  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      
    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      
    hasManufacturer:      
      description: 'A relationship identifying the manufacturer of an entity (e.g., device). The value is expected to be a string or a string with language tag'      
      type: string      
      x-ngsi:      
        type: Property      
    hasModel:      
      description: 'A relationship identifying the model of an entity (e.g., device). The value is expected to be a string or a string with language tag'      
      type: string      
      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      
    isContainedInBuildingSpace:      
      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: An entity used to define the physical spaces of the building. A building space contains devices or building objects. (BuildingSpace)      
      x-ngsi:      
        type: Property      
    isContainedInPhysicalObject:      
      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: Any Object that has a proper space region.  (Definition extracted from DUL ontology) (PhysicalObject)      
      x-ngsi:      
        type: Property      
    isSubSystemOf:      
      description: A reference to a system(s) that this Physical Object is part of      
      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: Relationship      
    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      
    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      
    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      
    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 must be equal to `FlowInstrument`      
      enum:      
        - FlowInstrument      
      type: string      
      x-ngsi:      
        type: Property      
  required:      
    - id      
    - type      
  type: object      
  x-derived-from: "https://saref.etsi.org/saref4bldg/v1.1.2/#s4bldg:FlowInstrument"      
  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) 2022 Contributors to Smart Data Models Program'      
  x-license-url: https://github.com/smart-data-models/dataModel.S4BLDG/blob/master/FlowInstrument/LICENSE.md      
  x-model-schema: https://smart-data-models.github.com/dataModel.SAREF4BLDG/FlowInstrument/schema.json      
  x-model-tags: SAREF FlowInstrument      
  x-version: 0.0.1

Ejemplo de carga útil

FlowInstrument NGSI-v2 key-values Ejemplo

Aquí hay un ejemplo de un FlowInstrument 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 
{  
  "id": "urn:ngsi-ld:FlowInstrument:dae4680c-2e88-47e6-b993-f1e29b3f50c8",  
  "type": "FlowInstrument",  
  "isContainedInBuildingSpace": "urn:ngsi-ld:BuildingSpace:fa1fe74d-f153-43f7-be65-1e4e6498dddd",  
  "isContainedInPhysicalObject": "urn:ngsi-ld:PhysicalObject:415ee32f-19dc-487b-bb68-8d3819ac2bb5",  
  "isSubSystemOf": [  
    "urn:ngsi-ld:System:7c9c5054-0de4-4113-808f-7fe6f98c3c4c",  
    "urn:ngsi-ld:System:befc8c25-4c95-4564-9e8f-2691b142c2aa",  
    "urn:ngsi-ld:System:30e906e9-8f14-4a95-8769-5a741e3ab247"  
  ],  
  "hasManufacturer": "FlowInstrument Company Inc.",  
  "hasModel": "FlowInstrument 0.1.2",  
  "dateCreated": "2023-01-25T22:14:07Z",  
  "dateModified": "2023-01-26T07:11:48Z",  
  "source": "Import",  
  "name": "FlowInstrument",  
  "alternateName": "FlowInstrument type 2",  
  "description": "FlowInstrument of limited FlowInstrument types",  
  "dataProvider": "IFC file"  
}

FlowInstrument NGSI-v2 normalizado Ejemplo

He aquí un ejemplo de un FlowInstrument 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 
{  
  "id": "urn:ngsi-ld:FlowInstrument:0c00b2fc-6e77-40f7-893f-62b6bf889a28",  
  "type": "FlowInstrument",  
  "isContainedInBuildingSpace": {  
    "type": "Text",  
    "value": "urn:ngsi-ld:BuildingSpace:9536fac3-8558-4d91-b41d-0ebc36181d1f"  
  },  
  "isContainedInPhysicalObject": {  
    "type": "Text",  
    "value": "urn:ngsi-ld:PhysicalObject:7d996944-8111-452d-af1a-e9ad243db4e9"  
  },  
  "isSubSystemOf": {  
    "type": "StructuredValue",  
    "value": [  
      "urn:ngsi-ld:System:9c5662ef-5dcd-4b51-9058-5a833f3afe72",  
      "urn:ngsi-ld:System:06ad7437-bd68-4c38-b3ba-3dcb2ad626c7",  
      "urn:ngsi-ld:System:52b6e1ce-e462-4ab0-b156-22a051b05d40"  
    ]  
  },  
  "hasManufacturer": {  
    "type": "Text",  
    "value": "FlowInstrument Company Inc."  
  },  
  "hasModel": {  
    "type": "Text",  
    "value": "FlowInstrument 0.1.2"  
  },  
  "dateCreated": {  
    "type": "DateTime",  
    "value": "2023-01-25T23:14:36.4680373+01:00"  
  },  
  "dateModified": {  
    "type": "DateTime",  
    "value": "2023-01-25T18:10:08.8180513+01:00"  
  },  
  "source": {  
    "type": "Text",  
    "value": "Import"  
  },  
  "name": {  
    "type": "Text",  
    "value": "FlowInstrument"  
  },  
  "alternateName": {  
    "type": "Text",  
    "value": "FlowInstrument type 2"  
  },  
  "description": {  
    "type": "Text",  
    "value": "FlowInstrument of limited FlowInstrument types"  
  },  
  "dataProvider": {  
    "type": "Text",  
    "value": "IFC file"  
  }  
}

FlowInstrument NGSI-LD key-values Ejemplo

Aquí hay un ejemplo de un FlowInstrument 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 
{  
  "id": "urn:ngsi-ld:FlowInstrument:d447c3e2-3835-4bb9-80a3-8d4701a1396b",  
  "type": "FlowInstrument",  
  "isContainedInBuildingSpace": "urn:ngsi-ld:BuildingSpace:0f95033a-db7c-4b6d-879a-60c29086ed63",  
  "isContainedInPhysicalObject": "urn:ngsi-ld:PhysicalObject:cc0d4687-1f82-4e06-af21-c305c5002e8c",  
  "isSubSystemOf": [  
    "urn:ngsi-ld:System:52a46d2f-3cb0-4dd0-ba5a-3c250d549475",  
    "urn:ngsi-ld:System:cd0c8606-a259-4a7b-ba37-5c7f482c48ac",  
    "urn:ngsi-ld:System:313373da-fa79-43b3-8fbb-84cb2cd36777"  
  ],  
  "hasManufacturer": "FlowInstrument Company Inc.",  
  "hasModel": "FlowInstrument 0.1.2",  
  "dateCreated": "2023-01-25T21:58:25Z",  
  "dateModified": "2023-01-25T20:06:56Z",  
  "source": "Import",  
  "name": "FlowInstrument",  
  "alternateName": "FlowInstrument type 2",  
  "description": "FlowInstrument of limited FlowInstrument types",  
  "dataProvider": "IFC file",  
  "@context": [  
    "https://raw.githubusercontent.com/smart-data-models/dataModel.S4BLDG/master/context.jsonld",  
    "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld"  
  ]  
}

FlowInstrument NGSI-LD normalizado Ejemplo

He aquí un ejemplo de un FlowInstrument 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 
{  
  "id": "urn:ngsi-ld:FlowInstrument:410ba33d-1e01-45cd-aff7-00e43a13b5a3",  
  "type": "FlowInstrument",  
  "isContainedInBuildingSpace": {  
    "type": "Relationship",  
    "object": "urn:ngsi-ld:BuildingSpace:3a053b81-b006-4f1c-8ece-a0b6ac287370"  
  },  
  "isContainedInPhysicalObject": {  
    "type": "Relationship",  
    "object": "urn:ngsi-ld:PhysicalObject:9e9a65e8-d47d-4a86-ab3b-f27e71079999"  
  },  
  "isSubSystemOf": [  
    {  
      "type": "Relationship",  
      "object": "urn:ngsi-ld:System:079c7aa5-a497-4294-97ce-d74d1f342d5f"  
    },  
    {  
      "type": "Relationship",  
      "object": "urn:ngsi-ld:System:300fb87b-d35b-409b-8201-96368defed80"  
    },  
    {  
      "type": "Relationship",  
      "object": "urn:ngsi-ld:System:7a99376b-7a65-45e5-8b81-515c9d9676ac"  
    }  
  ],  
  "hasManufacturer": {  
    "type": "Property",  
    "value": "FlowInstrument Company Inc."  
  },  
  "hasModel": {  
    "type": "Property",  
    "value": "FlowInstrument 0.1.2"  
  },  
  "dateCreated": {  
    "type": "Property",  
    "value": "2023-01-25T16:30:30Z"  
  },  
  "dateModified": {  
    "type": "Property",  
    "value": "2023-01-26T10:36:54Z"  
  },  
  "source": {  
    "type": "Property",  
    "value": "Import"  
  },  
  "name": {  
    "type": "Property",  
    "value": "FlowInstrument"  
  },  
  "alternateName": {  
    "type": "Property",  
    "value": "FlowInstrument type 2"  
  },  
  "description": {  
    "type": "Property",  
    "value": "FlowInstrument of limited FlowInstrument types"  
  },  
  "dataProvider": {  
    "type": "Property",  
    "value": "IFC file"  
  },  
  "@context": [  
    "https://raw.githubusercontent.com/smart-data-models/dataModel.S4BLDG/master/context.jsonld",  
    "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld"  
  ]  
}

Consulte FAQ 10 para obtener una respuesta sobre cómo tratar las unidades de magnitud.

Smart Data Models +++ Contribution Manual +++ About