leddriver18.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef LEDDRIVER18_H
#define LEDDRIVER18_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
 
#define LEDDRIVER18_WRITE_TO_RDAC           0x00
#define LEDDRIVER18_ONE_TIME_PROG           0x80
 
 // leddriver18_reg
 
#define LEDDRIVER18_PWM_MAX_VALUE           0x0FFF
#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
#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
 
 // leddriver18_set
 
#define LEDDRIVER18_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
    cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_PWM )
    
 // leddriver18_map
 // leddriver18
 
typedef struct
{
    // Output pins
    digital_out_t cs;       
    digital_out_t sck;      
    digital_out_t mosi;     
    digital_out_t rst;      
    digital_out_t en;       
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
} leddriver18_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t cs;              
    pin_name_t sck;             
    pin_name_t mosi;            
    pin_name_t rst;             
    pin_name_t en;              
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} leddriver18_cfg_t;
 
typedef enum
{
    LEDDRIVER18_OK = 0,
    LEDDRIVER18_ERROR = -1
 
} leddriver18_return_value_t;
 
void leddriver18_cfg_setup ( leddriver18_cfg_t *cfg );
 
err_t leddriver18_init ( leddriver18_t *ctx, leddriver18_cfg_t *cfg );
 
err_t leddriver18_default_cfg ( leddriver18_t *ctx );
 
err_t leddriver18_generic_write ( leddriver18_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t leddriver18_generic_read ( leddriver18_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t leddriver18_set_output_pwm ( uint8_t out_num, float pwm_val );
 
float leddriver18_get_output_pwm ( uint8_t out_num );
 
void leddriver18_write_config ( leddriver18_t *ctx );
 
void leddriver18_enable_output ( leddriver18_t *ctx );
 
void leddriver18_disable_output ( leddriver18_t *ctx );
 
err_t leddriver18_set_cc_output ( leddriver18_t *ctx, uint8_t current_limit );
 
err_t leddriver18_get_cc_output ( leddriver18_t *ctx, uint8_t *current_limit );
 
#ifdef __cplusplus
}
#endif
#endif // LEDDRIVER18_H
 
 // leddriver18
 
// ------------------------------------------------------------------------ END