Data Models

Detailed below are the attributes defined in the Agricultural Data Model used in the NGSI-LD tutorial.

Building

A Building is a human build structure where different activities occur related to living, working, healing and so on. Defined in Smart-Data-Models

Swagger : Building

  • id: URN holding the ID of the Building - Required
    • Attribute type: Property.
  • type: The entity type - Required

    • Attribute type: Property.
  • address: The mailing address. - Required

    • Attribute type: Property. address
    • Normative References: https://schema.org/address
  • category: The categories that this building belongs to - Required
    • Attribute type: EnumProperty.
  • containedInPlace: The URL this building resides within
    • Attribute type: Relationship. URL
  • dataProvider: Specifies the URL to information about the provider of this information
    • Attribute type: Property. URL
  • description: A description of the item
    • Attribute type: Property. Text
    • Normative References: http://purl.org/dc/elements/1.1/description
  • floorsAboveGround: Number of floors above ground within the building
    • Attribute type: Property. Integer
  • floorsBelowGround: Number of floors below ground within the building
    • Attribute type: Property. Integer
  • location: The current location of the item
  • occupier: Link to the occupiers of the building
    • Attribute type: Relationship. URL
  • openingHours:
    • Attribute type: Property. openingHours
    • Normative References: https://schema.org/openingHours
  • owner: The owner of this building
    • Attribute type: Relationship. URL
  • refMap: The URL holding a map of the building
    • Attribute type: Property. URL
  • source: A sequence of characters giving the source of the entity data.
    • Attribute type: Property. Text or URL
  • temperature: Property related to some measurements that are characterized by a certain value that is measured in a temperature unit (degree_Celsius, degree_Fahrenheit, or degree_kelvin)
    • Attribute type: Property. Number
    • Meta Data:
      • providedBy: The device that sent this reading
        • Attribute type: Relationship. URL
      • observedAt: A timestamp which denotes when the reading was taken
      • unitCode: A string representing the measurement unit corresponding to the Property value. It shall be encoded using the UN/CEFACT Common Codes for Units of Measurement
        • Attribute type: Property. Text
  • fillingLevel: Property related to some measurements that are characterized by a certain value that is a filling level.
    • Attribute type: Property. Number
    • Meta Data:
      • providedBy: The device that sent this reading
        • Attribute type: Relationship. URL
      • observedAt: A timestamp which denotes when the reading was taken
      • unitCode: A string representing the measurement unit corresponding to the Property value. It shall be encoded using the UN/CEFACT Common Codes for Units of Measurement
        • Attribute type: Property. Text

Temperature Sensor

A device that consists of a sensor, has category saref:Sensor and is used for the purpose of sensing temperature`. . Extension of Device from Smart-Data-Models

Swagger : Device

  • id: URN holding the ID of the Temperature Sensor - Required
    • Attribute type: Property.
  • type: The entity type - Required

    • Attribute type: Property.
  • batteryLevel: Device's battery level. It must be equal to 1.0 when battery is full. 0.0 when battery ìs empty. -1 when transiently cannot be determined.

  • Allowed values: Interval [0,1] and -1
    • Attribute type: Property. Number
  • category: See attribute category from DeviceModel). - Required
    • Attribute type: EnumProperty.
  • configuration: Device's technical configuration. This attribute is intended to be a dictionary of properties which capture parameters which have to do with the configuration of a device (timeouts, reporting periods, etc.) and which are not currently covered by the standard attributes defined by this model.
    • Attribute type: Property. StructuredValue
    • Meta Data:
      • dateModified: Last update timestamp of this attribute
  • controlledAsset: The asset(s) (building, object, etc.) controlled by the device.
    • Attribute type: Relationship. URL
  • controlledProperty: See attribute controlledProperty from DeviceModel). Optional but recommended to optimize queries.
    • Attribute type: EnumProperty.
  • dataProvider: Specifies the URL to information about the provider of this information
    • Attribute type: Property. URL
  • dateFirstUsed: A timestamp which denotes when the device was first used.
  • dateInstalled: A timestamp which denotes when the device was installed
  • dateLastCalibration: A timestamp which denotes when the last calibration of the device happened.
  • dateLastValueReported: A timestamp which denotes the last time when the device successfully reported data to the cloud.
  • dateManufactured: A timestamp which denotes when the device was manufactured.
  • description: A description of the item
    • Attribute type: Property. Text
    • Normative References: http://purl.org/dc/elements/1.1/description
  • deviceState: State of this device from an operational point of view. Its value can be vendor dependent.
    • Attribute type: Property. Text
  • firmwareVersion: The firmware version of this device.
    • Attribute type: Property. Text
  • hardwareVersion: The hardware version of this device.
    • Attribute type: Property. Text
  • ipAddress: The IP address of the device. It can be a comma separated list of values if the device has more than one IP address.
    • Attribute type: Property. Text
  • location: The current location of the item
  • macAddress: The MAC address of the device.
    • Attribute type: Property. Text
  • mcc: Mobile Country Code - This property identifies univoquely the country of the mobile network the device is attached to.
    • Attribute type: Property. Text
  • mnc: This property identifies the Mobile Network Code (MNC) of the network the device is attached to. The MNC is used in combination with a Mobile Country Code (MCC) (also known as a "MCC / MNC tuple") to uniquely identify a mobile phone operator/carrier using the GSM, CDMA, iDEN, TETRA and 3G / 4G public land mobile networks and some satellite mobile
    • Attribute type: Property. Text
  • name: A mnemonic name given to the device.
    • Attribute type: Property. Text
  • osVersion: The version of the host operating system device.
    • Attribute type: Property. Text
  • owner: The owners of a Device.
  • provider: The provider of the device.
  • refDeviceModel: The device's model.
  • rssi: Received signal strength indicator for a wireless enabled device. It must be equal to 1.0 when the signal strength is maximum. 0.0 when signal is missing. -1.0 when it cannot be determined.
  • Allowed values: Interval [0,1] and -1
    • Attribute type: Property. Number
  • serialNumber: The serial number assigned by the manufacturer. see https://schema.org/serialNumber
    • Attribute type: Property. Text
  • softwareVersion: The software version of this device.
    • Attribute type: Property. Text
  • source: A sequence of characters giving the source of the entity data.
    • Attribute type: Property. Text or URL
  • supportedProtocol: See attribute supportedProtocol from DeviceModel). Needed if due to a software update new protocols are supported. Otherwise it is better to convey it at DeviceModel level.
    • Attribute type: EnumProperty.
  • value: A observed or reported value. For actuator devices, it is an attribute that allows a controlling application to change the actuation setting. For instance, a switch device which is currently on can report a value "on"of type Text. Obviously, in order to toggle the referred switch, this attribute value will have to be changed to "off".
  • temperature: Property related to some measurements that are characterized by a certain value that is measured in a temperature unit (degree_Celsius, degree_Fahrenheit, or degree_kelvin) - Required
    • Attribute type: Property. Number
    • Meta Data:
      • providedBy: The device that sent this reading
        • Attribute type: Relationship. URL
      • observedAt: A timestamp which denotes when the reading was taken
      • unitCode: A string representing the measurement unit corresponding to the Property value. It shall be encoded using the UN/CEFACT Common Codes for Units of Measurement
        • Attribute type: Property. Text

Filling Level Sensor

A device that consists of a sensor, has category saref:Sensor and is used for the purpose of sensing filling Level. Extension of Device from Smart-Data-Models

Swagger : Device

  • id: URN holding the ID of the Filling Level Sensor - Required
    • Attribute type: Property.
  • type: The entity type - Required

    • Attribute type: Property.
  • batteryLevel: Device's battery level. It must be equal to 1.0 when battery is full. 0.0 when battery ìs empty. -1 when transiently cannot be determined.

  • Allowed values: Interval [0,1] and -1
    • Attribute type: Property. Number
  • category: See attribute category from DeviceModel). - Required
    • Attribute type: EnumProperty.
  • configuration: Device's technical configuration. This attribute is intended to be a dictionary of properties which capture parameters which have to do with the configuration of a device (timeouts, reporting periods, etc.) and which are not currently covered by the standard attributes defined by this model.
    • Attribute type: Property. StructuredValue
    • Meta Data:
      • dateModified: Last update timestamp of this attribute
  • controlledAsset: The asset(s) (building, object, etc.) controlled by the device.
    • Attribute type: Relationship. URL
  • controlledProperty: See attribute controlledProperty from DeviceModel). Optional but recommended to optimize queries.
    • Attribute type: EnumProperty.
  • dataProvider: Specifies the URL to information about the provider of this information
    • Attribute type: Property. URL
  • dateFirstUsed: A timestamp which denotes when the device was first used.
  • dateInstalled: A timestamp which denotes when the device was installed
  • dateLastCalibration: A timestamp which denotes when the last calibration of the device happened.
  • dateLastValueReported: A timestamp which denotes the last time when the device successfully reported data to the cloud.
  • dateManufactured: A timestamp which denotes when the device was manufactured.
  • description: A description of the item
    • Attribute type: Property. Text
    • Normative References: http://purl.org/dc/elements/1.1/description
  • deviceState: State of this device from an operational point of view. Its value can be vendor dependent.
    • Attribute type: Property. Text
  • firmwareVersion: The firmware version of this device.
    • Attribute type: Property. Text
  • hardwareVersion: The hardware version of this device.
    • Attribute type: Property. Text
  • ipAddress: The IP address of the device. It can be a comma separated list of values if the device has more than one IP address.
    • Attribute type: Property. Text
  • location: The current location of the item
  • macAddress: The MAC address of the device.
    • Attribute type: Property. Text
  • mcc: Mobile Country Code - This property identifies univoquely the country of the mobile network the device is attached to.
    • Attribute type: Property. Text
  • mnc: This property identifies the Mobile Network Code (MNC) of the network the device is attached to. The MNC is used in combination with a Mobile Country Code (MCC) (also known as a "MCC / MNC tuple") to uniquely identify a mobile phone operator/carrier using the GSM, CDMA, iDEN, TETRA and 3G / 4G public land mobile networks and some satellite mobile
    • Attribute type: Property. Text
  • name: A mnemonic name given to the device.
    • Attribute type: Property. Text
  • osVersion: The version of the host operating system device.
    • Attribute type: Property. Text
  • owner: The owners of a Device.
  • provider: The provider of the device.
  • refDeviceModel: The device's model.
  • rssi: Received signal strength indicator for a wireless enabled device. It must be equal to 1.0 when the signal strength is maximum. 0.0 when signal is missing. -1.0 when it cannot be determined.
  • Allowed values: Interval [0,1] and -1
    • Attribute type: Property. Number
  • serialNumber: The serial number assigned by the manufacturer. see https://schema.org/serialNumber
    • Attribute type: Property. Text
  • softwareVersion: The software version of this device.
    • Attribute type: Property. Text
  • source: A sequence of characters giving the source of the entity data.
    • Attribute type: Property. Text or URL
  • supportedProtocol: See attribute supportedProtocol from DeviceModel). Needed if due to a software update new protocols are supported. Otherwise it is better to convey it at DeviceModel level.
    • Attribute type: EnumProperty.
  • value: A observed or reported value. For actuator devices, it is an attribute that allows a controlling application to change the actuation setting. For instance, a switch device which is currently on can report a value "on"of type Text. Obviously, in order to toggle the referred switch, this attribute value will have to be changed to "off".
  • fillingLevel: Property related to some measurements that are characterized by a certain value that is a filling level. - Required
    • Attribute type: Property. Number
    • Meta Data:
      • providedBy: The device that sent this reading
        • Attribute type: Relationship. URL
      • observedAt: A timestamp which denotes when the reading was taken
      • unitCode: A string representing the measurement unit corresponding to the Property value. It shall be encoded using the UN/CEFACT Common Codes for Units of Measurement
        • Attribute type: Property. Text

Person

A person (alive, dead, undead, or fictional). Subset of Person from schema.org

  • id: URN holding the ID of the Person - Required
    • Attribute type: Property.
  • type: The entity type - Required

    • Attribute type: Property.
  • additionalName: An additional name for a Person, can be used for a middle name.

    • Attribute type: Property. Text
  • address: The mailing address.
    • Attribute type: Property. address
    • Normative References: https://schema.org/address
  • email: Email address.
    • Attribute type: Property. Text
  • familyName: Family name. In the U.S., the last name of an Person. This can be used along with givenName instead of the name property.
    • Attribute type: Property. Text
  • faxNumber: The fax number.
    • Attribute type: Property. Text
  • gender: Gender of something, typically a Person, but possibly also fictional characters, animals, etc. While http://schema.org/Male and http://schema.org/Female may be used, text strings are also acceptable for people who do not identify as a binary gender. The gender property can also be used in an extended sense to cover e.g. the gender of sports teams. As with the gender of individuals, we do not try to enumerate all possibilities. A mixed-gender SportsTeam can be indicated with a text value of "Mixed".. One of : female, male.
  • givenName: Given name. In the U.S., the first name of a Person. This can be used along with familyName instead of the name property.
    • Attribute type: Property. Text
  • honorificPrefix: An honorific prefix preceding a Person's name such as Dr/Mrs/Mr.
    • Attribute type: Property. Text
  • honorificSuffix: An honorific suffix preceding a Person's name such as M.D. /PhD/MSCSW.
    • Attribute type: Property. Text
  • isicV4: The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
    • Attribute type: Property. Text
  • jobTitle: The job title of the person (for example, Financial Manager).
    • Attribute type: Property. Text
  • name: The name of the item
    • Attribute type: Property.
  • taxID: The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in Spain.
    • Attribute type: Property. Text
  • telephone: The telephone number.
    • Attribute type: Property. Text
  • vatID: The Value-added Tax ID of the organization or person.
    • Attribute type: Property. Text