driver_ba234.h

Go to the documentation of this file.

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



#ifndef BA234_READ_TIMEOUT
    #define BA234_READ_TIMEOUT        2000        
#endif

typedef enum
{
    BA234_STATUS_OK                = 0x00,        
    BA234_STATUS_FRAME_ERROR       = 0x01,        
    BA234_STATUS_BUSY              = 0x02,        
    BA234_STATUS_CALIBRATION_ERROR = 0x03,        
} ba234_status_t;

typedef struct ba234_data_s
{
    uint16_t tds_raw;                            
    uint32_t electrical_conductivity_raw;        
    uint16_t salinity_raw;                       
    uint16_t specific_gravity_raw;               
    uint16_t temperature_raw;                    
    uint16_t water_hardness_raw;                 
    float tds_ppm;                               
    float electrical_conductivity_us_cm;         
    float salinity_percentage;                   
    float specific_gravity;                      
    float temperature_degrees_celsius;           
    float water_hardness_ppm;                    
} ba234_data_t;

typedef struct ba234_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_flush)(void);                              
    uint8_t (*uart_write)(uint8_t *buf, uint16_t len);        
    void (*delay_ms)(uint32_t ms);                            
    void (*debug_print)(const char *const fmt, ...);          
    uint8_t inited;                                           
    uint8_t last_status;                                      
} ba234_handle_t;

typedef struct ba234_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;           
} ba234_info_t;



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

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

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

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

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

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

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

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



uint8_t ba234_info(ba234_info_t *info);

uint8_t ba234_init(ba234_handle_t *handle);

uint8_t ba234_deinit(ba234_handle_t *handle);

uint8_t ba234_read(ba234_handle_t *handle, ba234_data_t *data);

uint8_t ba234_baseline_calibration(ba234_handle_t *handle);

uint8_t ba234_salinity_calibration(ba234_handle_t *handle, uint16_t value);

uint8_t ba234_get_last_status(ba234_handle_t *handle, ba234_status_t *status);

uint8_t ba234_salinity_convert_to_register(ba234_handle_t *handle, float percentage, uint16_t *reg);

uint8_t ba234_salinity_convert_to_data(ba234_handle_t *handle, uint16_t reg, float *percentage);



uint8_t ba234_set_buffer(ba234_handle_t *handle, uint8_t *buf, uint16_t len);

uint8_t ba234_get_buffer(ba234_handle_t *handle, uint8_t *buf, uint16_t len);


 
#ifdef __cplusplus
}
#endif
 
#endif