alphanumr.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 ALPHANUMR_H
#define ALPHANUMR_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"
 
#define ALPHANUMR_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.le2 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.ns1 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.ns = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // alphanumr_map
 // alphanumr
 
typedef struct
{
    // Output pins
    digital_out_t  le2; 
    digital_out_t  ns1; 
    digital_out_t  ns;  
 
    // Modules
    spi_master_t  spi;                               
    pin_name_t  chip_select;                         
    uint16_t display_speed;
} alphanumr_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  le2;      
    pin_name_t  ns1;      
    pin_name_t  ns;       
 
    // static variable
    uint32_t                           spi_speed;        
    spi_master_mode_t                  spi_mode;         
    spi_master_chip_select_polarity_t  cs_polarity;      
} alphanumr_cfg_t;
 
typedef enum
{
   ALPHANUMR_OK = 0,
   ALPHANUMR_ERROR = -1
 
} alphanumr_return_value_t;
 
void alphanumr_cfg_setup ( alphanumr_cfg_t *cfg );
 
err_t alphanumr_init ( alphanumr_t *ctx, alphanumr_cfg_t *cfg );
 
void alphanumr_set_display_interval ( alphanumr_t *ctx, uint16_t delay_char_display );
 
void alphanumr_display_write ( alphanumr_t *ctx, uint16_t left_char, uint16_t right_char );
 
void alphanumr_write_character ( alphanumr_t *ctx, uint8_t left_char, uint8_t right_char );
 
void alphanumr_write_number ( alphanumr_t *ctx, uint8_t left_char, uint8_t right_char );
 
void alphanumr_set_rst_high ( alphanumr_t *ctx );
 
void alphanumr_set_rst_low ( alphanumr_t *ctx );
 
void alphanumr_set_pwm_high ( alphanumr_t *ctx );
 
void alphanumr_set_pwm_low ( alphanumr_t *ctx );
 
void alphanumr_set_int_high ( alphanumr_t *ctx );
 
void alphanumr_set_int_low ( alphanumr_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // ALPHANUMR_H
 
 // alphanumr
 
// ------------------------------------------------------------------------ END