stepdown3 2.0.0.0
stepdown3.h File Reference

This file contains API for Step Down 3 Click Driver. More...

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

Go to the source code of this file.

Data Structures

struct  stepdown3_t
 Step Down 3 Click context object. More...
 
struct  stepdown3_cfg_t
 Step Down 3 Click configuration object. More...
 

Macros

#define STEPDOWN3_OUT_VOLTAGE_1V6   0x00
 Step Down 3 output voltage selection.
 
#define STEPDOWN3_OUT_VOLTAGE_1V8   0x01
 
#define STEPDOWN3_OUT_VOLTAGE_2V1   0x02
 
#define STEPDOWN3_OUT_VOLTAGE_2V5   0x03
 
#define STEPDOWN3_OUT_VOLTAGE_2V7   0x04
 
#define STEPDOWN3_OUT_VOLTAGE_2V8   0x05
 
#define STEPDOWN3_OUT_VOLTAGE_3V0   0x06
 
#define STEPDOWN3_OUT_VOLTAGE_3V3   0x07
 
#define STEPDOWN3_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  stepdown3_return_value_t { STEPDOWN3_OK = 0 , STEPDOWN3_ERROR = -1 }
 Step Down 3 Click return value data. More...
 

Functions

void stepdown3_cfg_setup (stepdown3_cfg_t *cfg)
 Step Down 3 configuration object setup function.
 
err_t stepdown3_init (stepdown3_t *ctx, stepdown3_cfg_t *cfg)
 Step Down 3 initialization function.
 
void stepdown3_enable_device (stepdown3_t *ctx)
 Step Down 3 enable device function.
 
void stepdown3_disable_device (stepdown3_t *ctx)
 Step Down 3 disable device function.
 
void stepdown3_enable_aux_output (stepdown3_t *ctx)
 Step Down 3 enable aux output function.
 
void stepdown3_disable_aux_output (stepdown3_t *ctx)
 Step Down 3 disable aux output function.
 
void stepdown3_set_output_voltage (stepdown3_t *ctx, uint8_t vout)
 Step Down 3 set output voltage function.
 

Detailed Description

This file contains API for Step Down 3 Click Driver.

Enumeration Type Documentation

◆ stepdown3_return_value_t

Step Down 3 Click return value data.

Predefined enum values for driver return values.

Enumerator
STEPDOWN3_OK 
STEPDOWN3_ERROR