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
42#ifdef PREINIT_SUPPORTED
43#include "preinit.h"
44#endif
45
46#ifdef MikroCCoreVersion
47 #if MikroCCoreVersion >= 1
48 #include "delays.h"
49 #endif
50#endif
51
52#include "drv_digital_out.h"
53#include "drv_digital_in.h"
54#include "drv_spi_master.h"
55
56// -------------------------------------------------------------- PUBLIC MACROS
67#define BARGRAPH2_MAP_MIKROBUS( cfg, mikrobus ) \
68 cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
69 cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
70 cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
71 cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
72 cfg.mr = MIKROBUS( mikrobus, MIKROBUS_RST ); \
73 cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM )
80#define BARGRAPH2_RETVAL uint8_t
81
82#define BARGRAPH2_OK 0x00
83#define BARGRAPH2_INIT_ERROR 0xFF
90#define BARGRAPH2_POWER_ON 1
91#define BARGRAPH2_POWER_OFF 0
98#define BARGRAPH2_LED_SEG_0 0x00
99#define BARGRAPH2_LED_SEG_1 0x01
100#define BARGRAPH2_LED_SEG_2 0x02
101#define BARGRAPH2_LED_SEG_3 0x04
102#define BARGRAPH2_LED_SEG_4 0x08
103#define BARGRAPH2_LED_SEG_5 0x10
104#define BARGRAPH2_LED_SEG_6 0x20
105#define BARGRAPH2_LED_SEG_7 0x40
106#define BARGRAPH2_LED_SEG_8 0x80
109 // End group macro
110// --------------------------------------------------------------- PUBLIC TYPES
119typedef struct
120{
121 digital_out_t cs;
122
123 // Output pins
124
125 digital_out_t mr;
126 digital_out_t pwm;
127
128 // Modules
129
130 spi_master_t spi;
131 pin_name_t chip_select;
132
134
138typedef struct
139{
140 // Communication gpio pins
141
142 pin_name_t miso;
143 pin_name_t mosi;
144 pin_name_t sck;
145 pin_name_t cs;
146
147 // Additional gpio pins
148
149 pin_name_t mr;
150 pin_name_t pwm;
151
152 // static variable
153
154 uint32_t spi_speed;
155 spi_master_mode_t spi_mode;
156 spi_master_chip_select_polarity_t cs_polarity;
157
159
160 // End types group
161// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
162
167#ifdef __cplusplus
168extern "C"{
169#endif
170
180
190
199
211void bargraph2_generic_transfer ( bargraph2_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len );
212
221
230void bargraph2_write_byte ( bargraph2_t *ctx, uint8_t input_data );
231
243void bargraph2_led_green ( bargraph2_t *ctx, uint8_t index );
244
256void bargraph2_led_red ( bargraph2_t *ctx, uint8_t index );
257
269void bargraph2_led_yellow ( bargraph2_t *ctx, uint8_t index );
270
281void bargraph2_leds_green ( bargraph2_t *ctx, int start_index, int end_index );
282
293void bargraph2_leds_red ( bargraph2_t *ctx, int start_index, int end_index );
294
305void bargraph2_leds_yellow ( bargraph2_t *ctx, int start_index, int end_index );
306
315
324void barpgraph2_power ( bargraph2_t *ctx, uint8_t power_on_off );
325
326#ifdef __cplusplus
327}
328#endif
329#endif // _BARGRAPH2_H_
330
331 // End public_function group
333
334// ------------------------------------------------------------------------- END
#define BARGRAPH2_RETVAL
Definition bargraph2.h:80
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:139
spi_master_chip_select_polarity_t cs_polarity
Definition bargraph2.h:156
pin_name_t mr
Definition bargraph2.h:149
pin_name_t sck
Definition bargraph2.h:144
spi_master_mode_t spi_mode
Definition bargraph2.h:155
pin_name_t mosi
Definition bargraph2.h:143
uint32_t spi_speed
Definition bargraph2.h:154
pin_name_t pwm
Definition bargraph2.h:150
pin_name_t miso
Definition bargraph2.h:142
pin_name_t cs
Definition bargraph2.h:145
Click ctx object definition.
Definition bargraph2.h:120
digital_out_t cs
Definition bargraph2.h:121
spi_master_t spi
Definition bargraph2.h:130
digital_out_t pwm
Definition bargraph2.h:126
digital_out_t mr
Definition bargraph2.h:125
pin_name_t chip_select
Definition bargraph2.h:131