leddriver15.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 LEDDRIVER15_H
#define LEDDRIVER15_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 LEDDRIVER15_REG_R0                  0x00
#define LEDDRIVER15_REG_R1                  0x01
 
 // leddriver15_reg
 
#define LEDDRIVER15_R0_EN                   0x80
#define LEDDRIVER15_R0_REF_SET_MASK         0x7C
#define LEDDRIVER15_R0_REF_SET_OFFSET       2
 
#define LEDDRIVER15_R1_DIMS_I2C             0x00
#define LEDDRIVER15_R1_DIMS_PWM             0x40
#define LEDDRIVER15_R1_DIMS_MASK            0x40
#define LEDDRIVER15_R1_SYNC_DISABLE         0x00
#define LEDDRIVER15_R1_SYNC_ENABLE          0x20
#define LEDDRIVER15_R1_SYNC_MASK            0x20
#define LEDDRIVER15_R1_OVP_13p5V            0x00
#define LEDDRIVER15_R1_OVP_24V              0x10
#define LEDDRIVER15_R1_OVP_35p5V            0x08
#define LEDDRIVER15_R1_OVP_MASK             0x18
#define LEDDRIVER15_R1_VOS                  0x04
#define LEDDRIVER15_R1_LED0                 0x02
#define LEDDRIVER15_R1_OTP                  0x01
 
#define LEDDRIVER15_I2C_DIMMING_MIN         0
#define LEDDRIVER15_I2C_DIMMING_MAX         31
 
#define LEDDRIVER15_DEVICE_ADDRESS          0x17
 
 // leddriver15_set
 
#define LEDDRIVER15_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_PWM );
 
 // leddriver15_map
 // leddriver15
 
typedef struct
{
    digital_out_t en;               
    i2c_master_t i2c;               
    uint8_t slave_address;          
} leddriver15_t;
 
typedef struct
{
    pin_name_t scl;                 
    pin_name_t sda;                 
    pin_name_t en;                  
    uint32_t   i2c_speed;           
    uint8_t    i2c_address;         
} leddriver15_cfg_t;
 
typedef enum
{
    LEDDRIVER15_OK = 0,
    LEDDRIVER15_ERROR = -1
 
} leddriver15_return_value_t;
 
void leddriver15_cfg_setup ( leddriver15_cfg_t *cfg );
 
err_t leddriver15_init ( leddriver15_t *ctx, leddriver15_cfg_t *cfg );
 
err_t leddriver15_default_cfg ( leddriver15_t *ctx );
 
err_t leddriver15_write_register ( leddriver15_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t leddriver15_read_register ( leddriver15_t *ctx, uint8_t reg, uint8_t *data_out );
 
void leddriver15_enable_device ( leddriver15_t *ctx );
 
void leddriver15_disable_device ( leddriver15_t *ctx );
 
err_t leddriver15_set_i2c_dimming ( leddriver15_t *ctx, uint8_t dimming );
 
#ifdef __cplusplus
}
#endif
#endif // LEDDRIVER15_H
 
 // leddriver15
 
// ------------------------------------------------------------------------ END