utl7segr.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 UTL7SEGR_H
#define UTL7SEGR_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_spi_master.h"
 
#define UTL7SEGR_DOT_LEFT              0x02
#define UTL7SEGR_DOT_RIGHT             0x01
#define UTL7SEGR_DOT_LEFT_RIGHT        0x03
#define UTL7SEGR_NO_DOT                0x00
 
#define UTL7SEGR_DISPLAY_ON            0x01
#define UTL7SEGR_DISPLAY_OFF           0x00
 
 // utl7segr_set
 
#define UTL7SEGR_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.oe   = MIKROBUS( mikrobus, MIKROBUS_PWM ) 
 
 // utl7segr_map
 // utl7segr
 
typedef struct
{
    // Output pins
 
    digital_out_t  oe;                                
    // Modules
 
    spi_master_t  spi;                               
    pin_name_t  chip_select;                         
} utl7segr_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  oe;                                      
    // static variable
 
    uint32_t                           spi_speed;        
    spi_master_mode_t                  spi_mode;         
    spi_master_chip_select_polarity_t  cs_polarity;      
} utl7segr_cfg_t;
 
typedef enum
{
   UTL7SEGR_OK = 0,
   UTL7SEGR_ERROR = -1
 
} utl7segr_return_value_t;
 
void utl7segr_cfg_setup ( utl7segr_cfg_t *cfg );
 
err_t utl7segr_init ( utl7segr_t *ctx, utl7segr_cfg_t *cfg );
 
void utl7segr_default_cfg ( utl7segr_t *ctx );
 
err_t utl7segr_generic_write ( utl7segr_t *ctx, uint8_t *data_in );
 
void utl7segr_display_state ( utl7segr_t *ctx, uint8_t state ) ;
 
err_t utl7segr_display_number ( utl7segr_t *ctx, uint8_t number, uint8_t dot_pos );
 
#ifdef __cplusplus
}
#endif
#endif // UTL7SEGR_H
 
 // utl7segr
 
// ------------------------------------------------------------------------ END