RBRInstrumentConfiguration.h

Go to the documentation of this file.

 
#ifndef LIBRBR_RBRINSTRUMENTCONFIGURATION_H
#define LIBRBR_RBRINSTRUMENTCONFIGURATION_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define RBRINSTRUMENT_CALIBRATION_C_COEFFICIENT_MAX 24
 
#define RBRINSTRUMENT_CALIBRATION_X_COEFFICIENT_MAX 8
 
#define RBRINSTRUMENT_CALIBRATION_N_COEFFICIENT_MAX 8
 
#define RBRINSTRUMENT_VALUE_COEFFICIENT 0xFF
 
#define RBRINSTRUMENT_CALIBRATION_EQUATION_MAX 31
 
#define RBRINSTRUMENT_CHANNEL_GAINS_MAX 8
 
#define RBRINSTRUMENT_INPUT_TIMEOUT_MIN 10000
 
#define RBRINSTRUMENT_INPUT_TIMEOUT_MAX 240000
 
#define RBRINSTRUMENT_SENSOR_PARAMETER_KEY_MAX 63
 
#define RBRINSTRUMENT_SENSOR_PARAMETER_VALUE_MAX 63
 
typedef uint8_t RBRInstrumentChannelIndex;
 
typedef uint8_t RBRInstrumentModuleAddress;
 
typedef struct RBRInstrumentCalibration
{
    RBRInstrumentDateTime dateTime;
    float c[RBRINSTRUMENT_CALIBRATION_C_COEFFICIENT_MAX];
    float x[RBRINSTRUMENT_CALIBRATION_X_COEFFICIENT_MAX];
    RBRInstrumentChannelIndex n[RBRINSTRUMENT_CALIBRATION_N_COEFFICIENT_MAX];
} RBRInstrumentCalibration;
 
typedef enum RBRInstrumentChannelRangingMode
{
    RBRINSTRUMENT_RANGING_NONE,
    RBRINSTRUMENT_RANGING_MANUAL,
    RBRINSTRUMENT_RANGING_AUTO,
    RBRINSTRUMENT_RANGING_COUNT,
    RBRINSTRUMENT_UNKNOWN_RANGING
} RBRInstrumentChannelRangingMode;
 
const char *RBRInstrumentChannelRangingMode_name(
    RBRInstrumentChannelRangingMode mode);
 
typedef struct RBRInstrumentChannelGain
{
    RBRInstrumentChannelRangingMode rangingMode;
 
    float currentGain;
 
    float availableGains[RBRINSTRUMENT_CHANNEL_GAINS_MAX];
} RBRInstrumentChannelGain;
 
typedef struct RBRInstrumentChannel
{
    char type[RBRINSTRUMENT_CHANNEL_TYPE_MAX + 1];
 
    RBRInstrumentModuleAddress module;
 
    bool status;
 
    RBRInstrumentPeriod settlingTime;
 
    RBRInstrumentPeriod readTime;
 
    char equation[RBRINSTRUMENT_CALIBRATION_EQUATION_MAX + 1];
 
    char userUnits[RBRINSTRUMENT_CHANNEL_UNIT_MAX + 1];
 
    RBRInstrumentChannelGain gain;
 
    bool derived;
 
    char label[RBRINSTRUMENT_CHANNEL_LABEL_MAX + 1];
 
    RBRInstrumentCalibration calibration;
} RBRInstrumentChannel;
 
typedef struct RBRInstrumentChannels
{
    int32_t count;
    int32_t on;
    RBRInstrumentPeriod settlingTime;
    RBRInstrumentPeriod readTime;
    RBRInstrumentPeriod minimumPeriod;
    RBRInstrumentChannel channels[RBRINSTRUMENT_CHANNEL_MAX];
} RBRInstrumentChannels;
 
RBRInstrumentError RBRInstrument_getChannels(RBRInstrument *instrument,
                                             RBRInstrumentChannels *channels);
 
RBRInstrumentError RBRInstrument_setChannelStatus(
    RBRInstrument *instrument,
    RBRInstrumentChannelIndex channel,
    bool status);
 
RBRInstrumentError RBRInstrument_setChannelGain(
    RBRInstrument *instrument,
    RBRInstrumentChannelIndex channel,
    RBRInstrumentChannelGain *gain);
 
RBRInstrumentError RBRInstrument_setCalibration(
    RBRInstrument *instrument,
    RBRInstrumentChannelIndex channel,
    const RBRInstrumentCalibration *calibration);
 
RBRInstrumentError RBRInstrument_getFetchPowerOffDelay(
    RBRInstrument *instrument,
    RBRInstrumentPeriod *fetchPowerOffDelay);
 
RBRInstrumentError RBRInstrument_setFetchPowerOffDelay(
    RBRInstrument *instrument,
    RBRInstrumentPeriod fetchPowerOffDelay);
 
RBRInstrumentError RBRInstrument_isSensorPowerAlwaysOn(
    RBRInstrument *instrument,
    bool *sensorPowerAlwaysOn);
 
RBRInstrumentError RBRInstrument_setSensorPowerAlwaysOn(
    RBRInstrument *instrument,
    bool sensorPowerAlwaysOn);
 
RBRInstrumentError RBRInstrument_getCastDetection(RBRInstrument *instrument,
                                                  bool *castDetection);
 
RBRInstrumentError RBRInstrument_setCastDetection(RBRInstrument *instrument,
                                                  bool castDetection);
 
RBRInstrumentError RBRInstrument_getInputTimeout(
    RBRInstrument *instrument,
    RBRInstrumentPeriod *inputTimeout);
 
RBRInstrumentError RBRInstrument_setInputTimeout(
    RBRInstrument *instrument,
    RBRInstrumentPeriod inputTimeout);
 
typedef enum RBRInstrumentValueSetting
{
    RBRINSTRUMENT_SETTING_SPECCONDTEMPCO,
    RBRINSTRUMENT_SETTING_ALTITUDE,
    RBRINSTRUMENT_SETTING_TEMPERATURE,
    RBRINSTRUMENT_SETTING_PRESSURE,
    RBRINSTRUMENT_SETTING_CONDUCTIVITY,
    RBRINSTRUMENT_SETTING_ATMOSPHERE,
    RBRINSTRUMENT_SETTING_DENSITY,
    RBRINSTRUMENT_SETTING_SALINITY,
    RBRINSTRUMENT_SETTING_AVGSOUNDSPEED,
    RBRINSTRUMENT_SETTING_COUNT,
    RBRINSTRUMENT_UNKNOWN_SETTING
} RBRInstrumentValueSetting;
 
const char *RBRInstrumentValueSetting_name(RBRInstrumentValueSetting setting);
 
RBRInstrumentError RBRInstrument_getValueSetting(
    RBRInstrument *instrument,
    RBRInstrumentValueSetting setting,
    float *value);
 
RBRInstrumentError RBRInstrument_setValueSetting(
    RBRInstrument *instrument,
    RBRInstrumentValueSetting setting,
    float value);
 
typedef struct RBRInstrumentSensorParameter
{
    char key[RBRINSTRUMENT_SENSOR_PARAMETER_KEY_MAX + 1];
    char value[RBRINSTRUMENT_SENSOR_PARAMETER_VALUE_MAX + 1];
} RBRInstrumentSensorParameter;
 
RBRInstrumentError RBRInstrument_getSensorParameter(
    RBRInstrument *instrument,
    RBRInstrumentChannelIndex channel,
    RBRInstrumentSensorParameter *parameter);
 
RBRInstrumentError RBRInstrument_getSensorParameters(
    RBRInstrument *instrument,
    RBRInstrumentChannelIndex channel,
    RBRInstrumentSensorParameter *parameters,
    int32_t *size);
 
RBRInstrumentError RBRInstrument_setSensorParameter(
    RBRInstrument *instrument,
    RBRInstrumentChannelIndex channel,
    RBRInstrumentSensorParameter *parameter);
 
#ifdef __cplusplus
}
#endif
 
#endif /* LIBRBR_RBRINSTRUMENTCONFIGURATION_H */