Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/52north/sensorweb-server-helgoland
Thin Web binding API to access series data.
https://github.com/52north/sensorweb-server-helgoland
52north java observation rest-api sensor sensorweb series-data spi
Last synced: 17 days ago
JSON representation
Thin Web binding API to access series data.
- Host: GitHub
- URL: https://github.com/52north/sensorweb-server-helgoland
- Owner: 52North
- License: gpl-2.0
- Created: 2013-09-03T05:36:08.000Z (over 11 years ago)
- Default Branch: develop
- Last Pushed: 2023-04-07T05:00:46.000Z (over 1 year ago)
- Last Synced: 2024-05-01T23:00:56.380Z (8 months ago)
- Topics: 52north, java, observation, rest-api, sensor, sensorweb, series-data, spi
- Language: Java
- Homepage:
- Size: 14.9 MB
- Stars: 22
- Watchers: 10
- Forks: 22
- Open Issues: 47
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 52n Sensor Web Server Helgoland
[](https://travis-ci.org/52North/sensorweb-server-helgoland) [](https://github.com/52North/sensorweb-server-helgoland/actions/workflows/maven.yml) [](https://search.maven.org/search?q=g:org.n52.sensorweb-server.helgoland) [](https://lgtm.com/projects/g/52North/sensorweb-server-helgoland/alerts/) [](https://lgtm.com/projects/g/52North/sensorweb-server-helgoland/context:javascript) [](https://lgtm.com/projects/g/52North/sensorweb-server-helgoland/context:java)
## Description
**Thin Web binding API to access timeseries data.**
_The Sensor Web Server Helgoland is a REST API provides an access layer to sensor data via RESTful Web binding with different output formats like json, pdf or png. It provides a well defined Sevice Provider Interface (SPI) which can be implemented by arbitrary backend services to make data available via the API_
The Sensor Web Server Helgoland provides a thin access layer to sensor and observation data via RESTful Web binding. In addition, it offers several IO functionalities e.g.
* prerendering of series data,
* generalization,
* overlaying of data from multiple series
* conversion of raw data to other formats like pdf and png
Output formats for *stationary*, *mobile*, *insitu* and *remote* sensors are available, each filterable by metadata parameters. This enables clients to access the data via different approaches, e.g. to filter all series by phenomena first or by a special procedure.
Next to the Web API, a Service Provider Interface (SPI) defines the underlying interface for data providing backends. With this, the API is flexible enough to be put ontop of arbitrary data stores. Its modular design enables a seamless integration into existing Web applications.
The following main frameworks are used to provide this API:
- [Spring MVC](https://spring.org/)
- [JFreeChart](http://www.jfree.org/jfreechart/)
### Existing SPI implementations:
- [Sensor Web Server Adapters](https://github.com/52North/sensorweb-server-helgoland-adapters): Allows to aggregate multiple OGC SOS instances under one API
- [Direct database access](https://github.com/52North/sensorweb-server-dao-impl): Allows to define Hibernate mappings to serve data directly from a database
- [Fotoquest database access](https://github.com/52North/fotoquest-series-api): tbd
- [DWD Weather Alerts](https://github.com/52North/dwd-series-api): tbd
## References
* The [SOS proxy demo](http://sensorweb.demo.52north.org/sensorwebclient-webapp-stable/api/v1/) provides an SPI implementation which accesses data from multiple Sensor Observation Services [(OGC SOS)](http://opengeospatial.org/standards/sos).
* The [Web application integration demo](sensorweb.demo.52north.org/52n-sos-webapp/api/v1/) gives an integration demo which directly accesses the data from a database.
* The [52°North Helgoland Web Client](https://githum.com/52North/helgoland) consumes one or multiple instances of the Sensor Web Server Helgoland API. A demo can be found under the http://sensorweb.demo.52north.org/client/#/
## License
The client is published under the [GNU General Public License v2 (GPLv2)](http://www.gnu.org/licenses/gpl-2.0.html).
## Changelog
- https://github.com/52North/sensorweb-server-helgoland/blob/develop/CHANGELOG.md
- for detailed infos check https://github.com/52North/sensorweb-server-helgoland/pulls?q=is%3Apr+is%3Aclosed
## Contributing
We try to follow [the GitFlow model](http://nvie.com/posts/a-successful-git-branching-model/),
although we do not see it that strict.
However, make sure to do pull requests for features, hotfixes, etc. by
making use of GitFlow. Altlassian provides [a good overview]
(https://www.atlassian.com/de/git/workflows#!workflow-gitflow). of the
most common workflows.
## Contact
Henning Bredel ([email protected])
## Quick Start
### Client development
The [Web API documentation](http://52north.github.io/sensorweb-server-helgoland) gives a detailed overview on how to access the data provided by the API. Available I/O functions are described there, too, like generelization, chart rendering/overlay, etc.
~~The API documentation is in the 52°North wiki:
https://wiki.52north.org/bin/view/SensorWeb/SensorWebClientRESTInterface~~
### API Configuration
How to provide a custom SPI implementation is beyond this section. See (...TBD...) to get detailed
information on this.
#### Logging
#### Generalizer
In file `WEB-INF/classes/config-general.json` add
```
"generalizer": {
"defaultGeneralizer": "lttb",
"noDataGapThreshold": 5
}
```
The parameters are described on the official [Web API documentation](http://52north.github.io/sensorweb-server-helgoland).
#### Prerendering
Prerendering is supported for measurement data.
Prerendering configuration is a task which can be run regularly by a scheduler. Configuration is done as a
`PreRenderingJob` bean. Checkout `WEB-INF/spring/spi-impl-dao_tasks.xml` how to set up a prerendering
job. The actual rendering configuration for each dataset/phenomenon can be referenced within the job bean.
Rendering configuration tells how to render the actual dataset information. It comprises a `phenomenonStyles`
section (valid for a set of dataset for a given phenomenon) and a `datasetStyles` section (which actually
overrides a phenomenon style of a specific dataset) Each section can override parameters made in the `generalConfig`.
Only those datasets are prerendered having a match either in `phenomenonStyles` or `datasetStyles`.
#### Date formatting
In file `WEB-INF/spring/config-general.json` you can set `timeformat` Parameter. Please checkout the
[Java SimpleDateFormat rules](https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html) how the
format has to look like.
#### Rendering Hints
TBD
#### Status Intervals
TBD
#### Metadata from a Database
TBD
## Credits
The development of the 52°North Sensor Web Server Helgoland REST-API implementation was supported by several organizations and projects. Among other we would like to thank the following organisations and project
| Project/Logo | Description |
| :-------------: | :------------- |
| 
| The development of this version of the 52°North Sensor Web Server Helgoland API was supported by the European Union’s Horizon 2020 research project Cos4Cloud (co-funded by the European Commission under the grant agreement n°863463) |
| 
| The development of this version of the 52°North Sensor Web Server Helgoland API was supported by the German Federal Ministry of Education and Research research project TaMIS (co-funded by the German Federal Ministry of Education and Research, programme Geotechnologien, under grant agreement no. 03G0854[A-D]) |
| 
| The development of this version of the 52°North Sensor Web Server Helgoland API was supported by the European Union’s Horizon 2020 research project JERICO-S3 (co-funded by the European Commission under the grant agreement n°871153) |
| 
| The development of this version of the 52°North Sensor Web Server Helgoland API was supported by the German Federal Ministry of Education and Research research project COLABIS (co-funded by the German Federal Ministry of Education and Research, programme Geotechnologien, under grant agreement no. 03G0852A) |
| 
| The development of this version of the 52°North Sensor Web Server Helgoland API was supported by the European FP7 research project NeXOS (co-funded by the European Commission under the grant agreement n°614102) |
| 
| The development of this version of the 52°North Sensor Web Server Helgoland API was supported by the European FP7 research project FixO3 (co-funded by the European Commission under the grant agreement n°312463) |
| 
| The development of this version of the 52°North Sensor Web Server Helgoland API was supported by the Horizon 2020 research project ODIP II (co-funded by the European Commission under the grant agreement n°654310) |
| 
| The development of this version of the 52°North Sensor Web Server Helgoland API was supported by the Horizon 2020 research project SeaDataCloud (co-funded by the European Commission under the grant agreement n°730960) |
| 
| The Wupperverband for water, humans and the environment (Germany) |
| 
| The Belgian Interregional Environment Agency (IRCEL - CELINE) is active in the domain of air quality (modelling, forecasts, informing the public on the state of their air quality, e-reporting to the EU under the air quality directives, participating in scientific research on air quality, etc.). IRCEL — CELINE is a permanent cooperation between three regional environment agencies: Agence wallonne de l'Air et du Climat (AWAC), Bruxelles Environnement - Leefmilieu Brussel and Vlaamse Milieumaatschappij (VMM). |
| 
| The development of this version of the 52°North Sensor Web Server Helgoland API was supported by the European FP7 research project GEOWOW (co-funded by the European Commission under the grant agreement n°282915) |