libRBR  v1.2.3
RBR instrument communication API
Data Fields
RBRInstrumentAuxOutput Struct Reference

Instrument streamserial command parameters relating to the auxiliary output signal functionality. More...

#include <RBRInstrumentStreaming.h>

Data Fields

uint8_t aux
 Which auxiliary output signal settings to retrieve or configure. More...
 
bool enabled
 Enables or disables the auxiliary output.
 
int32_t setup
 The signal set-up time. More...
 
int32_t hold
 The signal hold time. More...
 
RBRInstrumentAuxOutputActiveLevel active
 The active level of the auxiliary output signal seen by the external device during the setup time, data transmission, and hold time.
 
RBRInstrumentAuxOutputSleepLevel sleep
 The level of the auxiliary output signal seen by the external device while the instrument is asleep.
 

Detailed Description

Instrument streamserial command parameters relating to the auxiliary output signal functionality.

See also
RBRInstrument_getAuxOutput()
RBRInstrument_setAuxOutput()
https://docs.rbr-global.com/L3commandreference/commands/real-time-data/streamserial

Field Documentation

◆ aux

uint8_t RBRInstrumentAuxOutput::aux

Which auxiliary output signal settings to retrieve or configure.

Can currently only ever be set to 1 (AUX1).

◆ hold

int32_t RBRInstrumentAuxOutput::hold

The signal hold time.

This is the time for which the auxiliary output signal will be held at the active level after the streaming transmission has finished.

Specified in milliseconds. Must be in the range 10—120,000 (10 ms to 2 minutes). The default value is 1,000.

◆ setup

int32_t RBRInstrumentAuxOutput::setup

The signal set-up time.

When the logger is sampling and is about to stream data over the serial link, this is the time for which the auxiliary output signal will be held at the active level before the streaming transmission begins.

Specified in milliseconds. Must be in the range 10—120,000 (10 ms to 2 minutes). The default value is 1,000.


The documentation for this struct was generated from the following file: