RBRInstrumentSecurity.h File Reference

Instrument commands and structures pertaining to command security and interaction. More...

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

Go to the source code of this file.

Functions
RBRInstrumentError	RBRInstrument_permit (RBRInstrument *instrument, const char *command)
	Permits a protected command to be executed. More...
RBRInstrumentError	RBRInstrument_getPrompt (RBRInstrument *instrument, bool *prompt)
	Get the state of the “Ready:” prompt. More...
RBRInstrumentError	RBRInstrument_setPrompt (RBRInstrument *instrument, bool prompt)
	Set the state of the “Ready:” prompt. More...
RBRInstrumentError	RBRInstrument_getConfirmation (RBRInstrument *instrument, bool *confirmation)
	Get the state of the logger's confirmation responses. More...
RBRInstrumentError	RBRInstrument_setConfirmation (RBRInstrument *instrument, bool confirmation)
	Set the state of the logger's confirmation responses. More...
RBRInstrumentError	RBRInstrument_reboot (RBRInstrument *instrument, int32_t delay)
	Reset the logger CPU. More...

Detailed Description

Instrument commands and structures pertaining to command security and interaction.

See also

https://docs.rbr-global.com/L3commandreference/commands/security-and-interaction

Copyright

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

Function Documentation

RBRInstrument_getConfirmation()

RBRInstrumentError RBRInstrument_getConfirmation	(	RBRInstrument *	instrument,
		bool *	confirmation
	)

Get the state of the logger's confirmation responses.

The confirmation responses are normally sent after a parameter has been modified if the state is on.

Parameters

[in]	instrument	the instrument connection
[out]	confirmation	whether confirmation 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

https://docs.rbr-global.com/L3commandreference/commands/security-and-interaction/confirmation

RBRInstrument_getPrompt()

RBRInstrumentError RBRInstrument_getPrompt	(	RBRInstrument *	instrument,
		bool *	prompt
	)

Get the state of the “Ready:” prompt.

The prompt is normally sent by the logger in response to almost any command after any other output generated by the command is complete.

Parameters

[in]	instrument	the instrument connection
[out]	prompt	whether the prompt 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

https://docs.rbr-global.com/L3commandreference/commands/security-and-interaction/prompt

RBRInstrument_permit()

RBRInstrumentError RBRInstrument_permit	(	RBRInstrument *	instrument,
		const char *	command
	)

Permits a protected command to be executed.

Permits a protected command to be executed immediately after this one; receipt of anything else removes the permission again. Any other constraints on executing a particular command will still apply. It is not an error to permit a command which does not need it, merely unnecessary.

Parameters

[in]	instrument	the instrument connection
[in]	command	the command to permit

Returns

RBRINSTRUMENT_SUCCESS when the command has been permitted

RBRINSTRUMENT_TIMEOUT when a timeout occurs

RBRINSTRUMENT_CALLBACK_ERROR returned by a callback

RBRINSTRUMENT_HARDWARE_ERROR if the command can't be permitted

See also

https://docs.rbr-global.com/L3commandreference/commands/security-and-interaction/permit

RBRInstrument_reboot()

RBRInstrumentError RBRInstrument_reboot	(	RBRInstrument *	instrument,
		int32_t	delay
	)

Reset the logger CPU.

Parameters

[in]	instrument	the instrument connection
[in]	delay	time in milliseconds to wait before rebooting

Returns

RBRINSTRUMENT_SUCCESS when the CPU has been rebooted

RBRINSTRUMENT_TIMEOUT when a timeout occurs

RBRINSTRUMENT_CALLBACK_ERROR returned by a callback

See also

https://docs.rbr-global.com/L3commandreference/commands/security-and-interaction/reboot

RBRInstrument_setConfirmation()

RBRInstrumentError RBRInstrument_setConfirmation	(	RBRInstrument *	instrument,
		bool	confirmation
	)

Set the state of the logger's confirmation responses.

This function permits confirmation to be set on or off. However, the rest of the library expects confirmations to be on, and most setters will poll the instrument until timeout with it off.

Parameters

[in]	instrument	the instrument connection
[in]	confirmation	whether confirmation should be enabled

Returns

RBRINSTRUMENT_SUCCESS when the setting is successfully written

RBRINSTRUMENT_TIMEOUT when a timeout occurs

RBRINSTRUMENT_CALLBACK_ERROR returned by a callback

See also

https://docs.rbr-global.com/L3commandreference/commands/security-and-interaction/confirmation

RBRInstrument_setPrompt()

RBRInstrumentError RBRInstrument_setPrompt	(	RBRInstrument *	instrument,
		bool	prompt
	)

Set the state of the “Ready:” prompt.

Parameters

[in]	instrument	the instrument connection
[in]	prompt	whether the prompt should be enabled

Returns

RBRINSTRUMENT_SUCCESS when the setting is successfully written

RBRINSTRUMENT_TIMEOUT when a timeout occurs

RBRINSTRUMENT_CALLBACK_ERROR returned by a callback

See also

https://docs.rbr-global.com/L3commandreference/commands/security-and-interaction/prompt