OLS project file format

jawi edited this page Nov 27, 2011 · 4 revisions

Table of Contents

OLS project file format

version 1.0: November 27th, 2011

The OLS project functionality was introduced in version 0.9.3 and allows a user to store the capture result and all settings (both explicit and implicit) to disk for later use. The main difference with the open/save data file functionality is that the latter only stores the capture result itself and the cursors, trashing other settings, like channel labels, and such.

Project file

The client stores a project file by default with the extension .olp. Actually, it is a ZIP-file with a predefined file structure containing the following files:

  • ols.project, the project "marker" file;
  • data.ols, the last acquisition result;
  • channel.labels, the file containing the channel labels;
  • settings/*, the individual settings of dialogs.
Unless explicitly noted otherwise, all text files are UTF8-encoded without BOM.

A project file is considered valid, when it at least contains one of the mentioned files. However, this is subject to change, and later versions might require a larger set of files. Therefore, implementations wishing to implement the OLS project file format are advised to always include a project marker file.

Project marker file

This is a text file providing some metadata, such as the project name, the client-version that stored it and the date (as epoch timestamp) on which it was stored. An example of a project marker file:

  test project \n
  0.9.5-b2 \n
  1322387297384 \n

Note that each item is placed on a new line, and ends with a newline character (= \r and/or \n).

Last acquisition result

The last acquisition result is stored as "plain data file", see this page for details on its format.

Channel labels

This is a text file similar as to the marker file, containing the channel label for each channel. If set, channel labels are always non-empty strings. If no explicit label is set for a channel it is stored as an empty string ("") in this file. The file contains up to 32 lines, with the label for each channel. An example of a channel labels file (the double quotes are added for readability):

  my channel 1 \n
  my channel 2 \n
  "" \n
  "" \n
  TxD \n
  RxD \n
  "" \n
  "" \n
  ... \n
  my channel 32 \n

Note that each item is placed on a new line, and ends with a newline character (= \r and/or \n).

Setting files

These file represent the settings made in dialogs. They are stored as "plain" Java properties files, of which the details can be found on this page.