stepdown10.h File Reference

This file contains API for Step Down 10 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	stepdown10_t
	Step Down 10 Click context object. More...
struct	stepdown10_cfg_t
	Step Down 10 Click configuration object. More...

Macros
#define	STEPDOWN10_PFM_PWM_MODE   0x00
	Step Down 10 description register.
#define	STEPDOWN10_FORCED_PWM_MODE   0x01
#define	STEPDOWN10_R1_RPROG_ADDRESS   0x00
#define	STEPDOWN10_R1_VALUE   100000ul
	Step Down 10 description setting.
#define	STEPDOWN10_DIGIPOT_MAX_VALUE   100000ul
#define	STEPDOWN10_DIGIPOT_RESOLUTION   257
#define	STEPDOWN10_ROUND_TO_NEAREST_INT   0.5
#define	STEPDOWN10_R13_VALUE   1000u
#define	STEPDOWN10_MAX_OUTPUT   20
#define	STEPDOWN10_MIN_OUTPUT   2
#define	STEPDOWN10_PIN_STATE_HIGH   0x01
	Step Down 10 pin state setting.
#define	STEPDOWN10_PIN_STATE_LOW   0x00
#define	STEPDOWN10_ADDR_A2A1A0_000   0x28
	Step Down 10 device address setting.
#define	STEPDOWN10_ADDR_A2A1A0_001   0x29
#define	STEPDOWN10_ADDR_A2A1A0_010   0x2A
#define	STEPDOWN10_ADDR_A2A1A0_011   0x2B
#define	STEPDOWN10_ADDR_A2A1A0_100   0x2C
#define	STEPDOWN10_ADDR_A2A1A0_101   0x2D
#define	STEPDOWN10_ADDR_A2A1A0_110   0x2E
#define	STEPDOWN10_ADDR_A2A1A0_111   0x2F
#define	STEPDOWN10_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	stepdown10_return_value_t { STEPDOWN10_OK = 0 , STEPDOWN10_ERROR = -1 }
	Step Down 10 Click return value data. More...

Functions
void	stepdown10_cfg_setup (stepdown10_cfg_t *cfg)
	Step Down 10 configuration object setup function.
err_t	stepdown10_init (stepdown10_t *ctx, stepdown10_cfg_t *cfg)
	Step Down 10 initialization function.
err_t	stepdown10_default_cfg (stepdown10_t *ctx)
	Step Down 10 default configuration function.
err_t	stepdown10_generic_write (stepdown10_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
	Step Down 10 I2C writing function.
err_t	stepdown10_generic_read (stepdown10_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
	Step Down 10 I2C reading function.
void	stepdown10_set_en_pin (stepdown10_t *ctx, uint8_t pin_state)
	Step Down 10 set EN pin state function.
void	stepdown10_set_md (stepdown10_t *ctx, uint8_t mode)
	Step Down 10 mode selection function.
uint8_t	stepdown10_get_pg_state (stepdown10_t *ctx)
	Step Down 10 get PG pin state function.
err_t	stepdown10_set_wiper_pos (stepdown10_t *ctx, uint16_t wiper_pos)
	Step Down 10 set wiper position.
err_t	stepdown10_set_r2_resistance (stepdown10_t *ctx, uint32_t resistance)
	Step Down 10 set potentiometer resistance.
err_t	stepdown10_set_output (stepdown10_t *ctx, float voltage)
	Step Down 10 set output voltage.

Detailed Description

This file contains API for Step Down 10 Click Driver.

Enumeration Type Documentation

stepdown10_return_value_t

enum stepdown10_return_value_t

Step Down 10 Click return value data.

Predefined enum values for driver return values.

Enumerator
STEPDOWN10_OK
STEPDOWN10_ERROR