driver_ntc.h

Go to the documentation of this file.

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



#ifndef NTC_FILTER_BUFFER_SIZE
    #define NTC_FILTER_BUFFER_SIZE        32        
#endif

typedef enum
{
    NTC_CIRCUIT_VCC_NTC_R_GND = 0x00,        
    NTC_CIRCUIT_VCC_R_NTC_GND = 0x01,        
} ntc_circuit_t;

typedef enum
{
    NTC_ALGORITHM_BETA_FORMULA   = 0x00,        
    NTC_ALGORITHM_STEINHART_HART = 0x01,        
    NTC_ALGORITHM_LOOKUP_TABLE   = 0x02,        
} ntc_algorithm_t;

typedef enum
{
    NTC_FILTER_NONE                    = 0x00,        
    NTC_FILTER_FIRST_ORDER_LAG         = 0x01,        
    NTC_FILTER_MEDIAN                  = 0x02,        
    NTC_FILTER_ANTI_SPIKE_AVERAGE      = 0x03,        
    NTC_FILTER_MOVING_AVERAGE          = 0x04,        
    NTC_FILTER_WEIGHTED_MOVING_AVERAGE = 0x05,        
    NTC_FILTER_LIMITING                = 0x06,        
    NTC_FILTER_KALMAN                  = 0x07,        
} ntc_filter_t;

typedef struct ntc_table_s
{
    float degrees_celsius;        
    float ohm;                    
} ntc_table_t;

typedef struct ntc_handle_s
{
    uint8_t (*adc_init)(uint32_t *vcc_counter);                  
    uint8_t (*adc_deinit)(void);                                 
    uint8_t (*adc_read)(uint32_t *counter, uint16_t len);        
    void (*delay_ms)(uint32_t ms);                               
    void (*debug_print)(const char *const fmt, ...);             
    uint8_t inited;                                              
    uint8_t circuit;                                             
    uint32_t vcc_counter;                                        
    float r_fixed_ohm;                                           
    uint8_t algorithm;                                           
    float beta;                                                  
    float r25_ohm;                                               
    double a;                                                    
    double b;                                                    
    double c;                                                    
    const ntc_table_t *table;                                    
    uint16_t table_len;                                          
    uint8_t filter;                                              
    uint32_t buf[NTC_FILTER_BUFFER_SIZE];                        
    float buf_flt[NTC_FILTER_BUFFER_SIZE];                       
    float cache_flt[NTC_FILTER_BUFFER_SIZE];                     
    float param_flt[NTC_FILTER_BUFFER_SIZE];                     
    uint16_t filter_len;                                         
    uint16_t filter_pointer;                                     
} ntc_handle_t;

typedef struct ntc_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;           
} ntc_info_t;



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

#define DRIVER_NTC_LINK_ADC_INIT(HANDLE, FUC)          (HANDLE)->adc_init = FUC

#define DRIVER_NTC_LINK_ADC_DEINIT(HANDLE, FUC)        (HANDLE)->adc_deinit = FUC

#define DRIVER_NTC_LINK_ADC_READ(HANDLE, FUC)          (HANDLE)->adc_read = FUC

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

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


 

uint8_t ntc_info(ntc_info_t *info);

uint8_t ntc_init(ntc_handle_t *handle);

uint8_t ntc_deinit(ntc_handle_t *handle);

uint8_t ntc_read_temperature(ntc_handle_t *handle, float *ohm, float *degrees_celsius);

uint8_t ntc_calculate_temperature(ntc_handle_t *handle, float ohm, float *degrees_celsius);

uint8_t ntc_calculate_temperature_with_filter(ntc_handle_t *handle, float *ohm, uint16_t len, float *degrees_celsius);

uint8_t ntc_set_algorithm(ntc_handle_t *handle, ntc_algorithm_t algorithm);

uint8_t ntc_get_algorithm(ntc_handle_t *handle, ntc_algorithm_t *algorithm);

uint8_t ntc_set_algorithm_beta_formula_beta_value(ntc_handle_t *handle, float beta);

uint8_t ntc_get_algorithm_beta_formula_beta_value(ntc_handle_t *handle, float *beta);

uint8_t ntc_set_algorithm_beta_formula_r25_ohm(ntc_handle_t *handle, float r25_ohm);

uint8_t ntc_get_algorithm_beta_formula_r25_ohm(ntc_handle_t *handle, float *r25_ohm);

uint8_t ntc_set_algorithm_steinhart_hart(ntc_handle_t *handle, double a, double b, double c);

uint8_t ntc_get_algorithm_steinhart_hart(ntc_handle_t *handle, double *a, double *b, double *c);

uint8_t ntc_load_algorithm_lookup_table(ntc_handle_t *handle, const ntc_table_t *table, uint16_t table_len);

uint8_t ntc_set_circuit(ntc_handle_t *handle, ntc_circuit_t circuit);

uint8_t ntc_get_circuit(ntc_handle_t *handle, ntc_circuit_t *circuit);

uint8_t ntc_set_circuit_fixed_resistor(ntc_handle_t *handle, float r_fixed_ohm);

uint8_t ntc_get_circuit_fixed_resistor(ntc_handle_t *handle, float *r_fixed_ohm);



uint8_t ntc_set_filter(ntc_handle_t *handle, ntc_filter_t filter);

uint8_t ntc_get_filter(ntc_handle_t *handle, ntc_filter_t *filter);

uint8_t ntc_reset_filter(ntc_handle_t *handle);

uint8_t ntc_set_filter_first_order_lag(ntc_handle_t *handle, float alpha);

uint8_t ntc_set_filter_median_length(ntc_handle_t *handle, uint16_t length);

uint8_t ntc_set_filter_anti_spike_average_length(ntc_handle_t *handle, uint16_t length);

uint8_t ntc_set_filter_moving_average_length(ntc_handle_t *handle, uint16_t length);

uint8_t ntc_set_filter_weighted_moving_average_length(ntc_handle_t *handle, float *weight, uint16_t length);

uint8_t ntc_set_filter_limiting(ntc_handle_t *handle, float degrees_celsius);

uint8_t ntc_set_filter_kalman(ntc_handle_t *handle,
                              float q_process_noise_covariance,
                              float r_measurement_noise_covariance,
                              float p_estimation_error_covariance,
                              float x_estimated_value);


 
#ifdef __cplusplus
}
#endif
 
#endif