c4x4rgb2.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 C4X4RGB2_H
#define C4X4RGB2_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_spi_master.h"
#include "spi_specifics.h"
 
#define C4X4RGB2_FRAME_START                0x00
#define C4X4RGB2_FRAME_END                  0xFF
 
#define C4X4RGB2_LED_0                      0
#define C4X4RGB2_LED_1                      1
#define C4X4RGB2_LED_2                      2
#define C4X4RGB2_LED_3                      3
#define C4X4RGB2_LED_4                      4
#define C4X4RGB2_LED_5                      5
#define C4X4RGB2_LED_6                      6
#define C4X4RGB2_LED_7                      7
#define C4X4RGB2_LED_8                      8
#define C4X4RGB2_LED_9                      9
#define C4X4RGB2_LED_10                     10
#define C4X4RGB2_LED_11                     11
#define C4X4RGB2_LED_12                     12
#define C4X4RGB2_LED_13                     13
#define C4X4RGB2_LED_14                     14
#define C4X4RGB2_LED_15                     15
#define C4X4RGB2_NUM_LEDS                   16
 
#define C4X4RGB2_LED_BRIGHTNESS_MIN         0
#define C4X4RGB2_LED_BRIGHTNESS_DEFAULT     1
#define C4X4RGB2_LED_BRIGHTNESS_MAX         31
#define C4X4RGB2_LED_BRIGHTNESS_MASK        0xE0
 
#define C4X4RGB2_COLOR_BLACK                0x000000ul
#define C4X4RGB2_COLOR_WHITE                0xFFFFFFul
#define C4X4RGB2_COLOR_RED                  0xFF0000ul
#define C4X4RGB2_COLOR_LIME                 0x00FF00ul
#define C4X4RGB2_COLOR_BLUE                 0x0000FFul
#define C4X4RGB2_COLOR_YELLOW               0xFFFF00ul
#define C4X4RGB2_COLOR_CYAN                 0x00FFFFul
#define C4X4RGB2_COLOR_MAGENTA              0xFF00FFul
#define C4X4RGB2_COLOR_SILVER               0xC0C0C0ul
#define C4X4RGB2_COLOR_GRAY                 0x808080ul
#define C4X4RGB2_COLOR_MAROON               0x800000ul
#define C4X4RGB2_COLOR_OLIVE                0x808000ul
#define C4X4RGB2_COLOR_GREEN                0x008000ul
#define C4X4RGB2_COLOR_PURPLE               0x800080ul
#define C4X4RGB2_COLOR_TEAL                 0x008080ul
#define C4X4RGB2_COLOR_NAVY                 0x000080ul
#define C4X4RGB2_NUM_COLORS                 16
#define C4X4RGB2_SIZE_COLOR_NAME            32
 
#define C4X4RGB2_SET_DATA_SAMPLE_EDGE       SET_SPI_DATA_SAMPLE_EDGE
#define C4X4RGB2_SET_DATA_SAMPLE_MIDDLE     SET_SPI_DATA_SAMPLE_MIDDLE
 
 // c4x4rgb2_set
 
#define C4X4RGB2_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK );
#define C4X4RGB2_MAP_MIKROBUS( cfg, mikrobus ) \ …
 
 // c4x4rgb2_map
 // c4x4rgb2
 
typedef struct
{
    uint32_t rgb;                   
    uint8_t name[ C4X4RGB2_SIZE_COLOR_NAME ];   
} c4x4rgb2_color_t;
typedef struct {…};
 
typedef struct
{
    uint8_t brightness;             
    uint8_t red;                    
    uint8_t green;                  
    uint8_t blue;                   
} c4x4rgb2_led_t;
typedef struct {…};
 
typedef struct
{
    // Modules
    spi_master_t spi;               
    c4x4rgb2_led_t led_matrix[ C4X4RGB2_NUM_LEDS ]; 
} c4x4rgb2_t;
typedef struct {…};
 
typedef struct
{
    // Communication gpio pins
    pin_name_t miso;                
    pin_name_t mosi;                
    pin_name_t sck;                 
    // static variable
    uint32_t            spi_speed;  
    spi_master_mode_t   spi_mode;   
} c4x4rgb2_cfg_t;
typedef struct {…};
 
typedef enum
{
    C4X4RGB2_OK = 0,
    C4X4RGB2_ERROR = -1
 
} c4x4rgb2_return_value_t;
typedef enum {…};
 
void c4x4rgb2_cfg_setup ( c4x4rgb2_cfg_t *cfg );
 
err_t c4x4rgb2_init ( c4x4rgb2_t *ctx, c4x4rgb2_cfg_t *cfg );
 
err_t c4x4rgb2_default_cfg ( c4x4rgb2_t *ctx );
 
err_t c4x4rgb2_write_leds ( c4x4rgb2_t *ctx, c4x4rgb2_led_t *leds, uint8_t num_leds );
 
err_t c4x4rgb2_write_led_matrix ( c4x4rgb2_t *ctx );
 
void c4x4rgb2_set_led_brightness ( c4x4rgb2_t *ctx, uint8_t led_num, uint8_t brightness );
 
void c4x4rgb2_set_all_leds_brightness ( c4x4rgb2_t *ctx, uint8_t brightness );
 
void c4x4rgb2_set_led_color ( c4x4rgb2_t *ctx, uint8_t led_num, uint32_t rgb );
 
void c4x4rgb2_set_all_leds_color ( c4x4rgb2_t *ctx, uint32_t rgb );
 
#ifdef __cplusplus
}
#endif
#endif // C4X4RGB2_H
 
 // c4x4rgb2
 
// ------------------------------------------------------------------------ END