c4x4rgb  2.0.0.0
c4x4rgb.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 C4X4RGB_H
36 #define C4X4RGB_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 
41 // -------------------------------------------------------------- PUBLIC MACROS
51 #define C4X4RGB_MAP_MIKROBUS( cfg, mikrobus ) \
52  cfg.in1 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
53  cfg.in2 = MIKROBUS( mikrobus, MIKROBUS_CS ); \
54  cfg.out = MIKROBUS( mikrobus, MIKROBUS_PWM )
55 
61 #define C4X4RGB_OK 0
62 #define C4X4RGB_ERROR -1
63 
70 #define C4X4RGB_CTRL_PIN_IN1 1
71 #define C4X4RGB_CTRL_PIN_IN2 2
72 
79 #define C4X4RGB_COLOR_WHITE 0x001F1F1F
80 #define C4X4RGB_COLOR_RED 0x001F0000
81 #define C4X4RGB_COLOR_GREEN 0x00001F00
82 #define C4X4RGB_COLOR_BLUE 0x0000001F
83 #define C4X4RGB_COLOR_LIGHT_BLUE 0x00001F1F
84 #define C4X4RGB_COLOR_YELLOW 0x001F1F00
85 #define C4X4RGB_COLOR_PURPLE 0x001F001F
86  // End group macro
89 // --------------------------------------------------------------- PUBLIC TYPES
98 typedef void ( *drv_logic_t ) ( void );
99 
103 typedef struct
104 {
105  // Output pins
106  digital_out_t in1;
107  digital_out_t in2;
108  digital_out_t out;
109 
110  digital_out_t ctrl_pin;
111 
112  // Function pointers
115 
116  uint32_t diode_array[ 16 ];
117 
118 } c4x4rgb_t;
119 
123 typedef struct
124 {
125  // Additional gpio pins
126  pin_name_t in1;
127  pin_name_t in2;
128  pin_name_t out;
129 
130  uint8_t ctrl_pin;
131 
132  // Function pointers
135 
136 } c4x4rgb_cfg_t;
137  // End types group
139 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
140 
146 #ifdef __cplusplus
147 extern "C"{
148 #endif
149 
160 void c4x4rgb_cfg_setup ( c4x4rgb_cfg_t *cfg, drv_logic_t logic_zero, drv_logic_t logic_one, uint8_t select_ctrl_pin );
161 
169 err_t c4x4rgb_init ( c4x4rgb_t *ctx, c4x4rgb_cfg_t *cfg );
170 
182 err_t c4x4rgb_set_diode ( c4x4rgb_t *ctx, uint32_t diode_num, uint32_t diode_color );
183 
191 void c4x4rgb_fill_screen ( c4x4rgb_t *ctx, uint32_t fill_color );
192 
193 #ifdef __cplusplus
194 }
195 #endif
196 #endif // _C4X4RGB_H_
197  // End public_function group
200 
201 // ------------------------------------------------------------------------- END
c4x4rgb_cfg_setup
void c4x4rgb_cfg_setup(c4x4rgb_cfg_t *cfg, drv_logic_t logic_zero, drv_logic_t logic_one, uint8_t select_ctrl_pin)
Config Object Initialization function.
c4x4rgb_cfg_t::logic_one
drv_logic_t logic_one
Definition: c4x4rgb.h:134
c4x4rgb_set_diode
err_t c4x4rgb_set_diode(c4x4rgb_t *ctx, uint32_t diode_num, uint32_t diode_color)
Function for setting color color of one diode.
c4x4rgb_cfg_t::logic_zero
drv_logic_t logic_zero
Definition: c4x4rgb.h:133
c4x4rgb_cfg_t::ctrl_pin
uint8_t ctrl_pin
Definition: c4x4rgb.h:130
drv_logic_t
void(* drv_logic_t)(void)
Function pointer for logic level one and zero.
Definition: c4x4rgb.h:98
c4x4rgb_cfg_t
Click configuration structure definition.
Definition: c4x4rgb.h:124
c4x4rgb_cfg_t::in1
pin_name_t in1
Definition: c4x4rgb.h:126
c4x4rgb_init
err_t c4x4rgb_init(c4x4rgb_t *ctx, c4x4rgb_cfg_t *cfg)
Initialization function.
c4x4rgb_t::in2
digital_out_t in2
Definition: c4x4rgb.h:107
c4x4rgb_fill_screen
void c4x4rgb_fill_screen(c4x4rgb_t *ctx, uint32_t fill_color)
Function for filling color of ever diode.
c4x4rgb_t::ctrl_pin
digital_out_t ctrl_pin
Definition: c4x4rgb.h:110
c4x4rgb_cfg_t::out
pin_name_t out
Definition: c4x4rgb.h:128
c4x4rgb_t::out
digital_out_t out
Definition: c4x4rgb.h:108
c4x4rgb_cfg_t::in2
pin_name_t in2
Definition: c4x4rgb.h:127
c4x4rgb_t::in1
digital_out_t in1
Definition: c4x4rgb.h:106
c4x4rgb_t
Click ctx object definition.
Definition: c4x4rgb.h:104
c4x4rgb_t::logic_zero
drv_logic_t logic_zero
Definition: c4x4rgb.h:113
c4x4rgb_t::logic_one
drv_logic_t logic_one
Definition: c4x4rgb.h:114