95 lines
2.3 KiB
C
95 lines
2.3 KiB
C
/*
|
|
* SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <stdlib.h>
|
|
#include "esp_log.h"
|
|
#include "esp_adc/adc_cali.h"
|
|
#include "esp_adc/adc_oneshot.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @brief Supported circuit mode
|
|
*
|
|
*/
|
|
typedef enum {
|
|
CIRCUIT_MODE_NTC_VCC = 1, // Vcc --------> Rt --------> Rref --------> GND
|
|
CIRCUIT_MODE_NTC_GND = 2, // Vcc --------> Rref --------> Rt --------> GND
|
|
} ntc_circuit_mode_t;
|
|
|
|
/**
|
|
* @brief NTC config data type
|
|
*/
|
|
typedef struct {
|
|
ntc_circuit_mode_t circuit_mode; /*!< ntc circuit mode */
|
|
adc_unit_t unit; /*!< adc unit */
|
|
adc_atten_t atten; /*!< adc atten */
|
|
adc_channel_t channel; /*!< adc channel */
|
|
uint32_t b_value; /*!< beta value of NTC (K) */
|
|
uint32_t r25_ohm; /*!< 25℃ resistor value of NTC (K) */
|
|
uint32_t fixed_ohm; /*!< fixed resistor value (Ω) */
|
|
uint32_t vdd_mv; /*!< vdd voltage (mv) */
|
|
} ntc_config_t;
|
|
|
|
typedef void *ntc_device_handle_t;
|
|
|
|
/**
|
|
* @brief Initialize the NTC and ADC channel config
|
|
*
|
|
* @param config
|
|
* @param ntc_handle A ntc driver handle
|
|
* @param adc_handle A adc handle
|
|
*
|
|
* @return
|
|
* - ESP_OK Success
|
|
* - ESP_FAIL Failure
|
|
*/
|
|
esp_err_t ntc_dev_create(ntc_config_t *config, ntc_device_handle_t *ntc_handle, adc_oneshot_unit_handle_t *adc_handle);
|
|
|
|
/**
|
|
* @brief Get the adc handle
|
|
*
|
|
* @param ntc_handle A ntc driver handle
|
|
* @param adc_handle A adc handle
|
|
*
|
|
* @return
|
|
* - ESP_OK Success
|
|
* - ESP_FAIL Failure
|
|
*/
|
|
esp_err_t ntc_dev_get_adc_handle(ntc_device_handle_t ntc_handle, adc_oneshot_unit_handle_t *adc_handle);
|
|
|
|
/**
|
|
* @brief Delete ntc driver device and ntc detect device
|
|
*
|
|
* @param ntc_handle A ntc driver handle
|
|
*
|
|
* @return
|
|
* - ESP_OK Success
|
|
* - ESP_FAIL Failure
|
|
*/
|
|
esp_err_t ntc_dev_delete(ntc_device_handle_t ntc_handle);
|
|
|
|
/**
|
|
* @brief Get the ntc temperature
|
|
*
|
|
* @param ntc_handle A ntc driver handle
|
|
* @param temperature NTC temperature
|
|
*
|
|
* @return
|
|
* - ESP_OK Success
|
|
* - ESP_FAIL Failure
|
|
*
|
|
*/
|
|
esp_err_t ntc_dev_get_temperature(ntc_device_handle_t ntc_handle, float *temperature);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|