Details reported by the instrument channel command. More...

#include <RBRInstrumentConfiguration.h>

Collaboration diagram for RBRInstrumentChannel:

Data Fields
char	type [RBRINSTRUMENT_CHANNEL_TYPE_MAX+1]
	A short, pre-defined “generic” name for the installed channel as a null-terminated C string. More...

RBRInstrumentModuleAddress	module
	The internal address to which the channel responds.

bool	status
	Whether the channel is activated for sampling. More...

RBRInstrumentPeriod	settlingTime
	The minimum power-on settling time required by this channel. More...

RBRInstrumentPeriod	readTime
	The typical data acquisition time required by this channel. More...

char	equation [RBRINSTRUMENT_CALIBRATION_EQUATION_MAX+1]
	The type of formula used to convert raw readings to physical measurement units as a null-terminated C string. More...

char	userUnits [RBRINSTRUMENT_CHANNEL_UNIT_MAX+1]
	The unit in which processed data is normally reported from the logger as a null-terminated C string. More...

RBRInstrumentChannelGain	gain
	Gain parameters for the channel.

bool	derived
	Whether the channel is a derived channel.

char	label [RBRINSTRUMENT_CHANNEL_LABEL_MAX+1]
	An alphanumeric description of the physical parameter measured as a null-terminated C string. More...

RBRInstrumentCalibration	calibration
	The calibration for the channel.

Detailed Description

Details reported by the instrument channel command.

See also: RBRInstrumentChannels

Field Documentation

◆ equation

char RBRInstrumentChannel::equation[RBRINSTRUMENT_CALIBRATION_EQUATION_MAX+1]

The type of formula used to convert raw readings to physical measurement units as a null-terminated C string.

See also: https://docs.rbr-global.com/L3commandreference/calibration-equations-and-cross-channel-dependencies

◆ label

char RBRInstrumentChannel::label[RBRINSTRUMENT_CHANNEL_LABEL_MAX+1]

An alphanumeric description of the physical parameter measured as a null-terminated C string.

Set upon request for OEM customers. If not set, reported as “none”.

This parameter is unavailable for Logger2 instruments. Always populated with “none”.

◆ readTime

RBRInstrumentPeriod RBRInstrumentChannel::readTime

The typical data acquisition time required by this channel.

Specified in milliseconds.

◆ settlingTime

RBRInstrumentPeriod RBRInstrumentChannel::settlingTime

The minimum power-on settling time required by this channel.

Specified in milliseconds.

◆ status

bool RBRInstrumentChannel::status

Whether the channel is activated for sampling.

See also: RBRInstrument_setChannelStatus()

◆ type

char RBRInstrumentChannel::type[RBRINSTRUMENT_CHANNEL_TYPE_MAX+1]

A short, pre-defined “generic” name for the installed channel as a null-terminated C string.

E.g., “temp09”, “pres19”, “cond05”.

See also: https://docs.rbr-global.com/L3commandreference/supported-channel-types

◆ userUnits

char RBRInstrumentChannel::userUnits[RBRINSTRUMENT_CHANNEL_UNIT_MAX+1]

The unit in which processed data is normally reported from the logger as a null-terminated C string.

E.g., “C” for Celsius, “V” for Volts, “dbar” for decibars.

The documentation for this struct was generated from the following file:

include/RBRInstrumentConfiguration.h

Data Fields