ledflash3.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 LEDFLASH3_H
#define LEDFLASH3_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 LEDFLASH3_REG_ENABLE                0x01
#define LEDFLASH3_REG_CONFIGURATION         0x02
#define LEDFLASH3_REG_FLASH_CURRENT         0x03
#define LEDFLASH3_REG_TOUCH_CURRENT         0x04
#define LEDFLASH3_REG_FAULT_FLAG            0x05
#define LEDFLASH3_REG_DEVICE_ID             0x06
 
 // ledflash3_reg
 
#define LEDFLASH3_LVP_ENABLE            0x10
#define LEDFLASH3_STROBE_LEVEL          0x00
#define LEDFLASH3_STROBE_EDGE           0x08
#define LEDFLASH3_STROBE_PIN_ENABLE     0x04
#define LEDFLASH3_MODE_FLASH            0x03
#define LEDFLASH3_MODE_TORCH            0x02
#define LEDFLASH3_MODE_IR               0x01
#define LEDFLASH3_MODE_STANDBY          0x00
 
#define LEDFLASH3_LVP_THRESHOLD_2V9     0x00
#define LEDFLASH3_LVP_THRESHOLD_3V      0x02
#define LEDFLASH3_LVP_THRESHOLD_3V1     0x04
#define LEDFLASH3_LVP_THRESHOLD_3V2     0x06
#define LEDFLASH3_LVP_THRESHOLD_3V3     0x08
#define LEDFLASH3_LVP_THRESHOLD_3V4     0x0A
#define LEDFLASH3_LVP_THRESHOLD_3V5     0x0C
#define LEDFLASH3_LVP_THRESHOLD_3V6     0x0E
#define LEDFLASH3_TIME_OUT_40MS         0x00
#define LEDFLASH3_TIME_OUT_80MS         0x02
#define LEDFLASH3_TIME_OUT_120MS        0x04
#define LEDFLASH3_TIME_OUT_160MS        0x06
#define LEDFLASH3_TIME_OUT_200MS        0x08
#define LEDFLASH3_TIME_OUT_240MS        0x0A
#define LEDFLASH3_TIME_OUT_280MS        0x0C
#define LEDFLASH3_TIME_OUT_320MS        0x0E
#define LEDFLASH3_TIME_OUT_360MS        0x10
#define LEDFLASH3_TIME_OUT_400MS        0x12
#define LEDFLASH3_TIME_OUT_600MS        0x14
#define LEDFLASH3_TIME_OUT_800MS        0x16
#define LEDFLASH3_TIME_OUT_1000MS       0x18
#define LEDFLASH3_TIME_OUT_1200MS       0x1A
#define LEDFLASH3_TIME_OUT_1400MS       0x1C
#define LEDFLASH3_TIME_OUT_1600MS       0x1E
#define LEDFLASH3_TORCH_RAMP_TIME_1MS   0x01
 
#define LEDFLASH3_LVP_FAULT_MASK        0x40
#define LEDFLASH3_LED_SHORT_FAULT_MASK  0x20
#define LEDFLASH3_THERMAL_SHDN_MASK     0x04
#define LEDFLASH3_THERMAL_SHDN_MASK     0x04
#define LEDFLASH3_OVLO_FAULT_MASK       0x02
#define LEDFLASH3_FLASH_TIMEOUT_MASK    0x01
 
#define LEDFLASH3_SW_RESET_MASK         0x80
 
#define LEDFLASH3_TORCH_CURRENT_MAX     376.0f
#define LEDFLASH3_TORCH_CURRENT_MIN     2.94f
#define LEDFLASH3_FLASH_CURRENT_MAX     1500.0f
#define LEDFLASH3_FLASH_CURRENT_MIN     11.72f
#define LEDFLASH3_ROUND_TO_NEAR_INT     0.5f
 
#define LEDFLASH3_DEVICE_ADDRESS        0x64
 
 // ledflash3_set
 
#define LEDFLASH3_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.stb = MIKROBUS( mikrobus, MIKROBUS_PWM )
 
 // ledflash3_map
 // ledflash3
 
typedef struct
{
    // Output pins
    digital_out_t stb;          
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
} ledflash3_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t stb;             
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} ledflash3_cfg_t;
 
typedef enum
{
    LEDFLASH3_OK = 0,
    LEDFLASH3_ERROR = -1
 
} ledflash3_return_value_t;
 
void ledflash3_cfg_setup ( ledflash3_cfg_t *cfg );
 
err_t ledflash3_init ( ledflash3_t *ctx, ledflash3_cfg_t *cfg );
 
err_t ledflash3_default_cfg ( ledflash3_t *ctx );
 
err_t ledflash3_generic_write ( ledflash3_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t ledflash3_generic_read ( ledflash3_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t ledflash3_write_reg ( ledflash3_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t ledflash3_read_reg ( ledflash3_t *ctx, uint8_t reg, uint8_t *data_out );
 
void ledflash3_strobe_pin ( ledflash3_t *ctx );
 
err_t ledflash3_set_flash_current ( ledflash3_t *ctx, float flash_current );
 
err_t ledflash3_set_torch_current ( ledflash3_t *ctx, float torch_current );
 
#ifdef __cplusplus
}
#endif
#endif // LEDFLASH3_H
 
 // ledflash3
 
// ------------------------------------------------------------------------ END