The following information tells you how to configure the shore-side files for data extraction (decode, extract, etc). For configuring the OASIS3 controller itself, see (foo). For clarity, please note that there are two files named oasis.cfg. One resides on the OASIS3 controller CPU board, and is used for configuring the OASIS3 controller itself. The oasis.cfg file described below resides on the shore-side data processing machine (usually a Unix machine, such as tsunami), and is used to configure the data extraction process.
oasis.cfg is the main configuration file used by the data extraction programs (decode, extract, argos, argextract, etc.). It should contain the following information:
|
Note 1 - This documents the order of analog channels that is expected by 'decode' and 'extract'. This ordering is due to the historical ordering of analog assignments in the original OASIS controller. In OASIS3, the actual ordering is:
To maintain compatibility with 'decode' and 'extract', you must lie in the config file. That is, despite the fact that OASIS battery actually comes in on analog channel 0, you must call it channel 2 in oasis.cfg. Ditto for the other analog channels. |
The analog calibration lines have the format:
analog <channel> <a> <b> <c> <d> <units>
where
| Field | Description |
|---|---|
|
channel
|
Channel number (0-7) |
|
a
|
analog channel calibration slope (floating point number) |
|
b
|
analog channel calibration offset (floating point number) |
|
c
|
Sensor calibration slope (floating point number) |
|
d
|
Sensor calibration offset (floating point number) |
|
units
|
Units of converted measurement (string) |
The analog inputs are converted to engineering units using
(a*AD_Counts + b)*c + d
The calibration coefficients (a-d) are calculated using several spreadsheets; currently, these are in a single Excel workbook. The analog channel slope and offset are calculated in the oasis calibration spreadsheet. The sensor calibration slope for temperature and pressure are also calculated in the oasis calibration file using a single point. The ground fault and current shunt have their own calibration spreadsheets with approximately 10-point calibrations.
Typically, parameters c and d are used only by the current shunt and pressure inputs. For the current shunt, the c parameter is always approximately 1 and the d parameter is always 0, so the the analog channel slope (a) is used together with the sensor calibration offset (b) which comes from the current shunt calibration file.
The Data and Error Directory paths point the location where the cumulative instrument data and error data files should be stored. Usually, these are /oasis/<mooring>/data/ and /oasis/<mooring>/error/, respectively.
The Header Directory is the location of the data header files for a deployment. Usually, these are stored in /oasis/cfg/<mooring>/. Headers may be generated using a shellscript utility called lmkheaders, which uses templates stored in /oasis/cfg/template and prompts the user for descriptive information. The headers or templates may also be edited manually to change fields not affected by lmkheaders.
oasis.cfg may also contain comment lines; comment lines begin with '#'.
The oasis.cfg file may also contain information used by other data processing software. Comment lines are sometimes used for this purpose, for example by using '#:' or other combinations to tag such lines. Calibration history data sometimes appears in oasis.cfg. These lines are typically managed by the end data users, but coordination must take place to ensure that there are no naming conflicts in the configuration file.
oasis.cfg has an entry that points to gf<n>.cfg, the calibration file for ground fault board S/N <n>.
The groundfault calibration lines have the format:
raw_offset cal_offset cal_divisor units ident
where
| Field | Description |
|---|---|
|
raw_offset
|
Raw data begins at raw_offset bytes in the raw data stream |
|
cal_offset
|
calibration offset (floating point number) |
|
cal_divisor
|
calibration divisor (floating point number) |
|
units
|
Units of result (string) |
|
ident
|
Description of data field (string) |
The raw data is converted to calibrated data as follows:
output = (raw - cal_offset)/cal_divisor
Several instruments have configuration files of their own, pointed to from oasis.cfg. These files are usually located in /oasis/cfg/ and have headers describing their format and contents. Changing the format of a configuration file will require that modifications be made to decode, extract and any other programs that make use of the configuration files.