leddriver13 2.0.0.0
Topics | Functions
LED Driver 13 Click Driver

API for configuring and manipulating LED Driver 13 Click driver. More...

Topics

 LED Driver 13 PWM Settings
 Settings for configuration of LED Driver 13 Click driver.
 
 LED Driver 13 MikroBUS Map
 MikroBUS pin mapping of LED Driver 13 Click driver.
 
 Leddriver13_cfg
 

Functions

void leddriver13_cfg_setup (leddriver13_cfg_t *cfg)
 LED Driver 13 configuration object setup function.
 
err_t leddriver13_init (leddriver13_t *ctx, leddriver13_cfg_t *cfg)
 LED Driver 13 initialization function.
 
err_t leddriver13_default_cfg (leddriver13_t *ctx)
 LED Driver 13 default configuration function.
 
err_t leddriver13_set_duty_cycle (leddriver13_t *ctx, float duty_cycle)
 LED Driver 13 sets PWM duty cycle.
 
err_t leddriver13_pwm_stop (leddriver13_t *ctx)
 LED Driver 13 stop PWM module.
 
err_t leddriver13_pwm_start (leddriver13_t *ctx)
 LED Driver 13 start PWM module.
 
err_t leddriver13_set_enable (leddriver13_t *ctx)
 LED Driver 13 set enable function.
 
err_t leddriver13_set_disable (leddriver13_t *ctx)
 LED Driver 13 set disable function.
 
uint8_t leddriver13_get_fault (leddriver13_t *ctx)
 LED Driver 13 get fault function.
 

Detailed Description

API for configuring and manipulating LED Driver 13 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

◆ leddriver13_cfg_setup()

void leddriver13_cfg_setup ( leddriver13_cfg_t * cfg)

LED Driver 13 configuration object setup function.

This function initializes click configuration structure to initial values.

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

◆ leddriver13_default_cfg()

err_t leddriver13_default_cfg ( leddriver13_t * ctx)

LED Driver 13 default configuration function.

This function executes a default configuration of LED Driver 13 click board.

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

◆ leddriver13_get_fault()

uint8_t leddriver13_get_fault ( leddriver13_t * ctx)

LED Driver 13 get fault function.

This function get fault state of the A80604 High Power LED Driver with Pre-Emptive Boost for Ultra-High Dimming Ratio and Low Output Ripple on the LED Driver 13 board™.

Parameters
[out]ctx: Click context object. See leddriver13_t object definition for detailed explanation.
Returns
  • 0 ( LEDDRIVER13_FAULT_OCCURS ) - Fault occurs,
  • 1 ( LEDDRIVER13_CONDITION_OK ) - Condition OK, No Fault.
Note
None.

◆ leddriver13_init()

err_t leddriver13_init ( leddriver13_t * ctx,
leddriver13_cfg_t * cfg )

LED Driver 13 initialization function.

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

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

◆ leddriver13_pwm_start()

err_t leddriver13_pwm_start ( leddriver13_t * ctx)

LED Driver 13 start PWM module.

This function starts the PWM module output.

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

◆ leddriver13_pwm_stop()

err_t leddriver13_pwm_stop ( leddriver13_t * ctx)

LED Driver 13 stop PWM module.

This function stops the PWM module output.

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

◆ leddriver13_set_disable()

err_t leddriver13_set_disable ( leddriver13_t * ctx)

LED Driver 13 set disable function.

This function disable the A80604 High Power LED Driver with Pre-Emptive Boost for Ultra-High Dimming Ratio and Low Output Ripple on the LED Driver 13 board™.

Parameters
[out]ctx: Click context object. See leddriver13_t object definition for detailed explanation.
Returns
  • 0 - Success,
Note
None.

◆ leddriver13_set_duty_cycle()

err_t leddriver13_set_duty_cycle ( leddriver13_t * ctx,
float duty_cycle )

LED Driver 13 sets PWM duty cycle.

This function sets the PWM duty cycle in percentages ( Range[ 0..1 ] ).

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

◆ leddriver13_set_enable()

err_t leddriver13_set_enable ( leddriver13_t * ctx)

LED Driver 13 set enable function.

This function enable the A80604 High Power LED Driver with Pre-Emptive Boost for Ultra-High Dimming Ratio and Low Output Ripple on the LED Driver 13 board™.

Parameters
[out]ctx: Click context object. See leddriver13_t object definition for detailed explanation.
Returns
  • 0 - Success,
Note
None.