Smart Data Models - Device Model schema


This entity captures the static properties of a Device.

root allOf GSMA-Commons
Type: object

All from GSMA-Commons https://smart-data-models.github.io/data-models/common-schema.json#/definitions/GSMA-Commons

root allOf item 0 id
Type: object

Property. Unique identifier of the entity

root allOf item 0 id anyOf item 0
Type: string

Property. Identifier format of any NGSI entity

Must match regular expression: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$

Must be at least 1 characters long

Must be at most 256 characters long

root allOf item 0 id anyOf item 1
Type: string

Property. Identifier format of any NGSI entity

root allOf item 0 dateCreated
Type: string

Property. Entity creation timestamp. This will usually be allocated by the storage platform.

root allOf item 0 dateModified
Type: string

Property. Timestamp of the last modification of the entity. This will usually be allocated by the storage platform.

root allOf item 0 source
Type: string

Property. 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.

root allOf item 0 name
Type: string

Property. The name of this item.

root allOf item 0 alternateName
Type: string

Property. An alternative name for this item

root allOf item 0 description
Type: string

Property. A description of this item

root allOf item 0 dataProvider
Type: string

Property. A sequence of characters identifying the provider of the harmonised data entity.

root allOf item 0 owner
Type: array

Property. A List containing a JSON encoded sequence of characters referencing the unique Ids of the owner(s)

Each item of this array must be:

root allOf item 0 owner EntityIdentifierType
Type: object

Property. Unique identifier of the entity

Same definition as id

root allOf item 0 seeAlso

Property. list of uri pointing to additional resources about the item

root allOf item 0 seeAlso oneOf item 0
Type: array of string

Must contain a minimum of 1 items

Each item of this array must be:

root allOf item 0 seeAlso oneOf item 0 items
Type: string
root allOf item 0 seeAlso oneOf item 1
Type: string
root allOf Location-Commons
Type: object

All from Location-Commons https://smart-data-models.github.io/data-models/common-schema.json#/definitions/Location-Commons

root allOf item 1 location

Geoproperty. Geojson reference to the item. It can be Point, LineString, Polygon, MultiPoint, MultiLineString or MultiPolygon

root allOf item 1 location oneOf GeoJSON Point
Type: object

Geoproperty. Geojson reference to the item. Point

root allOf item 1 location oneOf GeoJSON Point type
Type: enum (of string)

Must be one of:

  • "Point"

root allOf item 1 location oneOf GeoJSON Point coordinates
Type: array of number

Must contain a minimum of 2 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON Point coordinates items
Type: number

root allOf item 1 location oneOf GeoJSON Point bbox
Type: array of number

Must contain a minimum of 4 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON Point bbox items
Type: number
root allOf item 1 location oneOf GeoJSON LineString
Type: object

Geoproperty. Geojson reference to the item. LineString

root allOf item 1 location oneOf GeoJSON LineString type
Type: enum (of string)

Must be one of:

  • "LineString"

root allOf item 1 location oneOf GeoJSON LineString coordinates
Type: array of array

Must contain a minimum of 2 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON LineString coordinates items
Type: array of number

Must contain a minimum of 2 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON LineString coordinates items items
Type: number

root allOf item 1 location oneOf GeoJSON LineString bbox
Type: array of number

Must contain a minimum of 4 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON LineString bbox items
Type: number
root allOf item 1 location oneOf GeoJSON Polygon
Type: object

Geoproperty. Geojson reference to the item. Polygon

root allOf item 1 location oneOf GeoJSON Polygon type
Type: enum (of string)

Must be one of:

  • "Polygon"

root allOf item 1 location oneOf GeoJSON Polygon coordinates
Type: array of array

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON Polygon coordinates items
Type: array of array

Must contain a minimum of 4 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON Polygon coordinates items items
Type: array of number

Must contain a minimum of 2 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON Polygon coordinates items items items
Type: number

root allOf item 1 location oneOf GeoJSON Polygon bbox
Type: array of number

Must contain a minimum of 4 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON Polygon bbox items
Type: number
root allOf item 1 location oneOf GeoJSON MultiPoint
Type: object

Geoproperty. Geojson reference to the item. MultiPoint

root allOf item 1 location oneOf GeoJSON MultiPoint type
Type: enum (of string)

Must be one of:

  • "MultiPoint"

root allOf item 1 location oneOf GeoJSON MultiPoint coordinates
Type: array of array

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiPoint coordinates items
Type: array of number

Must contain a minimum of 2 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiPoint coordinates items items
Type: number

root allOf item 1 location oneOf GeoJSON MultiPoint bbox
Type: array of number

Must contain a minimum of 4 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiPoint bbox items
Type: number
root allOf item 1 location oneOf GeoJSON MultiLineString
Type: object

Geoproperty. Geojson reference to the item. MultiLineString

root allOf item 1 location oneOf GeoJSON MultiLineString type
Type: enum (of string)

Must be one of:

  • "MultiLineString"

root allOf item 1 location oneOf GeoJSON MultiLineString coordinates
Type: array of array

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiLineString coordinates items
Type: array of array

Must contain a minimum of 2 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiLineString coordinates items items
Type: array of number

Must contain a minimum of 2 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiLineString coordinates items items items
Type: number

root allOf item 1 location oneOf GeoJSON MultiLineString bbox
Type: array of number

Must contain a minimum of 4 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiLineString bbox items
Type: number
root allOf item 1 location oneOf GeoJSON MultiPolygon
Type: object

Geoproperty. Geojson reference to the item. MultiLineString

root allOf item 1 location oneOf GeoJSON MultiPolygon type
Type: enum (of string)

Must be one of:

  • "MultiPolygon"

root allOf item 1 location oneOf GeoJSON MultiPolygon coordinates
Type: array of array

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiPolygon coordinates items
Type: array of array

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiPolygon coordinates items items
Type: array of array

Must contain a minimum of 4 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiPolygon coordinates items items items
Type: array of number

Must contain a minimum of 2 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiPolygon coordinates items items items items
Type: number

root allOf item 1 location oneOf GeoJSON MultiPolygon bbox
Type: array of number

Must contain a minimum of 4 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiPolygon bbox items
Type: number

root allOf item 1 address
Type: object

Property. The mailing address. Model:'https://schema.org/address'

root allOf item 1 address streetAddress
Type: string

Property. The street address. Model:'https://schema.org/streetAddress'

root allOf item 1 address addressLocality
Type: string

Property. The locality in which the street address is, and which is in the region. Model:'https://schema.org/addressLocality'

root allOf item 1 address addressRegion
Type: string

Property. The region in which the locality is, and which is in the country. Model:'https://schema.org/addressRegion'

root allOf item 1 address addressCountry
Type: string

Property. The country. For example, Spain. Model:'https://schema.org/addressCountry'

root allOf item 1 address postalCode
Type: string

Property. The postal code. For example, 24004. Model:'https://schema.org/https://schema.org/postalCode'

root allOf item 1 address postOfficeBoxNumber
Type: string

Property. The post office box number for PO box addresses. For example, 03578. Model:'https://schema.org/postOfficeBoxNumber'

root allOf item 1 areaServed
Type: string

Property. The geographic area where a service or offered item is provided. Model:'https://schema.org/Text'
root allOf Device-Commons
Type: object

All from Device-Commons https://smart-data-models.github.io/dataModel.Device/device-schema.json#/definitions/Device-Commons

root allOf item 2 category
Type: array of enum (of string)

Property. Model:'https://schema.org/Text'. Sensor: A device that detects and responds to events or changes in the physical environment such as light, motion, or temperature changes. https://w3id.org/saref#Sensor. actuator : A device responsible for moving or controlling a mechanism or system. https://w3id.org/saref#Actuator. Meter : A device built to accurately detect and display a quantity in a form readable by a human being. Partially defined by SAREF. HVAC : Heating, Ventilation and Air Conditioning (HVAC) device that provides indoor environmental comfort. https://w3id.org/saref#HVAC. Network : A device used to connect other devices in a network, such as hub, switch or router in a LAN or Sensor network. (https://w3id.org/saref#Network. Multimedia : A device designed to display, store, record or play multimedia content such as audio, images, animation, video. Enum:'actuator, beacon, endgun, HVAC, implement, irrSection, irrSystem, meter, multimedia, network, sensor'

Each item of this array must be:

root allOf item 2 category items
Type: enum (of string)

Must be one of:

  • "actuator"
  • "beacon"
  • "endgun"
  • "HVAC"
  • "implement"
  • "irrSection"
  • "irrSystem"
  • "meter"
  • "multimedia"
  • "network"
  • "sensor"

root allOf item 2 controlledProperty
Type: array of enum (of string)

Property. Model:'https://schema.org/Text'. Anything that can be sensed, measured or controlled by. Enum:'airPollution, atmosphericPressure, averageVelocity, batteryLife, batterySupply, cdom, conductance, conductivity, depth, eatingActivity, eatingActivity, electricityConsumption, energy, fillingLevel, freeChlorine, gasConsumption, gateOpening, heading, humidity, light, location, milking, motion, movementActivity, noiseLevel, occupancy, orp, pH, power, precipitation, pressure, refractiveIndex, salinity, smoke, soilMoisture, solarRadiation, speed, tds, temperature, trafficFlow, tss, turbidity, waterConsumption, waterFlow, waterLevel, waterPollution, weatherConditions, weight, windDirection, windSpeed'

Each item of this array must be:

root allOf item 2 controlledProperty items
Type: enum (of string)

Must be one of:

  • "airPollution"
  • "atmosphericPressure"
  • "averageVelocity"
  • "batteryLife"
  • "batterySupply"
  • "cdom"
  • "conductance"
  • "conductivity"
  • "depth"
  • "eatingActivity"
  • "eatingActivity"
  • "electricityConsumption"
  • "energy"
  • "fillingLevel"
  • "freeChlorine"
  • "gasConsumption"
  • "gateOpening"
  • "heading"
  • "humidity"
  • "light"
  • "location"
  • "milking"
  • "motion"
  • "movementActivity"
  • "noiseLevel"
  • "occupancy"
  • "orp"
  • "pH"
  • "power"
  • "precipitation"
  • "pressure"
  • "refractiveIndex"
  • "salinity"
  • "smoke"
  • "soilMoisture"
  • "solarRadiation"
  • "speed"
  • "tds"
  • "temperature"
  • "trafficFlow"
  • "tss"
  • "turbidity"
  • "waterConsumption"
  • "waterFlow"
  • "waterLevel"
  • "waterPollution"
  • "weatherConditions"
  • "weight"
  • "windDirection"
  • "windSpeed"

root allOf item 2 supportedProtocol
Type: array of enum (of string)

Property. Model:'https://schema.org/Text'. Supported protocol(s) or networks. Model:'3g, bluetooth, bluetooth LE, cat-m, coap, ec-gsm-iot, gprs, http, lwm2m, lora, lte-m, mqtt, nb-iot, onem2m, sigfox, ul20, websocket'

Each item of this array must be:

root allOf item 2 supportedProtocol items
Type: enum (of string)

Must be one of:

  • "3g"
  • "bluetooth"
  • "bluetooth LE"
  • "cat-m"
  • "coap"
  • "ec-gsm-iot"
  • "gprs"
  • "http"
  • "lwm2m"
  • "lora"
  • "lte-m"
  • "mqtt"
  • "nb-iot"
  • "onem2m"
  • "sigfox"
  • "ul20"
  • "websocket"

root allOf item 2 macAddress
Type: string

Property. Model:'https://schema.org/Text'. The MAC address of the device.

 Must match regular expression: ^([[:xdigit:]]{2}[:.-]?){5}[[:xdigit:]]{2}$
root allOf item 3
Type: object

root allOf item 3 type
Type: enum (of string)

Property. NGSI Entity type. it has to be DeviceModel

Must be one of:

  • "DeviceModel"

root allOf item 3 deviceClass
Type: enum (of string)

Property. Model:'https://schema.org/Text'. Class of constrained device as specified by RFC 7228. If the device is not a constrained device this property shall not be present. Normative References: RFC7228. Enum:'C0, C1, C2'

Must be one of:

  • "C0"
  • "C1"
  • "C2"

root allOf item 3 function
Type: array of enum (of string)

Property. Model:'https://schema.org/Text'. The functionality necessary to accomplish the task for which a Device is designed. A device can be designed to perform more than one function. Defined by SAREF. Enum:'levelControl, sensing, onOff, openClose, metering, eventNotification

Each item of this array must be:

root allOf item 3 function items
Type: enum (of string)

Must be one of:

  • "levelControl"
  • "sensing"
  • "onOff"
  • "openClose"
  • "metering"
  • "eventNotification"

root allOf item 3 supportedUnits
Type: array of string

Property. Model:'https://schema.org/Text'. Units of measurement supported by the device. The unit code (text) of measurement given using the UN/CEFACT Common Code (max. 3 characters).

Each item of this array must be:

root allOf item 3 supportedUnits items
Type: string

root allOf item 3 energyLimitationClass
Type: enum (of string)

Property. Model:'https://schema.org/Text'. Device's class of energy limitation as per RFC 7228. Normative References: RFC7228. Enum:'E0, E1, E2, E9'

Must be one of:

  • "E0"
  • "E1"
  • "E2"
  • "E9"

root allOf item 3 documentation
Type: string

Property. Model:'https://schema.org/URL'. A link to device's documentation.

root allOf item 3 brandName
Type: string

Property. Model:'https://schema.org/Text'. Device's brand name.

root allOf item 3 modelName
Type: string

Property. Model:'https://schema.org/Text. Device's model name.

root allOf item 3 manufacturerName
Type: string

Property. Model:'https://schema.org/Text'. Device's manufacturer name.

The following properties are required: