Quick Start

Inlinino is available for Windows and macOS, the packaged executable can be downloaded with the links below. Windows users will have to unzip the archive. On some web browsers the link below must be copied and paste into a new tab to download the files.

Advance users or developers can setup the software directly from source (GitHub Repository).

Startup Menu

To start Inlinino double click the executable: Inlinino-v2.8.2.exe on Windows and Inlinino-v2.8.2.app on macOS. When starting the software for the first time, it might take several seconds before displaying a window. Inlinino will first prompt which instrument will it be logging data from (Screenshot 1). Two options are available:

  • Setup a new instrument:

    1. Select the type of instrument to configure, the type of instrument available are listed in Table 1.
    2. Click on the setup button on the right side.
    3. A pop-up window will prompt you to configure the instrument, instructions for each type of instruments are available in the following sections.
    4. After validating the configuration of the instrument the main Inlinino window will be loaded.
  • Load a previously configured instrument:
    1. Select the instrument from the dropdown menu.
    2. Click on the load button on the right side.
    3. The main Inlinino window will be loaded for the selected instrument.
Table 1. Type of instruments supported
Instrument type Instrument supported
acs WET Labs AC-S
dataq
DATAQ DI-1100
(Data Acquisition Interface for analog sensors)
hyperbb Sequoia HyperBB
lisst Sequoia LISST
nmea Read & Parse NMEA over Serial or UDP
ontrack
Ontrack Control Systems ADU100
(supports Flow control, Flowmeter, & DAQ for Analog sensors)
satlantic Satlantic Instruments (requires Instrument’s Telemetry Definition or Calibration Files)
suna Satlantic Suna V1 and V2
generic
Any sensor outputting simple ascii frame
(e.g. WET Labs ECO-Triplets, BioSpherical PAR, SeaBird TSG)
_images/startup_acs.png

Screenshot 1. Inlinino Start up window

Setup a generic instrument

Instruments are considered as generic if they send data as structured ascii frame. The frame is considered structured when each variable is separated by a separator (e.g. comma, tabulation) and the frame terminate with a terminator (e.g. carriage return). An example on how to fill the form for a WET Labs ECO-BB3 is given in the Screenshot 2.

General section <top left>
The manufacturer, model, and serial number of the instruments must be entered at the top left of the window.
Logger Group-Box <middle leftt>

It’s possible to log the data in different format (select one or both options):

  • raw data: exact output of the instrument to which a timestamp is appended
  • products: variables of interest are extracted from the data frame received from the instrument and formatted into a comma separated value (csv) file with a timestamp.

The folder in which the data is logged is specified in the field Log Directory. The button Browse can be used to easily browse the computer file system and choose the adequate directory.

Parser Group-Box <left>
  • Frame Terminator: indicate the end of the frame, hence the beginning of the next frame. Typically rn or n.
  • Frame Separator: element separating values in frame. Typically , or t.
  • Variable Names: list of variable names separated by commas.
  • Variable Units: list of variable units separated by commas.
  • Variable Columns: list of position of each variable in the frame.
  • Variable Types: list of type of each variable. Can either be a floating number (float) or an integer (int).
  • Variable Precision: list of string format used for each variables to write product log file. Typically %d for integers and %.3f for floating number with a precision of 3 decimal places.

Note

Variable Names, Variable Units, Variable Columns, Variable Types, and Variable Precision must be lists containing the same number of elements. All elements are separated by commas. Spaces are ignored. Special characters are not permitted.

Note

Note that the software record the date and time at which it received each data frame, hence no need to record the instrument timestamp which often drifts significantly during month long campaigns and is rarely set properly.

Below is an example of two data frames received from a WET Labs ECO-BB3 to illustrate this settings. Each variable is separated by a tabulation (t). The column 2, 4, and 6 correspond to the wavelengths of the sensor (note that the indexing start at 0 not 1). The column of interest with values corresponding to each one of the wavelength are 3, 5, and 7 (e.g. 255, 244, and 232 for the first frame). An example of variable names could be: beta470, beta532, and beta650. The variable units are: counts, counts, and counts in this case. Frames are separated by a new line character (rn). The date, time, and checksum (last number) would be ignored in these case. The Screenshot 2 shows how to fill the form for this instrument and the data frames in question.:

11/08/16    20:33:49        470     255     532     244     650     232     524
11/08/16    20:33:50        470     263     532     251     650     237     588
Append prefix to log file Group-Box <left>
This group-box is common to every instrument and explanations are provided in the section Edit Instrument Configuration.
_images/setup_generic_bb3.png

Screenshot 2. Inlinino generic instrument setup window prefilled for a WET Labs ECO-BB3

Setup an analog instrument

Inlinino supports analog instruments by using a data acquisition (DAQ) module connected to a virtual serial port. The DAQ supported with the current version of Inlinino is the DataQ DI-1100 which is commercially available. Previous version of inlinino supporting a custom made DAQ PASC, which is not supported anymore.

DataQ DI-1100

General section <top left>

The manufacturer, model, and serial number of the instruments must be entered at the top left of the window. Special character are not supported and space will be ignored.

The folder in which the data is logged is specified in the field Log Directory. The button Browse can be used to easily browse the computer file system and choose the adequate directory.

General Group-Box <top right>

Select the channels from DataQ DI-1100 from which instruments are connected and tension (in Volts) will be recorded. Unchecked channels will be disregarded (no data logged).

Note

Selecting less channels increase the subsampling frequency (indirectly increasing the sampling resolution). Typically this DAQ is set to average all subsamples and log this average at 1 Hz.

Append prefix to log file Group-Box <left>
This group-box is common to every instrument and explanations are provided in the section Edit Instrument Configuration.
_images/setup_dataq.png

Screenshot 3. Inlinino DataQ DI-1100 setup window for analog instruments

PASC

The precision analog to serial converted (PASC) DAQ developed with the first version of Inlinino was not ported to the current version of Inlinino. For now, we recommend using the commercially available DataQ DI-1100 DAQ supported by Inlinino.

Setup a Sequoia LISST

Setting up the Sequoia LISST instrument is straightforward as all settings are contained in the manufacturer’s device file (.txt) and the initialization file (.ini). The browse button on the right side of each field can be used to locate this files on the computer. Both of these files are required.

The folder in which the data is logged is specified in the field Log Directory. The button Browse can be used to easily browse the computer file system and choose the adequate directory.

Append prefix to log file Group-Box <left>
This group-box is common to every instrument and explanations are provided in the section Edit Instrument Configuration.
_images/setup_lisst.png

Screenshot 4. Inlinino setup window for a Sequoia LISST

Setup a WET Labs AC-S

Setting up a WET Labs AC-S or AC-9 is simple as all settings needed are provided by the manufacturer in the device file (.dev). This file can be located on the computer with the browse button on the side of the Device File field.

The folder in which the data is logged is specified in the field Log Directory. The button Browse can be used to easily browse the computer file system and choose the adequate directory.

Append prefix to log file Group-Box <left>
This group-box is common to every instrument and explanations are provided in the section Edit Instrument Configuration.
_images/setup_acs_filled.png

Screenshot 5. Inlinino setup window for a WET Labs AC-S

Main Window

Once an instrument selected or setup through the startup window, the main Inlinino window will be loaded. The model and serial number of instrument will be displayed at the top of the sidebar. The color of the instrument’s model and serial number indicates the current status of the system:

  • red: the instrument is not connected
  • orange: the instrument is connected but not logging
  • green: the instrument is connected and logging data

To log data follow the steps describe in the following section (Log Data).

To log data from multiple instruments simultaneously, start multiple instances of Inlinino. To do so, simply click on the Inlinino executable icon (.app on macOS or .exe on Windows) as many times as instruments to log. On the startup window select the appropriate instrument each time.

The last 120 values of selected channels are displayed in the plotting section of the main window (Figure 7) once the instrument is connected. On generic and analog instruments all channels are selected. On the WET Labs ACS and Sequoia LISST the user can select the channels of interest from the Select Channel(s) Group-Box menu at the bottom of the sidebar. By default, the latest channels selected by the users are plotted.

The Packets Group-Box of the sidebar displays in real-time the number of packets received, logged, and corrupted. When an instrument is turned on a few corrupted packets could be received, they are generally due to the instruments initialization message. If the number of corrupted packets keep increasing, a problem with the data format, the instrument settings, or the connections is occurring. Note that if the raw data is logged, the corrupted packets are logged but not timestamped. The raw data logging option is available in the setup menu of generic instruments. For other instrument types it’s activated by defaults.

Instruments with many channels like the WET Labs AC-S and Sequoia LISST have an auxiliary window (Figure 8) which shows the latest value received of each channel. Instruments communicating auxiliary data (e.g. instrument temperature) have it displayed in the Auxiliary Data Group-Box of the sidebar.

_images/main_window_acs.png

Screenshot 6. Inlinino Main Window

_images/aux_window_acs.png

Screenshot 7. Inlinino Auxiliary window specific to instruments with many channels (e.g. AC-S, LISST)

Log data

  1. Verify the configuration of the instrument by clicking on the setup button. Detailled instruction are provided in the, c.f. next section.

  2. Connect the instrument:

    1. Click on Open button under the Controls section at the top of the sidebar.
    2. A pop-up window will prompt the serial port to which the instrument should be connected to.
    3. Once connected the instrument name at the top of the sidebar will change to an orange color, and data can be visualize on the figure section of the window.

Warning

If no data can be visualized or the data makes no sense, the instrument is either incorrectly configured, their is a problem wih the connection, the instrument has an issue, or the instrument is not sampling properly (e.g. bubbles in the sample).

  1. Log data:

    1. Click on Start button under the Controls section at the top of the sidebar.
    2. The name of the instrument will change to a green color. The filename under the Logger section will be updated to reflect the current file in which the data is logged. The filename is formatted as follow <prefix><instrument_model><instrument_serial_number>_<YYYYMMDD>_<hhmmss>. Prefix can be updated from the instrument setup (c.f. Edit Instrument Configuration). is Typically, a new file is created hourly, however, this can be adjusted through the configuration file.

Edit instrument configuration

Before logging data, it’s important to check the configuration of the instrument, that the variables recorded are correct or that the calibration files are up to date.

To edit the configuration of an instrument, Inlinino must be started with the instrument loaded. Click the Setup button under the Controls Group-Box at the top of the sidebar. The setup window will pop-up. To update settings follow instructions specific to each instrument’s type (c.f. Table 1).

Append prefix to log file Group-Box

Data filenames follow the syntax <instrument_model><instrument_serial_number>_YYYYMMDD_HHMMSS.csv. For example a file for a WET Labs ACS serial number 301 created July 9, 2016 at 16:01:00 UTC would be named: ACS301_20160709_160100.csv.

One might want to append a prefix to a data file name logged with Inlinino, in the event of instrument calibration or some experiments. To consistently append a prefix to the name of a file logged with Inlinino, select the prefix desired at the bottom of the setup window (Screenshot 8).

_images/setup_log_prefix.png

Screenshot 8. Append prefix to log file name.

Warning

The Append prefix to log file settings are only applied to the current Inlinino session and are reset when Inlinino is restarted.

Next step

Additional settings are explained in the Configuration section.