SensorThings API

SensorThings API is designed specifically for resource-constrained IoT devices and the Web developer community. It follows REST principles, the JSON encoding, and the OASIS OData protocol and URL conventions. Also, it has an MQTT extension allowing users/devices to publish and subscribe updates from devices, and can use CoAP in addition to HTTP.

SensorThings API data model

The foundation of the SensorThings API is its data model that is based on the ISO 19156 (ISO/OGC Observations and Measurements), that defines a conceptual model for observations, and for features involved in sampling when making observations. In the context of the SensorThings, the features are modelled as Things, Sensors (i.e., Procedures in O&M), and Feature of Interests. As a result, the SensorThings API provides an interoperable Observation-focus view, that is particularly useful to reconcile the differences between heterogeneous sensing systems (e.g., in-situ sensors and remote sensors).

An IoT device or system is modelled as a Thing. A Thing has an arbitrary number of Locations (including 0 Locations) and an arbitrary number of Datastreams (including 0 Datastreams). Each Datastream observes one ObservedProperty with one Sensor and has many Observations collected by the Sensor. Each Observation observes one particular FeatureOfInterest. The O&M based model allows SensorThings to accommodate heterogeneous IoT devices and the data collected by the devices.[5]

SensorThings API provides two main functionalities, each handled by a part. The two profiles are the Sensing part and the Tasking part. The Sensing part provides a standard way to manage and retrieve observations and metadata from heterogeneous IoT sensor systems, and the Sensing part functions are similar to the OGC Sensor Observation Service. The Tasking part provides a standard way for parameterizing - also called tasking - of task-able IoT devices, such as sensors or actuators. The Tasking part functions are similar to the OGC Sensor Planning Service. The Sensing part is designed based on the ISO/OGC Observations and Measurements (O&M) model, and allows IoT devices and applications to CREATE, READ, UPDATE, and DELETE (i.e., HTTP POST, GET, PATCH, and DELETE) IoT data and metadata in a SensorThings service.

SensorThings API Part I - Sensing defines the following resources. As SensorThings is a RESTful web service, each entity can be CREATE, READ, UPDATE, and DELETE with standard HTTP verbs (POST, GET, PATCH, and DELETE):[6][7]

• Thing: An object of the physical world (physical things) or the information world (virtual things) that is capable of being identified and integrated into communication networks.[8]
• Locations: Locates the Thing or the Things it associated with.
• HistoricalLocations: Set provides the current (i.e., last known) and previous locations of the Thing with their time.
• Datastream: A collection of Observations and the Observations in a Datastream measure the same ObservedProperty and are produced by the same Sensor.
• ObservedProperty : Specifies the phenomenon of an Observation.
• Sensor : An instrument that observes a property or phenomenon with the goal of producing an estimate of the value of the property.
• Observation: Act of measuring or otherwise determining the value of a property.[9]
• FeatureOfInterest: An Observation results in a value being assigned to a phenomenon.The phenomenon is a property of a feature, the latter being the FeatureOfInterest of the Observation.[9]

In addition to the above sensing resources, SensorThings API Part II - Tasking Core defines the following resources:[10]

• TaskingCapabilities: Specifies the task-able parameters of an actuator.
• Tasks: A collection of Tasks that has been created.
• Actuator : A type of transducer that converts a signal to some real-world action or phenomenon.[11]

http://example.org/v1.0/Datastream(id)/Observations

{
  "@iot.count": 2,
  "value": [
    {
      "@iot.id": 1,
      "@iot.selfLink": "http://example.org/v1.0/Observations(1)",
      "phenomenonTime": "2016-01-01T05:00:00.000Z",
      "result": "-9",
      "resultTime": null,
      "Datastream@iot.navigationLink": "http://example.org/v1.0/Observations(1)/Datastream",
      "FeatureOfInterest@iot.navigationLink": "http://example.org/v1.0/Observations(1)/FeatureOfInterest"
    },
    {
      "@iot.id": 2,
      "@iot.selfLink": "http://example.org/v1.0/Observations(2)",
      "phenomenonTime": "2016-01-01T04:00:00.000Z",
      "result": "-10",
      "resultTime": null,
      "Datastream@iot.navigationLink": "http://example.org/v1.0/Observations(2)/Datastream",
      "FeatureOfInterest@iot.navigationLink": "http://example.org/v1.0/Observations(2)/FeatureOfInterest"
    }
  ]
}

In order to reduce the data size transmitted over the network, SensorThings API data array extension allows users to request for multiple Observation entities and format the entities in the dataArray format. When a SensorThings service returns a dataArray response, the service groups Observation entities by Datastream or MultiDatastream, which means the Observation entities that link to the same Datastream or the same MultiDatastream are aggregated in one dataArray.

{
  "value": [
    {
      "Datastream@iot.navigationLink": "http://example.org/v1.0/Datastreams(1)",
      "components": [
        "id",
        "phenomenonTime",
        "resultTime",
        "result"
      ],
      "dataArray@iot.count": 3,
      "dataArray": [
        [
          1,
          "2005-08-05T12:21:13Z",
          "2005-08-05T12:21:13Z",
          20
        ],
        [
          2,
          "2005-08-05T12:22:08Z",
          "2005-08-05T12:21:13Z",
          30
        ],
        [
          3,
          "2005-08-05T12:22:54Z",
          "2005-08-05T12:21:13Z",
          0
        ]
      ]
    }
  ]
}

Interoperability between OpenIoT and SensorThings "We believe that the implementation of the SensorThing API will be a major improvement for the OpenIoT middleware. It will give OpenIoT a standardized and truly easy to use interface to sensor values.This will complement the rich semantic reasoning services with a simple resource based interface. And the consistent data model mapping gives both a common context to describe the internet of things".[12]

Efficiency of SensorThings API A comprehensive evaluation of the SensorThings API is published in Jazayeri, Mohammad Ali, Steve HL Liang, and Chih-Yuan Huang. "Implementation and Evaluation of Four Interoperable Open Standards for the Internet of Things." Sensors 15.9 (2015): 24343-24373.

SensorThings API was demonstrated in a pilot project[13] sponsored by the Department of Homeland Security Science and Technology Directorate. Dr. Reginald Brothers, the Undersecretary of the Homeland Security Science and Technology, was "impressed with the ‘state of the practical’ where these various industry sensors can be integrated today using open standards that remove the stovepipe limitations of one-off technologies.[14] "

• OGC® SensorThings API Part 1: Sensing[6]
  • Internal reference number of this OGC®  document: 15-078r6
  • Submission Date: 2015-06-18
  • Publication Date: 2016-07-26
  • Editor: Steve Liang (University of Calgary/SensorUp)
  • Co-Editors: Chih-Yuan Huang (National Central University) / Tania Khalafbeigi (University of Calgary/SensorUp)
• OGC® SensorThings API Part 2: Tasking Core[10]
  • Internal reference number of this OGC®  document: 17-079r1
  • Submission Date: 2017-10-13
  • Publication Date: 2019-01-08
  • Editor: Steve Liang (University of Calgary/SensorUp)
  • Co-Editors: Tania Khalafbeigi (University of Calgary/SensorUp)
• Developer API Documentation
  • Part I - Sensing
  • Part II - Tasking
• SensorThings API Sandbox
• SensorThings Compliance Test Suite

SensorThings API provides functions similar to the OGC Sensor Observation Service, an OGC specification approved in 2005. Both standard specifications are under the OGC Sensor Web Enablement standard suite. The following table summarizes the technical difference between the two specifications.[28]

1. SensorThings API - GitHub
2. Presentation: Sensor up your connected applications with OGC SensorThings API (FOSS4G)
3. Chapter: Mapping the OGC SensorThings API onto the OpenIoT Middleware
4. Tutorial in YouTube: Getting Started Series #1, SensorThings Tutorial Series #2 and SensorThings Tutorial Series #3
5. Application: SensorThings Playground allows interested people and organizations to experiment with a SensorThings system via a friendly, step-by-step process.