This API provides a status report for a monitored device A with regards to a target location B. It returns the coordinates of locations A and B, the proposed route between them, calculates the delay and tells you when B is reached. Internally the Monitoring Service queries the ExCELL Tracking API for the current position. Please, make sure that the ID used here as first parameter also exists in the Tracking Service.
This web service comes as a SpringBoot application so it's very easy to test it on your local machine. If you run the service from inside a Java IDE a Tomcat server will be launched and you can access the service through a browser via localhost:44434.
Internally, the Monitoring Service calls the ExCELL Routing API to calculate the delay for the final report. The user can set up his/her own Routing Service or use the online version on the ExCELL Developer Portal. The parameter url.routingservice in the application.properties defines which endpoint is used. The URL of the online API is the default setting but it requires a user login which can be configured in the application.properties as well. By default, the token is provided by the ExCELL API Gateway. If user authentification is not required change the parameter of url.routingservice.auth to false. Please, apply the same setup for the Tracking Service.
The project is using Maven as a build tool and for managing the software dependencies. So in order to build the software you should install Maven on your machine. To create an executable JAR file for your local machine open you favourite shell environment and run:
mvn clean package
This creates a JAR file called monitoring-1.0.0-SNAPSHOT.jar. You can change the name in the pom.xml file.
Run the JAR with the following. You might also want to change the server port:
java -jar monitoring-1.0.0-SNAPSHOT.jar
This projects provides a Swagger interface to support the Open API initiative. The Java library Springfox is used to automatically create the swagger UI configuration from annotations in the Java Spring code.
An online version of the monitoring API is available on the ExCELL Developer Portal: Try it out!. You need to sign up first in order to access the services from the portal. Every user receives a token that he/she has to use for authorization for each service.
- Felix Kunde (BHS)
- Stephan Piper (BHS)
- Oguzhan Uyar (BHS)
- Maximilian Allies (BHS)
- fkunde [at] beuth-hochschule.de
The Monitoring Service has been realized within the ExCELL project funded by the Federal Ministry for Economic Affairs and Energy (BMWi) and German Aerospace Center (DLR) - agreement 01MD15001B.
THIS SOFTWARE IS PROVIDED "AS IS" AND "WITH ALL FAULTS." BHS MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE QUALITY, SAFETY OR SUITABILITY OF THE SKRIPTS, EITHER EXPRESSED OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
IN NO EVENT WILL BHS BE LIABLE FOR ANY INDIRECT, PUNITIVE, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES HOWEVER THEY MAY ARISE AND EVEN IF BHS HAS BEEN PREVIOUSLY ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.