leddriver12.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 LEDDRIVER12_H
#define LEDDRIVER12_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 LEDDRIVER12_REG_INPUT0                      0x00
#define LEDDRIVER12_REG_INPUT1                      0x01
#define LEDDRIVER12_REG_PSC0                        0x02
#define LEDDRIVER12_REG_PWM0                        0x03
#define LEDDRIVER12_REG_PSC1                        0x04
#define LEDDRIVER12_REG_PWM1                        0x05
#define LEDDRIVER12_REG_LS0                         0x06
#define LEDDRIVER12_REG_LS1                         0x07
#define LEDDRIVER12_REG_LS2                         0x08
#define LEDDRIVER12_REG_LS3                         0x09
 
 // leddriver12_reg
 
#define LEDDRIVER12_AUTO_INCREMENT_BIT              0x10
 
#define LEDDRIVER12_LED_OFF                         0x00
#define LEDDRIVER12_LED_ON                          0x01
#define LEDDRIVER12_LED_PWM0                        0x02
#define LEDDRIVER12_LED_PWM1                        0x03
#define LEDDRIVER12_LED0                            0x00
#define LEDDRIVER12_LED1                            0x01
#define LEDDRIVER12_LED2                            0x02
#define LEDDRIVER12_LED3                            0x03
#define LEDDRIVER12_LED4                            0x04
#define LEDDRIVER12_LED5                            0x05
#define LEDDRIVER12_LED6                            0x06
#define LEDDRIVER12_LED7                            0x07
#define LEDDRIVER12_LED8                            0x08
#define LEDDRIVER12_LED9                            0x09
#define LEDDRIVER12_LED10                           0x0A
#define LEDDRIVER12_LED11                           0x0B
#define LEDDRIVER12_LED12                           0x0C
#define LEDDRIVER12_LED13                           0x0D
#define LEDDRIVER12_LED14                           0x0E
#define LEDDRIVER12_LED15                           0x0F
#define LEDDRIVER12_LED0_TO_3                       0x00
#define LEDDRIVER12_LED4_TO_7                       0x01
#define LEDDRIVER12_LED8_TO_11                      0x02
#define LEDDRIVER12_LED12_TO_15                     0x03
#define LEDDRIVER12_ALL_LEDS                        0xFF
 
#define LEDDRIVER12_BLINK_PERIOD_MAX                1.68421
#define LEDDRIVER12_BLINK_PERIOD_MIN                0.00657
#define LEDDRIVER12_BLINK_PERIOD_ONE_SECOND         1.0
#define LEDDRIVER12_BLINK_PERIOD_HALF_SECOND        0.5
#define LEDDRIVER12_DUTY_CYCLE_MAX                  0xFF
#define LEDDRIVER12_DUTY_CYCLE_HALF                 0x80
#define LEDDRIVER12_DUTY_CYCLE_QUARTER              0x40
#define LEDDRIVER12_DUTY_CYCLE_MIN                  0x00
 
#define LEDDRIVER12_DEV_ADDR_A2A1A0_000             0x60
#define LEDDRIVER12_DEV_ADDR_A2A1A0_001             0x61
#define LEDDRIVER12_DEV_ADDR_A2A1A0_010             0x62
#define LEDDRIVER12_DEV_ADDR_A2A1A0_011             0x63
#define LEDDRIVER12_DEV_ADDR_A2A1A0_100             0x64
#define LEDDRIVER12_DEV_ADDR_A2A1A0_101             0x65
#define LEDDRIVER12_DEV_ADDR_A2A1A0_110             0x66
#define LEDDRIVER12_DEV_ADDR_A2A1A0_111             0x67
 
 // leddriver12_set
 
#define LEDDRIVER12_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST );
 
 // leddriver12_map
 // leddriver12
 
typedef struct
{
    // Output pins
    digital_out_t rst;          
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
} leddriver12_t;
 
typedef struct
{
    pin_name_t  scl;            
    pin_name_t  sda;            
    pin_name_t  rst;            
    uint32_t  i2c_speed;        
    uint8_t   i2c_address;      
} leddriver12_cfg_t;
 
typedef enum
{
    LEDDRIVER12_OK = 0,
    LEDDRIVER12_ERROR = -1
 
} leddriver12_return_value_t;
 
void leddriver12_cfg_setup ( leddriver12_cfg_t *cfg );
 
err_t leddriver12_init ( leddriver12_t *ctx, leddriver12_cfg_t *cfg );
 
err_t leddriver12_default_cfg ( leddriver12_t *ctx );
 
err_t leddriver12_generic_write ( leddriver12_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t leddriver12_generic_read ( leddriver12_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
err_t leddriver12_write_register ( leddriver12_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t leddriver12_read_register ( leddriver12_t *ctx, uint8_t reg, uint8_t *data_out );
 
void leddriver12_set_rst_pin ( leddriver12_t *ctx, uint8_t state );
 
err_t leddriver12_set_led_config ( leddriver12_t *ctx, uint8_t led_number, uint8_t led_cfg );
 
err_t leddriver12_set_led_port_config ( leddriver12_t *ctx, uint8_t led_port_number, uint8_t led_cfg );
 
err_t leddriver12_read_input_0 ( leddriver12_t *ctx, uint8_t *data_out );
 
err_t leddriver12_read_input_1 ( leddriver12_t *ctx, uint8_t *data_out );
 
err_t leddriver12_set_blink_period_pwm_0 ( leddriver12_t *ctx, float blink_period );
 
err_t leddriver12_set_blink_period_pwm_1 ( leddriver12_t *ctx, float blink_period );
 
err_t leddriver12_set_duty_cycle_pwm_0 ( leddriver12_t *ctx, uint8_t duty_cycle );
 
err_t leddriver12_set_duty_cycle_pwm_1 ( leddriver12_t *ctx, uint8_t duty_cycle );
 
#ifdef __cplusplus
}
#endif
#endif // LEDDRIVER12_H
 
 // leddriver12
 
// ------------------------------------------------------------------------ END