peltier 2.0.0.0
Public function

Functions

void peltier_cfg_setup (peltier_cfg_t *cfg)
 Config Object Initialization function.
 
PELTIER_RETVAL peltier_init (peltier_t *ctx, peltier_cfg_t *cfg)
 Initialization function.
 
void peltier_enable_ldo2 (peltier_t *ctx)
 Enables LDO2 function.
 
void peltier_disable_ldo2 (peltier_t *ctx)
 Disables LDO2 function.
 
void peltier_enable_ldo1 (peltier_t *ctx)
 Enables LDO1 function.
 
void peltier_disable_ldo1 (peltier_t *ctx)
 Disables LDO1 function.
 
uint8_t peltier_battery_charge (peltier_t *ctx)
 Check ongoing battery charge flag pin function.
 
uint8_t peltier_vin_good_flag (peltier_t *ctx)
 Check input voltage good flag pin function.
 

Detailed Description

Function Documentation

◆ peltier_battery_charge()

uint8_t peltier_battery_charge ( peltier_t * ctx)

Check ongoing battery charge flag pin function.

Parameters
ctxClick object.

@description This function is used to check ongoing battery charge flag pin.

◆ peltier_cfg_setup()

void peltier_cfg_setup ( peltier_cfg_t * cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

@description This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ peltier_disable_ldo1()

void peltier_disable_ldo1 ( peltier_t * ctx)

Disables LDO1 function.

Parameters
ctxClick object.

@description This function is used to disable 1.8V output.

◆ peltier_disable_ldo2()

void peltier_disable_ldo2 ( peltier_t * ctx)

Disables LDO2 function.

Parameters
ctxClick object.

@description This function is used to disable 3.3V output..

◆ peltier_enable_ldo1()

void peltier_enable_ldo1 ( peltier_t * ctx)

Enables LDO1 function.

Parameters
ctxClick object.

@description This function is used to enable 1.8V output.

◆ peltier_enable_ldo2()

void peltier_enable_ldo2 ( peltier_t * ctx)

Enables LDO2 function.

Parameters
ctxClick object.

@description This function is used to enable 3.3V output.

◆ peltier_init()

PELTIER_RETVAL peltier_init ( peltier_t * ctx,
peltier_cfg_t * cfg )

Initialization function.

Parameters
peltierClick object.
cfgClick configuration structure.

@description This function initializes all necessary pins and peripherals used for this click.

◆ peltier_vin_good_flag()

uint8_t peltier_vin_good_flag ( peltier_t * ctx)

Check input voltage good flag pin function.

Parameters
ctxClick object.

@description This function is used to check input voltage flag pin.