leddriver3.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 LEDDRIVER3_H
#define LEDDRIVER3_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 LEDDRIVER3_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA )
#define LEDDRIVER3_RETVAL  uint8_t
 
#define LEDDRIVER3_OK           0x00
#define LEDDRIVER3_INIT_ERROR   0xFF
#define LEDDRIVER3_COLOR_RED      0x5F6080
#define LEDDRIVER3_COLOR_ORANGE   0x5F6280
#define LEDDRIVER3_COLOR_YELLOW   0x5F7480
#define LEDDRIVER3_COLOR_GREEN    0x407F80
#define LEDDRIVER3_COLOR_BLUE     0x40609F
#define LEDDRIVER3_COLOR_WHITE    0x5F7F9F
#define LEDDRIVER3_COLOR_PURPLE   0x58609C
#define LEDDRIVER3_COLOR_OFF      0x000000
#define LEDDRIVER3_TIMER_8ms      0xE1
#define LEDDRIVER3_TIMER_16ms     0xE2
#define LEDDRIVER3_TIMER_32ms     0xE4
#define LEDDRIVER3_TIMER_64ms     0xE8
#define LEDDRIVER3_TIMER_128ms    0xE0
#define LEDDRIVER3_INTENSITY_1    0x01
#define LEDDRIVER3_INTENSITY_2    0x02
#define LEDDRIVER3_INTENSITY_4    0x04
#define LEDDRIVER3_INTENSITY_8    0x08
#define LEDDRIVER3_INTENSITY_16   0x10
 
#define LEDDRIVER3_INCREMENT      0xA0
#define LEDDRIVER3_DECREMENT      0xC0
#define LEDDRIVER3_CONSTANT       0x20
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct 
{
  uint8_t red;
  uint8_t green;
  uint8_t blue;
} leddriver3_rgb_t;
 
typedef struct
{
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} leddriver3_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
 
    // static variable 
 
    i2c_master_speed_t i2c_speed;
    uint8_t i2c_address;
 
} leddriver3_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void leddriver3_cfg_setup ( leddriver3_cfg_t *cfg );
 
LEDDRIVER3_RETVAL leddriver3_init ( leddriver3_t *ctx, leddriver3_cfg_t *cfg );
 
void leddriver3_generic_write ( leddriver3_t *ctx, uint8_t reg );
 
void leddriver3_generic_read ( leddriver3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void leddriver3_set_intensity ( leddriver3_t *ctx, uint8_t intensity );
 
void leddriver3_set_rgb_color ( leddriver3_t *ctx, leddriver3_rgb_t *rgb );
 
void leddriver3_set_color ( leddriver3_t *ctx, uint32_t color );
 
void leddriver3_shut_down ( leddriver3_t *ctx );
 
void leddriver3_set_timer ( leddriver3_t *ctx, uint8_t time );
 
#ifdef __cplusplus
}
#endif
#endif  // _LEDDRIVER3_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END