Receiver receives data from IoT devices and 3rd party systems. It provides authentication and message verification mechanism to ensure the data security and integrity.
There are several modes, in which the Receiver can operate (Endpoint types) out of the box:
Modbus PLC - module implementing PLC4X framework to support Modbus communication protocol
See Receiver configuration to learn more about all configuration options. |
Independent on the way how the data are received by the module, once the message is on the Receiver side, following process is applied:
Clients can be authenticated using following methods:
Each message collected by the receiver is processed by the receiver's message processor, which evaluates message content rules defined in configuration (see receivers[].messageRules). There are 3 types of message rules:
Messages are rejected, if they don't pass message rules. Otherwise Receiver stores them in it's internal storage.
This module supports following roles:
Module | Role | Permitted operations |
---|---|---|
Receiver | SENSOR | Allows to send data to the IoT controller (HTTP POST, MQTT_PUBLISH, ...) |
Receiver | VIEWER | GET /status, GET /data |
Receiver | EDITOR | GET /data, GET/status, DELETE /data |
This module can have one of following statuses:
Verticle | Status | Description |
---|---|---|
Receiver | UP | Module is up and running. It operates without any specific limitations. |
PAUSED | Module is paused and not receiving any data. Request to "GET /" ends with response code 405. |
This module provides following HTTP endpoints:
Path | Method | Description | URL Parameters | Example |
---|---|---|---|---|
/ | GET | Returns plain text with ECHO message (should be used in load balancer to detect UP/DOWN status) | https://localhost:8001/ | |
/status | GET | Returns JSON object that contains internal state of audit verticle (e.g. total count of sensors) | https://localhost:8001/status | |
/config | POST | Sets the configuration to the module. ADMIN role is required. |
| https://localhost:8001/config |
/reload | POST | Forces reloading configuration of module. ADMIN role is required. |
| https://localhost:8001/reload |
/data | GET | Returns JSON array that contains data stored in receiver's internal memory |
| https://localhost:8001/data |
/data | DELETE | Deletes specified data from receiver's internal memory. |
| https://localhost:8001/data |
/pause | GET | Sets status PAUSED for receiver verticle immediately. Returns response from "GET /status" endpoint (see above) | https://localhost:8001/pause | |
/resume | GET | Sets status UP for receiver verticle immediately. Returns response from "GET /status" endpoint (see above) | https://localhost:8001/resume | |
/logout | GET | Executes logout of currently logged in user | https://localhost:8001/logout |
On this page