diff --git a/.gitbook/assets/liverig-csv-separator-config.png b/.gitbook/assets/liverig-csv-separator-config.png new file mode 100644 index 0000000..e0853c0 Binary files /dev/null and b/.gitbook/assets/liverig-csv-separator-config.png differ diff --git a/.gitbook/assets/tsv-configuration.png b/.gitbook/assets/tsv-configuration.png new file mode 100644 index 0000000..0b681d3 Binary files /dev/null and b/.gitbook/assets/tsv-configuration.png differ diff --git a/collector/protocols/csv.md b/collector/protocols/csv.md index e476273..182ec9a 100644 --- a/collector/protocols/csv.md +++ b/collector/protocols/csv.md @@ -22,6 +22,16 @@ The date time pattern can be customized to detect seconds, milliseconds, or text Each column in the CSV file will be interpreted as a channel value and the first column will be the date time index for each row in the dataset. +#### Separator + +The **Separator** field allows users to define custom delimiters for CSV files, providing greater flexibility in processing different input formats. + +Starting from **LiveRig 5.29.0** and **LiveRig Collector 5.28.0**, users can configure the field separator according to the system’s requirements or third-party data sources. The default separator is a **comma** (`,`), but it can be changed to other characters such as a **semicolon** (`;`), **tab** (`\t`), **pipe** (`|`), or any other delimiter. + +This configuration ensures proper data interpretation, especially when working with sources that use non-standard delimiters. + +

CSV field separator configuration

+ #### Access endpoint The CSV source can execute in client or server mode. Third parties applications may push data into the LiveRig CSV source endpoint. @@ -63,6 +73,19 @@ Locally in the LiveRig Collector machine, the [`sources.xml` can be configured]( ``` +This other example is the same as the above one but with a custom separator `\t` instead of the default `,` + +```markup + + CSV endpoint + server + my_rig + my_company + csv;separator=\t + tcp://0.0.0.0:9873/ + +``` + This other example reads the first COM port in a Unix system available at /dev/ttyS0 to watch for events in CSV format. ```markup diff --git a/collector/protocols/tsv.md b/collector/protocols/tsv.md new file mode 100644 index 0000000..6293503 --- /dev/null +++ b/collector/protocols/tsv.md @@ -0,0 +1,75 @@ +# TSV + +Starting from Liverig 5.29.0 and Liverig Collector 5.28.0, LiveRig collector supports the pushing of TSV payloads in order to convert them into Live events. + +The TSV protocol is very similar to [CSV protocol](../csv/), however, it uses the **tab character (`\t`)** to delimit values instead of a **comma (`,`)**. + +That is a very simple alternative to input data from third-party software through a LiveRig collector instance, typically co-located at operational sites. + +### Configuration by remote control + +Once the [Remote Control](../remote-control/) feature is enabled, the user can configure a new TSV source remotely as follows: + +

Overview of TSV source configuration options

+ +#### Null values + +As a textual representation, TSV typically carries some standard number that needs to be interpreted as **null values**. The TSV source enables you to specify your typical values and drop them from the actual event representation for the channels. + +#### Date time pattern + +The date time pattern can be customized to detect seconds, milliseconds, or textual samples of information like months, AM/PM marks, or either some fixed strings in the rows which represent the timestamp of each data measurement. See the [full list of symbols supported](https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html) (as in Java). + +

Date time custom format configuration rules

+ +Each column in the TSV file will be interpreted as a channel value and the first column will be the date time index for each row in the dataset. + +#### Access endpoint + +The TSV source can execute in client or server mode. Third parties applications may push data into the LiveRig TSV source endpoint. + +Starting at LiveRig 5.29.0, the access configuration supports both TCP and Serial ports: + +
+ +

TCP port configuration for TSV source endpoint

+ + + +

Serial port configuration for TSV 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. + +### Configuration by source file + +Locally in the LiveRig Collector machine, the [`sources.xml` can be configured](../configuration/sources.xml.md) as demonstrated below. This configuration opens the TCP port 9873 on all local interfaces to listen for files. + +```markup + + TSV endpoint + server + my_rig + my_company + tsv + tcp://0.0.0.0:9873/ + +``` + +This other example reads the first COM port in a Unix system available at /dev/ttyS0 to watch for events in TSV format. + +```markup + + TSV endpoint + client + my_rig + my_company + tsv + serial:///dev/ttyS0?baudRate=9600 + +``` + +{% hint style="info" %} +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. +{% endhint %}