RBRInstrumentDeployment.h File Reference

Instrument commands and structures pertaining to deployments. More...

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

Go to the source code of this file.

Data Structures
struct	RBRInstrumentSimulation
	Instrument simulation command parameters. More...

Typedefs
typedef struct RBRInstrumentSimulation	RBRInstrumentSimulation
	Instrument simulation command parameters. More...

Functions
RBRInstrumentError	RBRInstrument_verify (RBRInstrument *instrument, bool eraseMemory, RBRInstrumentDeploymentStatus *status)
	Perform a “dry run” of the enable command. More...
RBRInstrumentError	RBRInstrument_enable (RBRInstrument *instrument, bool eraseMemory, RBRInstrumentDeploymentStatus *status)
	Enable the instrument to sample according to the programmed schedule. More...
RBRInstrumentError	RBRInstrument_disable (RBRInstrument *instrument, RBRInstrumentDeploymentStatus *status)
	If the instrument is logging, terminate the current deployment. More...
RBRInstrumentError	RBRInstrument_getSimulation (RBRInstrument *instrument, RBRInstrumentSimulation *simulation)
	Get the instrument simulation settings. More...
RBRInstrumentError	RBRInstrument_setSimulation (RBRInstrument *instrument, const RBRInstrumentSimulation *simulation)
	Set the instrument simulation settings. More...

Detailed Description

Instrument commands and structures pertaining to deployments.

See also

https://docs.rbr-global.com/L3commandreference/commands/deployments

Copyright

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

Typedef Documentation

RBRInstrumentSimulation

typedef struct RBRInstrumentSimulation RBRInstrumentSimulation

Instrument simulation command parameters.

See also

RBRInstrument_getSimulation()

RBRInstrument_setSimulation()

https://docs.rbr-global.com/L3commandreference/commands/deployments/simulation

Function Documentation

RBRInstrument_disable()

RBRInstrumentError RBRInstrument_disable	(	RBRInstrument *	instrument,
		RBRInstrumentDeploymentStatus *	status
	)

If the instrument is logging, terminate the current deployment.

Parameters

[in]	instrument	the instrument connection
[out]	status	the instrument's status after having disabled logging

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/deployments/disable

RBRInstrument_enable()

RBRInstrumentError RBRInstrument_enable	(	RBRInstrument *	instrument,
		bool	eraseMemory,
		RBRInstrumentDeploymentStatus *	status
	)

Enable the instrument to sample according to the programmed schedule.

If eraseMemory is not true, RBRInstrument_memoryClear() must be used to erase the memory beforehand as necessary.

A hardware error can be generated for a variety of reasons. See the enable command documentation for a comprehensive list. In the event of a hardware error, status will be set to RBRINSTRUMENT_UNKNOWN_STATUS.

Parameters

[in]	instrument	the instrument connection
[in]	eraseMemory	whether to erase memory before enabling logging
[out]	status	the instrument's status after having enabled logging

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 an error occurs enabling logging

See also

https://docs.rbr-global.com/L3commandreference/commands/deployments/enable

RBRInstrument_getSimulation()

RBRInstrumentError RBRInstrument_getSimulation	(	RBRInstrument *	instrument,
		RBRInstrumentSimulation *	simulation
	)

Get the instrument simulation settings.

Parameters

[in]	instrument	the instrument connection
[out]	simulation	the simulation 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/deployments/simulation

RBRInstrument_setSimulation()

RBRInstrumentError RBRInstrument_setSimulation	(	RBRInstrument *	instrument,
		const RBRInstrumentSimulation *	simulation
	)

Set the instrument simulation settings.

Hardware errors may occur if:

• simulations are not available for the instrument (either due to its firmware version or channel configuration)
• the instrument is logging
• you set an out-of-bounds parameter the library fails to detect

Parameters

[in]	instrument	the instrument connection
[out]	simulation	the simulation 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 an out-of-bounds simulation period is requested

See also

https://docs.rbr-global.com/L3commandreference/commands/deployments/simulation

RBRInstrument_verify()

RBRInstrumentError RBRInstrument_verify	(	RBRInstrument *	instrument,
		bool	eraseMemory,
		RBRInstrumentDeploymentStatus *	status
	)

Perform a “dry run” of the enable command.

A hardware error can be generated for a variety of reasons. See the verify command documentation for a comprehensive list. In the event of a hardware error, status will be set to RBRINSTRUMENT_UNKNOWN_STATUS. While Logger2 hardware reports a status in addition to any error, Logger3 hardware does not, and the value will always be the same as the current instrument status.

The eraseMemory parameter is ignored by Logger2 instruments.

Parameters

[in]	instrument	the instrument connection
[in]	eraseMemory	whether to erase memory before enabling logging
[out]	status	the status which would be produced by enabling logging

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 an error would occur when enabling logging

See also

RBRInstrument_enable()

https://docs.rbr-global.com/L3commandreference/commands/deployments/verify