leddriver14 2.0.0.0
leddriver14.h File Reference

This file contains API for LED Driver 14 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
#include "drv_pwm.h"

Go to the source code of this file.

Data Structures

struct  leddriver14_t
 LED Driver 14 Click context object. More...
 
struct  leddriver14_cfg_t
 LED Driver 14 Click configuration object. More...
 

Macros

#define LEDDRIVER14_RSET_1   0
 LED Driver 14 rset selection values.
 
#define LEDDRIVER14_RSET_2   1
 
#define LEDDRIVER14_RSET_3   2
 
#define LEDDRIVER14_RSET_4   3
 
#define LEDDRIVER14_DIGIPOT_MAX_VALUE   50000
 LED Driver 14 rset calculation values.
 
#define LEDDRIVER14_DIGIPOT_RESOLUTION   257
 
#define LEDDRIVER14_ROUND_TO_NEAREST_INT   0.5
 
#define LEDDRIVER14_RSET_RES_MAX   24000
 
#define LEDDRIVER14_RSET_RES_DEFAULT   12000
 
#define LEDDRIVER14_RSET1_AND_RSET3_ADDRESS   0x10
 
#define LEDDRIVER14_WRITE_PROTECT_ENABLE   0
 LED Driver 14 rset write protect states.
 
#define LEDDRIVER14_WRITE_PROTECT_DISABLE   1
 
#define LEDDRIVER14_U2_ADDR_A2_GND   0x28
 LED Driver 14 device address setting.
 
#define LEDDRIVER14_U2_ADDR_A2_VCC   0x2C
 
#define LEDDRIVER14_U3_ADDR_A2_GND   0x29
 
#define LEDDRIVER14_U3_ADDR_A2_VCC   0x2D
 
#define LEDDRIVER14_DEF_FREQ   500
 LED Driver 14 default PWM frequency.
 
#define LEDDRIVER14_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  leddriver14_return_value_t { LEDDRIVER14_OK = 0 , LEDDRIVER14_ERROR = -1 }
 LED Driver 14 Click return value data. More...
 

Functions

void leddriver14_cfg_setup (leddriver14_cfg_t *cfg)
 LED Driver 14 configuration object setup function.
 
err_t leddriver14_init (leddriver14_t *ctx, leddriver14_cfg_t *cfg)
 LED Driver 14 initialization function.
 
err_t leddriver14_default_cfg (leddriver14_t *ctx)
 LED Driver 14 default configuration function.
 
err_t leddriver14_set_rset (leddriver14_t *ctx, uint8_t rset, uint16_t res_ohm)
 LED Driver 14 set rset function.
 
void leddriver14_rset_write_protect (leddriver14_t *ctx, uint8_t state)
 LED Driver 14 rset write protect function.
 
uint8_t leddriver14_get_int_pin (leddriver14_t *ctx)
 LED Driver 14 get int pin function.
 
err_t leddriver14_set_duty_cycle (leddriver14_t *ctx, float duty_cycle)
 LED Driver 14 sets PWM duty cycle.
 
err_t leddriver14_pwm_stop (leddriver14_t *ctx)
 LED Driver 14 stop PWM module.
 
err_t leddriver14_pwm_start (leddriver14_t *ctx)
 LED Driver 14 start PWM module.
 

Detailed Description

This file contains API for LED Driver 14 Click Driver.

Enumeration Type Documentation

◆ leddriver14_return_value_t

LED Driver 14 Click return value data.

Predefined enum values for driver return values.

Enumerator
LEDDRIVER14_OK 
LEDDRIVER14_ERROR