efuse  2.0.0.0
Modules | Functions
eFuse Click Driver

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

Modules

 eFuse MikroBUS Map
 MikroBUS pin mapping of eFuse Click driver.
 

Functions

void efuse_cfg_setup (efuse_cfg_t *cfg)
 eFuse configuration object setup function. More...
 
err_t efuse_init (efuse_t *ctx, efuse_cfg_t *cfg)
 eFuse initialization function. More...
 
err_t efuse_default_cfg (efuse_t *ctx)
 eFuse default configuration function. More...
 
void efuse_enable_device (efuse_t *ctx)
 eFuse enable the device function. More...
 
void efuse_disable_device (efuse_t *ctx)
 eFuse disable the device function. More...
 
void efuse_enable_pwm (efuse_t *ctx)
 eFuse enable PWM function. More...
 
void efuse_disable_pwm (efuse_t *ctx)
 eFuse disable the device function. More...
 

Detailed Description

API for configuring and manipulating eFuse Click driver.

Function Documentation

◆ efuse_cfg_setup()

void efuse_cfg_setup ( efuse_cfg_t cfg)

eFuse configuration object setup function.

This function initializes click configuration structure to initial values.

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

◆ efuse_default_cfg()

err_t efuse_default_cfg ( efuse_t ctx)

eFuse default configuration function.

This function executes a default configuration of eFuse click board.

Parameters
[in]ctx: Click context object. See efuse_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.

◆ efuse_disable_device()

void efuse_disable_device ( efuse_t ctx)

eFuse disable the device function.

This function performs disable the device by clears the EN pin on the low level of eFuse click board.

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

◆ efuse_disable_pwm()

void efuse_disable_pwm ( efuse_t ctx)

eFuse disable the device function.

This function performs disable the device by sets the PWM pin on the high level of eFuse click board.

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

◆ efuse_enable_device()

void efuse_enable_device ( efuse_t ctx)

eFuse enable the device function.

This function performs enable the device by sets the EN pin on the high level of eFuse click board.

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

◆ efuse_enable_pwm()

void efuse_enable_pwm ( efuse_t ctx)

eFuse enable PWM function.

This function performs enable PWM by clears the PWM pin on the low level of eFuse click board.

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

◆ efuse_init()

err_t efuse_init ( efuse_t ctx,
efuse_cfg_t cfg 
)

eFuse initialization function.

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

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