efuse7 2.1.0.0
eFuse 7 Click Driver

API for configuring and manipulating eFuse 7 Click driver. More...

Topics

 eFuse 7 Registers Settings
 Settings for registers of eFuse 7 Click driver.
 
 eFuse 7 MikroBUS Map
 MikroBUS pin mapping of eFuse 7 Click driver.
 

Functions

void efuse7_cfg_setup (efuse7_cfg_t *cfg)
 eFuse 7 configuration object setup function.
 
err_t efuse7_init (efuse7_t *ctx, efuse7_cfg_t *cfg)
 eFuse 7 initialization function.
 
err_t efuse7_default_cfg (efuse7_t *ctx)
 eFuse 7 default configuration function.
 
void efuse7_enable_output (efuse7_t *ctx)
 eFuse 7 output enable function.
 
void efuse7_disable_output (efuse7_t *ctx)
 eFuse 7 output disable function.
 
void efuse7_wiper_inc (efuse7_t *ctx, uint8_t inc_num)
 eFuse 7 wiper position increase function.
 
void efuse7_wiper_dec (efuse7_t *ctx, uint8_t dec_num)
 eFuse 7 wiper position decrease function.
 
err_t efuse7_set_resistance (efuse7_t *ctx, uint16_t resistance)
 eFuse 7 set digital potentiometer resistance function.
 
err_t efuse7_set_limit (efuse7_t *ctx, uint8_t set_current)
 eFuse 7 set current limit function.
 

Detailed Description

API for configuring and manipulating eFuse 7 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

◆ efuse7_cfg_setup()

void efuse7_cfg_setup ( efuse7_cfg_t * cfg)

eFuse 7 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters
[out]cfg: Click configuration structure. See efuse7_cfg_t object definition for detailed explanation.
Returns
Nothing.
Note
The all used pins will be set to unconnected state.

◆ efuse7_default_cfg()

err_t efuse7_default_cfg ( efuse7_t * ctx)

eFuse 7 default configuration function.

This function executes a default configuration of eFuse 7 click board.

Parameters
[in]ctx: Click context object. See efuse7_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
This function can consist any necessary configuration or setting to put device into operating mode.

◆ efuse7_disable_output()

void efuse7_disable_output ( efuse7_t * ctx)

eFuse 7 output disable function.

This function disables output of eFuse 7 click board.

Parameters
[in]ctx: Click context object. See efuse7_t object definition for detailed explanation.
Returns
Nothing.
Note
None.

◆ efuse7_enable_output()

void efuse7_enable_output ( efuse7_t * ctx)

eFuse 7 output enable function.

This function enables output of eFuse 7 click board.

Parameters
[in]ctx: Click context object. See efuse7_t object definition for detailed explanation.
Returns
Nothing.
Note
None.

◆ efuse7_init()

err_t efuse7_init ( efuse7_t * ctx,
efuse7_cfg_t * cfg )

eFuse 7 initialization function.

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

Parameters
[out]ctx: Click context object. See efuse7_t object definition for detailed explanation.
[in]cfg: Click configuration structure. See efuse7_cfg_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ efuse7_set_limit()

err_t efuse7_set_limit ( efuse7_t * ctx,
uint8_t set_current )

eFuse 7 set current limit function.

This function sets current limit of eFuse 7 click board.

Parameters
[in]ctx: Click context object. See efuse7_t object definition for detailed explanation.
[in]set_current: Specific eFuse current limit.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ efuse7_set_resistance()

err_t efuse7_set_resistance ( efuse7_t * ctx,
uint16_t resistance )

eFuse 7 set digital potentiometer resistance function.

This function sets digital potentiometer resistance of eFuse 7 click board.

Parameters
[in]ctx: Click context object. See efuse7_t object definition for detailed explanation.
[in]resistance: Digital potentiometer resistance in ohms.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ efuse7_wiper_dec()

void efuse7_wiper_dec ( efuse7_t * ctx,
uint8_t dec_num )

eFuse 7 wiper position decrease function.

This function decreases wiper position of eFuse 7 click board.

Parameters
[in]ctx: Click context object. See efuse7_t object definition for detailed explanation.
[in]dec_num: Wiper position decreases.
Returns
Nothing.
Note
None.

◆ efuse7_wiper_inc()

void efuse7_wiper_inc ( efuse7_t * ctx,
uint8_t inc_num )

eFuse 7 wiper position increase function.

This function increases wiper position of eFuse 7 click board.

Parameters
[in]ctx: Click context object. See efuse7_t object definition for detailed explanation.
[in]inc_num: Wiper position increases.
Returns
Nothing.
Note
None.