digipot13.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 DIGIPOT13_H
#define DIGIPOT13_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"
 
#define DIGIPOT13_CMD_VREG                           0x11
#define DIGIPOT13_CMD_NVREG                          0x21
#define DIGIPOT13_CMD_VREGxNVREG                     0x51
#define DIGIPOT13_CMD_NVREGxVREG                     0x61
 
 // digipot13_cmd
 
#define DIGIPOT13_WIPER_POS_MIN                        0
#define DIGIPOT13_WIPER_POS_MIDDLE                   127
#define DIGIPOT13_WIPER_POS_MAX                      255
#define DIGIPOT13_RES_0_KOHM                           0
#define DIGIPOT13_RES_50_KOHM                         50
#define DIGIPOT13_RES_200_KOHM                       200
 
#define DIGIPOT13_DEVICE_ADDRESS_GND                 0x28
#define DIGIPOT13_DEVICE_ADDRESS_VCC                 0x29
 
 // digipot13_set
 
#define DIGIPOT13_MAP_MIKROBUS( cfg, mikrobus )   \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
 // digipot13_map
 // digipot13
 
typedef struct
{
    // Modules
    i2c_master_t i2c;         
    // I2C slave address
    uint8_t slave_address;    
} digipot13_t;
 
typedef struct
{
    pin_name_t scl;    
    pin_name_t sda;    
    uint32_t   i2c_speed;      
    uint8_t    i2c_address;    
} digipot13_cfg_t;
 
typedef enum
{
    DIGIPOT13_OK = 0,
    DIGIPOT13_ERROR = -1
 
} digipot13_return_value_t;
 
typedef enum
{
    DIGIPOT13_CFG_RES_WL = 0,    
    DIGIPOT13_CFG_RES_WH         
} digipot13_cfg_res_t;
 
void digipot13_cfg_setup ( digipot13_cfg_t *cfg );
 
err_t digipot13_init ( digipot13_t *ctx, digipot13_cfg_t *cfg );
 
err_t digipot13_default_cfg ( digipot13_t *ctx );
 
err_t digipot13_write_data ( digipot13_t *ctx, uint8_t cmd, uint8_t data_in );
 
err_t digipot13_set_wiper_pos ( digipot13_t *ctx, uint8_t wiper_pos );
 
err_t digipot13_set_resistance ( digipot13_t *ctx, digipot13_cfg_res_t cfg_res, float res_kohm );
 
err_t digipot13_switch_v_to_nv ( digipot13_t *ctx );
 
err_t digipot13_switch_nv_to_v ( digipot13_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // DIGIPOT13_H
 
 // digipot13
 
// ------------------------------------------------------------------------ END