analogmux2.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 ANALOGMUX2_H
#define ANALOGMUX2_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_i2c_master.h"
#include "drv_analog_in.h"
 
#define ANALOGMUX2_SET_CHANNEL_0      0x00
#define ANALOGMUX2_SET_CHANNEL_1      0x01
#define ANALOGMUX2_SET_CHANNEL_2      0x02
#define ANALOGMUX2_SET_CHANNEL_3      0x03
#define ANALOGMUX2_SET_CHANNEL_4      0x04
#define ANALOGMUX2_SET_CHANNEL_5      0x05
#define ANALOGMUX2_SET_CHANNEL_6      0x06
#define ANALOGMUX2_SET_CHANNEL_7      0x07
#define ANALOGMUX2_SET_NO_CHANNEL     0xFF
 
#define ANALOGMUX2_VAL_CHANNEL_OFF    0x00
#define ANALOGMUX2_VAL_CHANNEL_0      0x01
#define ANALOGMUX2_VAL_CHANNEL_1      0x02
#define ANALOGMUX2_VAL_CHANNEL_2      0x04
#define ANALOGMUX2_VAL_CHANNEL_3      0x08
#define ANALOGMUX2_VAL_CHANNEL_4      0x10
#define ANALOGMUX2_VAL_CHANNEL_5      0x20
#define ANALOGMUX2_VAL_CHANNEL_6      0x40
#define ANALOGMUX2_VAL_CHANNEL_7      0x80
 
#define ANALOGMUX2_SET_DEV_ADDR_0      0x4C
#define ANALOGMUX2_SET_DEV_ADDR_1      0x4D
#define ANALOGMUX2_SET_DEV_ADDR_2      0x4E
#define ANALOGMUX2_SET_DEV_ADDR_3      0x4F
 
 // analogmux2_set
 
#define ANALOGMUX2_SUCCESS            0
#define ANALOGMUX2_ERROR             -1
 
 
 // status
 
 
#define ANALOGMUX2_MAP_MIKROBUS( cfg, mikrobus )  \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN );   \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST )
 
 // analogmux2_map
 // analogmux2
 
typedef struct
{
    // Output pins
 
    digital_out_t  rst;     
    // Modules
 
    analog_in_t  adc;
 
    i2c_master_t i2c;       
    // I2C slave address
 
    uint8_t slave_address;  
} analogmux2_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    pin_name_t  an;         
    pin_name_t  rst;        
    uint32_t  i2c_speed;    
    uint8_t   i2c_address;  
    analog_in_resolution_t  resolution;     
    float                   vref;           
} analogmux2_cfg_t;
 
void analogmux2_cfg_setup ( analogmux2_cfg_t *cfg );
 
err_t analogmux2_init ( analogmux2_t *ctx, analogmux2_cfg_t *cfg );
 
void analogmux2_default_cfg ( analogmux2_t *ctx );
 
void analogmux2_hw_reset ( analogmux2_t *ctx );
 
err_t analogmux2_generic_write ( analogmux2_t *ctx, uint8_t tx_data );
 
uint8_t analogmux2_generic_read ( analogmux2_t *ctx );
 
err_t analogmux2_set_channel ( analogmux2_t *ctx, uint8_t mux_ch );
 
uint8_t analogmux2_get_channel ( analogmux2_t *ctx );
 
err_t analogmux2_read_an_pin_value ( analogmux2_t *ctx, uint16_t *data_out );
 
err_t analogmux2_read_an_pin_voltage ( analogmux2_t *ctx, float *data_out );
 
#ifdef __cplusplus
}
#endif
#endif // ANALOGMUX2_H
 
 // analogmux2
 
// ------------------------------------------------------------------------ END