RBRInstrumentCommunication.h

Go to the documentation of this file.

 
#ifndef LIBRBR_RBRINSTRUMENTCOMMUNICATION_H
#define LIBRBR_RBRINSTRUMENTCOMMUNICATION_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum RBRInstrumentLink
{
    RBRINSTRUMENT_LINK_USB,
    RBRINSTRUMENT_LINK_SERIAL,
    RBRINSTRUMENT_LINK_WIFI,
    RBRINSTRUMENT_LINK_COUNT,
    RBRINSTRUMENT_UNKNOWN_LINK
} RBRInstrumentLink;
 
const char *RBRInstrumentLink_name(RBRInstrumentLink link);
 
RBRInstrumentError RBRInstrument_getLink(
    RBRInstrument *instrument,
    RBRInstrumentLink *link);
 
typedef enum RBRInstrumentSerialBaudRate
{
    RBRINSTRUMENT_SERIAL_BAUD_NONE   =       0,
    RBRINSTRUMENT_SERIAL_BAUD_300    = 1 <<  0,
    RBRINSTRUMENT_SERIAL_BAUD_600    = 1 <<  1,
    RBRINSTRUMENT_SERIAL_BAUD_1200   = 1 <<  2,
    RBRINSTRUMENT_SERIAL_BAUD_2400   = 1 <<  3,
    RBRINSTRUMENT_SERIAL_BAUD_4800   = 1 <<  4,
    RBRINSTRUMENT_SERIAL_BAUD_9600   = 1 <<  5,
    RBRINSTRUMENT_SERIAL_BAUD_19200  = 1 <<  6,
    RBRINSTRUMENT_SERIAL_BAUD_28800  = 1 <<  7,
    RBRINSTRUMENT_SERIAL_BAUD_38400  = 1 <<  8,
    RBRINSTRUMENT_SERIAL_BAUD_57600  = 1 <<  9,
    RBRINSTRUMENT_SERIAL_BAUD_115200 = 1 << 10,
    RBRINSTRUMENT_SERIAL_BAUD_230400 = 1 << 11,
    RBRINSTRUMENT_SERIAL_BAUD_460800 = 1 << 12,
    RBRINSTRUMENT_SERIAL_BAUD_921600 = 1 << 13,
    RBRINSTRUMENT_SERIAL_BAUD_MAX    = RBRINSTRUMENT_SERIAL_BAUD_921600
} RBRInstrumentSerialBaudRate;
 
const char *RBRInstrumentSerialBaudRate_name(RBRInstrumentSerialBaudRate baud);
 
typedef enum RBRInstrumentSerialMode
{
    RBRINSTRUMENT_SERIAL_MODE_NONE          =      0,
    RBRINSTRUMENT_SERIAL_MODE_RS232         = 1 << 0,
    RBRINSTRUMENT_SERIAL_MODE_RS485F        = 1 << 1,
    RBRINSTRUMENT_SERIAL_MODE_RS485H        = 1 << 2,
    RBRINSTRUMENT_SERIAL_MODE_UART          = 1 << 3,
    RBRINSTRUMENT_SERIAL_MODE_UART_IDLE_LOW = 1 << 4,
    RBRINSTRUMENT_SERIAL_MODE_MAX = RBRINSTRUMENT_SERIAL_MODE_UART_IDLE_LOW
} RBRInstrumentSerialMode;
 
const char *RBRInstrumentSerialMode_name(RBRInstrumentSerialMode mode);
 
typedef struct RBRInstrumentSerial
{
    RBRInstrumentSerialBaudRate baudRate;
    RBRInstrumentSerialMode mode;
    const RBRInstrumentSerialBaudRate availableBaudRates;
    const RBRInstrumentSerialMode availableModes;
} RBRInstrumentSerial;
 
RBRInstrumentError RBRInstrument_getSerial(RBRInstrument *instrument,
                                           RBRInstrumentSerial *serial);
 
RBRInstrumentError RBRInstrument_setSerial(RBRInstrument *instrument,
                                           const RBRInstrumentSerial *serial);
 
RBRInstrumentError RBRInstrument_sleep(RBRInstrument *instrument);
 
typedef enum RBRInstrumentWiFiState
{
    RBRINSTRUMENT_WIFI_NA,
    RBRINSTRUMENT_WIFI_ON,
    RBRINSTRUMENT_WIFI_OFF,
    RBRINSTRUMENT_WIFI_COUNT,
    RBRINSTRUMENT_UNKNOWN_WIFI
} RBRInstrumentWiFiState;
 
const char *RBRInstrumentWiFiState_name(RBRInstrumentWiFiState state);
 
typedef struct RBRInstrumentWiFi
{
    bool enabled;
    const RBRInstrumentWiFiState state;
    int32_t powerTimeout;
    int32_t commandTimeout;
    const RBRInstrumentSerialBaudRate baudRate;
} RBRInstrumentWiFi;
 
RBRInstrumentError RBRInstrument_getWiFi(RBRInstrument *instrument,
                                         RBRInstrumentWiFi *wifi);
 
RBRInstrumentError RBRInstrument_setWiFi(RBRInstrument *instrument,
                                         const RBRInstrumentWiFi *wifi);
 
#ifdef __cplusplus
}
#endif
 
#endif /* LIBRBR_RBRINSTRUMENTCOMMUNICATION_H */