leddriver11.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 LEDDRIVER11_H
#define LEDDRIVER11_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_analog_in.h"
#include "drv_pwm.h"
 
#define LEDDRIVER11_MAX_CURRENT             0x0000
#define LEDDRIVER11_MIN_CURRENT             0x0FFF
 
#define LEDDRIVER11_DEF_FREQ                5000
#define LEDDRIVER11_SET_DEV_ADDR            0x60
 
 // leddriver11_set
 
#define LEDDRIVER11_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM );
 
 // leddriver11_map
 // leddriver11
 
typedef struct
{
    // Modules
    analog_in_t  adc;           
    i2c_master_t i2c;           
    pwm_t pwm;                  
    // ctx variable
    uint32_t pwm_freq;          
    // I2C slave address
    uint8_t slave_address;      
} leddriver11_t;
 
typedef struct
{
    pin_name_t  scl;                        
    pin_name_t  sda;                        
    pin_name_t  an;                         
    pin_name_t pwm;                         
    analog_in_resolution_t  resolution;     
    float    vref;                          
    uint32_t i2c_speed;                     
    uint8_t  i2c_address;                   
    uint32_t dev_pwm_freq;                  
} leddriver11_cfg_t;
 
typedef enum
{
    LEDDRIVER11_OK = 0,
    LEDDRIVER11_ERROR = -1
 
} leddriver11_return_value_t;
 
void leddriver11_cfg_setup ( leddriver11_cfg_t *cfg );
 
err_t leddriver11_init ( leddriver11_t *ctx, leddriver11_cfg_t *cfg );
 
err_t leddriver11_default_cfg ( leddriver11_t *ctx );
 
err_t leddriver11_set_current ( leddriver11_t *ctx, uint16_t curr );
 
err_t leddriver11_read_dac_memory( leddriver11_t *ctx, uint8_t *data_out );
 
err_t leddriver11_read_an_pin_value ( leddriver11_t *ctx, uint16_t *data_out );
 
err_t leddriver11_read_an_pin_voltage ( leddriver11_t *ctx, float *data_out );
 
err_t leddriver11_set_duty_cycle ( leddriver11_t *ctx, float duty_cycle );
 
err_t leddriver11_pwm_stop ( leddriver11_t *ctx );
 
err_t leddriver11_pwm_start ( leddriver11_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // LEDDRIVER11_H
 
 // leddriver11
 
// ------------------------------------------------------------------------ END