# WITS

Data in WITS format can be transferred to the collector over Serial ports or TCP connections.

The WITS metadata is applied by Intelie Live during the normalization process when generating the raw JSON events.

{% hint style="info" %}
Data is always transmitted from the collector to Intelie Live exactly as it was received from the sources, for any protocol.
{% endhint %}

Intelie Live follows the [WITS specification](http://www.petrospec-technologies.com/resource/wits_doc.htm) to add the names, the set of units (imperial/UK, imperial/US or metric) and to relate a depth value to each sample. Spare channels can be associated with names and units in the web interface.

As it occurs with data transmitted in any other protocol, those names and units are present on the raw events but are converted to the environment standards in the normalized events.

Intelie Live supports WITS Level 0.

**Disclaimer:** WITS is a petroleum industry standard dated 90's (see [WITS ≠ WITSML](https://www.energistics.org/portfolio/witsml-data-standards/) on Energistics), so could be difficult to find out the spec, we also recommend a [page hosted by http://home.sprynet.com/\~carob (archived by web.archive.org)](https://web.archive.org/web/20170110225236/http://home.sprynet.com/~carob) and the [paper published in SPE Drilling Engineering Volume 4, Issue 04, December 1989](https://doi.org/10.2118/16141-PA).

### Configuration by remote control

Once the [Remote Control](/collector/remote-control.md) is enabled, the centralized Live can coordinate the source creation directly in an UI as follows:

<figure><img src="/files/pLcppt2uCxw3NcgK00Ho" alt=""><figcaption><p>WITS source configuration options</p></figcaption></figure>

#### Null values

As a textual representation, WITS typically carries some standard number that needs to be interpreted as **null values**. The WITS source enables you to specify your typical values and drop them from the actual event representation for the channels.

#### Mapping

Enables the user to choose between three standard record mappings.

<figure><img src="/files/u6F9vGlaubBP3Q6a6dWV" alt=""><figcaption><p>Standard WITS record mappings supported</p></figcaption></figure>

#### WITS custom mapping

Selects a custom mapping between WITS records and channel mnemonics supported in Live. See [WITS Custom Mapping](/administration/high-frequency-data/wits-custom-mapping.md) for more details.

#### Server mode configuration

In server mode, only the TCP configuration is supported, then the access endpoint will display a very simple input to configure the IP address and the port.

<figure><img src="/files/JhbtiGOTZi0ekAo0WdoH" alt=""><figcaption><p>TCP Port configuration for WITS in server mode</p></figcaption></figure>

#### Client mode configuration

For WITS client mode configuration, the access endpoint configuration will support both TCP and Serial ports (starting at LiveRig 4.7.0) as described:

<div><figure><img src="/files/Zqclr4mjqmDh9udzryXM" alt=""><figcaption><p>TCP port configuration for WITS client endpoint</p></figcaption></figure> <figure><img src="/files/gM6sWQYw4MpcR37iUD3M" alt=""><figcaption><p>Serial port configuration for WITS client endpoint</p></figcaption></figure></div>

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.

<figure><img src="/files/Yqk8K4d6BMqoDILpQiqm" alt=""><figcaption><p>Warning the lack of support for serial port connections at local sites</p></figcaption></figure>

### Configuration by source file

Locally in the LiveRig Collector machine, the [`sources.xml` can be configured](/collector/configuration/sources.xml.md) as demonstrated below. This configuration opens the TCP port 9872 on all local interfaces to listen for WITS data.

```markup
<source>
        <name>WITS sample</name>
        <mode>server</mode>
        <rig_name>my_rig</rig_name>
        <service_company>My Company</service_company>
        <protocol_name>wits;0;metric;null=9999;tz=utc</protocol_name>
        <endpoint>tcp://0.0.0.0:9872</endpoint>
</source>
```

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

```markup
<source>
        <name>WITS Sample</name>
        <mode>client</mode>
        <rig_name>my_rig</rig_name>
        <service_company>My Company</service_company>
        <protocol_name>wits;0;metric;null=9999;tz=utc</protocol_name>
        <endpoint>serial:///dev/ttyS0?baudRate=9600</endpoint>
</source>
```

{% 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 %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://drilling.intelie.com/collector/protocols/wits.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.