analogmux5.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** 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,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, 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 ANALOGMUX5_H
#define ANALOGMUX5_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_analog_in.h"
 
#define ANALOGMUX5_SEL_CH_1 0x01
#define ANALOGMUX5_SEL_CH_2 0x02
#define ANALOGMUX5_SEL_CH_3 0x03
#define ANALOGMUX5_SEL_CH_4 0x04
 
 // ch_select
 
#define ANALOGMUX5_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.a0 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.a1 = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // analogmux5_map
 // analogmux5
 
typedef struct
{
    digital_out_t  en;     
    digital_out_t  a0;     
    digital_out_t  a1;     
    analog_in_t  adc;      
} analogmux5_t;
 
typedef struct
{
    pin_name_t  an;     
    pin_name_t  en;     
    pin_name_t  a0;     
    pin_name_t  a1;     
    analog_in_resolution_t  resolution;     
    float                   vref;           
} analogmux5_cfg_t;
 
typedef enum
{
    ANALOGMUX5_OK = 0,
    ANALOGMUX5_ERROR = -1
 
} analogmux5_return_value_t;
 
void analogmux5_cfg_setup ( analogmux5_cfg_t *cfg );
 
err_t analogmux5_init ( analogmux5_t *ctx, analogmux5_cfg_t *cfg );
 
err_t analogmux5_default_cfg ( analogmux5_t *ctx );
 
err_t analogmux5_read_an_pin_value ( analogmux5_t *ctx, uint16_t *data_out );
 
err_t analogmux5_read_an_pin_voltage ( analogmux5_t *ctx, float *data_out );
 
void analogmux5_enable ( analogmux5_t *ctx );
 
void analogmux5_disable ( analogmux5_t *ctx );
 
err_t analogmux5_select_ch ( analogmux5_t *ctx, uint8_t ch_select );
 
#ifdef __cplusplus
}
#endif
#endif // ANALOGMUX5_H
 
 // analogmux5
 
// ------------------------------------------------------------------------ END