efuse3 2.0.0.0
Topics | Functions
e Fuse 3 Click Driver

API for configuring and manipulating e Fuse 3 Click driver. More...

Topics

 e Fuse 3 Registers Settings
 Settings for registers of e Fuse 3 Click driver.
 
 e Fuse 3 MikroBUS Map
 MikroBUS pin mapping of e Fuse 3 Click driver.
 
 Vc_sel
 
 Efuse3_get
 

Functions

void efuse3_cfg_setup (efuse3_cfg_t *cfg)
 e Fuse 3 configuration object setup function.
 
err_t efuse3_init (efuse3_t *ctx, efuse3_cfg_t *cfg)
 e Fuse 3 initialization function.
 
void efuse3_default_cfg (efuse3_t *ctx)
 e Fuse 3 default configuration function.
 
err_t efuse3_generic_read (efuse3_t *ctx, uint8_t *data_out, uint8_t len)
 e Fuse 3 data reading function.
 
err_t efuse3_get_monitor_output (efuse3_t *ctx, float *voltage, uint8_t *overflow)
 e Fuse 3 get monitor output function.
 
err_t efuse3_get_current (efuse3_t *ctx, float *current)
 e Fuse 3 get current function.
 
void efuse3_enable_device (efuse3_t *ctx)
 e Fuse 3 enable device function.
 
void efuse3_reset (efuse3_t *ctx)
 e Fuse 3 reset function.
 
void efuse3_disable_device (efuse3_t *ctx)
 e Fuse 3 disable device function.
 
void efuse3_set_overvoltage_clamp (efuse3_t *ctx, uint8_t vc_sel)
 e Fuse 3 set overvoltage clamp function.
 
uint8_t efuse3_get_flag (efuse3_t *ctx)
 e Fuse 3 get flag function.
 

Detailed Description

API for configuring and manipulating e Fuse 3 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

◆ efuse3_cfg_setup()

void efuse3_cfg_setup ( efuse3_cfg_t * cfg)

e Fuse 3 configuration object setup function.

This function initializes click configuration structure to initial values.

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

◆ efuse3_default_cfg()

void efuse3_default_cfg ( efuse3_t * ctx)

e Fuse 3 default configuration function.

This function executes a default configuration of e Fuse 3 click board.

Parameters
[in]ctx: Click context object. See efuse3_t object definition for detailed explanation.
Returns
Nothing.
Note
This function can consist any necessary configuration or setting to put device into operating mode.

◆ efuse3_disable_device()

void efuse3_disable_device ( efuse3_t * ctx)

e Fuse 3 disable device function.

This function idsble the the NIS6150 +5 Volt Electronic eFuse on the e Fuse 3 click board.

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

◆ efuse3_enable_device()

void efuse3_enable_device ( efuse3_t * ctx)

e Fuse 3 enable device function.

This function enable the the NIS6150 +5 Volt Electronic eFuse on the e Fuse 3 click board.

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

◆ efuse3_generic_read()

err_t efuse3_generic_read ( efuse3_t * ctx,
uint8_t * data_out,
uint8_t len )

e Fuse 3 data reading function.

This function reads a desired number of data bytes starting from the selected register by using SPI serial interface.

Parameters
[in]ctx: Click context object. See efuse3_t object definition for detailed explanation.
[out]data_out: Output read data.
[in]len: Number of bytes to be read.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.
Note
None.

◆ efuse3_get_current()

err_t efuse3_get_current ( efuse3_t * ctx,
float * current )

e Fuse 3 get current function.

This function reads current of the NIS6150 +5 Volt Electronic eFuse on the e Fuse 3 click board.

Parameters
[in]ctx: Click context object. See efuse3_t object definition for detailed explanation.
[out]current: Current [ V ].
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.
Note
None.

◆ efuse3_get_flag()

uint8_t efuse3_get_flag ( efuse3_t * ctx)

e Fuse 3 get flag function.

This function get flag state of the NIS6150 +5 Volt Electronic eFuse on the e Fuse 3 click board.

Parameters
[in]ctx: Click context object. See efuse3_t object definition for detailed explanation.
Returns
  • 0 ( EFUSE3_FLAG_NORMAL_OPERATION )- Normal operation,
  • 1 ( EFUSE3_FLAG_DEVICE_OFF ) - device off when one of the following conditions occurs:
    1. EN pin set to Logic Level Low (Output Disabled),
    2. Thermal fault,
    3. UVLO − Undervoltage Lockout,
    4. Reverse current fault.
See #err_t definition for detailed explanation.
Note
None.

◆ efuse3_get_monitor_output()

err_t efuse3_get_monitor_output ( efuse3_t * ctx,
float * voltage,
uint8_t * overflow )

e Fuse 3 get monitor output function.

This function reads and monitoring an output voltage of the NIS6150 +5 Volt Electronic eFuse on the e Fuse 3 click board.

Parameters
[in]ctx: Click context object. See efuse3_t object definition for detailed explanation.
[out]voltage: Output volatge [ V ].
[out]overflow: Overflow status.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.
Note
None.

◆ efuse3_init()

err_t efuse3_init ( efuse3_t * ctx,
efuse3_cfg_t * cfg )

e Fuse 3 initialization function.

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

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

◆ efuse3_reset()

void efuse3_reset ( efuse3_t * ctx)

e Fuse 3 reset function.

This function reset the the NIS6150 +5 Volt Electronic eFuse on the e Fuse 3 click board.

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

◆ efuse3_set_overvoltage_clamp()

void efuse3_set_overvoltage_clamp ( efuse3_t * ctx,
uint8_t vc_sel )

e Fuse 3 set overvoltage clamp function.

This function set overvoltage clamp to be set at either a 5.7 V or 6.5 V minimum of the NIS6150 +5 Volt Electronic eFuse on the e Fuse 3 click board.

Parameters
[in]ctx: Click context object. See efuse3_t object definition for detailed explanation.
[in]vc_sel:
  • 0 ( EFUSE3_VC_SEL_6_1_V ) - Allows the overvoltage clamp to be set 6.1 V,
  • 1 ( EFUSE3_VC_SEL_6_9_V ) - Allows the overvoltage clamp to be set 6.9 V.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.
Note
None.