Device.md

Device

This entity contains a harmonised description of a generic device. This entity provides an essentially static description of a generic device and is therefore applicable to all IoT segments and related IoT applications.

<Device><Generic Attributes>

Attribute Name	Attribute Type	Description	Mandatory /Optional	May be Null
id	Text	Unique id of this instance of this entity.	M	N
type	Text	Must be equal to "Device".	M	N
dateCreated	DateTime	Entity creation timestamp.	M	N
dateModified	DateTime	Timestamp of the last modification of the entity.	M	Y
source	Text	A sequence of characters giving the source of the entity data as a URL.	M	Y
dataProvider	Text	A sequence of characters identifying the originator of the harmonised entity.	M	Y

<Device><Entity Specific Attributes>

Attribute Name	Attribute Type	Description	Mandatory /Optional	May be Null
refDeviceModel	Reference	Unique id of this device model selected from DeviceModel.	M	N
serialNumber	Text	The serial number assigned by the manufacturer.	M	N
supplierName	Text	The details of the supplier of this device.	O	Y
manufacturerCountry	Text	The country where this device was manufactured.	O	Y
factory	Text	The factory manufacturing this device.	O	Y
dateManufactured	DateTime	The ISO8601 sequence of characters at which the device was manufactured in UTC.	M	N
description	Text	An optional description of this device.	O	Y
owner	Array of Reference	An array containing a JSON encoded sequence of characters referencing the unique Ids of the owner(s). Related to a Schema.org person or organization. https://schema.org/Person https://schema.org/Organization	O	Y
dateInstalled	DateTime	The ISO8601 sequence of characters at which the device was installed in UTC.	M	N
dateFirstUsed	DateTime	The ISO8601 sequence of characters at which the device was first used in UTC.	M	N
hardwareVersion	Text	The hardware version of this device.	M	N
firmwareVersion	Text	The firmware version of this device.	M	N
softwareVersion	Text	The software version of this device.	M	N
osVersion	Text	The operating system version of this device.	M	N
supportedProtocol	Array of Text	An array element per supported communication protocol.	M	N
location	geo:json	The geo:json encoded location, of this device.	O	Y
online	Boolean	The communication status of this device. A logical representation of Offline or Online.	M	N
status	Text	The JSON format device status description. Manufacturer or device. specific status codes generated by the device.	O	Y
dateLastCalibration	DateTime	The date this device was last calibrated.	O	Y
batteryLevel	ExtQuantitativeValue (Number)	Battery level. It must be equal to: 1.0 When the battery charge is full. 0.0 When the battery charge empty. Null when it cannot be determined. encoded as a ExtQuantitativeValue.	O	Y
value	ExtQuantitativeValue (Number)	The observed or reported value, for control applications the reported device setting value encoded as a ExtQuantitativeValue.	O	Y

Device JSON

The JSON code can be downloaded from:

https://gist.github.com/GSMADeveloper/8bec6a39f34601fffc430b7b0f306df8

{
  "id": "ba2d4fd9-f57f-4610-a589-2d52670d14f3",
  "type": "Device",
  "dateCreated": {
    "value": "2016-08-08T10:18:16Z",
    "type": "DateTime"
  },
  "dateModified": {
    "value": "2016-08-08T10:18:16Z",
    "type": "DateTime"
  },
  "source": {
    "value": "http://www.example.com",
    "type": "URL"
  },
  "dataProvider": {
    "value": "OperatorA",
    "type": "Text"
  },
  "refDeviceModel": {
    "value": "d1be2e61-d9e7-43cd-9c68-51e0861b3a49",
    "type": "Reference"
  },
  "serialNumber": {
    "value": "123456789",
    "type": "Text"
  },
  "supplierName": {
    "value": "ACME Direct, Inc.",
    "type": "Text"
  },
  "manufacturerCountry": {
    "value": "UK",
    "type": "Text"
  },
  "factory": {
    "value": "unknown",
    "type": "Text"
  },
  "dateManufactured": {
    "value": "2016-08-21T10:18:16Z",
    "type": "DateTime"
  },
  "description": {
    "value": "Thermocouple",
    "type": "Text"
  },
  "owner": [
    "43c46ff2-b0f7-4e4f-838a-adee1c9cae88",
    "ebf421c9-363b-4ed4-97a0-93a6e39786ff"
  ],
  "dateInstalled": {
    "value": "2016-08-22T10:18:16Z",
    "type": "DateTime"
  },
  "dateFirstUsed": {
    "value": "2016-08-22T10:18:16Z",
    "type": "DateTime"
  },
  "hardwareVersion": {
    "value": "1.2",
    "type": "Text"
  },
  "firmwareVersion": {
    "value": "2.8.56",
    "type": "Text"
  },
  "softwareVersion": {
    "value": "2.5.11",
    "type": "Text"
  },
  "osVersion": {
    "value": "8.1",
    "type": "Text"
  },
  "supportedProtocols": [
    "HTTP",
    "HTTPS",
    "FTP"
  ],
  "location": {
    "value": {
      "type": "Point",
      "coordinates": [
        -104.99404,
        39.75621
      ]
    },
    "type": "geo:json"
  },
  "online": {
    "value": "TRUE",
    "type": "Boolean"
  },
  "status": {
    "value": "SC1001",
    "type": "Text"
  },
  "dateLastCalibration": {
    "value": "2016-08-22T10:18:16Z",
    "type": "DateTime"
  },
  "batteryLevel": {
    "value": {
      "value": 0.7
    },
    "type": "ExtQuantitativeValue"
  },
  "value": {
    "value": {
      "value": 1
    },
    "type": "ExtQuantitativeValue"
  }
}