digipot13 2.1.0.0
digipot13.h File Reference

This file contains API for DIGI POT 13 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"

Go to the source code of this file.

Data Structures

struct  digipot13_t
 DIGI POT 13 Click context object. More...
 
struct  digipot13_cfg_t
 DIGI POT 13 Click configuration object. More...
 

Macros

#define DIGIPOT13_CMD_VREG   0x11
 DIGI POT 13 description command.
 
#define DIGIPOT13_CMD_NVREG   0x21
 
#define DIGIPOT13_CMD_VREGxNVREG   0x51
 
#define DIGIPOT13_CMD_NVREGxVREG   0x61
 
#define DIGIPOT13_WIPER_POS_MIN   0
 DIGI POT 13 wiper and resistance data values.
 
#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
 DIGI POT 13 device address setting.
 
#define DIGIPOT13_DEVICE_ADDRESS_VCC   0x29
 
#define DIGIPOT13_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  digipot13_return_value_t { DIGIPOT13_OK = 0 , DIGIPOT13_ERROR = -1 }
 DIGI POT 13 Click return value data. More...
 
enum  digipot13_cfg_res_t { DIGIPOT13_CFG_RES_WL = 0 , DIGIPOT13_CFG_RES_WH }
 DIGI POT 13 Click resistance configuration value data. More...
 

Functions

void digipot13_cfg_setup (digipot13_cfg_t *cfg)
 DIGI POT 13 configuration object setup function.
 
err_t digipot13_init (digipot13_t *ctx, digipot13_cfg_t *cfg)
 DIGI POT 13 initialization function.
 
err_t digipot13_default_cfg (digipot13_t *ctx)
 DIGI POT 13 default configuration function.
 
err_t digipot13_write_data (digipot13_t *ctx, uint8_t cmd, uint8_t data_in)
 DIGI POT 13 write data function.
 
err_t digipot13_set_wiper_pos (digipot13_t *ctx, uint8_t wiper_pos)
 DIGI POT 13 set the wiper position function.
 
err_t digipot13_set_resistance (digipot13_t *ctx, digipot13_cfg_res_t cfg_res, float res_kohm)
 DIGI POT 13 set the resistance function.
 
err_t digipot13_switch_v_to_nv (digipot13_t *ctx)
 DIGI POT 13 data transfers volatile to nonvolatile function.
 
err_t digipot13_switch_nv_to_v (digipot13_t *ctx)
 DIGI POT 13 data transfers nonvolatile to volatile function.
 

Detailed Description

This file contains API for DIGI POT 13 Click Driver.

Enumeration Type Documentation

◆ digipot13_cfg_res_t

DIGI POT 13 Click resistance configuration value data.

Predefined enum values for driver resistance configuration values.

Enumerator
DIGIPOT13_CFG_RES_WL 

Wiper to L.

DIGIPOT13_CFG_RES_WH 

Wiper to H.

◆ digipot13_return_value_t

DIGI POT 13 Click return value data.

Predefined enum values for driver return values.

Enumerator
DIGIPOT13_OK 
DIGIPOT13_ERROR