Instrument commands and structures pertaining to instrument configuration information and calibration. More...

This graph shows which files directly or indirectly include this file:

Data Structures
struct	RBRInstrumentCalibration
	A channel calibration. More...

struct	RBRInstrumentChannelGain

struct	RBRInstrumentChannel
	Details reported by the instrument `channel` command. More...

struct	RBRInstrumentChannels
	Details reported by a combination of the instrument `channels`, `channel`, and `calibration` commands. More...

struct	RBRInstrumentSensorParameter
	A sensor parameter. More...

Macros
#define	RBRINSTRUMENT_CALIBRATION_C_COEFFICIENT_MAX 24
	The maximum number of C calibration coefficients. More...

#define	RBRINSTRUMENT_CALIBRATION_X_COEFFICIENT_MAX 8
	The maximum number of X calibration coefficients. More...

#define	RBRINSTRUMENT_CALIBRATION_N_COEFFICIENT_MAX 8
	The maximum number of input channel indices. More...

#define	RBRINSTRUMENT_VALUE_COEFFICIENT 0xFF
	An in-band representation of the special “value” calibration correction value. More...

#define	RBRINSTRUMENT_CALIBRATION_EQUATION_MAX 31
	The maximum number of characters in a calibration equation name. More...

#define	RBRINSTRUMENT_CHANNEL_GAINS_MAX 8
	The maximum number of gain settings for a channel.

#define	RBRINSTRUMENT_INPUT_TIMEOUT_MIN 10000
	The minimum input timeout.

#define	RBRINSTRUMENT_INPUT_TIMEOUT_MAX 240000
	The maximum input timeout.

#define	RBRINSTRUMENT_SENSOR_PARAMETER_KEY_MAX 63
	The maximum number of characters in a sensor parameter key. More...

#define	RBRINSTRUMENT_SENSOR_PARAMETER_VALUE_MAX 63
	The maximum number of characters in a sensor parameter value. More...

Typedefs
typedef uint8_t	RBRInstrumentChannelIndex
	A channel identifier. More...

typedef uint8_t	RBRInstrumentModuleAddress
	An internal module identifier.

typedef struct RBRInstrumentCalibration	RBRInstrumentCalibration
	A channel calibration. More...

typedef enum RBRInstrumentChannelRangingMode	RBRInstrumentChannelRangingMode
	Possible channel gain ranging modes. More...

typedef struct RBRInstrumentChannelGain	RBRInstrumentChannelGain

typedef struct RBRInstrumentChannel	RBRInstrumentChannel
	Details reported by the instrument `channel` command. More...

typedef struct RBRInstrumentChannels	RBRInstrumentChannels
	Details reported by a combination of the instrument `channels`, `channel`, and `calibration` commands. More...

typedef enum RBRInstrumentValueSetting	RBRInstrumentValueSetting
	Value settings the instrument uses for calculation of derived channels, or as defaults for physical parameters the instrument does not measure. More...

typedef struct RBRInstrumentSensorParameter	RBRInstrumentSensorParameter
	A sensor parameter. More...

Enumerations
enum	RBRInstrumentChannelRangingMode { RBRINSTRUMENT_RANGING_NONE, RBRINSTRUMENT_RANGING_MANUAL, RBRINSTRUMENT_RANGING_AUTO, RBRINSTRUMENT_RANGING_COUNT, RBRINSTRUMENT_UNKNOWN_RANGING }
	Possible channel gain ranging modes. More...

enum	RBRInstrumentValueSetting { RBRINSTRUMENT_SETTING_SPECCONDTEMPCO, RBRINSTRUMENT_SETTING_ALTITUDE, RBRINSTRUMENT_SETTING_TEMPERATURE, RBRINSTRUMENT_SETTING_PRESSURE, RBRINSTRUMENT_SETTING_CONDUCTIVITY, RBRINSTRUMENT_SETTING_ATMOSPHERE, RBRINSTRUMENT_SETTING_DENSITY, RBRINSTRUMENT_SETTING_SALINITY, RBRINSTRUMENT_SETTING_AVGSOUNDSPEED, RBRINSTRUMENT_SETTING_COUNT, RBRINSTRUMENT_UNKNOWN_SETTING }
	Value settings the instrument uses for calculation of derived channels, or as defaults for physical parameters the instrument does not measure. More...

Functions
const char *	RBRInstrumentChannelRangingMode_name (RBRInstrumentChannelRangingMode mode)
	Get a human-readable string name for a channel gain ranging mode. More...

RBRInstrumentError	RBRInstrument_getChannels (RBRInstrument instrument, RBRInstrumentChannels channels)
	Get channel information for the instrument. More...

RBRInstrumentError	RBRInstrument_setChannelStatus (RBRInstrument *instrument, RBRInstrumentChannelIndex channel, bool status)
	Set the status of a channel. More...

RBRInstrumentError	RBRInstrument_setChannelGain (RBRInstrument instrument, RBRInstrumentChannelIndex channel, RBRInstrumentChannelGain gain)
	Set the gain parameters of a channel. More...

RBRInstrumentError	RBRInstrument_setCalibration (RBRInstrument instrument, RBRInstrumentChannelIndex channel, const RBRInstrumentCalibration calibration)
	Update a channel's calibration coefficients. More...

RBRInstrumentError	RBRInstrument_getFetchPowerOffDelay (RBRInstrument instrument, RBRInstrumentPeriod fetchPowerOffDelay)
	Get the fetch power-off delay. More...

RBRInstrumentError	RBRInstrument_setFetchPowerOffDelay (RBRInstrument *instrument, RBRInstrumentPeriod fetchPowerOffDelay)
	Set the fetch power-off delay. More...

RBRInstrumentError	RBRInstrument_isSensorPowerAlwaysOn (RBRInstrument instrument, bool sensorPowerAlwaysOn)
	Get whether sensor power is always on. More...

RBRInstrumentError	RBRInstrument_setSensorPowerAlwaysOn (RBRInstrument *instrument, bool sensorPowerAlwaysOn)
	Set whether sensor power is always on. More...

RBRInstrumentError	RBRInstrument_getCastDetection (RBRInstrument instrument, bool castDetection)
	Get whether cast detection is enabled. More...

RBRInstrumentError	RBRInstrument_setCastDetection (RBRInstrument *instrument, bool castDetection)
	Set whether cast detection is enabled. More...

RBRInstrumentError	RBRInstrument_getInputTimeout (RBRInstrument instrument, RBRInstrumentPeriod inputTimeout)
	Get the timeout for output suppression while receiving commands. More...

RBRInstrumentError	RBRInstrument_setInputTimeout (RBRInstrument *instrument, RBRInstrumentPeriod inputTimeout)
	Set the timeout for output suppression while receiving commands. More...

const char *	RBRInstrumentValueSetting_name (RBRInstrumentValueSetting setting)
	Get a human-readable string name for an instrument value setting. More...

RBRInstrumentError	RBRInstrument_getValueSetting (RBRInstrument instrument, RBRInstrumentValueSetting setting, float value)
	Read a value setting from the instrument. More...

RBRInstrumentError	RBRInstrument_setValueSetting (RBRInstrument *instrument, RBRInstrumentValueSetting setting, float value)
	Write the a value setting to the instrument. More...

RBRInstrumentError	RBRInstrument_getSensorParameter (RBRInstrument instrument, RBRInstrumentChannelIndex channel, RBRInstrumentSensorParameter parameter)
	Retrieve a single sensor parameter for a channel. More...

RBRInstrumentError	RBRInstrument_getSensorParameters (RBRInstrument instrument, RBRInstrumentChannelIndex channel, RBRInstrumentSensorParameter parameters, int32_t *size)
	Retrieve the sensor parameters for a channel. More...

RBRInstrumentError	RBRInstrument_setSensorParameter (RBRInstrument instrument, RBRInstrumentChannelIndex channel, RBRInstrumentSensorParameter parameter)
	Set a sensor parameter for a channel. More...

Detailed Description

Instrument commands and structures pertaining to instrument configuration information and calibration.

See also: https://docs.rbr-global.com/L3commandreference/commands/configuration-information-and-calibration

Copyright: Copyright (c) 2018 RBR Ltd. Licensed under the Apache License, Version 2.0.

Macro Definition Documentation

◆ RBRINSTRUMENT_CALIBRATION_C_COEFFICIENT_MAX

#define RBRINSTRUMENT_CALIBRATION_C_COEFFICIENT_MAX 24

The maximum number of C calibration coefficients.

See also: RBRInstrumentCalibration.c

◆ RBRINSTRUMENT_CALIBRATION_EQUATION_MAX

#define RBRINSTRUMENT_CALIBRATION_EQUATION_MAX 31

The maximum number of characters in a calibration equation name.

Does not include any null terminator.

◆ RBRINSTRUMENT_CALIBRATION_N_COEFFICIENT_MAX

#define RBRINSTRUMENT_CALIBRATION_N_COEFFICIENT_MAX 8

The maximum number of input channel indices.

See also: RBRInstrumentCalibration.n

◆ RBRINSTRUMENT_CALIBRATION_X_COEFFICIENT_MAX

#define RBRINSTRUMENT_CALIBRATION_X_COEFFICIENT_MAX 8

The maximum number of X calibration coefficients.

See also: RBRInstrumentCalibration.x

◆ RBRINSTRUMENT_SENSOR_PARAMETER_KEY_MAX

#define RBRINSTRUMENT_SENSOR_PARAMETER_KEY_MAX 63

The maximum number of characters in a sensor parameter key.

Does not include any null terminator.

◆ RBRINSTRUMENT_SENSOR_PARAMETER_VALUE_MAX

#define RBRINSTRUMENT_SENSOR_PARAMETER_VALUE_MAX 63

The maximum number of characters in a sensor parameter value.

Does not include any null terminator.

◆ RBRINSTRUMENT_VALUE_COEFFICIENT

#define RBRINSTRUMENT_VALUE_COEFFICIENT 0xFF

An in-band representation of the special “value” calibration correction value.

See also: RBRInstrumentCalibration.n

Typedef Documentation

◆ RBRInstrumentCalibration

typedef struct RBRInstrumentCalibration RBRInstrumentCalibration

A channel calibration.

See also: RBRInstrumentChannel; RBRInstrument_setCalibration()

◆ RBRInstrumentChannel

typedef struct RBRInstrumentChannel RBRInstrumentChannel

Details reported by the instrument channel command.

See also: RBRInstrumentChannels

◆ RBRInstrumentChannelGain

typedef struct RBRInstrumentChannelGain RBRInstrumentChannelGain

Gain parameters for a channel.

See also: RBRInstrumentChannel; RBRInstrument_setChannelGain()

◆ RBRInstrumentChannelIndex

typedef uint8_t RBRInstrumentChannelIndex

A channel identifier.

Channel indices are always 1-based. A value of 0 means the index is unset or empty.

◆ RBRInstrumentChannelRangingMode

typedef enum RBRInstrumentChannelRangingMode RBRInstrumentChannelRangingMode

Possible channel gain ranging modes.

See also: RBRInstrumentChannel; https://docs.rbr-global.com/L3commandreference/format-of-stored-data/standard-rawbin00-format/deployment-header/version-2-001

◆ RBRInstrumentChannels

typedef struct RBRInstrumentChannels RBRInstrumentChannels

Details reported by a combination of the instrument channels, channel, and calibration commands.

See also: RBRInstrument_getChannels(); https://docs.rbr-global.com/L3commandreference/commands/configuration-information-and-calibration/channels; https://docs.rbr-global.com/L3commandreference/commands/configuration-information-and-calibration/channel; https://docs.rbr-global.com/L3commandreference/commands/configuration-information-and-calibration/calibration

◆ RBRInstrumentSensorParameter

typedef struct RBRInstrumentSensorParameter RBRInstrumentSensorParameter

A sensor parameter.

See also: RBRInstrument_getSensorParameter(); RBRInstrument_getSensorParameters(); RBRInstrument_setSensorParameter()

◆ RBRInstrumentValueSetting

typedef enum RBRInstrumentValueSetting RBRInstrumentValueSetting

Value settings the instrument uses for calculation of derived channels, or as defaults for physical parameters the instrument does not measure.

See the command reference documentation for details on the use and default values for each of these parameters.

See also: RBRInstrument_getValueSetting(); RBRInstrument_setValueSetting(); https://docs.rbr-global.com/L3commandreference/commands/configuration-information-and-calibration/settings

Enumeration Type Documentation

◆ RBRInstrumentChannelRangingMode

enum RBRInstrumentChannelRangingMode

Possible channel gain ranging modes.

See also: RBRInstrumentChannel; https://docs.rbr-global.com/L3commandreference/format-of-stored-data/standard-rawbin00-format/deployment-header/version-2-001

Enumerator
RBRINSTRUMENT_RANGING_NONE	No gain ranging is available.
RBRINSTRUMENT_RANGING_MANUAL	A fixed gain is used.
RBRINSTRUMENT_RANGING_AUTO	The channel auto-ranges over the available gain settings.
RBRINSTRUMENT_RANGING_COUNT	The number of specific gain ranging modes.
RBRINSTRUMENT_UNKNOWN_RANGING	An unknown or unrecognized gain ranging mode.

◆ RBRInstrumentValueSetting

enum RBRInstrumentValueSetting

Value settings the instrument uses for calculation of derived channels, or as defaults for physical parameters the instrument does not measure.

See the command reference documentation for details on the use and default values for each of these parameters.

See also: RBRInstrument_getValueSetting(); RBRInstrument_setValueSetting(); https://docs.rbr-global.com/L3commandreference/commands/configuration-information-and-calibration/settings

Enumerator
RBRINSTRUMENT_SETTING_SPECCONDTEMPCO	The temperature coefficient used to correct the derived channel for specific conductivity to 25°C. Specified in degrees Celsius.
RBRINSTRUMENT_SETTING_ALTITUDE	The height above the seabed at which the logger is deployed. Specified in metres.
RBRINSTRUMENT_SETTING_TEMPERATURE	The default temperature. Specified in degrees Celsius.
RBRINSTRUMENT_SETTING_PRESSURE	The default absolute pressure. Specified in dbar.
RBRINSTRUMENT_SETTING_CONDUCTIVITY	The default conductivity. Specified in ms/cm². This parameter is unavailable for Logger3 instruments. It is only available on early Logger2 instruments.
RBRINSTRUMENT_SETTING_ATMOSPHERE	The default atmospheric pressure. Specified in dbar.
RBRINSTRUMENT_SETTING_DENSITY	The default water density. Specified in g/cm³.
RBRINSTRUMENT_SETTING_SALINITY	The default salinity. Specified in PSU.
RBRINSTRUMENT_SETTING_AVGSOUNDSPEED	The default average speed of sound. Specified in m/s.
RBRINSTRUMENT_SETTING_COUNT	The number of specific value settings.
RBRINSTRUMENT_UNKNOWN_SETTING	An unknown or unrecognized value setting.

Function Documentation

◆ RBRInstrument_getCastDetection()

RBRInstrumentError RBRInstrument_getCastDetection	(	RBRInstrument *	instrument,
		bool *	castDetection
	)

Get whether cast detection is enabled.

The instrument can automatically detect upcasts and downcasts and generate cast detection events in the datastream.

Parameters

[in]	instrument	the instrument connection
[out]	castDetection	whether cast detection is enabled

Returns: RBRINSTRUMENT_SUCCESS when the setting is successfully read; RBRINSTRUMENT_TIMEOUT when a timeout occurs; RBRINSTRUMENT_CALLBACK_ERROR returned by a callback

See also: RBRInstrument_setCastDetection(); https://docs.rbr-global.com/L3commandreference/commands/configuration-information-and-calibration/settings

◆ RBRInstrument_getChannels()

RBRInstrumentError RBRInstrument_getChannels	(	RBRInstrument *	instrument,
		RBRInstrumentChannels *	channels
	)

Get channel information for the instrument.

Channel information is composed from a combination of the channels, channel, and calibration commands. The information returned by this function should comprise a complete model of an instrument's channels.

Parameters

[in]	instrument	the instrument connection
[out]	channels	the channel information

Returns: RBRINSTRUMENT_SUCCESS when the settings are successfully read; RBRINSTRUMENT_TIMEOUT when a timeout occurs; RBRINSTRUMENT_CALLBACK_ERROR returned by a callback

See also: RBRInstrument_getSensorParameters(); https://docs.rbr-global.com/L3commandreference/commands/configuration-information-and-calibration/channels; https://docs.rbr-global.com/L3commandreference/commands/configuration-information-and-calibration/channel; https://docs.rbr-global.com/L3commandreference/commands/configuration-information-and-calibration/calibration

◆ RBRInstrument_getFetchPowerOffDelay()

RBRInstrumentError RBRInstrument_getFetchPowerOffDelay	(	RBRInstrument *	instrument,
		RBRInstrumentPeriod *	fetchPowerOffDelay
	)

Get the fetch power-off delay.

The fetch power-off delay delay in milliseconds between the successful completion of a fetch command and power to the front end sensors being removed by the instrument.

Parameters

[in]	instrument	the instrument connection
[out]	fetchPowerOffDelay	the fetch power-off delay

Returns: RBRINSTRUMENT_SUCCESS when the setting is successfully read; RBRINSTRUMENT_TIMEOUT when a timeout occurs; RBRINSTRUMENT_CALLBACK_ERROR returned by a callback

See also: RBRInstrument_setFetchPowerOffDelay(); https://docs.rbr-global.com/L3commandreference/commands/configuration-information-and-calibration/settings

◆ RBRInstrument_getInputTimeout()

RBRInstrumentError RBRInstrument_getInputTimeout	(	RBRInstrument *	instrument,
		RBRInstrumentPeriod *	inputTimeout
	)

Get the timeout for output suppression while receiving commands.

Specified in milliseconds. Must be between 10,000 and 240,000, inclusive; partial seconds are rounded up to the next whole second by the instrument.

Parameters

[in]	instrument	the instrument connection
[out]	inputTimeout	the timeout for output suppression

Returns: RBRINSTRUMENT_SUCCESS when the setting is successfully read; RBRINSTRUMENT_TIMEOUT when a timeout occurs; RBRINSTRUMENT_CALLBACK_ERROR returned by a callback

See also: RBRInstrument_setInputTimeout(); https://docs.rbr-global.com/L3commandreference/commands/configuration-information-and-calibration/settings

◆ RBRInstrument_getSensorParameter()

RBRInstrumentError RBRInstrument_getSensorParameter	(	RBRInstrument *	instrument,
		RBRInstrumentChannelIndex	channel,
		RBRInstrumentSensorParameter *	parameter
	)

Retrieve a single sensor parameter for a channel.

If the parameter is not configured, its value is set to “n/a”. This is the native behaviour of Logger3 instruments. However, at a hardware level, attempting to retrieve a nonexistent sensor parameter from a Logger2 instrument results in the error “E0501 item is not configured”. To simplify things for users, the library emulates the Logger3 behaviour for Logger2 instruments.

Parameters

	instrument	the instrument connection
[in]	channel	the index of the channel from which the parameter is to be retrieved
[in,out]	parameter	initially, the sensor parameter to be retrieved; after return, the instrument response

Returns: RBRINSTRUMENT_SUCCESS when the settings are successfully read; RBRINSTRUMENT_TIMEOUT when a timeout occurs; RBRINSTRUMENT_CALLBACK_ERROR returned by a callback

See also: RBRInstrument_getChannels(); RBRInstrument_getSensorParameters(); RBRInstrument_setSensorParameter(); https://docs.rbr-global.com/L3commandreference/commands/configuration-information-and-calibration/sensor

◆ RBRInstrument_getSensorParameters()

RBRInstrumentError RBRInstrument_getSensorParameters	(	RBRInstrument *	instrument,
		RBRInstrumentChannelIndex	channel,
		RBRInstrumentSensorParameter *	parameters,
		int32_t *	size
	)

Retrieve the sensor parameters for a channel.

To ease memory requirements, sensor parameters are not included with other channel information retrieved by RBRInstrument_getChannels().

Parameters

	instrument	the instrument connection
[in]	channel	the index of the channel for which sensor parameters are to be retrieved
[out]	parameters	the sensor parameters for the channel
[in,out]	size	initially, the maximum number of elements which can be written to parameters; after return, the number of parameters actually written

Returns: RBRINSTRUMENT_SUCCESS when the settings are successfully read; RBRINSTRUMENT_TIMEOUT when a timeout occurs; RBRINSTRUMENT_CALLBACK_ERROR returned by a callback

See also: RBRInstrument_getChannels(); RBRInstrument_getSensorParameter(); RBRInstrument_setSensorParameter(); https://docs.rbr-global.com/L3commandreference/commands/configuration-information-and-calibration/sensor

◆ RBRInstrument_getValueSetting()

RBRInstrumentError RBRInstrument_getValueSetting	(	RBRInstrument *	instrument,
		RBRInstrumentValueSetting	setting,
		float *	value
	)

Read a value setting from the instrument.

Parameters

[in]	instrument	the instrument connection
[in]	setting	the setting to retrieve
[out]	value	the value of the setting

Returns: RBRINSTRUMENT_SUCCESS when the setting is successfully read; RBRINSTRUMENT_TIMEOUT when a timeout occurs; RBRINSTRUMENT_CALLBACK_ERROR returned by a callback; RBRINSTRUMENT_INVALID_PARAMETER_VALUE when an unrecognized setting is requested

See also: RBRInstrument_setValueSetting(); https://docs.rbr-global.com/L3commandreference/commands/configuration-information-and-calibration/settings

◆ RBRInstrument_isSensorPowerAlwaysOn()

RBRInstrumentError RBRInstrument_isSensorPowerAlwaysOn	(	RBRInstrument *	instrument,
		bool *	sensorPowerAlwaysOn
	)

Get whether sensor power is always on.

The instrument does not have to power down front end sensors between samples. This can be useful for sensors with very long power-on stabilization times.

Parameters

[in]	instrument	the instrument connection
[out]	sensorPowerAlwaysOn	whether sensor power is always on

Returns: RBRINSTRUMENT_SUCCESS when the setting is successfully read; RBRINSTRUMENT_TIMEOUT when a timeout occurs; RBRINSTRUMENT_CALLBACK_ERROR returned by a callback

See also: RBRInstrument_setSensorPowerAlwaysOn(); https://docs.rbr-global.com/L3commandreference/commands/configuration-information-and-calibration/settings

◆ RBRInstrument_setCalibration()

RBRInstrumentError RBRInstrument_setCalibration	(	RBRInstrument *	instrument,
		RBRInstrumentChannelIndex	channel,
		const RBRInstrumentCalibration *	calibration
	)

Update a channel's calibration coefficients.

Hardware errors may occur if:

the instrument is logging
you set an out-of-range or incorrect coefficient
you set too many coefficients
you set the wrong types of coefficients

If coefficients used by the channel are omitted from the set sent, then those coefficients will retain their current values. You can call RBRInstrument_getChannels() after updating coefficients to confirm the values written.

Values of in the n coefficient group (RBRInstrumentCalibration.n) are ignored.

Parameters

[in]	instrument	the instrument connection
[in]	channel	the index of the channel to update
[in]	calibration	the new calibration coefficients for the channel

Returns: RBRINSTRUMENT_SUCCESS when the setting is successfully written; RBRINSTRUMENT_TIMEOUT when a timeout occurs; RBRINSTRUMENT_CALLBACK_ERROR returned by a callback; RBRINSTRUMENT_HARDWARE_ERROR when the calibration cannot be changed; RBRINSTRUMENT_INVALID_PARAMETER_VALUE when no coefficients are populated

See also: RBRInstrument_getChannels(); https://docs.rbr-global.com/L3commandreference/commands/configuration-information-and-calibration/calibration

◆ RBRInstrument_setCastDetection()

RBRInstrumentError RBRInstrument_setCastDetection	(	RBRInstrument *	instrument,
		bool	castDetection
	)

Set whether cast detection is enabled.

A hardware error will occur if the instrument is logging.

Parameters

[in]	instrument	the instrument connection
[in]	castDetection	whether cast detection is enabled

Returns: RBRINSTRUMENT_SUCCESS when the setting is successfully written; RBRINSTRUMENT_TIMEOUT when a timeout occurs; RBRINSTRUMENT_CALLBACK_ERROR returned by a callback; RBRINSTRUMENT_HARDWARE_ERROR if the instrument is logging

See also: RBRInstrument_getCastDetection(); https://docs.rbr-global.com/L3commandreference/commands/configuration-information-and-calibration/settings

◆ RBRInstrument_setChannelGain()

RBRInstrumentError RBRInstrument_setChannelGain	(	RBRInstrument *	instrument,
		RBRInstrumentChannelIndex	channel,
		RBRInstrumentChannelGain *	gain
	)

Set the gain parameters of a channel.

RBRInstrumentChannelGain.rangingMode must be either RBRINSTRUMENT_RANGING_MANUAL or RBRINSTRUMENT_RANGING_AUTO. Otherwise, RBRINSTRUMENT_INVALID_PARAMETER_VALUE is returned.

For manual gain selection, the gain given by RBRInstrumentChannelGain.currentGain must be one of the available gains reported by the instrument. Otherwise, the instrument will produce a hardware error. If RBRInstrumentChannelGain.availableGains is populated (contains at least one leading non-NaN entry), this function will verify the presence of the chosen gain. If it is not found, RBRINSTRUMENT_INVALID_PARAMETER_VALUE is returned.

RBRInstrumentChannelGain.availableGains is only used for parameter verification. It is not sent to the instrument.

Parameters

[in]	instrument	the instrument connection
[in]	channel	the index of the channel to update
[in]	gain	the gain parameters for the channel

Returns: RBRINSTRUMENT_SUCCESS when the settings are successfully written; RBRINSTRUMENT_TIMEOUT when a timeout occurs; RBRINSTRUMENT_CALLBACK_ERROR returned by a callback; RBRINSTRUMENT_HARDWARE_ERROR if the instrument is logging, or an invalid gain value is given; RBRINSTRUMENT_INVALID_PARAMETER_VALUE if the ranging mode is invalid, or if the gain value can be conclusively determined to be invalid

See also: RBRInstrument_getChannels(); https://docs.rbr-global.com/L3commandreference/commands/configuration-information-and-calibration/channel

◆ RBRInstrument_setChannelStatus()

RBRInstrumentError RBRInstrument_setChannelStatus	(	RBRInstrument *	instrument,
		RBRInstrumentChannelIndex	channel,
		bool	status
	)

Set the status of a channel.

Parameters

[in]	instrument	the instrument connection
[in]	channel	the index of the channel to update
[in]	status	whether the channel is activated for sampling

Returns: RBRINSTRUMENT_SUCCESS when the setting is successfully written; RBRINSTRUMENT_TIMEOUT when a timeout occurs; RBRINSTRUMENT_CALLBACK_ERROR returned by a callback; RBRINSTRUMENT_HARDWARE_ERROR if the instrument is logging

See also: RBRInstrument_getChannels(); https://docs.rbr-global.com/L3commandreference/commands/configuration-information-and-calibration/channel

◆ RBRInstrument_setFetchPowerOffDelay()

RBRInstrumentError RBRInstrument_setFetchPowerOffDelay	(	RBRInstrument *	instrument,
		RBRInstrumentPeriod	fetchPowerOffDelay
	)

Set the fetch power-off delay.

Hardware errors may occur if:

the instrument is logging
you set an out-of-bounds time the library fails to detect

Parameters

[in]	instrument	the instrument connection
[in]	fetchPowerOffDelay	the fetch power-off delay

Returns: RBRINSTRUMENT_SUCCESS when the setting is successfully written; RBRINSTRUMENT_TIMEOUT when a timeout occurs; RBRINSTRUMENT_CALLBACK_ERROR returned by a callback; RBRINSTRUMENT_HARDWARE_ERROR when the settings cannot be changed

See also: RBRInstrument_getFetchPowerOffDelay(); https://docs.rbr-global.com/L3commandreference/commands/configuration-information-and-calibration/settings

◆ RBRInstrument_setInputTimeout()

RBRInstrumentError RBRInstrument_setInputTimeout	(	RBRInstrument *	instrument,
		RBRInstrumentPeriod	inputTimeout
	)

Set the timeout for output suppression while receiving commands.

Must be between 10,000 and 240,000, inclusive; partial seconds are rounded up to the next whole second.

A hardware error will occur if the instrument is logging.

Parameters

[in]	instrument	the instrument connection
[in]	inputTimeout	the timeout for output suppression

Returns: RBRINSTRUMENT_SUCCESS when the setting is successfully written; RBRINSTRUMENT_TIMEOUT when a timeout occurs; RBRINSTRUMENT_CALLBACK_ERROR returned by a callback; RBRINSTRUMENT_HARDWARE_ERROR if the instrument is logging

See also: RBRInstrument_getInputTimeout(); https://docs.rbr-global.com/L3commandreference/commands/configuration-information-and-calibration/settings

◆ RBRInstrument_setSensorParameter()

RBRInstrumentError RBRInstrument_setSensorParameter	(	RBRInstrument *	instrument,
		RBRInstrumentChannelIndex	channel,
		RBRInstrumentSensorParameter *	parameter
	)

Set a sensor parameter for a channel.

Hardware errors may occur if:

the instrument is logging
the parameter name has not been defined at the RBR factory

Parameters

	instrument	the instrument connection
[in]	channel	the index of the channel the sensor parameter of which is to be updated
[in]	parameter	the sensor parameter for the channel

Returns: RBRINSTRUMENT_SUCCESS when the setting is successfully written; RBRINSTRUMENT_TIMEOUT when a timeout occurs; RBRINSTRUMENT_CALLBACK_ERROR returned by a callback; RBRINSTRUMENT_HARDWARE_ERROR when the parameter cannot be changed

See also: RBRInstrument_getChannels(); RBRInstrument_getSensorParameter(); RBRInstrument_getSensorParameters(); https://docs.rbr-global.com/L3commandreference/commands/configuration-information-and-calibration/sensor

◆ RBRInstrument_setSensorPowerAlwaysOn()

RBRInstrumentError RBRInstrument_setSensorPowerAlwaysOn	(	RBRInstrument *	instrument,
		bool	sensorPowerAlwaysOn
	)

Set whether sensor power is always on.

A hardware error will occur if the instrument is logging.

Parameters

[in]	instrument	the instrument connection
[in]	sensorPowerAlwaysOn	whether sensor power is always on

Returns: RBRINSTRUMENT_SUCCESS when the setting is successfully written; RBRINSTRUMENT_TIMEOUT when a timeout occurs; RBRINSTRUMENT_CALLBACK_ERROR returned by a callback; RBRINSTRUMENT_HARDWARE_ERROR if the instrument is logging

See also: RBRInstrument_isSensorPowerAlwaysOn(); https://docs.rbr-global.com/L3commandreference/commands/configuration-information-and-calibration/settings

◆ RBRInstrument_setValueSetting()

RBRInstrumentError RBRInstrument_setValueSetting	(	RBRInstrument *	instrument,
		RBRInstrumentValueSetting	setting,
		float	value
	)

Write the a value setting to the instrument.

A hardware error will occur if the instrument is logging.

Parameters

[in]	instrument	the instrument connection
[in]	setting	the setting to retrieve
[in]	value	the value of the setting

Returns: RBRINSTRUMENT_SUCCESS when the setting is successfully written; RBRINSTRUMENT_TIMEOUT when a timeout occurs; RBRINSTRUMENT_CALLBACK_ERROR returned by a callback; RBRINSTRUMENT_HARDWARE_ERROR if the instrument is logging; RBRINSTRUMENT_INVALID_PARAMETER_VALUE when an unrecognized setting is requested or when the value is NaN

See also: RBRInstrument_getValueSetting(); https://docs.rbr-global.com/L3commandreference/commands/configuration-information-and-calibration/settings

◆ RBRInstrumentChannelRangingMode_name()

const char* RBRInstrumentChannelRangingMode_name ( RBRInstrumentChannelRangingMode mode )

Get a human-readable string name for a channel gain ranging mode.

Parameters

[in] mode the ranging mode

Returns: a string name for the ranging mode

See also: RBRInstrumentError_name() for a description of the format of names

◆ RBRInstrumentValueSetting_name()

const char* RBRInstrumentValueSetting_name ( RBRInstrumentValueSetting setting )

Get a human-readable string name for an instrument value setting.

Parameters

[in] setting the value setting

Returns: a string name for the value setting

See also: RBRInstrumentError_name() for a description of the format of names

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ RBRINSTRUMENT_CALIBRATION_C_COEFFICIENT_MAX

◆ RBRINSTRUMENT_CALIBRATION_EQUATION_MAX

◆ RBRINSTRUMENT_CALIBRATION_N_COEFFICIENT_MAX

◆ RBRINSTRUMENT_CALIBRATION_X_COEFFICIENT_MAX

◆ RBRINSTRUMENT_SENSOR_PARAMETER_KEY_MAX

◆ RBRINSTRUMENT_SENSOR_PARAMETER_VALUE_MAX

◆ RBRINSTRUMENT_VALUE_COEFFICIENT

Typedef Documentation

◆ RBRInstrumentCalibration

◆ RBRInstrumentChannel

◆ RBRInstrumentChannelGain

◆ RBRInstrumentChannelIndex

◆ RBRInstrumentChannelRangingMode

◆ RBRInstrumentChannels

◆ RBRInstrumentSensorParameter

◆ RBRInstrumentValueSetting

Enumeration Type Documentation

◆ RBRInstrumentChannelRangingMode

◆ RBRInstrumentValueSetting

Function Documentation

◆ RBRInstrument_getCastDetection()

◆ RBRInstrument_getChannels()

◆ RBRInstrument_getFetchPowerOffDelay()

◆ RBRInstrument_getInputTimeout()

◆ RBRInstrument_getSensorParameter()

◆ RBRInstrument_getSensorParameters()

◆ RBRInstrument_getValueSetting()

◆ RBRInstrument_isSensorPowerAlwaysOn()

◆ RBRInstrument_setCalibration()

◆ RBRInstrument_setCastDetection()

◆ RBRInstrument_setChannelGain()

◆ RBRInstrument_setChannelStatus()

◆ RBRInstrument_setFetchPowerOffDelay()

◆ RBRInstrument_setInputTimeout()

◆ RBRInstrument_setSensorParameter()

◆ RBRInstrument_setSensorPowerAlwaysOn()

◆ RBRInstrument_setValueSetting()

◆ RBRInstrumentChannelRangingMode_name()

◆ RBRInstrumentValueSetting_name()