bargraph4.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 BARGRAPH4_H
#define BARGRAPH4_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 BARGRAPH4_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define BARGRAPH4_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // bargraph4_set
 
#define BARGRAPH4_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.rst  = MIKROBUS( mikrobus, MIKROBUS_RST );
 
 // bargraph4_map
 // bargraph4
 
typedef struct
{
    // Output pins
    digital_out_t  rst;                                 
    // Modules
    spi_master_t  spi;                                  
    pin_name_t  chip_select;                            
} bargraph4_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  rst;                                     
    // static variable
    uint32_t                           spi_speed;        
    spi_master_mode_t                  spi_mode;         
    spi_master_chip_select_polarity_t  cs_polarity;      
} bargraph4_cfg_t;
 
typedef enum
{
    BARGRAPH4_OK = 0,
    BARGRAPH4_ERROR = -1
 
} bargraph4_return_value_t;
 
typedef enum
{
    BARGRAPH4_CHANNEL_A = 0,
    BARGRAPH4_CHANNEL_B,
    BARGRAPH4_CHANNEL_C,
    BARGRAPH4_CHANNEL_D
 
} bargraph4_sel_ch_t;
 
typedef enum
{
    BARGRAPH4_LEVEL_0 = 0,
    BARGRAPH4_LEVEL_1,
    BARGRAPH4_LEVEL_2,
    BARGRAPH4_LEVEL_3,
    BARGRAPH4_LEVEL_4
 
} bargraph4_level_t;
 
void bargraph4_cfg_setup ( bargraph4_cfg_t *cfg );
 
err_t bargraph4_init ( bargraph4_t *ctx, bargraph4_cfg_t *cfg );
 
err_t bargraph4_set_output ( bargraph4_t *ctx, uint16_t ch_mask );
 
err_t bargraph4_read_output ( bargraph4_t *ctx, uint16_t *ch_mask );
 
void bargraph4_disable_output ( bargraph4_t *ctx );
 
void bargraph4_enable_output ( bargraph4_t *ctx );
 
err_t bargraph4_set_channel_level ( bargraph4_t *ctx, bargraph4_sel_ch_t channel, bargraph4_level_t level );
 
#ifdef __cplusplus
}
#endif
#endif // BARGRAPH4_H
 
 // bargraph4
 
// ------------------------------------------------------------------------ END