|
|
|
|
|
|
|
|
## Do we need to install the platform (the part with docker) if we want to run the SDK?
|
|
|
Nope, you can either run the SDK requests against the development server.
|
|
|
|
|
|
## For the WMS modules and its associated ML algorithm (e.g. to predict weather values and send them to the platform) should be developed as a separate container? e.g. using wms_example as a starting point?
|
|
|
## What is the SDK provided by UDGA?
|
|
|
The SDK is a package [found online](https://gitlab.distantaccess.com/naiades/naiades-platform-poc) composed of
|
|
|
1. code (mostly docker files, configuration files and a folder/files project structure )
|
|
|
2. tutorials and docs for interacting with the platform
|
|
|
3. tutorials and docs for running an IoT platform
|
|
|
|
|
|
yep, you can use that as a starting point, WMS_example **only** exemplifies how to use the subscription feature or of the IoT platfrom though.. you will probably need more than that . E.g. consuming data from the historical API
|
|
|
You should not try to install the platform (3) if you just want to act as a client of the platform (GUI, AI module, etc..).
|
|
|
|
|
|
|
|
|
## Where can I find the spec of the IoT Platform APIs ?
|
|
|
|
|
|
You can find Orions API spec here:
|
|
|
- [Orion API spec (context broker)](https://fiware.github.io/specifications/ngsiv2/stable/#simplified-entity-representation)
|
|
|
- [QuantumLeap API spec (historic API)](https://app.swaggerhub.com/apis/smartsdk/ngsi-tsdb/0.7)
|
|
|
|
|
|
|
|
|
## How to build a AI module for the platform?
|
|
|
|
|
|
you can use as starting point the WMS_example from the git project.
|
|
|
WMS_example **only** exemplifies how to use the subscription feature or of the IoT platfrom though.. you will probably need more than that . E.g. consuming data from the historical API
|
|
|
All the doc for consuming data can be found in the SDKv1 and SDKv2
|
|
|
|
|
|
## Is there a API wrapper for facilitating use of the API
|
|
|
|
... | ... | @@ -16,44 +31,39 @@ Please check https://fiware-tutorials.readthedocs.io/en/latest/accessing-context |
|
|
|
|
|
## How to we integrate our AI/WMS/GUI module to the IoT platform?
|
|
|
|
|
|
you can either
|
|
|
you can either:
|
|
|
|
|
|
1. push the code to the git repo (different branch from master) and provide the `Dockerfile` describing how to build and run the service then the operator of the platform (SIMAVI) will add it to the docker-compose which handle all internal services
|
|
|
2. push directly the docker image to dockerhub same procedure as 1 for the operation of the service
|
|
|
3. you run your AI module from ourside the IoT platform (in your own server)
|
|
|
|
|
|
for all of the above options, the interface between the modules and the platform should be the context manager API and the historical data API
|
|
|
|
|
|
## How do I create an entity and push historical records to the historical API?\
|
|
|
## How do I create an entity and push historical records to the historical API?
|
|
|
|
|
|
step1. define your entity id, it should follow the conventions:
|
|
|
1. CHOOSE entity id, it should follow the conventions:
|
|
|
`udn:ngsi-ld:<dataType>:<string>`
|
|
|
e.g
|
|
|
`urn:ngsi-ld:WaterQualityObserved:fountain-1`
|
|
|
|
|
|
step2. create entity, use script example named `watering_01_create_entity.sh`
|
|
|
2. CREATE entity, use script example named `watering_01_create_entity.sh`
|
|
|
|
|
|
step3. ask historical DB to start tracking a certain entity (start saving records in historic DB)
|
|
|
3. SUBSCRIBE - send to context manager (Orion) subscription to start tracking a certain entity (start saving records in historic DB)
|
|
|
please use as template script `historic_01_set_up.sh`, you will need to update the `description` and the `type` as minimal modifications
|
|
|
|
|
|
|
|
|
step4. test it
|
|
|
4. test it
|
|
|
please use as template script `historic_02_api_query.sh`
|
|
|
|
|
|
## Historical API query returns empty reponses
|
|
|
- check again step 3 and 4 .sh examples
|
|
|
- remeber to include the headers in the requyest:
|
|
|
## Historical API query returns empty responses, why?
|
|
|
|
|
|
- check the examples provided above (dots 3 and 4) .sh examples
|
|
|
- remember to include the corresponding pilot headers in the request:
|
|
|
|
|
|
```
|
|
|
--header "Fiware-Service: carouge"
|
|
|
--header "Fiware-ServicePath: /"
|
|
|
```
|
|
|
|
|
|
## Where can I find the spec of the IoT Platform APIs ?
|
|
|
|
|
|
You can find Orions API spec here:
|
|
|
- [Orion API spec (context broker)](https://fiware.github.io/specifications/ngsiv2/stable/#simplified-entity-representation)
|
|
|
- [QuantumLeap API spec (historic API)](https://app.swaggerhub.com/apis/smartsdk/ngsi-tsdb/0.7)
|
|
|
|
|
|
|
|
|
## Fail to consume data from historical API
|
|
|
|
... | ... | |