Skip to content

spec_ZH.md

Latest commit

 

History

History
716 lines (660 loc) · 26.7 KB

spec_ZH.md

File metadata and controls

716 lines (660 loc) · 26.7 KB
Raw

Smart Data Models

实体：单元控制元素

开放许可

文件自动生成

全球描述：单元式控制元件将多个控制元件组合成一个产品，如恒温器或湿度调节器。 单元式控制元件为控制元件或配电元件的组合提供了一个外壳，这些元件组合在一起可实现单一（单元）的目的。集合体中的每个元件都有自己的几何形状和位置。

版本： 0.0.1

属性列表

[*] 如果属性中没有类型，是因为它可能有多个类型或不同的格式/模式。

  • address[object]: 邮寄地址 . Model: https://schema.org/address
  • alternateName[string]: 该项目的替代名称
  • areaServed[string]: 提供服务或提供物品的地理区域 . Model: https://schema.org/Text
  • dataProvider[string]: 标识统一数据实体提供者的字符序列
  • dateCreated[date-time]: 实体创建时间戳。通常由存储平台分配
  • dateModified[date-time]: 实体最后一次修改的时间戳。通常由存储平台分配
  • description[string]: 项目描述
  • hasManufacturer[string]: 标识实体（如设备）制造商的关系。该值应为字符串或带有语言标记的字符串。
  • hasModel[string]: 标识实体（如设备）模型的关系。该值应是字符串或带有语言标记的字符串
  • id[*]: 实体的唯一标识符
  • isContainedInBuildingSpace[*]: 用于定义楼宇物理空间的实体。建筑空间包含设备或建筑对象。(建筑空间）
  • isContainedInPhysicalObject[*]: 任何具有适当空间区域的物体。 (从 DUL 本体中提取的定义）（物理对象）
  • isSubSystemOf[array]: 该物理对象所属系统的引用
  • location[*]: 项目的 Geojson 引用。它可以是点、线条字符串、多边形、多点、多线条字符串或多多边形
  • name[string]: 该项目的名称
  • owner[array]: 包含一个 JSON 编码字符序列的列表，其中引用了所有者的唯一 Ids
  • seeAlso[*]: 指向有关该项目的其他资源的 uri 列表
  • source[string]: 以 URL 形式给出实体数据原始来源的字符串。建议使用源提供者的完全合格域名或源对象的 URL
  • type[string]: 必须等于 `UnitaryControlElement

所需属性

  • id
  • type

属性的数据模型描述

按字母顺序排列（点击查看详情）

full yaml details 
UnitaryControlElement:      
  description: 'A unitary control element combines a number of control components into a single product, such as a thermostat or humidistat.  A unitary control element provides a housing for an aggregation of control or electrical distribution elements that, in combination, perform a singular (unitary) purpose. Each item in the aggregation may have its own geometric representation and location.'      
  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 `UnitaryControlElement`      
      enum:      
        - UnitaryControlElement      
      type: string      
      x-ngsi:      
        type: Property      
  required:      
    - id      
    - type      
  type: object      
  x-derived-from: "https://saref.etsi.org/saref4bldg/v1.1.2/#s4bldg:UnitaryControlElement"      
  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/UnitaryControlElement/LICENSE.md      
  x-model-schema: https://smart-data-models.github.com/dataModel.SAREF4BLDG/UnitaryControlElement/schema.json      
  x-model-tags: SAREF UnitaryControlElement      
  x-version: 0.0.1

有效载荷示例

UnitaryControlElement NGSI-v2 键值示例

下面是一个以 JSON-LD 格式作为键值的 UnitaryControlElement 示例。当使用 options=keyValues 时，它与 NGSI-v2 兼容，并返回单个实体的上下文数据。

show/hide example 
{  
  "id": "urn:ngsi-ld:UnitaryControlElement:9b0091cc-67a4-4ee5-9897-0003eee7a3aa",  
  "type": "UnitaryControlElement",  
  "isContainedInBuildingSpace": "urn:ngsi-ld:BuildingSpace:24bf0631-f744-4194-bdf5-def458f3ba69",  
  "isContainedInPhysicalObject": "urn:ngsi-ld:PhysicalObject:5dce9d0b-6e08-42e1-a51a-7ef621a04bbe",  
  "isSubSystemOf": [  
    "urn:ngsi-ld:System:79c4846e-e92e-4a08-b330-d1bee78542b5",  
    "urn:ngsi-ld:System:7744a54d-7f3f-46f7-bb9d-9a63eeb42d21",  
    "urn:ngsi-ld:System:e0468a21-2fb0-45b9-be57-a15df4734b9c"  
  ],  
  "hasManufacturer": "UnitaryControlElement Company Inc.",  
  "hasModel": "UnitaryControlElement 0.1.2",  
  "dateCreated": "2023-01-26T07:59:17Z",  
  "dateModified": "2023-01-26T06:48:06Z",  
  "source": "Import",  
  "name": "UnitaryControlElement",  
  "alternateName": "UnitaryControlElement type 2",  
  "description": "UnitaryControlElement of limited UnitaryControlElement types",  
  "dataProvider": "IFC file"  
}

UnitaryControlElement NGSI-v2 标准化示例

下面是一个规范化 JSON-LD 格式的 UnitaryControlElement 示例。当不使用选项时，它与 NGSI-v2 兼容，并返回单个实体的上下文数据。

show/hide example 
{  
  "id": "urn:ngsi-ld:UnitaryControlElement:c84da314-c30d-44b5-b771-d76d46dcdb99",  
  "type": "UnitaryControlElement",  
  "isContainedInBuildingSpace": {  
    "type": "Text",  
    "value": "urn:ngsi-ld:BuildingSpace:a04769fb-fa20-497e-b7d0-2c654a1cd175"  
  },  
  "isContainedInPhysicalObject": {  
    "type": "Text",  
    "value": "urn:ngsi-ld:PhysicalObject:64da82f5-692e-4e35-8455-8875b528bd2d"  
  },  
  "isSubSystemOf": {  
    "type": "StructuredValue",  
    "value": [  
      "urn:ngsi-ld:System:ca9a9e7a-ed2d-40d3-8522-59bea2ce734f",  
      "urn:ngsi-ld:System:092a9dd6-2c61-4a96-8bcd-1f9f636265a0",  
      "urn:ngsi-ld:System:d4d65fa2-766f-4e47-bc86-feb9d1d97a81"  
    ]  
  },  
  "hasManufacturer": {  
    "type": "Text",  
    "value": "UnitaryControlElement Company Inc."  
  },  
  "hasModel": {  
    "type": "Text",  
    "value": "UnitaryControlElement 0.1.2"  
  },  
  "dateCreated": {  
    "type": "DateTime",  
    "value": "2023-01-25T22:08:29.4344968+01:00"  
  },  
  "dateModified": {  
    "type": "DateTime",  
    "value": "2023-01-26T10:21:30.9945735+01:00"  
  },  
  "source": {  
    "type": "Text",  
    "value": "Import"  
  },  
  "name": {  
    "type": "Text",  
    "value": "UnitaryControlElement"  
  },  
  "alternateName": {  
    "type": "Text",  
    "value": "UnitaryControlElement type 2"  
  },  
  "description": {  
    "type": "Text",  
    "value": "UnitaryControlElement of limited UnitaryControlElement types"  
  },  
  "dataProvider": {  
    "type": "Text",  
    "value": "IFC file"  
  }  
}

UnitaryControlElement NGSI-LD 键值示例

下面是一个以 JSON-LD 格式作为键值的 UnitaryControlElement 示例。当使用 options=keyValues 时，它与 NGSI-LD 兼容，并返回单个实体的上下文数据。

show/hide example 
{  
  "id": "urn:ngsi-ld:UnitaryControlElement:240a91ac-96f1-442e-8184-325d360bfeaa",  
  "type": "UnitaryControlElement",  
  "isContainedInBuildingSpace": "urn:ngsi-ld:BuildingSpace:0f0dae53-507c-46b8-9652-417a9b85118c",  
  "isContainedInPhysicalObject": "urn:ngsi-ld:PhysicalObject:d2ef380f-dd2f-416a-842b-e9edaec6477e",  
  "isSubSystemOf": [  
    "urn:ngsi-ld:System:d419231f-a58e-4cf4-8ab4-0d8cb3979026",  
    "urn:ngsi-ld:System:0bd1035c-e8ad-45c2-8358-3ac3885fb48f",  
    "urn:ngsi-ld:System:16151825-9a3e-4fd1-a31a-275d7d74588a"  
  ],  
  "hasManufacturer": "UnitaryControlElement Company Inc.",  
  "hasModel": "UnitaryControlElement 0.1.2",  
  "dateCreated": "2023-01-25T16:01:16Z",  
  "dateModified": "2023-01-25T18:51:09Z",  
  "source": "Import",  
  "name": "UnitaryControlElement",  
  "alternateName": "UnitaryControlElement type 2",  
  "description": "UnitaryControlElement of limited UnitaryControlElement 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"  
  ]  
}

UnitaryControlElement NGSI-LD 标准化示例

下面是一个规范化 JSON-LD 格式的 UnitaryControlElement 示例。当不使用选项时，它与 NGSI-LD 兼容，并返回单个实体的上下文数据。

show/hide example 
{  
  "id": "urn:ngsi-ld:UnitaryControlElement:6e5343a3-0c93-4a64-9e20-5c9d682c9b09",  
  "type": "UnitaryControlElement",  
  "isContainedInBuildingSpace": {  
    "type": "Relationship",  
    "object": "urn:ngsi-ld:BuildingSpace:3c70c2ee-eacd-4141-a8eb-8059ad543d83"  
  },  
  "isContainedInPhysicalObject": {  
    "type": "Relationship",  
    "object": "urn:ngsi-ld:PhysicalObject:154c01a9-25e7-4c1e-84c9-3551c8b546c4"  
  },  
  "isSubSystemOf": [  
    {  
      "type": "Relationship",  
      "object": "urn:ngsi-ld:System:025947da-781f-4c60-bf99-633a2b421de0"  
    },  
    {  
      "type": "Relationship",  
      "object": "urn:ngsi-ld:System:9d4d3b16-a69f-48e6-a30e-78538ebb8383"  
    },  
    {  
      "type": "Relationship",  
      "object": "urn:ngsi-ld:System:31c054bd-c83d-441e-8527-44d30a44a698"  
    }  
  ],  
  "hasManufacturer": {  
    "type": "Property",  
    "value": "UnitaryControlElement Company Inc."  
  },  
  "hasModel": {  
    "type": "Property",  
    "value": "UnitaryControlElement 0.1.2"  
  },  
  "dateCreated": {  
    "type": "Property",  
    "value": "2023-01-26T05:50:48Z"  
  },  
  "dateModified": {  
    "type": "Property",  
    "value": "2023-01-26T05:44:54Z"  
  },  
  "source": {  
    "type": "Property",  
    "value": "Import"  
  },  
  "name": {  
    "type": "Property",  
    "value": "UnitaryControlElement"  
  },  
  "alternateName": {  
    "type": "Property",  
    "value": "UnitaryControlElement type 2"  
  },  
  "description": {  
    "type": "Property",  
    "value": "UnitaryControlElement of limited UnitaryControlElement 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"  
  ]  
}

请参阅 FAQ 10，获取如何处理幅度单位的答案。

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