Skip to content

Latest commit

 

History

History
884 lines (827 loc) · 31 KB

spec_ZH.md

File metadata and controls

884 lines (827 loc) · 31 KB
Raw

Smart Data Models

实体：颜色 RGB

开放许可

文件自动生成

全局描述：**每个颜色值由一个红、绿、蓝分量描述，这些颜色值被编码为一个整数数组（[R,G,B]）。每个分量的最小和最大颜色值可由属性 "范围 "描述。

版本： 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]: 项目描述
  • id[*]: 实体的唯一标识符
  • if[array]: 该资源支持的 OCF 接口集
  • location[*]: 项目的 Geojson 引用。它可以是点、线条字符串、多边形、多点、多线条字符串或多多边形
  • n[string]: 资源的友好名称
  • name[string]: 该项目的名称
  • owner[array]: 包含一个 JSON 编码字符序列的列表，其中引用了所有者的唯一 Ids
  • range[array]: 资源中属性的有效范围（整数）。数组中的第一个值是最小值，数组中的第二个值是最大值
  • rgbValue[array]: RGB 值；第一项是 R，第二项是 G，第三项是 B
  • rt[array]: 资源类型
  • seeAlso[*]: 指向有关该项目的其他资源的 uri 列表
  • source[string]: 以 URL 形式给出实体数据原始来源的字符串。建议使用源提供者的完全合格域名或源对象的 URL
  • step[number]: 当范围为整数时，定义范围内的步长值。 这是整个范围内有效值的增量；因此，如果范围为 0...10，步长为 2，则有效值为 0,2,4,6,8,10
  • type[string]: NGSI 实体类型。必须是 ColourRGB

所需属性

  • id
  • rgbValue
  • type

数据模型改编自开放连接基金会创建的原始数据。原始资料库 https://github.com/openconnectivityfoundation/IoTDataModels

属性的数据模型描述

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

full yaml details 
ColourRGB:      
  description: 'This Resource specifies the actual colour in the RGB space represented as an array of integers.Each colour value is described with a Red, Green, Blue component.These colour values are encoded as an array of integer values ([R,G,B]).The minimum and maximum colour value per component may be described by the Property ''range''.When ''range'' is omitted, then the ''range'' is [0,255].'      
  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      
    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      
    if:      
      description: The OCF Interface set supported by this Resource      
      items:      
        enum:      
          - oic.if.a      
          - oic.if.baseline      
        type: string      
      minItems: 2      
      readOnly: true      
      type: array      
      uniqueItems: true      
      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      
    n:      
      description: Friendly name of the Resource      
      maxLength: 64      
      readOnly: true      
      type: string      
      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      
    range:      
      description: 'The valid range for the Property in the Resource as an integer. The first value in the array is the minimum value, the second value in the array is the maximum value'      
      items:      
        type: integer      
      maxItems: 2      
      minItems: 2      
      readOnly: true      
      type: array      
      x-ngsi:      
        type: Property      
    rgbValue:      
      description: 'The RGB value; the first item is the R, second the G, third the B'      
      items:      
        type: integer      
      maxItems: 3      
      minItems: 3      
      type: array      
      x-ngsi:      
        type: Property      
    rt:      
      description: The Resource Type      
      items:      
        enum:      
          - oic.r.colour.rgb      
        maxLength: 64      
        type: string      
      minItems: 1      
      readOnly: true      
      type: array      
      uniqueItems: true      
      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      
    step:      
      description: 'Step value across the defined range when the range is an integer.  This is the increment for valid values across the range; so if range is 0..10 and step is 2 then valid values are 0,2,4,6,8,10'      
      readOnly: true      
      type: number      
      x-ngsi:      
        type: Property      
    type:      
      description: NGSI entity type. It has to be ColourRGB      
      enum:      
        - ColourRGB      
      type: string      
      x-ngsi:      
        type: Property      
  required:      
    - rgbValue      
    - id      
    - type      
  type: object      
  x-derived-from: https://raw.githubusercontent.com/openconnectivityfoundation/IoTDataModels/master/ColourRGBResURI.swagger.json      
  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.OCF/blob/master/ColourRGB/LICENSE.md      
  x-model-schema: https://smart-data-models.github.io/dataModel.OCF/ColourRGB/schema.json      
  x-model-tags: OCF      
  x-version: 0.0.1

有效载荷示例

ColourRGB NGSI-v2 关键值 示例

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

show/hide example 
{  
  "id": "urn:ngsi-ld:ColourRGB:id:KJWY:68382916",  
  "dateCreated": "2006-08-05T19:36:08Z",  
  "dateModified": "1995-09-26T08:55:09Z",  
  "source": "That line reveal big. Reach picture feel note",  
  "name": "Need Republican nice risk. Evening Republican right then. Trade team less research.",  
  "alternateName": "Name five now ahead attack. Continue vote behavior a maintain. Himself if Congress large land education.",  
  "description": "Myself risk finally this discussion. Citizen beautiful want room force sure draw several.",  
  "dataProvider": "Watch author own stop east point.",  
  "owner": [  
    "urn:ngsi-ld:ColourRGB:items:WTEF:42428519",  
    "urn:ngsi-ld:ColourRGB:items:BGJN:78474606"  
  ],  
  "seeAlso": [  
    "urn:ngsi-ld:ColourRGB:items:YDVE:88023157"  
  ],  
  "location": {  
    "type": "Point",  
    "coordinates": [  
      37.353019,  
      142.932264  
    ]  
  },  
  "address": {  
    "streetAddress": "Carry thing probably consumer billion less. Account source against. Affect keep happy election cell not.",  
    "addressLocality": "Important if before senior. Baby prevent possible behavior dark place",  
    "addressRegion": "Money sing body natural development. Environmental PM chance call son.",  
    "addressCountry": "Camera foreign behind short prepare already field. Various pick stock year.",  
    "postalCode": "Discover act feeling control beat newspaper. Wind",  
    "postOfficeBoxNumber": "West environment appear toward fish. Structure consider early. These first until place character.",  
    "streetNr": "Over true plant sit pattern. Field also rule program big loss song.",  
    "district": "Science through own. Surface very hand house."  
  },  
  "areaServed": "Establish president meeti",  
  "rt": [  
    "oic.r.colour.rgb"  
  ],  
  "rgbValue": [  
    864,  
    864,  
    864  
  ],  
  "n": "American whole magazine truth stop w",  
  "range": [  
    864,  
    864  
  ],  
  "step": 864,  
  "if": [  
    "oic.if.baseline",  
    "oic.if.a"  
  ],  
  "type": "ColourRGB"  
}

ColourRGB NGSI-v2 标准化示例

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

show/hide example 
{  
  "id": "urn:ngsi-ld:ColourRGB:id:KJWY:68382916",  
  "dateCreated": {  
    "type": "DateTime",  
    "value": "2006-08-05T19:36:08Z"  
  },  
  "dateModified": {  
    "type": "DateTime",  
    "value": "1995-09-26T08:55:09Z"  
  },  
  "source": {  
    "type": "Text",  
    "value": "That line reveal big. Reach picture feel note"  
  },  
  "name": {  
    "type": "Text",  
    "value": "Need Republican nice risk. Evening Republican right then. Trade team less research."  
  },  
  "alternateName": {  
    "type": "Text",  
    "value": "Name five now ahead attack. Continue vote behavior a maintain. Himself if Congress large land education."  
  },  
  "description": {  
    "type": "Text",  
    "value": "Myself risk finally this discussion. Citizen beautiful want room force sure draw several."  
  },  
  "dataProvider": {  
    "type": "Text",  
    "value": "Watch author own stop east point."  
  },  
  "owner": {  
    "type": "StructuredValue",  
    "value": [  
      "urn:ngsi-ld:ColourRGB:items:WTEF:42428519",  
      "urn:ngsi-ld:ColourRGB:items:BGJN:78474606"  
    ]  
  },  
  "seeAlso": {  
    "type": "StructuredValue",  
    "value": [  
      "urn:ngsi-ld:ColourRGB:items:YDVE:88023157"  
    ]  
  },  
  "location": {  
    "type": "geo:json",  
    "value": {  
      "type": "Point",  
      "coordinates": [  
        37.353019,  
        142.932264  
      ]  
    }  
  },  
  "address": {  
    "type": "StructuredValue",  
    "value": {  
      "streetAddress": "Carry thing probably consumer billion less. Account source against. Affect keep happy election cell not.",  
      "addressLocality": "Important if before senior. Baby prevent possible behavior dark place",  
      "addressRegion": "Money sing body natural development. Environmental PM chance call son.",  
      "addressCountry": "Camera foreign behind short prepare already field. Various pick stock year.",  
      "postalCode": "Discover act feeling control beat newspaper. Wind",  
      "postOfficeBoxNumber": "West environment appear toward fish. Structure consider early. These first until place character.",  
      "streetNr": "Over true plant sit pattern. Field also rule program big loss song.",  
      "district": "Science through own. Surface very hand house."  
    }  
  },  
  "areaServed": {  
    "type": "Text",  
    "value": "Establish president meeti"  
  },  
  "rt": {  
    "type": "StructuredValue",  
    "value": [  
      "oic.r.colour.rgb"  
    ]  
  },  
  "rgbValue": {  
    "type": "StructuredValue",  
    "value": [  
      864,  
      864,  
      864  
    ]  
  },  
  "n": {  
    "type": "Text",  
    "value": "American whole magazine truth stop w"  
  },  
  "range": {  
    "type": "StructuredValue",  
    "value": [  
      864,  
      864  
    ]  
  },  
  "step": {  
    "type": "Number",  
    "value": 864  
  },  
  "if": {  
    "type": "StructuredValue",  
    "value": [  
      "oic.if.baseline",  
      "oic.if.a"  
    ]  
  },  
  "type": "ColourRGB"  
}

ColourRGB NGSI-LD 关键值 示例

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

show/hide example 
{  
  "id": "urn:ngsi-ld:ColourRGB:id:KJWY:68382916",  
  "dateCreated": "2006-08-05T19:36:08Z",  
  "dateModified": "1995-09-26T08:55:09Z",  
  "source": "That line reveal big. Reach picture feel note",  
  "name": "Need Republican nice risk. Evening Republican right then. Trade team less research.",  
  "alternateName": "Name five now ahead attack. Continue vote behavior a maintain. Himself if Congress large land education.",  
  "description": "Myself risk finally this discussion. Citizen beautiful want room force sure draw several.",  
  "dataProvider": "Watch author own stop east point.",  
  "owner": [  
    "urn:ngsi-ld:ColourRGB:items:WTEF:42428519",  
    "urn:ngsi-ld:ColourRGB:items:BGJN:78474606"  
  ],  
  "seeAlso": [  
    "urn:ngsi-ld:ColourRGB:items:YDVE:88023157"  
  ],  
  "location": {  
    "type": "Point",  
    "coordinates": [  
      37.353019,  
      142.932264  
    ]  
  },  
  "address": {  
    "streetAddress": "Carry thing probably consumer billion less. Account source against. Affect keep happy election cell not.",  
    "addressLocality": "Important if before senior. Baby prevent possible behavior dark place",  
    "addressRegion": "Money sing body natural development. Environmental PM chance call son.",  
    "addressCountry": "Camera foreign behind short prepare already field. Various pick stock year.",  
    "postalCode": "Discover act feeling control beat newspaper. Wind",  
    "postOfficeBoxNumber": "West environment appear toward fish. Structure consider early. These first until place character.",  
    "streetNr": "Over true plant sit pattern. Field also rule program big loss song.",  
    "district": "Science through own. Surface very hand house."  
  },  
  "areaServed": "Establish president meeti",  
  "rt": [  
    "oic.r.colour.rgb"  
  ],  
  "rgbValue": [  
    864,  
    864,  
    864  
  ],  
  "n": "American whole magazine truth stop w",  
  "range": [  
    864,  
    864  
  ],  
  "step": 864,  
  "if": [  
    "oic.if.baseline",  
    "oic.if.a"  
  ],  
  "type": "ColourRGB",  
  "@context": [  
    "https://smartdatamodels.org/context.jsonld"  
  ]  
}

ColourRGB NGSI-LD 标准化示例

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

show/hide example 
{  
    "id": "urn:ngsi-ld:ColourRGB:id:KJWY:68382916",  
    "dateCreated": {  
        "type": "Property",  
        "value": {  
            "@type": "DateTime",  
            "@value": "2006-08-05T19:36:08Z"  
        }  
    },  
    "dateModified": {  
        "type": "Property",  
        "value": {  
            "@type": "DateTime",  
            "@value": "1995-09-26T08:55:09Z"  
        }  
    },  
    "source": {  
        "type": "Property",  
        "value": "That line reveal big. Reach picture feel note"  
    },  
    "name": {  
        "type": "Property",  
        "value": "Need Republican nice risk. Evening Republican right then. Trade team less research."  
    },  
    "alternateName": {  
        "type": "Property",  
        "value": "Name five now ahead attack. Continue vote behavior a maintain. Himself if Congress large land education."  
    },  
    "description": {  
        "type": "Property",  
        "value": "Myself risk finally this discussion. Citizen beautiful want room force sure draw several."  
    },  
    "dataProvider": {  
        "type": "Property",  
        "value": "Watch author own stop east point."  
    },  
    "owner": {  
        "type": "Property",  
        "value": [  
            "urn:ngsi-ld:ColourRGB:items:WTEF:42428519",  
            "urn:ngsi-ld:ColourRGB:items:BGJN:78474606"  
        ]  
    },  
    "seeAlso": {  
        "type": "Property",  
        "value": [  
            "urn:ngsi-ld:ColourRGB:items:YDVE:88023157"  
        ]  
    },  
    "location": {  
        "type": "GeoProperty",  
        "value": {  
            "type": "Point",  
            "coordinates": [  
                37.353019,  
                142.932264  
            ]  
        }  
    },  
    "address": {  
        "type": "Property",  
        "value": {  
            "streetAddress": "Carry thing probably consumer billion less. Account source against. Affect keep happy election cell not.",  
            "addressLocality": "Important if before senior. Baby prevent possible behavior dark place",  
            "addressRegion": "Money sing body natural development. Environmental PM chance call son.",  
            "addressCountry": "Camera foreign behind short prepare already field. Various pick stock year.",  
            "postalCode": "Discover act feeling control beat newspaper. Wind",  
            "postOfficeBoxNumber": "West environment appear toward fish. Structure consider early. These first until place character.",  
            "streetNr": "Over true plant sit pattern. Field also rule program big loss song.",  
            "district": "Science through own. Surface very hand house."  
        }  
    },  
    "areaServed": {  
        "type": "Property",  
        "value": "Establish president meeti"  
    },  
    "rt": {  
        "type": "Property",  
        "value": [  
            "oic.r.colour.rgb"  
        ]  
    },  
    "rgbValue": {  
        "type": "Property",  
        "value": [  
            864,  
            864,  
            864  
        ]  
    },  
    "n": {  
        "type": "Property",  
        "value": "American whole magazine truth stop w"  
    },  
    "range": {  
        "type": "Property",  
        "value": [  
            864,  
            864  
        ]  
    },  
    "step": {  
        "type": "Property",  
        "value": 864  
    },  
    "if": {  
        "type": "Property",  
        "value": [  
            "oic.if.baseline",  
            "oic.if.a"  
        ]  
    },  
    "type": "ColourRGB",  
    "@context": [  
        "https://smartdatamodels.org/context.jsonld"  
    ]  
}

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

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