Skip to content

N
naiades-platform-poc

Home

Last edited by Cédric Crettaz
Page history
This is an old version of this page. You can view the most recent version or browse the history.

IoT Platform Documentation

Note well

  • This home wiki redirects to SDK-v1 SDK-v2, but also to server installation wiki.

  • Developers of AI, WMS and/or HMI do not follow the installing the platform, you test comms directy agains dev or prod platforms

Deployment servers

We currently use two deployments (platforms) for NAIADES,

  1. DEVELOPMENT platform: also known as dev platform, is an environment where we test new features, test integration, etc. DATABASEs data will probably be wiped out from time to time

  2. PRODUCTION platform: also known as prod platform, is an environment where we deploy stable features, databases are backed-up regularly

environment host opened ports services running
DEVELOPMENT 5.53.108.182 1026/tcp
1027/tcp
3005/tcp
8668/tcp		 current data (pull and/or subscribe)
access controlled querying
identity manager
querying historical data
PRODUCTION ? 80/tcp
443/tcp

IoT Platform services

The following table describes what is the purposes of each platform service:

service purpose public API (REST)
db-crate database for timeseries (historical data) None
db-mongo database for context-manager (currrent data) None
db-mysql database for identities and roles None
fiware-keyrock manages identities and roles 5.53.108.182/identity-api
fiware-orion context manager, API server for all entities 5.53.108.182/context-api
fiware-orion-proxy enforce access control WIP
fiware-quantumleap REST service for storing, querying and retrieving NGSI v2 spatial-temporal data 5.53.108.182/time-series-api
wms-app-example Dummy example of a WMS component, acts as a consumer(subscriber) and publisher of messages to NAIADES None

SDK (software development kits) and other documents

Here below we provide some documents which will help any developer either i) communicate with an existing IoT platform (as clients) or ii) deploy the IoT platform (deploy your own server).

NOTE: Developers of AI, WMS and/or HMI components can skip document about server installation, and focus on SDK-v1 and SDK-v2 documents:

Document description Document link Comments
Installing the IoT platform in your own server server installation Advanced Only for partners which want to build their own IoT platform. Not needed for running SDKs
Getting started with Context Manager and Time Series APIs SDK-v1 Please run SDK scripts against dev environment server (5.53.108.182)
How to use IdM API and tokens for queries SDK-v2 Please run SDK scripts against dev environment server (5.53.108.182)
Some examples on using the API w/ postman postman collection
How to push local data I collected to historical data component rewriting-history

Integration tests:

The following table describes which partners have managed to test successfully communications with the dev platform

Partner Component Testeds comms ok (sdk-v1) Tested Auth(s) comms ok (sdk-v2)
UDGA Data collection OK OK
SIMAVI Data collection not tested ⚠ not tested ⚠
ADSYS Data collection not tested ⚠ not tested ⚠
AIMEN Data collection OK OK
IHE WMS service not tested ⚠ not tested ⚠
JSI WMS service not tested ⚠ not tested ⚠
AIMEN WMS service OK OK
CERTH WMS service OK OK
ADSYS Data fusion not tested ⚠ not tested ⚠
KT HMI OK not tested ⚠
ICCS HMI OK OK
SIMAVI HMI not tested ⚠ not tested ⚠

Recommended reads:

this section collects documents that are nice reads to understand more in depth how the IoT platform works and how you can consume data in a more efficient way using the powers of the NGSI-v2 API

consuming time-series (historical data) using query filters: https://fiware-tutorials.readthedocs.io/en/latest/time-series-data/index.html

FAQs:

please check the IoT Platform FAQ

TODO :

  • fill in PRODUCTION row after testing services are reachable (SIMAVI)
  • Include section about maintainance , e.g. data base backups and restoring (SIMAVI)
  • Describe NGINX integration (SIMAVI)