driver_aox4000.h

Go to the documentation of this file.

 
#ifndef DRIVER_AOX4000_H
#define DRIVER_AOX4000_H
 
#include <stdio.h>
#include <stdint.h>
#include <stdlib.h>
#include <string.h>
 
#ifdef __cplusplus
extern "C"{
#endif



#ifndef AOX4000_UART_DELAY_MS
    #define AOX4000_UART_DELAY_MS        200        
#endif

#ifndef AOX4000_UART_POLL_DELAY_MS
    #define AOX4000_UART_POLL_DELAY_MS        3500        
#endif

typedef enum
{
    AOX4000_STATUS_OK              = 0x00,        
    AOX4000_STATUS_OVERRUN         = 0x01,        
    AOX4000_STATUS_INVALID_COMMAND = 0x02,        
    AOX4000_STATUS_INVALID_FRAME   = 0x03,        
    AOX4000_STATUS_INVALID_PARAM   = 0x04,        
    AOX4000_STATUS_UNKNOWN         = 0x05,        
} aox4000_status_t;

typedef enum
{
    AOX4000_MODE_AUTO    = 0x00,        
    AOX4000_MODE_REQUEST = 0x01,        
} aox4000_mode_t;

typedef struct aox4000_handle_s
{
    uint8_t (*uart_init)(void);                               
    uint8_t (*uart_deinit)(void);                             
    uint16_t (*uart_read)(uint8_t *buf, uint16_t len);        
    uint8_t (*uart_write)(uint8_t *buf, uint16_t len);        
    uint8_t (*uart_flush)(void);                              
    void (*delay_ms)(uint32_t ms);                            
    void (*debug_print)(const char *const fmt, ...);          
    uint8_t mode;                                             
    uint8_t last_error;                                       
    uint8_t inited;                                           
} aox4000_handle_t;

typedef struct aox4000_info_s
{
    char chip_name[32];                
    char manufacturer_name[32];        
    char interface[8];                 
    float supply_voltage_min_v;        
    float supply_voltage_max_v;        
    float max_current_ma;              
    float temperature_min;             
    float temperature_max;             
    uint32_t driver_version;           
} aox4000_info_t;



#define DRIVER_AOX4000_LINK_INIT(HANDLE, STRUCTURE)   memset(HANDLE, 0, sizeof(STRUCTURE))

#define DRIVER_AOX4000_LINK_UART_INIT(HANDLE, FUC)   (HANDLE)->uart_init = FUC

#define DRIVER_AOX4000_LINK_UART_DEINIT(HANDLE, FUC) (HANDLE)->uart_deinit = FUC

#define DRIVER_AOX4000_LINK_UART_READ(HANDLE, FUC)   (HANDLE)->uart_read = FUC

#define DRIVER_AOX4000_LINK_UART_WRITE(HANDLE, FUC)  (HANDLE)->uart_write = FUC

#define DRIVER_AOX4000_LINK_UART_FLUSH(HANDLE, FUC)  (HANDLE)->uart_flush = FUC

#define DRIVER_AOX4000_LINK_DELAY_MS(HANDLE, FUC)    (HANDLE)->delay_ms = FUC

#define DRIVER_AOX4000_LINK_DEBUG_PRINT(HANDLE, FUC) (HANDLE)->debug_print = FUC



uint8_t aox4000_info(aox4000_info_t *info);

uint8_t aox4000_init(aox4000_handle_t *handle);

uint8_t aox4000_deinit(aox4000_handle_t *handle);

uint8_t aox4000_read(aox4000_handle_t *handle, float *oxygen_ppo2_mbar,
                     float *oxygen_density_percentage,
                     float *temperature_degree, float *pressure_mbar);

uint8_t aox4000_read_oxygen_ppo2(aox4000_handle_t *handle, float *mbar);

uint8_t aox4000_read_oxygen_density(aox4000_handle_t *handle, float *percentage);

uint8_t aox4000_read_temperature(aox4000_handle_t *handle, float *degree);

uint8_t aox4000_read_pressure(aox4000_handle_t *handle, float *mbar);

uint8_t aox4000_set_mode(aox4000_handle_t *handle, aox4000_mode_t mode);

uint8_t aox4000_get_mode(aox4000_handle_t *handle, aox4000_mode_t *mode);

uint8_t aox4000_get_last_error(aox4000_handle_t *handle, aox4000_status_t *status);



uint8_t aox4000_command_read(aox4000_handle_t *handle, char *buf, uint16_t len);

uint8_t aox4000_command_write(aox4000_handle_t *handle, char *buf, uint16_t len);


 
#ifdef __cplusplus
}
#endif
 
#endif