stepup2  2.1.0.0
Data Structures | Macros | Enumerations | Functions
stepup2.h File Reference

This file contains API for Step Up 2 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  stepup2_t
 Step Up 2 Click context object. More...
 
struct  stepup2_cfg_t
 Step Up 2 Click configuration object. More...
 

Macros

#define STEPUP2_CTRL_BYTE_VREG   0x11
 Step Up 2 description control byte. More...
 
#define STEPUP2_CTRL_BYTE_NVREG   0x21
 
#define STEPUP2_CTRL_BYTE_VREG_NVREG   0x51
 
#define STEPUP2_CTRL_BYTE_NVREG_VREG   0x61
 
#define STEPUP2_WIPER_POS_MIN   0
 Step Up 2 wiper and resistance data values. More...
 
#define STEPUP2_WIPER_POS_MIDDLE   127
 
#define STEPUP2_WIPER_POS_MAX   255
 
#define STEPUP2_RES_0_KOHM   0.0f
 
#define STEPUP2_RES_3_01_KOHM   3.01f
 
#define STEPUP2_RES_50_KOHM   50.0f
 
#define STEPUP2_RES_200_KOHM   200.0f
 
#define STEPUP2_RESISTANCE_LIST
 Step Up 2 resistance and output voltage lists. More...
 
#define STEPUP2_VOUT_LIST
 
#define STEPUP2_DEVICE_ADDRESS_0   0x28
 Step Up 2 device address setting. More...
 
#define STEPUP2_DEVICE_ADDRESS_1   0x29
 
#define STEPUP2_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  stepup2_vout_t {
  STEPUP2_VOUT_5V5 = 0, STEPUP2_VOUT_5V2, STEPUP2_VOUT_5V, STEPUP2_VOUT_4V8,
  STEPUP2_VOUT_4V5, STEPUP2_VOUT_4V3, STEPUP2_VOUT_4V, STEPUP2_VOUT_3V8,
  STEPUP2_VOUT_3V6, STEPUP2_VOUT_3V5, STEPUP2_VOUT_3V3, STEPUP2_VOUT_3V2,
  STEPUP2_VOUT_3V, STEPUP2_VOUT_2V8, STEPUP2_VOUT_2V5
}
 Step Up 2 Click output voltage selection. More...
 
enum  stepup2_return_value_t { STEPUP2_OK = 0, STEPUP2_ERROR = -1 }
 Step Up 2 Click return value data. More...
 

Functions

void stepup2_cfg_setup (stepup2_cfg_t *cfg)
 Step Up 2 configuration object setup function. More...
 
err_t stepup2_init (stepup2_t *ctx, stepup2_cfg_t *cfg)
 Step Up 2 initialization function. More...
 
err_t stepup2_default_cfg (stepup2_t *ctx)
 Step Up 2 default configuration function. More...
 
void stepup2_enable (stepup2_t *ctx)
 Step Up 2 enable the device function. More...
 
void stepup2_disable (stepup2_t *ctx)
 Step Up 2 disable the device function. More...
 
err_t stepup2_write_data (stepup2_t *ctx, uint8_t ctrl_byte, uint8_t data_in)
 Step Up 2 data writing function. More...
 
err_t stepup2_read_data (stepup2_t *ctx, uint8_t *data_out)
 Step Up 2 data reading function. More...
 
err_t stepup2_set_wiper_pos (stepup2_t *ctx, uint8_t wiper_pos)
 Step Up 2 sets the wiper position function. More...
 
err_t stepup2_set_resistance (stepup2_t *ctx, float res_kohm)
 Step Up 2 sets the resistance function. More...
 
err_t stepup2_set_vout (stepup2_t *ctx, stepup2_vout_t vout)
 Step Up 2 sets the VOUT function. More...
 

Detailed Description

This file contains API for Step Up 2 Click Driver.

Enumeration Type Documentation

◆ stepup2_return_value_t

Step Up 2 Click return value data.

Predefined enum values for driver return values.

Enumerator
STEPUP2_OK 
STEPUP2_ERROR 

◆ stepup2_vout_t

Step Up 2 Click output voltage selection.

Output voltage selection of Step Up 2 Click driver.

Enumerator
STEPUP2_VOUT_5V5 
STEPUP2_VOUT_5V2 
STEPUP2_VOUT_5V 
STEPUP2_VOUT_4V8 
STEPUP2_VOUT_4V5 
STEPUP2_VOUT_4V3 
STEPUP2_VOUT_4V 
STEPUP2_VOUT_3V8 
STEPUP2_VOUT_3V6 
STEPUP2_VOUT_3V5 
STEPUP2_VOUT_3V3 
STEPUP2_VOUT_3V2 
STEPUP2_VOUT_3V 
STEPUP2_VOUT_2V8 
STEPUP2_VOUT_2V5