RAW

The raw protocol is capable of receiving data in JSON format via TCP or Serial port.

If the data format respects the same raw schema that the collector generates for other protocols, the data can be normalized in Intelie Live.

Configuration by remote control

Once the Remote Control is enabled, the centralized Live can coordinate the source creation directly in an UI as follows:

Source configuration for RAW protocol

Access endpoint

Starting at LiveRig 4.7.0, the access configuration supports both TCP and Serial ports:

TCP port configuration for RAW source endpoint

Serial port configuration for RAW source endpoint

The TCP connector puts the source in server mode and waits for data to be pushed into it. On the other hand, the Serial port connector configures the source as client mode and watches the Unix device file to consume the data passing through.

In case, any older LiveRig Collector is used in the edge installation, the selection for Serial ports will be unavailable since only TCP endpoints are allowed up to 4.6 series.

Warning the lack of support for serial port connections at local sites

Configuration by source file

Locally in the LiveRig Collector machine, the sources.xml can be configured as demonstrated below. This configuration opens the TCP port 9876 on all local interfaces to listen for events in JSON format.

<source>
	<name>Raw endpoint</name>
	<mode>server</mode>
	<rig_name>my_rig</rig_name>
	<service_company>my_company</service_company>
	<protocol_name>raw</protocol_name>
	<endpoint>tcp://0.0.0.0:9876/</endpoint>
</source>

This other example reads the first COM port in a Unix system available at /dev/ttyS0 to watch for events in JSON format.

<source>
	<name>Raw endpoint</name>
	<mode>client</mode>
	<rig_name>my_rig</rig_name>
	<service_company>my_company</service_company>
	<protocol_name>raw</protocol_name>
	<endpoint>serial:///dev/ttyS0?baudRate=9600</endpoint>
</source>

A sample of the JSON payload supported as Intelie Live events. This sample is compliant with the data schema required by the normalization engine.

{
   "liverig__index__timestamp": 12345,
   "channel1": {
       "value": 1.0,
       "uom": "m"
   },
   "channel2": {
       "value": 2.0,
       "uom": "m"
   },
   "channel3": {
       "error": "something went wrong"
   }
}

Each line of the input data stream should end with the '\n' (the end of line character). The maximum allowed line length in characters is 4,194,304. This limit was imposed to avoid huge lines that could extrapolate the Live event maximum size or extrapolate the internal implementation buffer capacity.