drv_analog_in.h

Go to the documentation of this file.

/****************************************************************************
**
** Copyright (C) 2024 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** This file is part of the mikroSDK package
**
** Commercial License Usage
**
** Licensees holding valid commercial NECTO compilers AI licenses may use this
** file in accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The MikroElektronika Company.
** For licensing terms and conditions see
** https://www.mikroe.com/legal/software-license-agreement.
** For further information use the contact form at
** https://www.mikroe.com/contact.
**
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used for
** non-commercial projects under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** OF MERCHANTABILITY, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
** TO THE WARRANTIES FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
** OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
**
****************************************************************************/
#ifndef _DRV_ANALOG_IN_H_
#define _DRV_ANALOG_IN_H_
 
#ifdef __cplusplus
extern "C"{
#endif
 
#include "drv_name.h"
#include "hal_adc.h"
 
typedef enum
{
    ADC_SUCCESS = 0,              
    ADC_ERROR = (-1)              
} analog_in_err_t;
 
typedef enum
{
    ANALOG_IN_VREF_EXTERNAL = 0,  
    ANALOG_IN_VREF_INTERNAL       
} analog_in_vref_t;
 
typedef enum
{
    ANALOG_IN_RESOLUTION_NOT_SET = 0,  
    ANALOG_IN_RESOLUTION_6_BIT,        
    ANALOG_IN_RESOLUTION_8_BIT,        
    ANALOG_IN_RESOLUTION_10_BIT,       
    ANALOG_IN_RESOLUTION_12_BIT,       
    ANALOG_IN_RESOLUTION_14_BIT,       
    ANALOG_IN_RESOLUTION_16_BIT,       
    ANALOG_IN_RESOLUTION_DEFAULT = ANALOG_IN_RESOLUTION_CMAKE
} analog_in_resolution_t;
 
typedef struct
{
    pin_name_t input_pin;               
    analog_in_resolution_t resolution;  
    analog_in_vref_t vref_input;        
    float vref_value;                   
} analog_in_config_t;
 
typedef struct
{
    handle_t handle;            
    analog_in_config_t config;  
} analog_in_t;
 
void analog_in_configure_default( analog_in_config_t *config );
 
err_t analog_in_open( analog_in_t *obj, analog_in_config_t *config );
 
err_t analog_in_set_resolution( analog_in_t *obj, analog_in_resolution_t resolution );
 
err_t analog_in_set_vref_input( analog_in_t *obj, analog_in_vref_t vref );
 
err_t analog_in_set_vref_value( analog_in_t *obj, float vref_value );
 
err_t analog_in_read( analog_in_t *obj, uint16_t *readDatabuf );
 
err_t analog_in_read_voltage( analog_in_t *obj, float *readDatabuf );
 
err_t analog_in_close( analog_in_t *obj );
 
 // drvadcgroup
 // drvgroup
 // pergroup
 
#ifdef __cplusplus
}
#endif
 
#endif // _DRV_ANALOG_IN_H_
// ------------------------------------------------------------------------- END