leddriver17
2.1.0.0
|
API for configuring and manipulating LED Driver 17 Click driver. More...
Modules | |
LED Driver 17 PWM Settings | |
Settings for configuration of LED Driver 17 Click driver. | |
LED Driver 17 MikroBUS Map | |
MikroBUS pin mapping of LED Driver 17 Click driver. | |
Functions | |
void | leddriver17_cfg_setup (leddriver17_cfg_t *cfg) |
LED Driver 17 configuration object setup function. More... | |
err_t | leddriver17_init (leddriver17_t *ctx, leddriver17_cfg_t *cfg) |
LED Driver 17 initialization function. More... | |
err_t | leddriver17_default_cfg (leddriver17_t *ctx) |
LED Driver 17 default configuration function. More... | |
err_t | leddriver17_set_duty_cycle (leddriver17_t *ctx, float duty_cycle) |
LED Driver 17 sets PWM duty cycle. More... | |
err_t | leddriver17_pwm_stop (leddriver17_t *ctx) |
LED Driver 17 stop PWM module. More... | |
err_t | leddriver17_pwm_start (leddriver17_t *ctx) |
LED Driver 17 start PWM module. More... | |
uint8_t | leddriver17_get_fault_pin (leddriver17_t *ctx) |
LED Driver 17 get fault pin function. More... | |
API for configuring and manipulating LED Driver 17 Click driver.
void leddriver17_cfg_setup | ( | leddriver17_cfg_t * | cfg | ) |
LED Driver 17 configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See leddriver17_cfg_t object definition for detailed explanation. |
err_t leddriver17_default_cfg | ( | leddriver17_t * | ctx | ) |
LED Driver 17 default configuration function.
This function executes a default configuration of LED Driver 17 click board.
[in] | ctx | : Click context object. See leddriver17_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. uint8_t leddriver17_get_fault_pin | ( | leddriver17_t * | ctx | ) |
LED Driver 17 get fault pin function.
This function returns the fault (FLT) pin logic state.
[in] | ctx | : Click context object. See leddriver17_t object definition for detailed explanation. |
err_t leddriver17_init | ( | leddriver17_t * | ctx, |
leddriver17_cfg_t * | cfg | ||
) |
LED Driver 17 initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See leddriver17_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See leddriver17_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t leddriver17_pwm_start | ( | leddriver17_t * | ctx | ) |
LED Driver 17 start PWM module.
This function starts the PWM module output.
[in] | ctx | : Click context object. See leddriver17_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t leddriver17_pwm_stop | ( | leddriver17_t * | ctx | ) |
LED Driver 17 stop PWM module.
This function stops the PWM module output.
[in] | ctx | : Click context object. See leddriver17_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t leddriver17_set_duty_cycle | ( | leddriver17_t * | ctx, |
float | duty_cycle | ||
) |
LED Driver 17 sets PWM duty cycle.
This function sets the PWM duty cycle in percentages ( Range[ 0..1 ] ).
[in] | ctx | : Click context object. See leddriver17_t object definition for detailed explanation. |
[in] | duty_cycle | : PWM duty cycle. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation.