ledflash2.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 LEDFLASH2_H
#define LEDFLASH2_H
 
#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"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define LEDFLASH2_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.fi = MIKROBUS( mikrobus, MIKROBUS_AN ); \
  cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST ); \
  cfg.fen = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
  cfg.ten = MIKROBUS( mikrobus, MIKROBUS_INT ); 
#define LEDFLASH2_RETVAL  uint8_t
 
#define LEDFLASH2_OK                    0x00
#define LEDFLASH2_INIT_ERROR            0xFF
#define LEDFLASH2_MODE_OFF              0x00
#define LEDFLASH2_MODE_FLASH            0x01
#define LEDFLASH2_MODE_TORCH            0x02
#define LEDFLASH2_CUR_100               0x00
#define LEDFLASH2_CUR_90                0x01
#define LEDFLASH2_CUR_80                0x02
#define LEDFLASH2_CUR_70                0x03
#define LEDFLASH2_CUR_63                0x04
#define LEDFLASH2_CUR_56                0x05
#define LEDFLASH2_CUR_50                0x06
#define LEDFLASH2_CUR_44                0x07
#define LEDFLASH2_CUR_39                0x08
#define LEDFLASH2_CUR_35                0x09
#define LEDFLASH2_CUR_31                0x0A
#define LEDFLASH2_CUR_28                0x0B
#define LEDFLASH2_CUR_25                0x0C
#define LEDFLASH2_CUR_22                0x0D
#define LEDFLASH2_CUR_20                0x0E
#define LEDFLASH2_CUR_18                0x0F
#define LEDFLASH2_FTMR_1250             0xE0
#define LEDFLASH2_FTMR_1093             0xC0
#define LEDFLASH2_FTMR_937              0xA0
#define LEDFLASH2_FTMR_781              0x80
#define LEDFLASH2_FTMR_625              0x60
#define LEDFLASH2_FTMR_468              0x40
#define LEDFLASH2_FTMR_312              0x20
#define LEDFLASH2_FTMR_156              0x00
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t fi;
    digital_out_t en;
    digital_out_t fen;
    digital_out_t ten;
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} ledflash2_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
 
    pin_name_t fi;
    pin_name_t en;
    pin_name_t fen;
    pin_name_t ten;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} ledflash2_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void ledflash2_cfg_setup ( ledflash2_cfg_t *cfg );
 
LEDFLASH2_RETVAL ledflash2_init ( ledflash2_t *ctx, ledflash2_cfg_t *cfg );
 
void ledflash2_generic_write ( ledflash2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void ledflash2_generic_read ( ledflash2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
uint8_t ledflash2_read_register ( ledflash2_t *ctx, uint8_t reg_address );
 
void ledflash2_write_register ( ledflash2_t *ctx, uint8_t reg_address, uint8_t reg_data );
 
void ledflash2_set_mode ( ledflash2_t *ctx, uint8_t mode, uint8_t intensity, uint8_t flash_duration );
 
void ledflash2_toggle_flash_inhibit ( ledflash2_t *ctx, uint8_t pin_state );
 
#ifdef __cplusplus
}
#endif
#endif  // _LEDFLASH2_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END