Instrument commands and structures pertaining to memory and data retrieval. More...

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

Data Structures
struct	RBRInstrumentMemoryInfo
	Instrument `meminfo` command parameters. More...

struct	RBRInstrumentData
	Instrument `readdata` command parameters. More...

struct	RBRInstrumentPostprocessingChannelsList

struct	RBRInstrumentPostprocessing
	The instrument post-processing configuration. More...

Macros
#define	RBRINSTRUMENT_POSTPROCESSING_CHANNEL_MAX 24
	The maximum number of channels which can be generated by a post-processing job.

Typedefs
typedef enum RBRInstrumentDataset	RBRInstrumentDataset
	Possible instrument datasets. More...

typedef struct RBRInstrumentMemoryInfo	RBRInstrumentMemoryInfo
	Instrument `meminfo` command parameters. More...

typedef struct RBRInstrumentData	RBRInstrumentData
	Instrument `readdata` command parameters. More...

typedef enum RBRInstrumentMemoryFormat	RBRInstrumentMemoryFormat
	Instrument memory formats. More...

typedef enum RBRInstrumentPostprocessingAggregate	RBRInstrumentPostprocessingAggregate
	Functions available to aggregate channel values within bins. More...

typedef struct RBRInstrumentPostprocessingChannelsList	RBRInstrumentPostprocessingChannelsList

typedef enum RBRInstrumentPostprocessingStatus	RBRInstrumentPostprocessingStatus
	Post-processing job statuses. More...

typedef enum RBRInstrumentPostprocessingCommand	RBRInstrumentPostprocessingCommand
	Post-processing control commands. More...

typedef enum RBRInstrumentPostprocessingBinFilter	RBRInstrumentPostprocessingBinFilter
	Post-processing bin filters. More...

typedef struct RBRInstrumentPostprocessing	RBRInstrumentPostprocessing
	The instrument post-processing configuration. More...

Enumerations
enum	RBRInstrumentDataset { RBRINSTRUMENT_DATASET_EASYPARSE_EVENTS = 0, RBRINSTRUMENT_DATASET_STANDARD = 1, RBRINSTRUMENT_DATASET_EASYPARSE_SAMPLE_DATA = 1, RBRINSTRUMENT_DATASET_EASYPARSE_DEPLOYMENT_HEADER = 2, RBRINSTRUMENT_DATASET_UNKNOWN_DATASET1 = 3, RBRINSTRUMENT_DATASET_POSTPROCESSING_SAMPLE_DATA = 4, RBRINSTRUMENT_DATASET_COUNT, RBRINSTRUMENT_UNKNOWN_DATASET }
	Possible instrument datasets. More...

enum	RBRInstrumentMemoryFormat { RBRINSTRUMENT_MEMFORMAT_NONE = 0, RBRINSTRUMENT_MEMFORMAT_RAWBIN00 = 1 << 0, RBRINSTRUMENT_MEMFORMAT_CALBIN00 = 1 << 1, RBRINSTRUMENT_MEMFORMAT_MAX = RBRINSTRUMENT_MEMFORMAT_CALBIN00 }
	Instrument memory formats. More...

enum	RBRInstrumentPostprocessingAggregate { RBRINSTRUMENT_POSTPROCESSING_AGGREGATE_MEAN, RBRINSTRUMENT_POSTPROCESSING_AGGREGATE_STD, RBRINSTRUMENT_POSTPROCESSING_AGGREGATE_SAMPLE_COUNT, RBRINSTRUMENT_POSTPROCESSING_AGGREGATE_COUNT, RBRINSTRUMENT_UNKNOWN_POSTPROCESSING_AGGREGATE }
	Functions available to aggregate channel values within bins. More...

enum	RBRInstrumentPostprocessingStatus { RBRINSTRUMENT_POSTPROCESSING_STATUS_IDLE, RBRINSTRUMENT_POSTPROCESSING_STATUS_PROCESSING, RBRINSTRUMENT_POSTPROCESSING_STATUS_COMPLETED, RBRINSTRUMENT_POSTPROCESSING_STATUS_ABORTED, RBRINSTRUMENT_POSTPROCESSING_STATUS_COUNT, RBRINSTRUMENT_UNKNOWN_POSTPROCESSING_STATUS }
	Post-processing job statuses. More...

enum	RBRInstrumentPostprocessingCommand { RBRINSTRUMENT_POSTPROCESSING_COMMAND_START, RBRINSTRUMENT_POSTPROCESSING_COMMAND_RESET, RBRINSTRUMENT_POSTPROCESSING_COMMAND_ABORT, RBRINSTRUMENT_POSTPROCESSING_COMMAND_COUNT, RBRINSTRUMENT_UNKNOWN_POSTPROCESSING_COMMAND }
	Post-processing control commands. More...

enum	RBRInstrumentPostprocessingBinFilter { RBRINSTRUMENT_POSTPROCESSING_BINFILTER_NONE, RBRINSTRUMENT_POSTPROCESSING_BINFILTER_ASCENTONLY, RBRINSTRUMENT_POSTPROCESSING_BINFILTER_DESCENTONLY, RBRINSTRUMENT_POSTPROCESSING_BINFILTER_COUNT, RBRINSTRUMENT_UNKNOWN_POSTPROCESSING_BINFILTER }
	Post-processing bin filters. More...

Functions
const char *	RBRInstrumentDataset_name (RBRInstrumentDataset dataset)
	Get a human-readable string name for a dataset. More...

RBRInstrumentError	RBRInstrument_getMemoryInfo (RBRInstrument instrument, RBRInstrumentMemoryInfo memoryInfo)
	Get information about the usage and characteristics of data memory. More...

RBRInstrumentError	RBRInstrument_readData (RBRInstrument instrument, RBRInstrumentData data)
	Request a chunk of binary data from instrument data memory. More...

RBRInstrumentError	RBRInstrument_memoryClear (RBRInstrument *instrument)
	Clear the data storage area of the flash memory. More...

const char *	RBRInstrumentMemoryFormat_name (RBRInstrumentMemoryFormat format)
	Get a human-readable string name for a memory format. More...

RBRInstrumentError	RBRInstrument_getAvailableMemoryFormats (RBRInstrument instrument, RBRInstrumentMemoryFormat memoryFormats)
	Report a list of available memory formats. More...

RBRInstrumentError	RBRInstrument_getCurrentMemoryFormat (RBRInstrument instrument, RBRInstrumentMemoryFormat memoryFormat)
	Get the current memory format. More...

RBRInstrumentError	RBRInstrument_getNewMemoryFormat (RBRInstrument instrument, RBRInstrumentMemoryFormat memoryFormat)
	Get the memory format to be used for the next deployment. More...

RBRInstrumentError	RBRInstrument_setNewMemoryFormat (RBRInstrument *instrument, RBRInstrumentMemoryFormat memoryFormat)
	Set the memory format to be used for the next deployment. More...

const char *	RBRInstrumentPostprocessingAggregate_name (RBRInstrumentPostprocessingAggregate function)
	Get a human-readable string name for an aggregate function. More...

const char *	RBRInstrumentPostprocessingStatus_name (RBRInstrumentPostprocessingStatus status)
	Get a human-readable string name for a post-processing status. More...

const char *	RBRInstrumentPostprocessingCommand_name (RBRInstrumentPostprocessingCommand command)
	Get a human-readable string name for a post-processing command. More...

const char *	RBRInstrumentPostprocessingBinFilter_name (RBRInstrumentPostprocessingBinFilter filter)
	Get a human-readable string name for a post-processing bin filter. More...

RBRInstrumentError	RBRInstrument_getPostprocessing (RBRInstrument instrument, RBRInstrumentPostprocessing postprocessing)
	Get the instrument post-processing settings. More...

RBRInstrumentError	RBRInstrument_setPostprocessing (RBRInstrument instrument, const RBRInstrumentPostprocessing postprocessing)
	Set the instrument post-processing settings. More...

RBRInstrumentError	RBRInstrument_setPostprocessingCommand (RBRInstrument instrument, RBRInstrumentPostprocessingCommand command, RBRInstrumentPostprocessingStatus status)
	Exercises control over the post-processing state. More...

uint16_t	calculateCrc (const void *data, int32_t size)
	Calculate the 16-bit CRC using the CCITT polynomial f(x)=x^16+x^12+x^5+1 feeding bytes into the generator LSB first and using 0xFFFF as a seed value, is then transmitted. More...

Detailed Description

Instrument commands and structures pertaining to memory and data retrieval.

See also: https://docs.rbr-global.com/L3commandreference/commands/memory-and-data-retrieval

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

Typedef Documentation

◆ RBRInstrumentData

typedef struct RBRInstrumentData RBRInstrumentData

Instrument readdata command parameters.

See also: RBRInstrument_readData(); https://docs.rbr-global.com/L3commandreference/commands/memory-and-data-retrieval/readdata

◆ RBRInstrumentDataset

typedef enum RBRInstrumentDataset RBRInstrumentDataset

Possible instrument datasets.

As an internal implementation detail, the instrument reuses file identifiers (for standard and EasyParse data), and the identifiers are non-continuous (there is no dataset 3). To keep confusion to a minimum, we use those same identifiers here.

◆ RBRInstrumentMemoryFormat

typedef enum RBRInstrumentMemoryFormat RBRInstrumentMemoryFormat

Instrument memory formats.

See also: RBRInstrument_getAvailableMemoryFormats(); RBRInstrument_getCurrentMemoryFormat(); RBRInstrument_getNewMemoryFormat(); RBRInstrument_setNewMemoryFormat(); https://docs.rbr-global.com/L3commandreference/commands/memory-and-data-retrieval/memformat

◆ RBRInstrumentMemoryInfo

typedef struct RBRInstrumentMemoryInfo RBRInstrumentMemoryInfo

Instrument meminfo command parameters.

See also: RBRInstrument_getMemoryInfo(); https://docs.rbr-global.com/L3commandreference/commands/memory-and-data-retrieval/meminfo

◆ RBRInstrumentPostprocessing

typedef struct RBRInstrumentPostprocessing RBRInstrumentPostprocessing

The instrument post-processing configuration.

See also: RBRInstrument_getPostprocessing(); RBRInstrument_setPostprocessing(); https://docs.rbr-global.com/L3commandreference/commands/memory-and-data-retrieval/postprocessing

◆ RBRInstrumentPostprocessingAggregate

typedef enum RBRInstrumentPostprocessingAggregate RBRInstrumentPostprocessingAggregate

Functions available to aggregate channel values within bins.

See also: RBRInstrumentPostprocessingChannel; https://docs.rbr-global.com/L3commandreference/commands/memory-and-data-retrieval/postprocessing

◆ RBRInstrumentPostprocessingBinFilter

typedef enum RBRInstrumentPostprocessingBinFilter RBRInstrumentPostprocessingBinFilter

Post-processing bin filters.

See also: RBRInstrumentPostprocessing; https://docs.rbr-global.com/L3commandreference/commands/memory-and-data-retrieval/postprocessing

◆ RBRInstrumentPostprocessingChannelsList

typedef struct RBRInstrumentPostprocessingChannelsList RBRInstrumentPostprocessingChannelsList

Post-processing channel configurations.

See also: RBRInstrumentPostprocessing; https://docs.rbr-global.com/L3commandreference/commands/memory-and-data-retrieval/postprocessing

◆ RBRInstrumentPostprocessingCommand

typedef enum RBRInstrumentPostprocessingCommand RBRInstrumentPostprocessingCommand

Post-processing control commands.

See also: RBRInstrumentPostprocessing; https://docs.rbr-global.com/L3commandreference/commands/memory-and-data-retrieval/postprocessing

◆ RBRInstrumentPostprocessingStatus

typedef enum RBRInstrumentPostprocessingStatus RBRInstrumentPostprocessingStatus

Post-processing job statuses.

See also: RBRInstrumentPostprocessing; https://docs.rbr-global.com/L3commandreference/commands/memory-and-data-retrieval/postprocessing

Enumeration Type Documentation

◆ RBRInstrumentDataset

enum RBRInstrumentDataset

Possible instrument datasets.

As an internal implementation detail, the instrument reuses file identifiers (for standard and EasyParse data), and the identifiers are non-continuous (there is no dataset 3). To keep confusion to a minimum, we use those same identifiers here.

Enumerator
RBRINSTRUMENT_DATASET_EASYPARSE_EVENTS	EasyParse events
RBRINSTRUMENT_DATASET_STANDARD	Standard data
RBRINSTRUMENT_DATASET_EASYPARSE_SAMPLE_DATA	EasyParse sample data
RBRINSTRUMENT_DATASET_EASYPARSE_DEPLOYMENT_HEADER	EasyParse deployment header
RBRINSTRUMENT_DATASET_UNKNOWN_DATASET1	Reserved for use by the instrument. Cannot be downloaded.
RBRINSTRUMENT_DATASET_POSTPROCESSING_SAMPLE_DATA	Post-processing sample data
RBRINSTRUMENT_DATASET_COUNT	The number of specific datasets.
RBRINSTRUMENT_UNKNOWN_DATASET	An unknown or unrecognized dataset.

◆ RBRInstrumentMemoryFormat

enum RBRInstrumentMemoryFormat

Instrument memory formats.

See also: RBRInstrument_getAvailableMemoryFormats(); RBRInstrument_getCurrentMemoryFormat(); RBRInstrument_getNewMemoryFormat(); RBRInstrument_setNewMemoryFormat(); https://docs.rbr-global.com/L3commandreference/commands/memory-and-data-retrieval/memformat

Enumerator
RBRINSTRUMENT_MEMFORMAT_NONE	No format.
RBRINSTRUMENT_MEMFORMAT_RAWBIN00	“Standard” format, `rawbin00`.
RBRINSTRUMENT_MEMFORMAT_CALBIN00	“EasyParse” format, `calbin00`.
RBRINSTRUMENT_MEMFORMAT_MAX	Corresponds to the largest memory format enum value.

◆ RBRInstrumentPostprocessingAggregate

enum RBRInstrumentPostprocessingAggregate

Functions available to aggregate channel values within bins.

See also: RBRInstrumentPostprocessingChannel; https://docs.rbr-global.com/L3commandreference/commands/memory-and-data-retrieval/postprocessing

Enumerator
RBRINSTRUMENT_POSTPROCESSING_AGGREGATE_MEAN	average value in the bin
RBRINSTRUMENT_POSTPROCESSING_AGGREGATE_STD	standard deviation of the bin
RBRINSTRUMENT_POSTPROCESSING_AGGREGATE_SAMPLE_COUNT	number of samples in the bin
RBRINSTRUMENT_POSTPROCESSING_AGGREGATE_COUNT	The number of specific post-processing aggregate functions.
RBRINSTRUMENT_UNKNOWN_POSTPROCESSING_AGGREGATE	An unknown or unrecognized post-processing aggregate function.

◆ RBRInstrumentPostprocessingBinFilter

enum RBRInstrumentPostprocessingBinFilter

Post-processing bin filters.

See also: RBRInstrumentPostprocessing; https://docs.rbr-global.com/L3commandreference/commands/memory-and-data-retrieval/postprocessing

Enumerator
RBRINSTRUMENT_POSTPROCESSING_BINFILTER_NONE	No filter.
RBRINSTRUMENT_POSTPROCESSING_BINFILTER_ASCENTONLY	Only ascending values. Equivalent to ascending regimes binning. Only valid when binning by depth.
RBRINSTRUMENT_POSTPROCESSING_BINFILTER_DESCENTONLY	Only descending values. Equivalent to descending regimes binning. Only valid when binning by depth.
RBRINSTRUMENT_POSTPROCESSING_BINFILTER_COUNT	The number of specific post-processing bin filters.
RBRINSTRUMENT_UNKNOWN_POSTPROCESSING_BINFILTER	An unknown or unrecognized post-processing bin filter.

◆ RBRInstrumentPostprocessingCommand

enum RBRInstrumentPostprocessingCommand

Post-processing control commands.

See also: RBRInstrumentPostprocessing; https://docs.rbr-global.com/L3commandreference/commands/memory-and-data-retrieval/postprocessing

Enumerator
RBRINSTRUMENT_POSTPROCESSING_COMMAND_START	Start the post-processing job.
RBRINSTRUMENT_POSTPROCESSING_COMMAND_RESET	Reset the post-processing job.
RBRINSTRUMENT_POSTPROCESSING_COMMAND_ABORT	Abort any current post-processing job.
RBRINSTRUMENT_POSTPROCESSING_COMMAND_COUNT	The number of specific post-processing commands.
RBRINSTRUMENT_UNKNOWN_POSTPROCESSING_COMMAND	An unknown or unrecognized post-processing command.

◆ RBRInstrumentPostprocessingStatus

enum RBRInstrumentPostprocessingStatus

Post-processing job statuses.

See also: RBRInstrumentPostprocessing; https://docs.rbr-global.com/L3commandreference/commands/memory-and-data-retrieval/postprocessing

Enumerator
RBRINSTRUMENT_POSTPROCESSING_STATUS_IDLE	Post-processing is idle.
RBRINSTRUMENT_POSTPROCESSING_STATUS_PROCESSING	Post-processing is in progress.
RBRINSTRUMENT_POSTPROCESSING_STATUS_COMPLETED	Post-processing has completed.
RBRINSTRUMENT_POSTPROCESSING_STATUS_ABORTED	Post-processing has been aborted.
RBRINSTRUMENT_POSTPROCESSING_STATUS_COUNT	The number of specific post-processing statuses.
RBRINSTRUMENT_UNKNOWN_POSTPROCESSING_STATUS	An unknown or unrecognized post-processing status.

Function Documentation

◆ calculateCrc()

uint16_t calculateCrc	(	const void *	data,
		int32_t	size
	)

Calculate the 16-bit CRC using the CCITT polynomial f(x)=x^16+x^12+x^5+1 feeding bytes into the generator LSB first and using 0xFFFF as a seed value, is then transmitted.

Parameters

[in]	data	the data string used to calculate the CRC
[in]	size	the number of characters in the string used to calculate the CRC

Returns: calculated CRC

See also: https://docs.rbr-global.com/L3commandreference/commands/memory-and-data-retrieval/postprocessing

◆ RBRInstrument_getAvailableMemoryFormats()

RBRInstrumentError RBRInstrument_getAvailableMemoryFormats	(	RBRInstrument *	instrument,
		RBRInstrumentMemoryFormat *	memoryFormats
	)

Report a list of available memory formats.

memoryFormats will be treated as a bit field representation of available memory formats as defined by RBRInstrumentMemoryFormat. For details, consult Working with Bit Fields.

Parameters

[in]	instrument	the instrument connection
[out]	memoryFormats	available memory formats

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

See also: https://docs.rbr-global.com/L3commandreference/commands/memory-and-data-retrieval/memformat

◆ RBRInstrument_getCurrentMemoryFormat()

RBRInstrumentError RBRInstrument_getCurrentMemoryFormat	(	RBRInstrument *	instrument,
		RBRInstrumentMemoryFormat *	memoryFormat
	)

Get the current memory format.

Retrieves the format of the data presently stored in memory, either for a deployment in progress or for one which has finished. If the memory is completely empty because it has been cleared, the response will be RBRINSTRUMENT_MEMFORMAT_NONE.

Parameters

[in]	instrument	the instrument connection
[out]	memoryFormat	the current memory format

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

See also: https://docs.rbr-global.com/L3commandreference/commands/memory-and-data-retrieval/memformat

◆ RBRInstrument_getMemoryInfo()

RBRInstrumentError RBRInstrument_getMemoryInfo	(	RBRInstrument *	instrument,
		RBRInstrumentMemoryInfo *	memoryInfo
	)

Get information about the usage and characteristics of data memory.

RBRInstrumentMemoryInfo.dataset must be set to the index of the dataset for which information is to be retrieved.

RBRInstrumentMemoryInfo memoryInfo;
memoryInfo.dataset = RBRINSTRUMENT_DATASET_STANDARD;
RBRInstrument_getMemoryInfo(instrument, &memoryInfo);

Parameters

[in]	instrument	the instrument connection
[in,out]	memoryInfo	data memory information

Returns: RBRINSTRUMENT_SUCCESS when the settings are successfully read; RBRINSTRUMENT_TIMEOUT when a timeout occurs; RBRINSTRUMENT_CALLBACK_ERROR returned by a callback; RBRINSTRUMENT_INVALID_PARAMETER_VALUE when an invalid dataset is requested; RBRINSTRUMENT_HARDWARE_ERROR if the dataset is unsupported

See also: https://docs.rbr-global.com/L3commandreference/commands/memory-and-data-retrieval/meminfo

◆ RBRInstrument_getNewMemoryFormat()

RBRInstrumentError RBRInstrument_getNewMemoryFormat	(	RBRInstrument *	instrument,
		RBRInstrumentMemoryFormat *	memoryFormat
	)

Get the memory format to be used for the next deployment.

Parameters

[in]	instrument	the instrument connection
[out]	memoryFormat	the new memory format

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

See also: https://docs.rbr-global.com/L3commandreference/commands/memory-and-data-retrieval/memformat

◆ RBRInstrument_getPostprocessing()

RBRInstrumentError RBRInstrument_getPostprocessing	(	RBRInstrument *	instrument,
		RBRInstrumentPostprocessing *	postprocessing
	)

Get the instrument post-processing settings.

Parameters

[in]	instrument	the instrument connection
[out]	postprocessing	the post-processing parameters

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

See also: https://docs.rbr-global.com/L3commandreference/commands/memory-and-data-retrieval/postprocessing

◆ RBRInstrument_memoryClear()

RBRInstrumentError RBRInstrument_memoryClear ( RBRInstrument * instrument )

Clear the data storage area of the flash memory.

Currently, all datasets are erased, regardless of the data storage format in use.

Parameters

[in] instrument the instrument connection

Returns: RBRINSTRUMENT_SUCCESS when the settings are successfully read; RBRINSTRUMENT_TIMEOUT when a timeout occurs; RBRINSTRUMENT_CALLBACK_ERROR returned by a callback; RBRINSTRUMENT_HARDWARE_ERROR if the memory failed to erase

See also: https://docs.rbr-global.com/L3commandreference/commands/memory-and-data-retrieval/memclear

◆ RBRInstrument_readData()

RBRInstrumentError RBRInstrument_readData	(	RBRInstrument *	instrument,
		RBRInstrumentData *	data
	)

Request a chunk of binary data from instrument data memory.

When calling RBRInstrument_readData(), data must be populated:

RBRInstrumentData.dataset must be the index of the dataset to read from
RBRInstrumentData.size must be the maximum amount of data to read
RBRInstrumentData.offset must be the offset in memory from which to read
RBRInstrumentData.data must be a pointer to a location to which the data can be written

Upon return, data will have been modified so that the dataset, size, and offset reflect the the instrument response. Be sure to check the reported size as it may differ from the requested size, especially when the instrument is busy or if you're reading the last chunk of the dataset.

For example:

uint8_t buf[1400];
RBRInstrumentData data = {
    .dataset = RBRINSTRUMENT_DATASET_STANDARD,
    .size    = 1400,
    .offset  = 2800,
    .data    = buf
};
RBRInstrument_readData(instrument, &data);
fwrite(buf, data.size, 1, datasetFile);

A communication error will be reported if the offset in response doesn't match request. A checksum error will be reported if the CRC check of the read data fails. However, data will still faithfully reflect the response parameters and data. Be sure to check the return value lest you accidentally consume invalid/corrupt data!

Parameters

[in]	instrument	the instrument connection
[in,out]	data	the instrument data

Returns: RBRINSTRUMENT_SUCCESS when the settings are successfully read; RBRINSTRUMENT_TIMEOUT when a timeout occurs; RBRINSTRUMENT_CALLBACK_ERROR returned by a callback; RBRINSTRUMENT_CHECKSUM_ERROR in the event of a CRC failure; RBRINSTRUMENT_INVALID_PARAMETER_VALUE when an invalid dataset is requested; RBRINSTRUMENT_HARDWARE_ERROR if the dataset is unsupported

See also: https://docs.rbr-global.com/L3commandreference/commands/memory-and-data-retrieval/readdata

◆ RBRInstrument_setNewMemoryFormat()

RBRInstrumentError RBRInstrument_setNewMemoryFormat	(	RBRInstrument *	instrument,
		RBRInstrumentMemoryFormat	memoryFormat
	)

Set the memory format to be used for the next deployment.

Hardware errors may occur if:

the instrument is logging
you select an unavailable memory format

Parameters

[in]	instrument	the instrument connection
[in]	memoryFormat	the new memory format

Returns: RBRINSTRUMENT_SUCCESS when the settings are successfully read; RBRINSTRUMENT_TIMEOUT when a timeout occurs; RBRINSTRUMENT_CALLBACK_ERROR returned by a callback; RBRINSTRUMENT_INVALID_PARAMETER_VALUE when an invalid format is requested; RBRINSTRUMENT_HARDWARE_ERROR when the instrument is logging or if an unavailable memory format is selected

See also: https://docs.rbr-global.com/L3commandreference/commands/memory-and-data-retrieval/memformat

◆ RBRInstrument_setPostprocessing()

RBRInstrumentError RBRInstrument_setPostprocessing	(	RBRInstrument *	instrument,
		const RBRInstrumentPostprocessing *	postprocessing
	)

Set the instrument post-processing settings.

Hardware errors may occur if:

post-processing is not available for the instrument
a post-processing job is already running
you set an out-of-bounds parameter the library fails to detect

Parameters

[in]	instrument	the instrument connection
[in]	postprocessing	the post-processing parameters

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 when the settings cannot be changed; RBRINSTRUMENT_INVALID_PARAMETER_VALUE when parameter values are out of range

See also: https://docs.rbr-global.com/L3commandreference/commands/memory-and-data-retrieval/postprocessing

◆ RBRInstrument_setPostprocessingCommand()

RBRInstrumentError RBRInstrument_setPostprocessingCommand	(	RBRInstrument *	instrument,
		RBRInstrumentPostprocessingCommand	command,
		RBRInstrumentPostprocessingStatus *	status
	)

Exercises control over the post-processing state.

Hardware errors may occur if:

post-processing is not available for the instrument
post-processing settings are invalid
the wrong memory format is in use
the requested reference channel is unavailable

Parameters

[in]	instrument	the instrument connection
[in]	command	the post-processing command
[out]	status	the post-processing status after executing the command

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 when the settings cannot be changed; RBRINSTRUMENT_INVALID_PARAMETER_VALUE when parameter values are out of range

See also: https://docs.rbr-global.com/L3commandreference/commands/memory-and-data-retrieval/postprocessing

◆ RBRInstrumentDataset_name()

const char* RBRInstrumentDataset_name ( RBRInstrumentDataset dataset )

Get a human-readable string name for a dataset.

Contrary to convention for values returned by other enum _name functions, instances of “EasyParse” found in the names returned by this function are capitalized: “EasyParse sample data” instead of “easyparse sample data”. And, because the standard and EasyParse sample data datasets share an identifier, “standard or EasyParse data” is returned for that value.

Parameters

[in] dataset the dataset

Returns: a string name for the dataset

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

◆ RBRInstrumentMemoryFormat_name()

const char* RBRInstrumentMemoryFormat_name ( RBRInstrumentMemoryFormat format )

Get a human-readable string name for a memory format.

Parameters

[in] format the memory format

Returns: a string name for the memory format

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

◆ RBRInstrumentPostprocessingAggregate_name()

const char* RBRInstrumentPostprocessingAggregate_name ( RBRInstrumentPostprocessingAggregate function )

Get a human-readable string name for an aggregate function.

For consistency with the instrument command language, returns “count”, not “sample count”, for RBRINSTRUMENT_POSTPROCESSING_AGGREGATE_SAMPLE_COUNT. The value name only includes _SAMPLE to disambiguate between the aggregate function and the value which is the count of valid values, RBRINSTRUMENT_POSTPROCESSING_AGGREGATE_COUNT.

Parameters

[in] function the aggregate function

Returns: a string name for the aggregate function

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

◆ RBRInstrumentPostprocessingBinFilter_name()

const char* RBRInstrumentPostprocessingBinFilter_name ( RBRInstrumentPostprocessingBinFilter filter )

Get a human-readable string name for a post-processing bin filter.

Parameters

[in] filter the post-processing bin filter

Returns: a string name for the post-processing bin filter

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

◆ RBRInstrumentPostprocessingCommand_name()

const char* RBRInstrumentPostprocessingCommand_name ( RBRInstrumentPostprocessingCommand command )

Get a human-readable string name for a post-processing command.

Parameters

[in] command the post-processing command

Returns: a string name for the post-processing command

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

◆ RBRInstrumentPostprocessingStatus_name()

const char* RBRInstrumentPostprocessingStatus_name ( RBRInstrumentPostprocessingStatus status )

Get a human-readable string name for a post-processing status.

Parameters

[in] status the post-processing status

Returns: a string name for the post-processing status

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

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ RBRInstrumentData

◆ RBRInstrumentDataset

◆ RBRInstrumentMemoryFormat

◆ RBRInstrumentMemoryInfo

◆ RBRInstrumentPostprocessing

◆ RBRInstrumentPostprocessingAggregate

◆ RBRInstrumentPostprocessingBinFilter

◆ RBRInstrumentPostprocessingChannelsList

◆ RBRInstrumentPostprocessingCommand

◆ RBRInstrumentPostprocessingStatus

Enumeration Type Documentation

◆ RBRInstrumentDataset

◆ RBRInstrumentMemoryFormat

◆ RBRInstrumentPostprocessingAggregate

◆ RBRInstrumentPostprocessingBinFilter

◆ RBRInstrumentPostprocessingCommand

◆ RBRInstrumentPostprocessingStatus

Function Documentation

◆ calculateCrc()

◆ RBRInstrument_getAvailableMemoryFormats()

◆ RBRInstrument_getCurrentMemoryFormat()

◆ RBRInstrument_getMemoryInfo()

◆ RBRInstrument_getNewMemoryFormat()

◆ RBRInstrument_getPostprocessing()

◆ RBRInstrument_memoryClear()

◆ RBRInstrument_readData()

◆ RBRInstrument_setNewMemoryFormat()

◆ RBRInstrument_setPostprocessing()

◆ RBRInstrument_setPostprocessingCommand()

◆ RBRInstrumentDataset_name()

◆ RBRInstrumentMemoryFormat_name()

◆ RBRInstrumentPostprocessingAggregate_name()

◆ RBRInstrumentPostprocessingBinFilter_name()

◆ RBRInstrumentPostprocessingCommand_name()

◆ RBRInstrumentPostprocessingStatus_name()