c10x10rgb  2.0.0.0
c10x10rgb.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 C10X10RGB_H
36 #define C10X10RGB_H
37 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 
51 // -------------------------------------------------------------- PUBLIC MACROS
61 #define C10X10RGB_MAP_MIKROBUS( cfg, mikrobus ) \
62  cfg.di_pin = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
63  cfg.do_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
64 
66 #define SELECT_INVERT( pos , x ) ( ( pos == 0 ) ? x : ( 8 - x ) )
67 #define SELECT_ROTATE( pos , x , y ) ( ( pos == 0 ) ? ( 10 * y + x ) : ( 10 * x + y ) )
68 #define SELECT_INV_BYTE_POS( rotate, x ) ( ( ( rotate & 0x11 ) == 0x11 || ( rotate & 0x11 ) == 0x00 ) ? x : ( 9 - x ) )
69 
74 #define C10X10RGB_RETVAL uint8_t
75 
76 #define C10X10RGB_OK 0x00
77 #define C10X10RGB_INIT_ERROR 0xFF
78 
84 #define LOGIC_ONE 0x01
85 #define LOGIC_ZERO 0x00
86 
87 #define NUM_DATA_BITS 24
88 #define NUM_MATRIX_BYTE 100
89 #define NUX_MAX_CHAR 40
90 
91 #define COLOR_DEFAULT 0x00000000
92 #define BG_COLOR_DEFAULT 0x00000000
93 #define ROTATE_DEFAULT 0x00
94 
95 #define C10X10RGB_BYTE_ROTATE_H_UP 0x00
96 #define C10X10RGB_BYTE_ROTATE_H_DOWN 0x01
97 #define C10X10RGB_BYTE_ROTATE_V_RIGHT 0x11
98 #define C10X10RGB_BYTE_ROTATE_V_LEFT 0x10
99 
100 #define C10X10RGB_SCROLL_ROTATE_H 0x00
101 #define C10X10RGB_SCROLL_ROTATE_V 0x11
102 
103 #define C10X10RGB_CTRL_PIN_LOW 0x00
104 #define C10X10RGB_CTRL_PIN_HIGH 0x01
105 
111 #define C10X10RGB_COLOR_WHITE_100 0x002F2F2F
112 #define C10X10RGB_COLOR_WHITE_75 0x00232323
113 #define C10X10RGB_COLOR_WHITE_50 0x00181818
114 #define C10X10RGB_COLOR_WHITE_25 0x000C0C0C
115 
116 #define C10X10RGB_COLOR_RED_100 0x00002F00
117 #define C10X10RGB_COLOR_RED_75 0x00002300
118 #define C10X10RGB_COLOR_RED_50 0x00001800
119 #define C10X10RGB_COLOR_RED_25 0x00000C00
120 
121 #define C10X10RGB_COLOR_GREEN_100 0x002F0000
122 #define C10X10RGB_COLOR_GREEN_75 0x00230000
123 #define C10X10RGB_COLOR_GREEN_50 0x00180000
124 #define C10X10RGB_COLOR_GREEN_25 0x000C0000
125 
126 #define C10X10RGB_COLOR_BLUE_100 0x0000002F
127 #define C10X10RGB_COLOR_BLUE_75 0x00000023
128 #define C10X10RGB_COLOR_BLUE_50 0x00000018
129 #define C10X10RGB_COLOR_BLUE_25 0x0000000C
130 
131 #define C10X10RGB_COLOR_LIGHT_BLUE_100 0x002F002F
132 #define C10X10RGB_COLOR_LIGHT_BLUE_75 0x00230023
133 #define C10X10RGB_COLOR_LIGHT_BLUE_50 0x00180018
134 #define C10X10RGB_COLOR_LIGHT_BLUE_25 0x000C000C
135 
136 #define C10X10RGB_COLOR_YELLOW_100 0x002F2F00
137 #define C10X10RGB_COLOR_YELLOW_75 0x00232300
138 #define C10X10RGB_COLOR_YELLOW_50 0x00181800
139 #define C10X10RGB_COLOR_YELLOW_25 0x000C0C00
140 
141 #define C10X10RGB_COLOR_PURPLE_100 0x00002F2F
142 #define C10X10RGB_COLOR_PURPLE_75 0x00002323
143 #define C10X10RGB_COLOR_PURPLE_50 0x00001818
144 #define C10X10RGB_COLOR_PURPLE_25 0x00000C0C
145 
146 #define C10X10RGB_COLOR_OFF 0x00000000
147  // End group macro
150 // --------------------------------------------------------------- PUBLIC TYPES
156 typedef void ( *drv_logic_t ) ( void );
157 
161 typedef struct
162 {
163  char data_byte;
164  uint32_t color;
165  uint32_t bg_color;
166  uint8_t rotate;
167 
169 
173 typedef struct
174 {
175  uint8_t new_data;
176  uint8_t rotate;
177  uint8_t line_pos;
178  uint32_t color;
179  uint32_t bg_color;
180 
182 
186 typedef struct
187 {
188  c10x10rgb_byte_t buffer[ 200 ];
189  uint8_t len;
190 
192 
196 typedef struct
197 {
198  // Output pins
199  digital_out_t di_pin;
200 
201  // Input pins
202  digital_in_t do_pin;
203 
204  // Function pointers
207 
208  uint32_t matrix[ NUM_MATRIX_BYTE ];
209 
210 } c10x10rgb_t;
211 
215 typedef struct
216 {
217  // Additional gpio pins
218  pin_name_t di_pin;
219  pin_name_t do_pin;
220 
221  // Function pointers
224 
226  // End types group
228 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
229 
235 #ifdef __cplusplus
236 extern "C"{
237 #endif
238 
247 void c10x10rgb_cfg_setup ( c10x10rgb_cfg_t *cfg, drv_logic_t logic_zero, drv_logic_t logic_one );
248 
257 
266 void c10x10rgb_write_data ( c10x10rgb_t *ctx, uint32_t w_data );
267 
276 void c10x10rgb_fill_screen ( c10x10rgb_t *ctx, uint32_t screen_color );
277 
289 uint32_t c10x10rgb_make_color ( uint8_t red, uint8_t green, uint8_t blue, uint8_t brightness );
290 
299 void c10x10rgb_display_image ( c10x10rgb_t *ctx, const uint32_t *demo_image );
300 
310 
322  uint8_t len, uint16_t speed_ms );
323 
333 void c10x10rgb_demo_rainbow ( c10x10rgb_t *ctx, uint8_t brightness, uint16_t speed_ms );
334 
335 #ifdef __cplusplus
336 }
337 #endif
338 #endif // _C10X10RGB_H_
339  // End public_function group
342 
343 // ------------------------------------------------------------------------- END
drv_update_line_t
Update line object definition.
Definition: c10x10rgb.h:174
c10x10rgb_byte_t::bg_color
uint32_t bg_color
Definition: c10x10rgb.h:165
c10x10rgb_cfg_t::do_pin
pin_name_t do_pin
Definition: c10x10rgb.h:219
c10x10rgb_t::di_pin
digital_out_t di_pin
Definition: c10x10rgb.h:199
NUM_MATRIX_BYTE
#define NUM_MATRIX_BYTE
Definition: c10x10rgb.h:88
c10x10rgb_t::do_pin
digital_in_t do_pin
Definition: c10x10rgb.h:202
drv_scroll_buf_t::len
uint8_t len
Definition: c10x10rgb.h:189
c10x10rgb_cfg_t::di_pin
pin_name_t di_pin
Definition: c10x10rgb.h:218
drv_logic_t
void(* drv_logic_t)(void)
Definition: c10x10rgb.h:156
c10x10rgb_display_image
void c10x10rgb_display_image(c10x10rgb_t *ctx, const uint32_t *demo_image)
Display image function.
c10x10rgb_fill_screen
void c10x10rgb_fill_screen(c10x10rgb_t *ctx, uint32_t screen_color)
Fill screen function.
c10x10rgb_demo_rainbow
void c10x10rgb_demo_rainbow(c10x10rgb_t *ctx, uint8_t brightness, uint16_t speed_ms)
Demo rainbow function.
c10x10rgb_cfg_t::logic_one
drv_logic_t logic_one
Definition: c10x10rgb.h:223
drv_update_line_t::new_data
uint8_t new_data
Definition: c10x10rgb.h:175
c10x10rgb_display_byte
void c10x10rgb_display_byte(c10x10rgb_t *ctx, c10x10rgb_byte_t *data_obj)
Display byte function.
C10X10RGB_RETVAL
#define C10X10RGB_RETVAL
Definition: c10x10rgb.h:74
c10x10rgb_cfg_t
Click configuration structure definition.
Definition: c10x10rgb.h:216
c10x10rgb_init
C10X10RGB_RETVAL c10x10rgb_init(c10x10rgb_t *ctx, c10x10rgb_cfg_t *cfg)
Initialization function.
c10x10rgb_cfg_setup
void c10x10rgb_cfg_setup(c10x10rgb_cfg_t *cfg, drv_logic_t logic_zero, drv_logic_t logic_one)
Config Object Initialization function.
drv_update_line_t::line_pos
uint8_t line_pos
Definition: c10x10rgb.h:177
c10x10rgb_byte_t
Byte object definition.
Definition: c10x10rgb.h:162
c10x10rgb_write_data
void c10x10rgb_write_data(c10x10rgb_t *ctx, uint32_t w_data)
Write data function.
c10x10rgb_t::logic_one
drv_logic_t logic_one
Definition: c10x10rgb.h:206
c10x10rgb_t
Click ctx object definition.
Definition: c10x10rgb.h:197
c10x10rgb_byte_t::rotate
uint8_t rotate
Definition: c10x10rgb.h:166
drv_update_line_t::color
uint32_t color
Definition: c10x10rgb.h:178
c10x10rgb_cfg_t::logic_zero
drv_logic_t logic_zero
Definition: c10x10rgb.h:222
drv_update_line_t::bg_color
uint32_t bg_color
Definition: c10x10rgb.h:179
c10x10rgb_display_string
void c10x10rgb_display_string(c10x10rgb_t *ctx, c10x10rgb_byte_t *data_obj, uint8_t len, uint16_t speed_ms)
Display string function.
c10x10rgb_t::logic_zero
drv_logic_t logic_zero
Definition: c10x10rgb.h:205
c10x10rgb_byte_t::data_byte
char data_byte
Definition: c10x10rgb.h:163
c10x10rgb_make_color
uint32_t c10x10rgb_make_color(uint8_t red, uint8_t green, uint8_t blue, uint8_t brightness)
Make color function.
drv_update_line_t::rotate
uint8_t rotate
Definition: c10x10rgb.h:176
drv_scroll_buf_t
Scroll buffer object definition.
Definition: c10x10rgb.h:187
c10x10rgb_byte_t::color
uint32_t color
Definition: c10x10rgb.h:164