mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
101 lines
2.7 KiB
C
101 lines
2.7 KiB
C
// Copyright 2019-2020 Espressif Systems (Shanghai) PTE LTD
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
#pragma once
|
|
|
|
#include "driver/adc_common.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*---------------------------------------------------------------
|
|
Common setting
|
|
---------------------------------------------------------------*/
|
|
/*************************************/
|
|
/* Digital controller filter setting */
|
|
/*************************************/
|
|
/**
|
|
* @brief Reset adc digital controller filter.
|
|
*
|
|
* @param idx Filter index.
|
|
*
|
|
* @return
|
|
* - ESP_OK Success
|
|
*/
|
|
esp_err_t adc_digi_filter_reset(adc_digi_filter_idx_t idx);
|
|
|
|
/**
|
|
* @brief Set adc digital controller filter configuration.
|
|
*
|
|
* @param idx Filter index.
|
|
* @param config See ``adc_digi_filter_t``.
|
|
*
|
|
* @return
|
|
* - ESP_OK Success
|
|
*/
|
|
esp_err_t adc_digi_filter_set_config(adc_digi_filter_idx_t idx, adc_digi_filter_t *config);
|
|
|
|
/**
|
|
* @brief Get adc digital controller filter configuration.
|
|
*
|
|
* @param idx Filter index.
|
|
* @param config See ``adc_digi_filter_t``.
|
|
*
|
|
* @return
|
|
* - ESP_OK Success
|
|
*/
|
|
esp_err_t adc_digi_filter_get_config(adc_digi_filter_idx_t idx, adc_digi_filter_t *config);
|
|
|
|
/**
|
|
* @brief Enable/disable adc digital controller filter.
|
|
* Filtering the ADC data to obtain smooth data at higher sampling rates.
|
|
*
|
|
* @param idx Filter index.
|
|
* @param enable Enable/Disable filter.
|
|
*
|
|
* @return
|
|
* - ESP_OK Success
|
|
*/
|
|
esp_err_t adc_digi_filter_enable(adc_digi_filter_idx_t idx, bool enable);
|
|
|
|
/**************************************/
|
|
/* Digital controller monitor setting */
|
|
/**************************************/
|
|
|
|
/**
|
|
* @brief Config monitor of adc digital controller.
|
|
*
|
|
* @param idx Monitor index.
|
|
* @param config See ``adc_digi_monitor_t``.
|
|
*
|
|
* @return
|
|
* - ESP_OK Success
|
|
*/
|
|
esp_err_t adc_digi_monitor_set_config(adc_digi_monitor_idx_t idx, adc_digi_monitor_t *config);
|
|
|
|
/**
|
|
* @brief Enable/disable monitor of adc digital controller.
|
|
*
|
|
* @param idx Monitor index.
|
|
* @param enable True or false enable monitor.
|
|
*
|
|
* @return
|
|
* - ESP_OK Success
|
|
*/
|
|
esp_err_t adc_digi_monitor_enable(adc_digi_monitor_idx_t idx, bool enable);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|