leddriver18 2.1.0.0
leddriver18.h File Reference

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

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

Go to the source code of this file.

Data Structures

struct  leddriver18_t
 LED Driver 18 Click context object. More...
 
struct  leddriver18_cfg_t
 LED Driver 18 Click configuration object. More...
 

Macros

#define LEDDRIVER18_WRITE_TO_RDAC   0x00
 LED Driver 18 description register.
 
#define LEDDRIVER18_ONE_TIME_PROG   0x80
 
#define LEDDRIVER18_PWM_MAX_VALUE   0x0FFF
 LED Driver 18 description setting.
 
#define LEDDRIVER18_MAX_OUTPUT_NUM   24
 
#define LEDDRIVER18_MAX_RES_BITS   12
 
#define LEDDRIVER18_CC_MASK   0x3F
 
#define LEDDRIVER18_CC_ERROR   0x80
 
#define LEDDRIVER18_CURRENT_30_mA   0x00
 LED Driver 18 constant current values.
 
#define LEDDRIVER18_CURRENT_20_mA   0x01
 
#define LEDDRIVER18_CURRENT_15_mA   0x02
 
#define LEDDRIVER18_CURRENT_10_mA   0x04
 
#define LEDDRIVER18_CURRENT_5_mA   0x0B
 
#define LEDDRIVER18_CURRENT_2_mA   0x1E
 
#define LEDDRIVER18_DEVICE_ADDRESS   0x2C
 LED Driver 18 device address setting.
 
#define LEDDRIVER18_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  leddriver18_return_value_t { LEDDRIVER18_OK = 0 , LEDDRIVER18_ERROR = -1 }
 LED Driver 18 Click return value data. More...
 

Functions

void leddriver18_cfg_setup (leddriver18_cfg_t *cfg)
 LED Driver 18 configuration object setup function.
 
err_t leddriver18_init (leddriver18_t *ctx, leddriver18_cfg_t *cfg)
 LED Driver 18 initialization function.
 
err_t leddriver18_default_cfg (leddriver18_t *ctx)
 LED Driver 18 default configuration function.
 
err_t leddriver18_generic_write (leddriver18_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
 LED Driver 18 I2C writing function.
 
err_t leddriver18_generic_read (leddriver18_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
 LED Driver 18 I2C reading function.
 
err_t leddriver18_set_output_pwm (uint8_t out_num, float pwm_val)
 LED Driver 18 set output channel PWM value function.
 
float leddriver18_get_output_pwm (uint8_t out_num)
 LED Driver 18 get output channel PWM value function.
 
void leddriver18_write_config (leddriver18_t *ctx)
 LED Driver 18 write config function.
 
void leddriver18_enable_output (leddriver18_t *ctx)
 LED Driver 18 enable output function.
 
void leddriver18_disable_output (leddriver18_t *ctx)
 LED Driver 18 disable output function.
 
err_t leddriver18_set_cc_output (leddriver18_t *ctx, uint8_t current_limit)
 LED Driver 18 set constant current output function.
 
err_t leddriver18_get_cc_output (leddriver18_t *ctx, uint8_t *current_limit)
 LED Driver 18 get constant current output function.
 

Detailed Description

This file contains API for LED Driver 18 Click Driver.

Enumeration Type Documentation

◆ leddriver18_return_value_t

LED Driver 18 Click return value data.

Predefined enum values for driver return values.

Enumerator
LEDDRIVER18_OK 
LEDDRIVER18_ERROR