bargraph5  2.1.0.0
Data Structures | Macros | Enumerations | Functions
bargraph5.h File Reference

This file contains API for BarGraph 5 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"

Go to the source code of this file.

Data Structures

struct  bargraph5_t
 BarGraph 5 Click context object. More...
 
struct  bargraph5_cfg_t
 BarGraph 5 Click configuration object. More...
 

Macros

#define BARGRAPH5_CHANNELS_NUM   24
 BarGraph 5 number of output channels. More...
 
#define BARGRAPH5_BRIGHTNESS_MIN   0
 BarGraph 5 default output brightness. More...
 
#define BARGRAPH5_BRIGHTNESS_DEFAULT   3000
 
#define BARGRAPH5_BRIGHTNESS_MAX   4095
 
#define BARGRAPH5_SET_DATA_SAMPLE_EDGE   SET_SPI_DATA_SAMPLE_EDGE
 Data sample selection. More...
 
#define BARGRAPH5_SET_DATA_SAMPLE_MIDDLE   SET_SPI_DATA_SAMPLE_MIDDLE
 
#define BARGRAPH5_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  bargraph5_bar_sel_t {
  BARGRAPH5_BAR_0 = 0, BARGRAPH5_BAR_1, BARGRAPH5_BAR_2, BARGRAPH5_BAR_3,
  BARGRAPH5_BAR_4, BARGRAPH5_BAR_5
}
 BarGraph 5 Click select bar channel. More...
 
enum  bargraph5_level_t {
  BARGRAPH5_LEVEL_0 = 0, BARGRAPH5_LEVEL_1, BARGRAPH5_LEVEL_2, BARGRAPH5_LEVEL_3,
  BARGRAPH5_LEVEL_4
}
 BarGraph 5 Click bar level. More...
 
enum  bargraph5_return_value_t { BARGRAPH5_OK = 0, BARGRAPH5_ERROR = -1 }
 BarGraph 5 Click return value data. More...
 

Functions

void bargraph5_cfg_setup (bargraph5_cfg_t *cfg)
 BarGraph 5 configuration object setup function. More...
 
err_t bargraph5_init (bargraph5_t *ctx, bargraph5_cfg_t *cfg)
 BarGraph 5 initialization function. More...
 
err_t bargraph5_default_cfg (bargraph5_t *ctx)
 BarGraph 5 default configuration function. More...
 
err_t bargraph5_write_channels (bargraph5_t *ctx)
 BarGraph 5 write channels function. More...
 
err_t bargraph5_read_channels (bargraph5_t *ctx)
 BarGraph 5 read channels function. More...
 
void bargraph5_output_enable (bargraph5_t *ctx)
 BarGraph 5 output enable function. More...
 
void bargraph5_output_disable (bargraph5_t *ctx)
 BarGraph 5 output disable function. More...
 
err_t bargraph5_set_bar_level (bargraph5_t *ctx, bargraph5_bar_sel_t bar_num, bargraph5_level_t level, uint16_t brightness)
 BarGraph 5 set bar level function. More...
 

Detailed Description

This file contains API for BarGraph 5 Click Driver.

Enumeration Type Documentation

◆ bargraph5_bar_sel_t

BarGraph 5 Click select bar channel.

Enum values for bar channel selection.

Enumerator
BARGRAPH5_BAR_0 
BARGRAPH5_BAR_1 
BARGRAPH5_BAR_2 
BARGRAPH5_BAR_3 
BARGRAPH5_BAR_4 
BARGRAPH5_BAR_5 

◆ bargraph5_level_t

BarGraph 5 Click bar level.

Enum values for bar level.

Enumerator
BARGRAPH5_LEVEL_0 
BARGRAPH5_LEVEL_1 
BARGRAPH5_LEVEL_2 
BARGRAPH5_LEVEL_3 
BARGRAPH5_LEVEL_4 

◆ bargraph5_return_value_t

BarGraph 5 Click return value data.

Predefined enum values for driver return values.

Enumerator
BARGRAPH5_OK 
BARGRAPH5_ERROR