RBRInstrumentPauseresume.h File Reference

Instrument commands and structures pertaining to pauseresume. This feature is available in firmware versions 1.116 or later. More...

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

Go to the source code of this file.

Typedefs
typedef enum RBRInstrumentPauseresumeState	RBRInstrumentPauseresumeState
	The state of a pauseresume condition.
typedef enum RBRInstrumentPauseStatus	RBRInstrumentPauseStatus
	Possible instrument pause status. More...
typedef enum RBRInstrumentResumeStatus	RBRInstrumentResumeStatus
	Possible instrument resume status. More...

Enumerations
enum	RBRInstrumentPauseresumeState { RBRINSTRUMENT_PAUSERESUME_NA, RBRINSTRUMENT_PAUSERESUME_PAUSED, RBRINSTRUMENT_PAUSERESUME_RUNNING, RBRINSTRUMENT_UNKNOWN_PAUSERESUME }
	The state of a pauseresume condition. More...
enum	RBRInstrumentPauseStatus { RBRINSTRUMENT_PAUSE_PAUSED, RBRINSTRUMENT_UNKNOWN_PAUSE }
	Possible instrument pause status. More...
enum	RBRInstrumentResumeStatus { RBRINSTRUMENT_RESUME_PENDING, RBRINSTRUMENT_RESUME_LOGGING, RBRINSTRUMENT_UNKNOWN_RESUME }
	Possible instrument resume status. More...

Functions
const char *	RBRInstrumentPauseresumeState_name (RBRInstrumentPauseresumeState state)
	Get a human-readable string name for a pauseresume state. More...
const char *	RBRInstrumentPauseStatus_name (RBRInstrumentPauseStatus status)
	Get a human-readable string name for a pause status. More...
const char *	RBRInstrumentResumeStatus_name (RBRInstrumentResumeStatus status)
	Get a human-readable string name for a resume status. More...
RBRInstrumentError	RBRInstrument_getPauseresume (RBRInstrument *instrument, RBRInstrumentPauseresumeState *state)
RBRInstrumentError	RBRInstrument_pause (RBRInstrument *instrument, RBRInstrumentPauseStatus *status)
RBRInstrumentError	RBRInstrument_resume (RBRInstrument *instrument, RBRInstrumentResumeStatus *status)

Detailed Description

Instrument commands and structures pertaining to pauseresume. This feature is available in firmware versions 1.116 or later.

See also

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

Copyright

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

Typedef Documentation

RBRInstrumentPauseStatus

typedef enum RBRInstrumentPauseStatus RBRInstrumentPauseStatus

Possible instrument pause status.

See also

RBRInstrumentPause

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

RBRInstrumentResumeStatus

typedef enum RBRInstrumentResumeStatus RBRInstrumentResumeStatus

Possible instrument resume status.

See also

RBRInstrumentResume

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

Enumeration Type Documentation

RBRInstrumentPauseresumeState

enum RBRInstrumentPauseresumeState

The state of a pauseresume condition.

Enumerator
RBRINSTRUMENT_PAUSERESUME_NA	The pauseresuming condition is disabled, or sampling mode is regimes.
RBRINSTRUMENT_PAUSERESUME_PAUSED	Deployment is enaled and paused.
RBRINSTRUMENT_PAUSERESUME_RUNNING	Deployment is enabled and not paused.
RBRINSTRUMENT_UNKNOWN_PAUSERESUME	feature is not allowed, or firmware in use doesn't support this feature.

RBRInstrumentPauseStatus

enum RBRInstrumentPauseStatus

Possible instrument pause status.

See also

RBRInstrumentPause

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

Enumerator
RBRINSTRUMENT_PAUSE_PAUSED	Deployment is paused and no more samples will be taken once the current acquisition finishes.
RBRINSTRUMENT_UNKNOWN_PAUSE	An unknown or unrecognized pause status.

RBRInstrumentResumeStatus

enum RBRInstrumentResumeStatus

Possible instrument resume status.

See also

RBRInstrumentResume

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

Enumerator
RBRINSTRUMENT_RESUME_PENDING	Deployment has resumed running as scheduled.
RBRINSTRUMENT_UNKNOWN_RESUME	An unknown or unrecognized resume status.

Function Documentation

RBRInstrument_getPauseresume()

RBRInstrumentError RBRInstrument_getPauseresume	(	RBRInstrument *	instrument,
		RBRInstrumentPauseresumeState *	state
	)

It allows the host to determine if the pauseresume feature is available on the instrument. It allows an elevated host to allow and deny the feature for the instrument.

Parameters

[in]	instrument	the instrument connection
[in,out]	state	the state of pauseresume

Returns

RBRINSTRUMENT_SUCCESS when the state is one of the following: "n/a", "paused", or "running".

RBRINSTRUMENT_UNSUPPORTED when the current firmware doesn't support pauseresume feature, or pauseresume is not allowed.

RBRINSTRUMENT_HARDWARE_ERROR when the response indicates an error.

RBRInstrument_pause()

RBRInstrumentError RBRInstrument_pause	(	RBRInstrument *	instrument,
		RBRInstrumentPauseStatus *	status
	)

It pauses an enabled deloyment.

Parameters

[in]	instrument	the instrument connection
[in,out]	status	the status of pause

Returns

RBRINSTRUMENT_SUCCESS when the status is "paused".

RBRINSTRUMENT_UNSUPPORTED when the current firmware doesn't support pauseresume feature, or pauseresume is not allowed.

RBRINSTRUMENT_HARDWARE_ERROR when the response indicates an error.

RBRInstrument_resume()

RBRInstrumentError RBRInstrument_resume	(	RBRInstrument *	instrument,
		RBRInstrumentResumeStatus *	status
	)

It resumes an enabled deployment which was previously paused using the pause command

Parameters

[in]	instrument	the instrument connection
[in,out]	status	the status of resume

Returns

RBRINSTRUMENT_SUCCESS when the state is one of the following: "pending", "logging".

RBRINSTRUMENT_UNSUPPORTED when the current firmware doesn't support pauseresume feature, or pauseresume is not allowed.

RBRINSTRUMENT_HARDWARE_ERROR when the response indicates an error.

RBRInstrumentPauseresumeState_name()

const char* RBRInstrumentPauseresumeState_name

(

RBRInstrumentPauseresumeState

state

)

Get a human-readable string name for a pauseresume state.

Parameters

[in]

state

the pauseresume state

Returns

a string name for the gating state

See also

RBRInstrumentError_name() for a description of the format of names

RBRInstrumentPauseStatus_name()

const char* RBRInstrumentPauseStatus_name

(

RBRInstrumentPauseStatus

status

)

Get a human-readable string name for a pause status.

Parameters

[in]

status

the pause status

Returns

a string name for the pause status

See also

RBRInstrumentError_name() for a description of the format of names

RBRInstrumentResumeStatus_name()

const char* RBRInstrumentResumeStatus_name

(

RBRInstrumentResumeStatus

status

)

Get a human-readable string name for a resume status.

Parameters

[in]

status

the resume status

Returns

a string name for the resume status

See also

RBRInstrumentError_name() for a description of the format of names