leddriver14.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 LEDDRIVER14_H
#define LEDDRIVER14_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"
#include "drv_pwm.h"
 
#define LEDDRIVER14_RSET_1                  0
#define LEDDRIVER14_RSET_2                  1
#define LEDDRIVER14_RSET_3                  2
#define LEDDRIVER14_RSET_4                  3
 
#define LEDDRIVER14_DIGIPOT_MAX_VALUE       50000
#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
#define LEDDRIVER14_WRITE_PROTECT_DISABLE   1
 
#define LEDDRIVER14_U2_ADDR_A2_GND          0x28
#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
 
 // leddriver14_set
 
#define LEDDRIVER14_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.wp = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // leddriver14_map
 // leddriver14
 
typedef struct
{
    // Output pins
    digital_out_t  wp;              
    // Input pins
    digital_in_t  int_pin;          
    // Modules
    i2c_master_t i2c;               
    pwm_t pwm;                      
    // I2C slave address
    uint8_t slave_address_u2;       
    uint8_t slave_address_u3;       
    uint32_t pwm_freq;              
} leddriver14_t;
 
typedef struct
{
    pin_name_t  scl;                
    pin_name_t  sda;                
    pin_name_t  wp;                 
    pin_name_t  pwm;                
    pin_name_t  int_pin;            
    uint32_t  i2c_speed;            
    uint8_t   i2c_address_u2;       
    uint8_t   i2c_address_u3;       
    uint32_t  dev_pwm_freq;         
} leddriver14_cfg_t;
 
typedef enum
{
    LEDDRIVER14_OK = 0,
    LEDDRIVER14_ERROR = -1
 
} leddriver14_return_value_t;
 
void leddriver14_cfg_setup ( leddriver14_cfg_t *cfg );
 
err_t leddriver14_init ( leddriver14_t *ctx, leddriver14_cfg_t *cfg );
 
err_t leddriver14_default_cfg ( leddriver14_t *ctx );
 
err_t leddriver14_set_rset ( leddriver14_t *ctx, uint8_t rset, uint16_t res_ohm );
 
void leddriver14_rset_write_protect ( leddriver14_t *ctx, uint8_t state );
 
uint8_t leddriver14_get_int_pin ( leddriver14_t *ctx );
 
err_t leddriver14_set_duty_cycle ( leddriver14_t *ctx, float duty_cycle );
 
err_t leddriver14_pwm_stop ( leddriver14_t *ctx );
 
err_t leddriver14_pwm_start ( leddriver14_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // LEDDRIVER14_H
 
 // leddriver14
 
// ------------------------------------------------------------------------ END