1
0
Fork 0
mirror of https://git.rwth-aachen.de/acs/public/villas/node/ synced 2025-03-23 00:00:01 +01:00
VILLASnode/doc/nodes/NGSI.md

58 lines
1.8 KiB
Markdown
Raw Normal View History

2016-02-10 19:22:06 +01:00
# OMA Next Generation Services Interface {#ngsi}
2015-09-22 15:27:23 +02:00
The `ngsi` node type implements an interface to FIWARE context brokers following the NGSI 10 RESTful HTTP API.
This implementation if currently limited to the `updateContext` operation.
Therefore only publishing updates is supported. Subscribtion or polling of events is planned for later versions.
It's using `libcurl` and `libjansson` to communicate with the context broker over JSON.
## Configuration
You can use the `vectorize` setting to send multiple samples in a vector.
2015-09-22 15:27:23 +02:00
Every `ngsi` node supports the following special settings:
#### `endpoint` *(string: URL)*
#### `entity_id` *(string)*
2015-09-22 15:27:23 +02:00
#### `entity_type` *(string)*
2015-09-22 15:27:23 +02:00
#### `ssl_verify` *(boolean)*
2015-09-22 15:27:23 +02:00
#### `timeout` *(float: seconds)*
2015-09-22 15:27:23 +02:00
#### `mapping` *(array of strings)*
2016-02-10 19:22:06 +01:00
Example: `AttributeName(AttributeType) MetadataName1(MetadataType1)=MetadataValue1 MetadataName2(MetadataType2)=MetadataValue2 ...`
2015-09-22 15:27:23 +02:00
### Example
2015-12-11 19:20:50 +01:00
nodes = {
ngsi_node = {
type = "ngsi",
2015-12-11 19:20:50 +01:00
### The following settings are specific to the ngsi node-type!! ###
endpoint = "http://46.101.131.212:1026",# The HTTP REST API endpoint of the FIRWARE context broker
2015-12-11 19:20:50 +01:00
entity_id = "S3_ElectricalGrid",
entity_type = "ElectricalGridMonitoring",
2015-12-11 19:20:50 +01:00
timeout = 5, # Timeout of HTTP request in seconds (default is 1)
verify_ssl = false, # Verification of SSL server certificates (default is true)
2016-02-10 19:22:06 +01:00
mapping = [
"PTotalLosses(MW)",
"QTotalLosses(Mvar)",
"Phase(rad) min(rad)=0 max(rad)=3.141"
2015-12-11 19:20:50 +01:00
]
}
}
2015-09-22 15:27:23 +02:00
## Further reading
This standard was specified by the Open Mobile Alliance (OMA).
@see https://forge.fiware.org/plugins/mediawiki/wiki/fiware/index.php/FI-WARE_NGSI-10_Open_RESTful_API_Specification
@see http://technical.openmobilealliance.org/Technical/Release_Program/docs/NGSI/V1_0-20120529-A/OMA-TS-NGSI_Context_Management-V1_0-20120529-A.pdf