FROST-Server Documentation

Live documentation for the development version.

Plugin Configuration Options

The functionality of FROST-Server can be expanded using plugins. Which plugins are loaded is controlled by two parameters:

Besides these configuration options telling FROST which plugins exist, each plugin usually has a separate option that controls whether the plugin is active or not.

Data Model Plugins

These plugins implement the data models are provided with FROST-Server by default.

Actuation

The actuation plugin implements the standard OGC SensorThings API - Part 2: Actuation. It adds the entity types described in this specification. This plugin requires the CoreModel plugin.

CoreModel

The Core Model plugin implements the data model of the standard OGC SensorThings API - Part 1: Sensing. It adds the entity types described in this specification and their behaviour.

MultiDatastream

The MultiDatastream plugin implements the MultiDatastream extendion of the OGC SensorThings API standard. This plugin requires the CoreModel plugin.

Response Format Plugins

These plugins enable various response formats.

DataArray

The DataArray plugin implements the SensorThings Data Array Extension as described in the SensorThings API standard.

CSV Result Format

The CSV plugin implements a CSV result formatter, enabling CSV output as described in: CSV-ResultFormat

GeoJSON Result Format

The GeoJSON plugin implements a GeoJSON result formatter, enabling GeoJSON output as described in: GeoJSON-ResultFormat

Other Plugins

These plugins enable various other behaviours.

BatchProcessing

The BatchProcessing plugin implements the Batch Requests extension as described in the SensorThings API standard.

OData

The OData plugin makes the data in your FROST-Server available as OData 4.0 and 4.01 API. The endpoint for these are on [service root URL]/ODATA_4.0/ and [service root URL]/ODATA_4.01/.

OpenAPI

The OpenAPI plugin makes an OpenAPI description of the SensorThings service available at the /v1.x/api path. This description is still experimental, and probably incomplete. If you use it and have experience with OpenAPI, we welcome feedback!