driver_ntc_basic.c

Go to the documentation of this file.

 
#include "driver_ntc_basic.h"
 
static ntc_handle_t gs_handle;        

uint8_t ntc_basic_init(ntc_circuit_t circuit, float r_fixed_ohm)
{
    uint8_t res;
    
    /* link interface function */
    DRIVER_NTC_LINK_INIT(&gs_handle, ntc_handle_t);
    DRIVER_NTC_LINK_ADC_INIT(&gs_handle, ntc_interface_adc_init);
    DRIVER_NTC_LINK_ADC_DEINIT(&gs_handle, ntc_interface_adc_deinit);
    DRIVER_NTC_LINK_ADC_READ(&gs_handle, ntc_interface_adc_read);
    DRIVER_NTC_LINK_DELAY_MS(&gs_handle, ntc_interface_delay_ms);
    DRIVER_NTC_LINK_DEBUG_PRINT(&gs_handle, ntc_interface_debug_print);
    
    /* init */
    res = ntc_init(&gs_handle);
    if (res != 0)
    {
        ntc_interface_debug_print("ntc: init failed.\n");
       
        return 1;
    }
    
    /* set circuit */
    res = ntc_set_circuit(&gs_handle, circuit);
    if (res != 0)
    {
        ntc_interface_debug_print("ntc: set circuit.\n");
        (void)ntc_deinit(&gs_handle);
        
        return 1;
    }
    
    /* set circuit fixed resistor */
    res = ntc_set_circuit_fixed_resistor(&gs_handle, r_fixed_ohm);
    if (res != 0)
    {
        ntc_interface_debug_print("ntc: set circuit fixed resistor.\n");
        (void)ntc_deinit(&gs_handle);
        
        return 1;
    }
    
    return 0;
}

uint8_t ntc_basic_deinit(void)
{
    if (ntc_deinit(&gs_handle) != 0)
    {
        return 1;
    }
    
    return 0;
}

uint8_t ntc_basic_set_algorithm_beta_formula(float beta, float r25_ohm)
{
    uint8_t res;
    
    /* set algorithm beta formula */
    res = ntc_set_algorithm(&gs_handle, NTC_ALGORITHM_BETA_FORMULA);
    if (res != 0)
    {
        return 1;
    }
    
    /* set algorithm beta formula beta value */
    res = ntc_set_algorithm_beta_formula_beta_value(&gs_handle, beta);
    if (res != 0)
    {
        return 1;
    }
    
    /* set algorithm beta formula r25 ohm */
    res = ntc_set_algorithm_beta_formula_r25_ohm(&gs_handle, r25_ohm);
    if (res != 0)
    {
        return 1;
    }
    
    return 0;
}

uint8_t ntc_basic_set_algorithm_steinhart_hart(double a, double b, double c)
{
    uint8_t res;
    
    /* set algorithm steinhart hart */
    res = ntc_set_algorithm(&gs_handle, NTC_ALGORITHM_STEINHART_HART);
    if (res != 0)
    {
        return 1;
    }
    
    /* set algorithm steinhart hart */
    res = ntc_set_algorithm_steinhart_hart(&gs_handle, a, b, c);
    if (res != 0)
    {
        return 1;
    }
    
    return 0;
}

uint8_t ntc_basic_set_algorithm_lookup_table(const ntc_table_t *table, uint16_t table_len)
{
    uint8_t res;
    
    /* set algorithm steinhart hart */
    res = ntc_set_algorithm(&gs_handle, NTC_ALGORITHM_LOOKUP_TABLE);
    if (res != 0)
    {
        return 1;
    }
    
    /* set algorithm lookup table */
    res = ntc_load_algorithm_lookup_table(&gs_handle, table, table_len);
    if (res != 0)
    {
        return 1;
    }
    
    return 0;
}

uint8_t ntc_basic_set_filter_none(void)
{
    uint8_t res;
    
    /* set filter */
    res = ntc_set_filter(&gs_handle, NTC_FILTER_NONE);
    if (res != 0)
    {
        return 1;
    }
    
    return 0;
}

uint8_t ntc_basic_set_filter_first_order_lag(float alpha)
{
    uint8_t res;
    
    /* set filter */
    res = ntc_set_filter(&gs_handle, NTC_FILTER_FIRST_ORDER_LAG);
    if (res != 0)
    {
        return 1;
    }
    
    /* filter first order lag */
    res = ntc_set_filter_first_order_lag(&gs_handle, alpha);
    if (res != 0)
    {
        return 1;
    }
    
    return 0;
}

uint8_t ntc_basic_set_filter_median(uint16_t length)
{
    uint8_t res;
    
    /* set filter */
    res = ntc_set_filter(&gs_handle, NTC_FILTER_MEDIAN);
    if (res != 0)
    {
        return 1;
    }
    
    /* set median filter length */
    res = ntc_set_filter_median_length(&gs_handle, length);
    if (res != 0)
    {
        return 1;
    }
    
    return 0;
}

uint8_t ntc_basic_set_filter_anti_spike_average(uint16_t length)
{
    uint8_t res;
    
    /* set filter */
    res = ntc_set_filter(&gs_handle, NTC_FILTER_ANTI_SPIKE_AVERAGE);
    if (res != 0)
    {
        return 1;
    }
    
    /* set anti spike average length */
    res = ntc_set_filter_anti_spike_average_length(&gs_handle, length);
    if (res != 0)
    {
        return 1;
    }
    
    return 0;
}

uint8_t ntc_basic_set_filter_moving_average(uint16_t length)
{
    uint8_t res;
    
    /* set filter */
    res = ntc_set_filter(&gs_handle, NTC_FILTER_MOVING_AVERAGE);
    if (res != 0)
    {
        return 1;
    }
    
    /* set moving average length */
    res = ntc_set_filter_moving_average_length(&gs_handle, length);
    if (res != 0)
    {
        return 1;
    }
    
    return 0;
}

uint8_t ntc_basic_set_filter_weighted_moving_average(float *weight, uint16_t length)
{
    uint8_t res;
    
    /* set filter */
    res = ntc_set_filter(&gs_handle, NTC_FILTER_WEIGHTED_MOVING_AVERAGE);
    if (res != 0)
    {
        return 1;
    }
    
    /* set weighted moving average length */
    res = ntc_set_filter_weighted_moving_average_length(&gs_handle, weight, length);
    if (res != 0)
    {
        return 1;
    }
    
    return 0;
}

uint8_t ntc_basic_set_filter_limiting(float degrees_celsius)
{
    uint8_t res;
    
    /* set filter */
    res = ntc_set_filter(&gs_handle, NTC_FILTER_LIMITING);
    if (res != 0)
    {
        return 1;
    }
    
    /* set limiting */
    res = ntc_set_filter_limiting(&gs_handle, degrees_celsius);
    if (res != 0)
    {
        return 1;
    }
    
    return 0;
}

uint8_t ntc_basic_set_filter_kalman(float q_process_noise_covariance,
                                    float r_measurement_noise_covariance,
                                    float p_estimation_error_covariance,
                                    float x_estimated_value)
{
    uint8_t res;
    
    /* set filter */
    res = ntc_set_filter(&gs_handle, NTC_FILTER_KALMAN);
    if (res != 0)
    {
        return 1;
    }
    
    /* set kalman */
    res = ntc_set_filter_kalman(&gs_handle,
                                q_process_noise_covariance,
                                r_measurement_noise_covariance,
                                p_estimation_error_covariance,
                                x_estimated_value);
    if (res != 0)
    {
        return 1;
    }
    
    return 0;
}

uint8_t ntc_basic_reset_filter(void)
{
    uint8_t res;
    
    /* reset filter */
    res = ntc_reset_filter(&gs_handle);
    if (res != 0)
    {
        return 1;
    }
    
    return 0;
}

uint8_t ntc_basic_read(float *degrees_celsius)
{
    uint8_t res;
    float ohm;
    
    /* read temperature */
    res = ntc_read_temperature(&gs_handle, &ohm, degrees_celsius);
    if (res != 0)
    {
        return 1;
    }
    
    return 0;
}

uint8_t ntc_basic_calculate_temperature(float ohm, float *degrees_celsius)
{
    uint8_t res;
    
    /* calculate temperature */
    res = ntc_calculate_temperature(&gs_handle, ohm, degrees_celsius);
    if (res != 0)
    {
        return 1;
    }
    
    return 0;
}

uint8_t ntc_basic_calculate_temperature_with_filter(float *ohm, uint16_t len, float *degrees_celsius)
{
    uint8_t res;
    
    /* calculate temperature with filter */
    res = ntc_calculate_temperature_with_filter(&gs_handle, ohm, len, degrees_celsius);
    if (res != 0)
    {
        return 1;
    }
    
    return 0;
}