alphanumg2.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 ALPHANUMG2_H
#define ALPHANUMG2_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 ALPHANUMG2_NIBBLE_LOW                0x000Fu
#define ALPHANUMG2_BYTE_LOW                  0x00FFu
#define ALPHANUMG2_WORD_BIT_POS_0            0x0001u
#define ALPHANUMG2_WORD_BIT_POS_14           0x4000u
#define ALPHANUMG2_WORD_BIT_POS_15           0x8000u
 
#define ALPHANUMG2_BRIGHTNESS_MIN            0x0000u
#define ALPHANUMG2_BRIGHTNESS_MAX            0x0FFFu
 
#define ALPHANUMG2_DEFAULT_DUR_1000_MS       1000
 
#define ALPHANUMG2_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define ALPHANUMG2_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // alphanumg2_set
 
#define ALPHANUMG2_MAP_MIKROBUS( cfg, mikrobus )    \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK );  \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS );   \
    cfg.blk  = MIKROBUS( mikrobus, MIKROBUS_AN );   \
    cfg.ca1  = MIKROBUS( mikrobus, MIKROBUS_PWM );  \
    cfg.ca2  = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // alphanumg2_map
 // alphanumg2
 
typedef struct
{
    // Output pins
    digital_out_t blk;    
    digital_out_t ca1;    
    digital_out_t ca2;    
    // Modules
    spi_master_t spi;            
    pin_name_t   chip_select;    
    uint16_t char_duration;      
} alphanumg2_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t miso;    
    pin_name_t mosi;    
    pin_name_t sck;     
    pin_name_t cs;      
    // Additional gpio pins
    pin_name_t blk;     
    pin_name_t ca1;     
    pin_name_t ca2;     
    // static variable
    uint32_t                          spi_speed;    
    spi_master_mode_t                 spi_mode;     
    spi_master_chip_select_polarity_t cs_polarity;  
} alphanumg2_cfg_t;
 
typedef enum
{
    ALPHANUMG2_OK = 0,
    ALPHANUMG2_ERROR = -1
 
} alphanumg2_return_value_t;
 
typedef enum
{
    ALPHANUMG2_NO_DOT = 0,
    ALPHANUMG2_SET_DOT
 
} alphanumg2_dot_t;
 
void alphanumg2_cfg_setup ( alphanumg2_cfg_t *cfg );
 
err_t alphanumg2_init ( alphanumg2_t *ctx, alphanumg2_cfg_t *cfg );
 
err_t alphanumg2_default_cfg ( alphanumg2_t *ctx );
 
err_t alphanumg2_generic_write ( alphanumg2_t *ctx, uint8_t *data_in, uint8_t len );
 
err_t alphanumg2_generic_read ( alphanumg2_t *ctx, uint8_t *data_out, uint8_t len );
 
void alphanumg2_set_char_duration ( alphanumg2_t *ctx, uint16_t duration_ms );
 
void alphanumg2_set_outputs_off ( alphanumg2_t *ctx );
 
void alphanumg2_set_outputs_on ( alphanumg2_t *ctx );
 
void alphanumg2_set_seg_left_off ( alphanumg2_t *ctx );
 
void alphanumg2_set_seg_left_on ( alphanumg2_t *ctx );
 
void alphanumg2_set_seg_right_off ( alphanumg2_t *ctx );
 
void alphanumg2_set_seg_right_on ( alphanumg2_t *ctx );
 
err_t alphanumg2_set_led_output ( alphanumg2_t *ctx, uint16_t seg_bit_mask, 
                                  alphanumg2_dot_t seg_dot, uint16_t brightness );
 
err_t alphanumg2_display_character ( alphanumg2_t *ctx, uint8_t left_char, uint16_t left_brightness,  
                                                        uint8_t right_char, uint16_t right_brightness );
 
#ifdef __cplusplus
}
#endif
#endif // ALPHANUMG2_H
 
 // alphanumg2
 
// ------------------------------------------------------------------------ END