RBRInstrumentStreaming.h

Go to the documentation of this file.

 
#ifndef LIBRBR_RBRINSTRUMENTSTREAMING_H
#define LIBRBR_RBRINSTRUMENTSTREAMING_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define RBRINSTRUMENT_OUTPUT_FORMAT_NAME_MAX 15
 
typedef struct RBRInstrumentChannelsList
{
    int32_t count;
    struct
    {
        char name[RBRINSTRUMENT_CHANNEL_NAME_MAX + 1];
        char unit[RBRINSTRUMENT_CHANNEL_UNIT_MAX + 1];
    } channels[RBRINSTRUMENT_CHANNEL_MAX];
} RBRInstrumentChannelsList;
 
RBRInstrumentError RBRInstrument_getChannelsList(
    RBRInstrument *instrument,
    RBRInstrumentChannelsList *channelsList);
 
typedef struct RBRInstrumentLabelsList
{
    int32_t count;
    char labels[RBRINSTRUMENT_CHANNEL_MAX][RBRINSTRUMENT_CHANNEL_LABEL_MAX + 1];
} RBRInstrumentLabelsList;
 
RBRInstrumentError RBRInstrument_getLabelsList(
    RBRInstrument *instrument,
    RBRInstrumentLabelsList *labelsList);
 
typedef enum RBRInstrumentOutputFormat
{
    RBRINSTRUMENT_OUTFORMAT_NONE      = 0,
    RBRINSTRUMENT_OUTFORMAT_CALTEXT01 = 1 << 0,
    RBRINSTRUMENT_OUTFORMAT_CALTEXT02 = 1 << 1,
    RBRINSTRUMENT_OUTFORMAT_CALTEXT03 = 1 << 2,
    RBRINSTRUMENT_OUTFORMAT_CALTEXT04 = 1 << 3,
    RBRINSTRUMENT_OUTFORMAT_CALTEXT07 = 1 << 4,
    RBRINSTRUMENT_OUTFORMAT_MAX       = RBRINSTRUMENT_OUTFORMAT_CALTEXT07
} RBRInstrumentOutputFormat;
 
const char *RBRInstrumentOutputFormat_name(RBRInstrumentOutputFormat format);
 
RBRInstrumentError RBRInstrument_getAvailableOutputFormats(
    RBRInstrument *instrument,
    RBRInstrumentOutputFormat *outputFormats);
 
RBRInstrumentError RBRInstrument_getOutputFormat(
    RBRInstrument *instrument,
    RBRInstrumentOutputFormat *outputFormat);
 
RBRInstrumentError RBRInstrument_setOutputFormat(
    RBRInstrument *instrument,
    RBRInstrumentOutputFormat outputFormat);
 
RBRInstrumentError RBRInstrument_getUSBStreamingState(
    RBRInstrument *instrument,
    bool *enabled);
 
RBRInstrumentError RBRInstrument_setUSBStreamingState(
    RBRInstrument *instrument,
    bool enabled);
 
RBRInstrumentError RBRInstrument_getSerialStreamingState(
    RBRInstrument *instrument,
    bool *enabled);
 
RBRInstrumentError RBRInstrument_setSerialStreamingState(
    RBRInstrument *instrument,
    bool enabled);
 
typedef enum RBRInstrumentAuxOutputActiveLevel
{
    /* Signal actively driven high. */
    RBRINSTRUMENT_ACTIVE_HIGH,
    /* Signal actively driven low. */
    RBRINSTRUMENT_ACTIVE_LOW,
    RBRINSTRUMENT_ACTIVE_COUNT,
    RBRINSTRUMENT_UNKNOWN_ACTIVE
} RBRInstrumentAuxOutputActiveLevel;
 
const char *RBRInstrumentAuxOutputActiveLevel_name(
    RBRInstrumentAuxOutputActiveLevel level);
 
typedef enum RBRInstrumentAuxOutputSleepLevel
{
    /* Passive, high-impedance signal. */
    RBRINSTRUMENT_SLEEP_TRISTATE,
    /* Signal actively driven high. */
    RBRINSTRUMENT_SLEEP_HIGH,
    /* Signal actively driven low. */
    RBRINSTRUMENT_SLEEP_LOW,
    RBRINSTRUMENT_SLEEP_COUNT,
    RBRINSTRUMENT_UNKNOWN_SLEEP
} RBRInstrumentAuxOutputSleepLevel;
 
const char *RBRInstrumentAuxOutputSleepLevel_name(
    RBRInstrumentAuxOutputSleepLevel level);
 
typedef struct RBRInstrumentAuxOutput
{
    uint8_t aux;
    bool enabled;
    int32_t setup;
    int32_t hold;
    RBRInstrumentAuxOutputActiveLevel active;
    RBRInstrumentAuxOutputSleepLevel sleep;
} RBRInstrumentAuxOutput;
 
RBRInstrumentError RBRInstrument_getAuxOutput(
    RBRInstrument *instrument,
    RBRInstrumentAuxOutput *auxOutput);
 
RBRInstrumentError RBRInstrument_setAuxOutput(
    RBRInstrument *instrument,
    const RBRInstrumentAuxOutput *auxOutput);
 
typedef enum RBRInstrumentReadingFlag
{
    RBRINSTRUMENT_READING_FLAG_NONE,
    RBRINSTRUMENT_READING_FLAG_UNCALIBRATED,
    RBRINSTRUMENT_READING_FLAG_ERROR,
    RBRINSTRUMENT_READING_FLAG_COUNT,
    RBRINSTRUMENT_UNKNOWN_READING_FLAG
} RBRInstrumentReadingFlag;
 
const char *RBRInstrumentReadingFlag_name(RBRInstrumentReadingFlag flag);
 
RBRInstrumentReadingFlag RBRInstrumentReading_getFlag(double reading);
 
uint8_t RBRInstrumentReading_getError(double reading);
 
double RBRInstrumentReading_setError(RBRInstrumentReadingFlag flag,
                                     uint8_t value);
 
typedef struct RBRInstrumentSample
{
    RBRInstrumentDateTime timestamp;
    int32_t channels;
    double readings[RBRINSTRUMENT_CHANNEL_MAX];
} RBRInstrumentSample;
 
RBRInstrumentError RBRInstrument_readSample(RBRInstrument *instrument);
 
#ifdef __cplusplus
}
#endif
 
#endif /* LIBRBR_RBRINSTRUMENTSTREAMING_H */