bargraph2 2.0.0.0
bargraph2.h
Go to the documentation of this file.
1/*
2 * MikroSDK - MikroE Software Development Kit
3 * Copyright© 2020 MikroElektronika d.o.o.
4 *
5 * Permission is hereby granted, free of charge, to any person
6 * obtaining a copy of this software and associated documentation
7 * files (the "Software"), to deal in the Software without restriction,
8 * including without limitation the rights to use, copy, modify, merge,
9 * publish, distribute, sublicense, and/or sell copies of the Software,
10 * and to permit persons to whom the Software is furnished to do so,
11 * subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be
14 * included in all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22 * OR OTHER DEALINGS IN THE SOFTWARE.
23 */
24
33// ----------------------------------------------------------------------------
34
35#ifndef BARGRAPH2_H
36#define BARGRAPH2_H
37
38#include "drv_digital_out.h"
39#include "drv_digital_in.h"
40#include "drv_spi_master.h"
41
42// -------------------------------------------------------------- PUBLIC MACROS
53#define BARGRAPH2_MAP_MIKROBUS( cfg, mikrobus ) \
54 cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
55 cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
56 cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
57 cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
58 cfg.mr = MIKROBUS( mikrobus, MIKROBUS_RST ); \
59 cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM )
66#define BARGRAPH2_RETVAL uint8_t
67
68#define BARGRAPH2_OK 0x00
69#define BARGRAPH2_INIT_ERROR 0xFF
76#define BARGRAPH2_POWER_ON 1
77#define BARGRAPH2_POWER_OFF 0
84#define BARGRAPH2_LED_SEG_0 0x00
85#define BARGRAPH2_LED_SEG_1 0x01
86#define BARGRAPH2_LED_SEG_2 0x02
87#define BARGRAPH2_LED_SEG_3 0x04
88#define BARGRAPH2_LED_SEG_4 0x08
89#define BARGRAPH2_LED_SEG_5 0x10
90#define BARGRAPH2_LED_SEG_6 0x20
91#define BARGRAPH2_LED_SEG_7 0x40
92#define BARGRAPH2_LED_SEG_8 0x80 // End group macro
96// --------------------------------------------------------------- PUBLIC TYPES
105typedef struct
106{
107 digital_out_t cs;
108
109 // Output pins
110
111 digital_out_t mr;
112 digital_out_t pwm;
113
114 // Modules
115
116 spi_master_t spi;
117 pin_name_t chip_select;
118
120
124typedef struct
125{
126 // Communication gpio pins
127
128 pin_name_t miso;
129 pin_name_t mosi;
130 pin_name_t sck;
131 pin_name_t cs;
132
133 // Additional gpio pins
134
135 pin_name_t mr;
136 pin_name_t pwm;
137
138 // static variable
139
140 uint32_t spi_speed;
141 spi_master_mode_t spi_mode;
142 spi_master_chip_select_polarity_t cs_polarity;
143
145 // End types group
147// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
148
153#ifdef __cplusplus
154extern "C"{
155#endif
156
166
176
185
197void bargraph2_generic_transfer ( bargraph2_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len );
198
207
216void bargraph2_write_byte ( bargraph2_t *ctx, uint8_t input_data );
217
229void bargraph2_led_green ( bargraph2_t *ctx, uint8_t index );
230
242void bargraph2_led_red ( bargraph2_t *ctx, uint8_t index );
243
255void bargraph2_led_yellow ( bargraph2_t *ctx, uint8_t index );
256
267void bargraph2_leds_green ( bargraph2_t *ctx, int start_index, int end_index );
268
279void bargraph2_leds_red ( bargraph2_t *ctx, int start_index, int end_index );
280
291void bargraph2_leds_yellow ( bargraph2_t *ctx, int start_index, int end_index );
292
301
310void barpgraph2_power ( bargraph2_t *ctx, uint8_t power_on_off );
311
312#ifdef __cplusplus
313}
314#endif
315#endif // _BARGRAPH2_H_
316 // End public_function group
319
320// ------------------------------------------------------------------------- END
#define BARGRAPH2_RETVAL
Definition: bargraph2.h:66
void bargraph2_lights_out(bargraph2_t *ctx)
Lights out function.
BARGRAPH2_RETVAL bargraph2_init(bargraph2_t *ctx, bargraph2_cfg_t *cfg)
Initialization function.
void bargraph2_default_cfg(bargraph2_t *ctx)
Click Default Configuration function.
void bargraph2_leds_yellow(bargraph2_t *ctx, int start_index, int end_index)
LEDs red function.
void bargraph2_cfg_setup(bargraph2_cfg_t *cfg)
Config Object Initialization function.
void bargraph2_generic_transfer(bargraph2_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
Generic transfer function.
void bargraph2_led_red(bargraph2_t *ctx, uint8_t index)
LED red function.
void barpgraph2_power(bargraph2_t *ctx, uint8_t power_on_off)
Lights out function.
void bargraph2_reset(bargraph2_t *ctx)
Reset function.
void bargraph2_led_green(bargraph2_t *ctx, uint8_t index)
LED green function.
void bargraph2_leds_red(bargraph2_t *ctx, int start_index, int end_index)
LEDs red function.
void bargraph2_leds_green(bargraph2_t *ctx, int start_index, int end_index)
LEDs green function.
void bargraph2_write_byte(bargraph2_t *ctx, uint8_t input_data)
Write byte function.
void bargraph2_led_yellow(bargraph2_t *ctx, uint8_t index)
LED yellow function.
Click configuration structure definition.
Definition: bargraph2.h:125
spi_master_chip_select_polarity_t cs_polarity
Definition: bargraph2.h:142
pin_name_t mr
Definition: bargraph2.h:135
pin_name_t sck
Definition: bargraph2.h:130
spi_master_mode_t spi_mode
Definition: bargraph2.h:141
pin_name_t mosi
Definition: bargraph2.h:129
uint32_t spi_speed
Definition: bargraph2.h:140
pin_name_t pwm
Definition: bargraph2.h:136
pin_name_t miso
Definition: bargraph2.h:128
pin_name_t cs
Definition: bargraph2.h:131
Click ctx object definition.
Definition: bargraph2.h:106
digital_out_t cs
Definition: bargraph2.h:107
spi_master_t spi
Definition: bargraph2.h:116
digital_out_t pwm
Definition: bargraph2.h:112
digital_out_t mr
Definition: bargraph2.h:111
pin_name_t chip_select
Definition: bargraph2.h:117