Metadata layout

TAG

A special tag.  Ruskin or external reader can use it to check if the data is a L3.5/Gen4 header.

Metadata

1

A high level map of the metadata, used for navigation, not required to interpret the metadata itself.

Logger

2

Fixed information about the logger.

Settings

3

User settings that do not directly impact a deployment, and may not even be changed very often between deployments.

Deployment

4

User settings that do impact the values, storage, or presentation of deployment data for all schedules, or which are otherwise closely related to the deployment.

Configuration

5

Top level information about the configuration used for the deployment.

Schedules

6

Organized to allow extraction of individual schedules to construct metadata on a per-schedule basis.

6.1

Schedule map.  Only those schedules used by this configuration appear in the map.

6.2.1

Schedule details. Details of the 1st schedule.

6.2.2

Schedule details. Details of the 2nd schedule.
Details as above for 1st schedule.

...

...

6.2.S

Schedule details. Details of the S th schedule.
Details as above for 1st schedule.

User-groups

7

Organized to allow extraction of individual groups to construct metadata on a per-schedule basis.

7.1

Group map.  Only those groups used by this configuration appear in the map.

7.2.1

Group details. Details of the 1st user-group.

7.2.2

Group details. Details of the 2nd user-group.
Details as above for 1st group.

...

...

7.2.G

Group details. Details of the G th user-group.
Details as above for 1st group.

Module-groups

8

If present, used for diagnostic purposes.

8.1

Module group map.

8.2.1

Module group details. Details of the 1st FE-group.

8.2.2

Module group details. Details of the 2nd FE-group.
Details as above for 1st FE-group.

...

...

8.2.F

Module group details. Details of the F th FE-group.
Details as above for 1st FE-group.

Channels

9

Internal map, then each channel has its own self-contained subsection, so that individual channels can be extracted to construct metadata on a per-schedule basis.

9.1

Channel map outlining where the channel details can be found within the following sections.

9.2.1

Channel details. Details of the 1st channel.

9.2.2

Channel details. Details of the 2nd channel.
Details as above for 1st channel.

...

...

9.2.C

Channel details. Details of the C th channel.
Details as above for 1st channel.

0x00524252

4

A tag to indicate L3.5/Gen4 type header ( "RBR\0" ).  L3 deployment header start with byte 0x01.

Section ID

4

0x01000000, "1.0.0.0"

Section size

2

Variable; omitted sections have no map entry.  Includes section CRC.

Metadata version

4

Major.Minor.Patch, eg. 0x01166AA5, "1.22.27301"

0x00020000, "00.02.0000" - Added hash code
0x00010000, "00.01.0000" - Initial release

Total size

4

Complete size of all metadata, including all CRCs.

Hash code

4

Unique deployment identifier.

Introduction: v00.02.0000

0x01000000

0x00000004

variable

Section 1 always present at offset 4.

0x02000000

variable

variable

Includes any and all 2.X.X.X sections.

....

....

variable

Except for Section 1, it should not be assumed that all sections are present, or that they are in order.

0x08000000

variable

variable

Includes any and all 8.X.X.X sections.

Section 8 is the last in this example.

Section ID

4

0x02000000, "2.0.0.0"

Section size

2

Variable; part number sizes may vary.  Includes CRC.

f/w type

4

120 for L3.5, 130 for SL4

fw_version_string

36

NUL-terminated firmware version string, maximum 35 printable characters.  Example for Gen4, including semantic version number, special identifiers, and build date/time:
0.1.1-dev+202307281615

serial_number

4

model_name

16

Max 15 printable characters, NUL terminated, 0xFF-padded if necessary.

permissions

4

32b flags for permitted features.

 Bit flags for feature permissions.

cell_count

2

Battery capacity in AA cells, usually 0, 4, or 8.

cell_format ¹

16

Max 15 printable characters, NUL terminated, 0xFF-padded if necessary.

fe_baudrate

4

Baud rate on FE-bus.

pn_size

2

Length of part number, includes terminating NUL.

part_number

variable

Part number string, does not include a NUL terminator.

psu_pn_size

2

Length of PSU part number, includes terminating NUL.

psu_part_number

variable

Power supply part number string, does not include a NUL terminator.

CRC

2

A standard 16b CRC of all Section 2.

¹ An arbitrary string that the logger does not currently use internally.

Section ID

4

0x03000000, "3.0.0.0"

Section size

2

As things stand, 44.  Includes CRC.

serial_baudrate

4

The baud rate as an integer number.

serial_mode

4

Enumerated code.

See Serial mode definitions.

RESERVED

4

RESERVED

4

RESERVED

4

wifi_initial_timeout

4

seconds - CHANGED to milliseconds for consistency.

wifi_command_timeout

4

seconds - CHANGED to milliseconds for consistency.

poll_poweroff_delay

4

milliseconds - formerly fetch.

feature_usage

4

Bit flags showing usage of instrument-wide features; moved here from the Deployment section.

 See Feature flag bit assignments.

CRC

2

A standard 16b CRC of all Section 3.

PROMPT

b00

prompt was turned on/off

on

off

CONFIRMATION

b01

confirmation was turned on/off

on

off

FWLOCK

b10

f/w updates locked/permitted

locked

permitted

WETSWITCH

b14

indicates whether the wetswitch gate is used or not

used

unused

SENSORPOWERALWAYSON

b15

sensors kept powered up between samples, or not

always on

normal

TWISTACTIVATION

b16

indicates whether the twist activation gate used or not

used

unused

RESERVED

b19

used

unused

SIMULATED_DATA

b20

simulated data in use or not

simulated

normal

WIFI

b22

Wi-Fi enabled or not

enabled

disabled

PAUSERESUME

b23

pause/resume feature used or not

used

unused

0

RS232

full duplex standard RS-232

1

RS485F

full duplex RS-485

2

UART

non-inverted 3V (idle high)

3

UART_IDLELOW

inverted 3V (idle low)

Section ID

4

0x04000000, "4.0.0.0"

Section size

2

Fixed, 116 as it stands.  Includes CRC.

data_format

4

An enumerated code.

 See Memory format codes.

output_format

4

Bit flags enable/disable features of the format.

See Outputformat bit flags.

status

2

At time of enable; one of pending (1), gated (4) or logging (2). ¹

enable_time

8

Logger time when enable successful, 64b Unix epoch milliseconds.

start_time

8

64b Unix epoch milliseconds

end_time

8

64b Unix epoch milliseconds

utc_offset

4

milliseconds (signed 32b integer).  If the clock command reports offsetfromutc = unknown, the value is -2147483648 (0x80000000).

simulation_period

4

milliseconds

reserved

1

reserved

1

reserved

4

reserved

4

wifi_reference_pressure

4

float, nominal pressure at water surface (not fixed, can vary during deployment).

batt_type_internal

2

Enumerated ID code

See Internal battery codes.

batt_type_external

2

Enumerated ID code

See External battery codes.

batt_cap_internal

4

float, Joules

batt_cap_external

4

float, Joules

energyused_internal

4

float, Joules at time deployment enabled

energyused_external

4

float, Joules at time deployment enabled

speccond_tempco

4

float

default_temp

4

float

default_pres

4

float

default_atms

4

float

default_dens

4

float

default_salinity

4

float

default_avgsoundspeed

4

float

altitude

4

float

CRC

2

A standard 16b CRC of all Section 4.

0

QUERY

( Internal use only: requests current format )

1

FLOAT32

32b IEEE single precision floating point, calibration equation applied.

2

FLOAT64

64b IEEE double precision floating point, calibration equation applied.

3

CALFLOAT64

64b IEEE double precision floating point in the nominal range 0.0 to 1.0, no calibration equation applied.

4

NORMAL

( Internal use only: clears CALFLOAT64 format and restores FLOAT32 or FLOAT64 )

b0

1 / 0

Output does/doesn't include the logger serial number.

b1

1 / 0

Output does/doesn't include a schedule label.

b2

1 / 0

Output does/doesn't include a CRC.

b3

1 / 0

Output encoding is binary (TBD) / ASCII.

b4

1 / 0

Output data type is float64 / float32.

b5

1 / 0

Output does/doesn't include a date and time.

b6 ... b31

n/a

Reserved

0

NONE

no internal battery at all.

1

OTHER

unspecified battery, not yet supported.

2

LISOCL2

lithium thionyl chloride.

3

LIFES2

lithium iron sulphide.

4

ZNMNO2

generic alkaline.

5

LINIMNCO

lithium-ion rechargeable (UltraFire).

6

NIMH

nickel metal hydride rechargeable.

100

NONE

no external power source.

101

OTHER

unspecified external power source.

102

LISOCL2

RBRfermata lithium thionyl chloride.

103

ZNMNO2

RBRfermata generic alkaline.

104

LIMNO2

RBRfermette³ CR123A lithium.

105

FERMETTE3_LISOCL2

RBRfermette³ lithium thionyl chloride.

106

FERMETTE3_LIFES2

RBRfermette³ lithium iron sulphide.

107

FERMETTE3_ZNMNO2

RBRfermette³ generic alkaline.

108

FERMETTE3_LINIMNCO

RBRfermette³ generic alkaline.

109

FERMETTE3_NIMH

RBRfermette³ generic alkaline.

110

FERMATA_NIMH

RBRfermata nickel metal hydride (rechargeable) 12V (12s4p).

111

FERMATA_LISOCL2

RBRfermata lithium thionyl chloride 24V (8s6p).

112

FERMATA_ZNMNO2

RBRfermata generic alkaline 12V (12s4p).

Section ID

4

0x05000000, "5.0.0.0"

Section size

2

As it stands, 72.  Includes CRC.

dataset_label

32

NUL-terminated string, padded with 0xFF if needed.

configuration_label

32

NUL-terminated string, padded with 0xFF if needed.

CRC

2

A standard 16b CRC of all Section 5.

Section ID

4

0x06010000, "6.1.0.0"

Section size

2

Variable, depends on number of schedules.  Includes CRC.

schedule_count

2

16b number of schedules used in this configuration, S

1st schedule index

2

16b internal index value, 1-based

1st schedule label

32

NUL-terminated string, padded with 0xFF if needed.

1st schedule offset

2

Offset in bytes from the very start of Section 6.1.

2nd schedule index

2

16b internal index value

2nd schedule label

32

NUL-terminated string, padded with 0xFF if needed.

2nd schedule offset

2

Offset in bytes from the very start of Section 6.1.

...

...

...

S th schedule index

2

16b internal index value

S th schedule label

32

NUL-terminated string, padded with 0xFF if needed.

S th schedule offset

2

Offset in bytes from the very start of Section 6.1.

CRC

2

A standard 16b CRC of all Section 6.1.

Section ID

4

0x06020100, "6.2.1.0"

Section size

2

Variable, depends on type of schedule.  Includes CRC.

internal_index

2

Duplicated from the map so the section can stand alone.

schedule_label

32

Duplicated from the map so the section can stand alone.

mode

1

Enumerated code for sampling mode (continuous, burst, etc.).

See Sampling mode codes.

flags

4

Stream on/off, storage on/off.  Also destination of stream.

 See Schedule flags.

user_group_count

1

Number of user-groups in this schedule.

user_groups

16

Internal indices of user-groups in this schedule, fixed-size list, 0xFF-padded.

FE-group_count

1

(Diagnostic) Number of FE-groups in this schedule.

FE-groups

16

(Diagnostic) Internal indices of FE-bus groups, fixed-size list, 0xFF-padded.

parameters

variable

mode-dependent sampling parameters

See Sampling mode parameters

• continuous

• burst / wave / average / tide

• ddsampling

• regimes

CRC

2

A standard 16b CRC of all Section 6.2.1.

0

CONTINUOUS

1

AVERAGE

2

TIDE

3

BURST

4

WAVE

5

DDSAMPLING

6

REGIMES

7

unknown (error)

b0

1 / 0

Data is / isn't stored to memory.

b1

1 / 0

Data is / isn't streamed to USB.

b2

1 / 0

Data is / isn't streamed to Serial.

b3

1 / 0

Data is / isn't streamed to Wi-Fi.

b4 ... b31

n/a

Reserved

period

4

milliseconds

cast_detection

1

off (0) | on (1)

measurementperiod

4

milliseconds

period

4

milliseconds

measurementcount

4

samples

direction

1

descending (0) | ascending (1)

cast_detection

1

off (0) | on (1)

fast_period

4

milliseconds

slow_period

4

milliseconds

fast_threshold

4

dbar, float

slow_threshold

4

dbar, float

direction

1

descending (0) | ascending (1)

count

1

1 | 2 | 3

reference

1

This is an index of the channel used as a reference pressure for controlling regimes operation. The channel indices are assigned in the same order as the channel labels are reported by the command channels channellist. The index of the first channel is 1.

finalboundary

2

units of dbar

boundary1

2

units of dbar

binsize1

2

units of 0.1 dbar

period1

4

milliseconds

boundary2

2

units of dbar

binsize2

2

units of 0.1 dbar

period2

4

milliseconds

boundary3

2

units of dbar

binsize3

2

units of 0.1 dbar

period3

4

milliseconds

Section ID

4

0x07010000, "7.1.0.0"

Section size

2

Variable, depends on number of groups.  Includes CRC.

user_group_count

2

16b number of user-groups used in this configuration, G

1st user-group index

2

16b internal index value, 1-based

1st user-group label

32

NUL-terminated string, padded with 0xFF if needed.

1st user-group offset

2

Offset in bytes from the very start of Section 7.1.

2nd user-group index

2

16b internal index value

2nd user-group label

32

NUL-terminated string, padded with 0xFF if needed.

2nd user-group offset

2

Offset in bytes from the very start of Section 7.1.

...

...

...

G th user-group index

2

16b internal index value

G th user-group label

32

NUL-terminated string, padded with 0xFF if needed.

G th user-group offset

2

Offset in bytes from the very start of Section 7.1.

CRC

2

A standard 16b CRC of all Section 7.1.

Section ID

4

0x07020100, "7.2.1.0"

Section size

2

As it stands, 116.  Includes CRC.

internal_index

2

Duplicated from the map so the section can stand alone.

group_label

32

Duplicated from the map so the section can stand alone.

schedule_list

4

Bit flags referencing schedules to which this group belongs ¹

fe_group_list

4

Bit flags referencing FE-groups associated with this group ¹

channel_count

2

Total number of channels in the group, including hidden

channel_list

64

User group channel details. An ordered list of internal channel (index-flags) pairs, 0xFFFF-padded

CRC

2

A standard 16b CRC of all Section 7.2.1.

¹ Bit flags for any items associated with this group but which are NOT used by this configuration are not set.

index

1

Internal index of channel, 1..32

flags

1

b0: 1 stored, 0 not stored.
b1: 1 streamed, 0 not streamed.
b2: 1 always hidden, 0 may be visible (deprecated for sl4-v0.27.0)
b3: 1 hidden for this group, 0 visible (deprecated for sl4-v0.27.0)
b4: 1 derived, 0 measured. (deprecated for sl4-v0.27.0)

b5...b7: reserved (0)

Section ID

4

0x08010000, "8.1.0.0"

Section size

2

Variable, depends on number of FE-groups defined.  Includes CRC.

fe_group_count

2

16b number of FE-groups defined, F

1st FE-group index

2

16b internal index value, 1-based

1st FE-group offset

2

Offset in bytes from the very start of Section 8.1.

2nd FE-group index

2

16b internal index value

2nd FE-group offset

2

Offset in bytes from the very start of Section 8.1.

...

...

...

F th FE-group index

2

16b internal index value

F th FE-group offset

2

Offset in bytes from the very start of Section 8.1.

CRC

2

A standard 16b CRC of all Section 8.1.

Section ID

4

0x08020100, "8.2.1.0"

Section size

2

As it stands, 18 without the module_list, 82 with it.  Includes CRC.

index

2

16b internal index value, 1..16

group_list

4

Bit-flags referencing the associated user-group indices.

channel_list

4

Bit-flags referencing the internal channel indices.

module_list

64

Redundant and optional, but may be convenient; up to 32 FE-bus addresses (16-bit) in order of channel list, 0xFF-padded.

CRC

2

A standard 16b CRC of all Section 8.2.1.

Section ID

4

0x09010000, "9.1.0.0"

Section size

2

Variable.  Includes CRC.

channel_count

2

Number of channels included in the configuration, C.

1st channel index

2

Internal index value, 1...32

1st channel label

32

NUL-terminated string, padded with 0xFF if needed.

1st channel offset

2

Offset in bytes from the very start of Section 9.1.

2nd channel index

2

Internal index value, 1...32

2nd channel label

32

NUL-terminated string, padded with 0xFF if needed.

2nd channel offset

2

Offset in bytes from the very start of Section 9.1.

...

...

...

C th channel index

2

Internal index value, 1...32

C th channel label

32

NUL-terminated string, padded with 0xFF if needed.

C th channel offset

2

Offset in bytes from the very start of Section 9.1.

CRC

2

A standard 16b CRC of all Section 9.1.

Section ID

4

0x09020100, "9.2.1.0"

Section size

2

Variable, depends on channel details.  Includes CRC.

internal_index

2

Duplicated from the map so the section can stand alone.

module_address

2

FE-bus address corresponding to this channel.

type_key

16

NUL-terminated string, padded out to 16 bytes with 0xFF; for Ruskin to use as it sees fit, unused by the logger.

channel_label

32

Duplicated from the map so the section can stand alone.

fw_info_size

2

Length of FE-module firmware information string, includes terminating NUL (may be NUL-padded to a multiple of four bytes).

fw_info_string

variable

NUL-terminated string reporting all FE-module firmware information (may be NUL-padded to a multiple of four bytes).  Example for L3/L3.5 FE-module:
T = FE-serial-phytoflash-Yield, F = 10.041, r = 4662, H = 1, A = 128

user_groups

4

Bit flags referencing the internal indices of user-groups to which this channel belongs. ¹

fe_group_list

4

Bit flags referencing FE-groups associated with this channel. ¹

flags

4

Bit mask of channel properties.

See Channel property bit flags.

settling_time

4

milliseconds

read_time

4

milliseconds (intended to apply only to power-cycled, 'normal' sampling.)

guard_time

4

milliseconds - time for which the power must remain off once it has been removed.

specifics_count

2

Number of channel-specific information items following calibration coefficients.

specifics_offset

2

Offset in bytes from beginning of section to first channel-specific item.

The following are fixed-size items relating to calibration.

equation

32

Fixed length character array giving the name of the calibration equation used for this channel; up to 31 printable characters terminated with a NUL (0) character.

See Channel equation types.

calibration_date

8

Format: Unix epoch milliseconds

user_offset

4

float32, default 0.0.

user_slope

4

float32, default 1.0.

factory_units

16

NUL-terminated string for display of units, 0xFF-padded - units used by RBR for Factory calibration, not user-modifiable.

user_units

16

NUL-terminated string for display of units, 0xFF-padded - potentially user-specified, for future use; same as factory_units unless modified.

coefficient_count

4

Enhanced to assist with navigation.

See Coefficient count breakdown.

Actual calibration coefficients: total size of coefficient storage is not fixed.

coefficient_c0

4

The C and X coefficients are single precision IEEE floating point numbers.

The N cross-reference indicators are signed 32-bit integers.

coefficient_c1

4

...

...

coefficient_nN

4

Total size of storage for channel-specific information is not fixed: if 'specifics_count' (above) is zero, there will be nothing here.

Channel-specific item  #1 (if any)

variable

There are various types of information required only for a particular type of channel and which do not apply to other types; these are referred to as "channel;-specific" items.  Storage requirements for these items vary widely because the information is so diverse.

See Channel specific items.

Channel-specific item #2

variable

Details of the 2nd item which is specific to this channel, as above for 1st item.

...

...

...

Channel-specific item #N

variable

Details of the Nth item which is specific to this channel, as above for 1st item.

CRC

2

A standard 16b CRC of all Section 9.2.1.

¹ Bit flags for any items associated with this channel but which are NOT used by this configuration are not set.

b00

unused

b01

Uses MAX11210 A/D converter.

b02

Supports gain switching.

b03

Channel is derived.

b04

High resolution data

b05

Can control Wi-Fi, cast detection, ddsampling.

b06

Can control regimes.

b07

Can be conductivity reference for cast detection.

b08

Must handle a long read-time (will likely become redundant).

b09

Temperature used for conductivity correction.

b10

Is a temperature channel.

b11

Is an FE-freq channel.

b12

Requires 12V supply for sensor.

b13

Requires extended power-down sequence, uses READY/*BUSY mechanism.

b14

Takes special actions at start and/or end of deployment.

b15

Validity depends on hardware revision.

b16

Channel is hidden.

b17

Channel is raw.

b18

Channel is system.

b19

Channel is measured.

corr_cond3

corr_cond3 - Conductivity corrections for RBRLegato and 6000dbar C and CT cell

corr_irr

corr_irr - Irradiance 

corr_irr2

corr_irr2 - generic irradiance and PAR

corr_metsmeth

corr_metsmeth - Temperature correction of METS methane output

corr_metstemp

corr_metstemp - Temperature measured by a METS (methane sensor)

corr_o2conc_garcia

corr_o2conc_garcia - O2 concentration compensated for salinity and pressure

corr_ph

corr_pH - Simple temperature correction of pH

corr_pres2

corr_pres2 - Temperature correction of Pressure

corr_rinkob2

corr_rinkoB2 - Correction of Rinko Dissolved Oxygen using Rinko Temperature sensor

corr_rinkotemp

corr_rinkotemp - Temperature measured by a Rinko DO sensor

cub

cub, or Cubic

deri_bprpres

deri_bprpres and deri_bprtemp, BPR channels

deri_bprtemp

deri_bprpres and deri_bprtemp, BPR channels

deri_depth

depth - derivation of depth from pressure

deri_dyncorrS

deri_dyncorrT and deri_dyncorrS dynamic correction channels

deri_dyncorrT

deri_dyncorrT and deri_dyncorrS dynamic correction channels

deri_o2sat_garcia

deri_o2sat_garcia, Derived O2 saturation from concentration

deri_salinity

pss78 - derivation of Practical Salinity (1978)

deri_seapres

seapres - derivation of sea pressure from pressure

deri_sos

deri_sos, speed of sound

deri_speccond

deri_speccond - derivation of specific conductivity

lin

lin, or Linear

lind

Same as lin, or Linear but using double precision arithmetic, for high resolution channels (e.g. FE-freq).

none

optic2

optic2 - optical parameters measured by a Satlantic OCR sensor

qad

qad, or Quadratic

b00...b07

Total number of coefficients.

b08...b15

Number of C coefficients.

b16...b23

Number of X coefficients.

b24...b31

Number of N cross-references.

item_type

1

An enumerated code for the type of information.

item_size

2

Total size of item in bytes.

item_spare

2

Unused

item_data

variable

Currently three types of information are supported:

• Gain switching data (item_type = 3)

• Frequency settings (item_type = 128)

• Sensor key-value pairs (item_type = 2)

mode

1

Gain switching mode, none=0, manual=1, auto=2.

gain_count

1

Number of gain settings available.

current_gain_value

4

float, gain value in use, minimum gain if auto-ranging.

all_gain_values

4 * gain_count

floats, values of all gains

integration_time

4

milliseconds

meas_average

1

For over-sampling; sample count

settling_time

2

milliseconds

interp_cos[]

8

Array of 4 signed 16b integers, internal coefficients

pot_setting

1

Setting of digital frequency-trimming

xtal_settling

2

milliseconds

cal_date

8

calibration date in Unix epoch milliseconds

key_name

variable

NUL-terminated string, length arbitrary, but 0xFF-padded to a multiple of 4 bytes if needed.

value_string

variable

NUL-terminated string, length arbitrary, but 0xFF-padded to a multiple of 4 bytes if needed.