Skip to content

spec.md

Latest commit

 

History

History
678 lines (620 loc) · 22.4 KB

spec.md

File metadata and controls

678 lines (620 loc) · 22.4 KB

Smart Data Models

Entity: NightSkyQuality

Open License

document generated automatically

Global description: Data regarding the observed sky quality and the status of the measuring device.

version: 0.0.2

List of properties

[*] If there is not a type in an attribute is because it could have several types or different formats/patterns

  • address[object]: The mailing address . Model: https://schema.org/address
  • alternateName[string]: An alternative name for this item
  • ambientTemperature[number]: Temperature measurement
  • areaServed[string]: The geographic area where a service or offered item is provided . Model: https://schema.org/Text
  • battery[number]: Voltage provided by the battery
  • batteryLevel[*]: Device battery level. It must be equal to 1.0 when battery is full. 0.0 when battery is empty. -1 when transiently cannot be determined . Model: https://schema.org/Number
  • clouds[string]: Qualitative indicator of the amount of cloud cover
  • dataProvider[string]: A sequence of characters identifying the provider of the harmonised data entity
  • dateCreated[date-time]: Entity creation timestamp. This will usually be allocated by the storage platform
  • dateModified[date-time]: Timestamp of the last modification of the entity. This will usually be allocated by the storage platform
  • description[string]: A description of this item
  • id[*]: Unique identifier of the entity
  • location[*]: Geojson reference to the item. It can be Point, LineString, Polygon, MultiPoint, MultiLineString or MultiPolygon
  • name[string]: The name of this item
  • owner[array]: A List containing a JSON encoded sequence of characters referencing the unique Ids of the owner(s)
  • seeAlso[*]: list of uri pointing to additional resources about the item
  • sigmaMagnitude[number]: Unitless parameter, expressing the Standard Deviation corresponding to the measurement of sky magnitude
  • skyMagnitude[number]: Unitless parameter: the measurement taken by the device, corresponding to the apparent magnitude of the night sky (that is, its brightness)
  • skyTemperature[number]: Direct measurement of the sky temperature, as taken by the device
  • source[string]: 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]: NGSI Entity type. It has to be MosquitoDensity

Required properties

  • id
  • location
  • type

Data Model description of properties

Sorted alphabetically (click for details)

full yaml details 
NightSkyQuality:    
  description: Data regarding the observed sky quality and the status of the measuring device.    
  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    
    ambientTemperature:    
      description: Temperature measurement    
      type: number    
      x-ngsi:    
        type: Property    
        units: degrees Celsius (C)    
    areaServed:    
      description: The geographic area where a service or offered item is provided    
      type: string    
      x-ngsi:    
        model: https://schema.org/Text    
        type: Property    
    battery:    
      description: Voltage provided by the battery    
      type: number    
      x-ngsi:    
        type: Property    
        units: Changes relative to the  millivolts (mV)    
    batteryLevel:    
      description: Device battery level. It must be equal to 1.0 when battery is full. 0.0 when battery is empty. -1 when transiently cannot be determined    
      oneOf:    
        - maximum: 1    
          minimum: 0    
          type: number    
        - maximum: -1    
          minimum: -1    
          type: number    
      x-ngsi:    
        model: https://schema.org/Number    
        type: Property    
    clouds:    
      description: Qualitative indicator of the amount of cloud cover    
      type: string    
      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    
    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    
    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    
    sigmaMagnitude:    
      description: 'Unitless parameter, expressing the Standard Deviation corresponding to the measurement of sky magnitude'    
      type: number    
      x-ngsi:    
        type: Property    
    skyMagnitude:    
      description: 'Unitless parameter: the measurement taken by the device, corresponding to the apparent magnitude of the night sky (that is, its brightness)'    
      type: number    
      x-ngsi:    
        type: Property    
    skyTemperature:    
      description: 'Direct measurement of the sky temperature, as taken by the device'    
      type: number    
      x-ngsi:    
        type: Property    
        units: degrees Celsius (C)    
    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: NGSI Entity type. It has to be MosquitoDensity    
      enum:    
        - NightSkyQuality    
      type: string    
      x-ngsi:    
        type: Property    
  required:    
    - id    
    - type    
    - location    
  type: object    
  x-derived-from: ""    
  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) 2023 Contributors to Smart Data Models Program'    
  x-license-url: https://github.com/smart-data-models/dataModel.Environment/blob/master/NightSkyQuality/LICENSE.md    
  x-model-schema: https://smart-data-models.github.io/dataModel.NightSkyQuality/NightSkyQuality/schema.json    
  x-model-tags: ""    
  x-version: 0.0.2

Example payloads

NightSkyQuality NGSI-v2 key-values Example

Here is an example of a NightSkyQuality in JSON-LD format as key-values. This is compatible with NGSI-v2 when using options=keyValues and returns the context data of an individual entity.

show/hide example 
{  
  "id": "DTI-036",  
  "type": "NightSkyQuality",  
  "ambientTemperature": 10.17,  
  "battery": 3691,  
  "clouds": "Despejado",  
  "dateCreated": "2023-03-15T14:00:00.000Z",  
  "dateModified": "2023-03-15T14:10:00.000Z",  
  "location": {  
    "type": "Point",  
    "coordinates": [  
      -103.9904,  
      39.7564  
    ]  
  },  
  "sigmaMagnitude": 0.003,  
  "skyMagnitude": 19.4,  
  "skyTemperature": -6.23  
}

NightSkyQuality NGSI-v2 normalized Example

Here is an example of a NightSkyQuality in JSON-LD format as normalized. This is compatible with NGSI-v2 when not using options and returns the context data of an individual entity.

show/hide example 
{  
  "id": "DTI-036",  
  "type": "NightSkyQuality",  
  "ambientTemperature": {  
    "type": "Number",  
    "value": 10.17  
  },  
  "battery": {  
    "type": "Number",  
    "value": 3691  
  },  
  "clouds": {  
    "type": "Text",  
    "value": "Despejado"  
  },  
  "dateCreated": {  
    "type": "DateTime",  
    "value": "2023-03-15T14:00:00.000Z"  
  },  
  "dateModified": {  
    "type": "DateTime",  
    "value": "2023-03-15T14:10:00.000Z"  
  },  
  "location": {  
    "type": "geo:json",  
    "value": {  
      "type": "Point",  
      "coordinates": [  
        -103.9904,  
        39.7564  
      ]  
    }  
  },  
  "sigmaMagnitude": {  
    "type": "Number",  
    "value": 0.003  
  },  
  "skyMagnitude": {  
    "type": "Number",  
    "value": 19.4  
  },  
  "skyTemperature": {  
    "type": "Number",  
    "value": -6.23  
  }  
}

NightSkyQuality NGSI-LD key-values Example

Here is an example of a NightSkyQuality in JSON-LD format as key-values. This is compatible with NGSI-LD when using options=keyValues and returns the context data of an individual entity.

show/hide example 
{  
  "id": "DTI-036",  
  "type": "NightSkyQuality",  
  "ambientTemperature": 10.17,  
  "battery": 3691,  
  "clouds": "Despejado",  
  "dateCreated": "2023-03-15T14:00:00.000Z",  
  "dateModified": "2023-03-15T14:10:00.000Z",  
  "location": {  
    "type": "Point",  
    "coordinates": [  
      -103.9904,  
      39.7564  
    ]  
  },  
  "sigmaMagnitude": 0.003,  
  "skyMagnitude": 19.4,  
  "skyTemperature": -6.23,  
  "@context": [  
    "https://smart-data-models.github.io/dataModel.Environment/NightSkyQuality/schema.json"  
  ]  
}

NightSkyQuality NGSI-LD normalized Example

Here is an example of a NightSkyQuality in JSON-LD format as normalized. This is compatible with NGSI-LD when not using options and returns the context data of an individual entity.

show/hide example 
{  
  "id": "DTI-036",  
  "type": "NightSkyQuality",  
  "ambientTemperature": {  
    "type": "Property",  
    "value": 10.17  
  },  
  "battery": {  
    "type": "Property",  
    "value": 3691  
  },  
  "clouds": {  
    "type": "Property",  
    "value": "Despejado"  
  },  
  "dateCreated": {  
    "type": "Property",  
    "value": {  
      "@type": "date-time",  
      "@value": "2023-03-15T14:00:00.000Z"  
    }  
  },  
  "dateModified": {  
    "type": "DateTime",  
    "value": {  
      "@type": "date-time",  
      "@value": "2023-03-15T14:10:00.000Z"  
    }  
  },  
  "location": {  
    "type": "GeoProperty",  
    "value": {  
      "type": "Point",  
      "coordinates": [  
        -103.9904,  
        39.7564  
      ]  
    }  
  },  
  "sigmaMagnitude": {  
    "type": "Property",  
    "value": 0.003  
  },  
  "skyMagnitude": {  
    "type": "Property",  
    "value": 19.4  
  },  
  "skyTemperature": {  
    "type": "Property",  
    "value": -6.23  
  },  
  "@context": [  
    "https://smart-data-models.github.io/dataModel.Environment/NightSkyQuality/schema.json"  
  ]  
}

See FAQ 10 to get an answer on how to deal with magnitude units

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