channel

Usage

availablegains | derived | label | index ]

Security

Unsafe.

Description

Returns information about the channel at the specified <indexorlabel>. Channels can be identified either by an index (an integer) or by their label (a meaningful string, for example temperature_00 or conductivity_00). The first channel has an index of 1.

A special value of allindices or alllabels may be given for <indexorlabel> causing the requested parameters to be reported for all channels. The output for each channel is terminated by ||, except for the last channel which is terminated by a <cr><lf> pair as normal.

The following parameters give the basic information available for all channels. None of these values may be modified by end users. All parameters might be obtained using the all in lieu of parameter names.

type is a short, pre-defined 'generic' name for the installed channel; for example:
1. temp09 RBRduo³ temperature,
2. pres19 RBRduo³ pressure,
3. cond05 RBRconcerto³ marine conductivity,
  and so on. RBR Ltd continually adds support for more sensor types and variants; the Section Supported Channel Types contains a complete listing of channel types available at the time of writing this document.
module is the internal address to which this channel responds; it is normally of no interest to end users.
status [= <status>] is a further basic parameter which applies to all channels. It is modifiable by end users, and allows any individual channel to be turned off or on for the duration of a deployment.
1. on: the channel is activated for sampling; its data will be stored in memory if appropriate, and its value will appear in streamed output if streaming is enabled. However, note that if data storage is set to Standard format (rawbin00), data is never stored for derived channels, because raw data for such channels does not exist.
2. off: the channel is not sampled, no data will be stored in memory or streamed for this channel.
settlingtime is the minimum power-on settling delay in milliseconds required by this channel, taking into account both the sensor and the interface electronics.
readtime is the typical data acquisition time in milliseconds required by this channel, again taking into account both the sensor and the interface electronics.
Most channels have a fixed, pre-determined readtime, but for some it may be variable. An example would be a channel which supports, and is configured to use, the auto-ranging feature: the readtime is longer when the channel is in auto-ranging mode than when operated in a fixed-gain mode. The logger adjusts the reported value of the readtime to reflect the operating mode and status of the channel.
equation is the type of formula used to convert raw data readings to physical measurement units. The values for the core equations are shown below as examples; see the section Calibration Equations and Cross-channel Dependencies for details of all supported equations.
1. tmp temperature
2. lin linear
3. qad quadratic polynomial
4. cub cubic polynomial
userunits is a short text string giving the units in which processed data is normally reported from the logger; for example C for Celsius, V for Volts, dbar for decibars, etc. Presently this is a factory-set field representing the fundamental units in which the channel is calibrated; support for user-selectable units is planned in the future.
derived is a flag which is either on or off to indicate whether the channel is a derived channel (on) or a measured channel (off). This is an intrinsic property of the channel type, and can not be modified: it is for information only.
gain reports the gain setting currently in use by the channel referenced by <indexorlabel>. In addition to one of the fixed values from the list reported by the availablegains option, the response may indicate auto for auto-ranging. In this mode the channel will select the most appropriate gain setting depending on the value of the parameter being measured. Again, if the channel does not support multiple gain settings, the response is none.

The gain option may also be used to set the gain used. For a fixed gain setting, the value supplied must be from the list reported by the availablegains option. For auto-ranging, use the word auto. Although they are typically whole numbers, gains are reported in a floating point format, and may be specified as such, as long as the value appears in the list of available gains.

availablegains reports the gain settings supported by the sensor at channel <indexorlabel>. The settings are given as a list of numerical values in order of increasing gain, with a vertical bar character '|' separating the values. If the channel at <indexorlabel> does not support multiple gain settings, the response is none.

The availablegains and gain parameters are only available for channel types which support sensors having variable gain, or multiple ranges. Presently these include sensors from Seapoint, and the Cyclops series from Turner Designs, which can measure turbidity, fluorescence, and various other optical properties. For a complete list refer to the Section Supported Channel Types.

label is a short text string without white spaces,comma, equal symbol or special character, describing the physical parameter measured (example: temperature_00). It is reported when the channel requested is referred by its index.

index is the index of the channel. It is reported when the channel requested is referred by its label.

Examples

CODE

>> channel 1
<< channel 1 type = temp09, module = 6, status = on, settlingtime = 50, readtime = 260, equation = tmp, userunits = C, derived = off, label = temperature_00

CODE

>> channel 2 equation userunits
<< channel 2 equation = cub, userunits = dbar

CODE

>> channel allindices type
<< channel 1 type = temp09 || channel 2 type = pres19
>> channel alllabels type
<< channel temperature_00 type = temp09 || channel pressure_00 type = pres19

CODE

>> channel 4 availablegains
<< channel 4 availablegains = 1.0|5.0|20.0|100.0

CODE

>> channel 4 gain
<< channel 4 gain = auto

CODE

>> channel 4 gain = 20
<< channel 4 gain = 20.0

CODE

>> channel 1 all
<< channel 1 type = temp14, module = 1, status = on, settlingtime = 50, readtime = 260, equation = tmp, userunits = C, gain = none, availablegains = none, derived = off, label = temperature_00

Errors

Error E0105 command prohibited while logging
Settings may not be modified while logging is in progress; reading them is permitted.

Error E0107 expected argument missing
An argument expected by the logger was not given with the command; for example, there must always be an <indexorlabel> argument.

Error E0108 invalid argument to command: '<invalid-argument>'
This error will occur if the <index> is out of range, or if an unknown parameter is requested. Logger channels are numbered from 1 to N; zero is not valid.

Error E0111 command failed
There was a problem reading or modifying some configuration data for the specified channel; typically in response to accessing gain control information for those channels which support it. Please contact RBR Ltd for help.

Error E0505 no channels configured
There was a problem reading or modifying some configuration data for the specified channel; typically in response to accessing gain control information for those channels which support it. Please contact RBR Ltd for help.

Error E0501 item is not configured
There is a problem with the configuration of the specified channel; please contact RBR Ltd for help.

Further status parameter details

Example use-cases

1. RBRconcerto³ C.T.D; realtime output data (streamed or fetched) is required to show only salinity, temperature and pressure

Ensure the derived salinity channel is on.

Turn off any other derived channels which are available but not required (eg. depth, sea pressure, etc).
Turn off the Conductivity channel (!!).

The logger knows it requires conductivity to compute salinity, and will still sample this 'off' channel, but will not report or store (see Note) the data.

2: RBRconcerto³ C.T.D; realtime output data (streamed or fetched) is required to show only depth

Ensure the derived depth channel is on.

Turn off any other derived channels which are available but not required.
Turn off the Conductivity and Temperature channels.
Turn off the Pressure channel (!!).

The logger knows it requires pressure to compute depth, and it also knows that temperature is required for the correction of pressure, so it will still sample both of these "off" channels, but will not report or store (see Note) the data. Conductivity is not needed, so this channel will be truly "off".

Storage implications

For storage of data in standard format (rawbin00):

Only raw, uncorrected, measured channels are stored.
Corrected or derived channels are never stored.
A raw, uncorrected, measured channel will not be stored if the channel has been turned off, and no other channel depends on its data for correction.
A raw, uncorrected, measured channel which has been turned off will still be stored if any other channel depends on its data for correction.

For storage of data in EasyParse format (calbin00):

All channels which are on are stored, including any derived channels.
No channel which is off is ever stored, even if another channel depends on its data for correction. The value of the dependent channel is already computed and stored, so there is no need to also store the supporting channel unless it is on.