matrixrgb  2.0.0.0
matrixrgb.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 MATRIXRGB_H
36 #define MATRIXRGB_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_spi_master.h"
41 
42 
43 // -------------------------------------------------------------- PUBLIC MACROS
54 #define MATRIXRGB_MAP_MIKROBUS( cfg, mikrobus ) \
55  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
56  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
57  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
58  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
59  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
60  cfg.slp = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
61  cfg.rdy = MIKROBUS( mikrobus, MIKROBUS_INT );
62 
68 #define MATRIXRGB_RETVAL uint8_t
69 
70 #define MATRIXRGB_OK 0x00
71 #define MATRIXRGB_INIT_ERROR 0xFF
72 
78 #define MATRIXRGB_FONT_HORIZONTAL 0
79 #define MATRIXRGB_FONT_VERTICAL 1
80 #define MATRIXRGB_FONT_VERTICAL_COLUMN 2
81 
87 #define MATRIXRGB_PATTERN_1_MAP_5MM 0x00
88 #define MATRIXRGB_PATTERN_1_MAP_6MM 0x01
89 #define MATRIXRGB_PATTERN_2H_MAP_5MM 0x02
90 #define MATRIXRGB_PATTERN_2H_MAP_6MM 0x03
91 #define MATRIXRGB_PATTERN_2V_MAP_5MM 0x04
92 #define MATRIXRGB_PATTERN_2V_MAP_6MM 0x05
93 #define MATRIXRGB_PATTERN_3H_MAP_5MM 0x06
94 #define MATRIXRGB_PATTERN_3H_MAP_6MM 0x07
95 #define MATRIXRGB_PATTERN_3V_MAP_5MM 0x08
96 #define MATRIXRGB_PATTERN_3V_MAP_6MM 0x09
97 #define MATRIXRGB_PATTERN_4H_MAP_5MM 0x0A
98 #define MATRIXRGB_PATTERN_4H_MAP_6MM 0x0B
99 #define MATRIXRGB_PATTERN_4V_MAP_5MM 0x0C
100 #define MATRIXRGB_PATTERN_4V_MAP_6MM 0x0D
101 #define MATRIXRGB_PATTERN_4S_MAP_5MM 0x0E
102 #define MATRIXRGB_PATTERN_4S_MAP_6MM 0x0F
103  // End group macro
106 // --------------------------------------------------------------- PUBLIC TYPES
116 typedef struct
117 {
118  uint8_t *p_font;
119  uint16_t color;
120  uint8_t orientation;
121  uint16_t first_char;
122  uint16_t last_char;
123  uint16_t height;
124 
126 
127 typedef struct
128 {
129  uint16_t pixel_width;
130  uint16_t pixel_height;
131  uint16_t ram_size;
132 
134 
135 typedef struct
136 {
137  uint16_t x_cord;
138  uint16_t y_cord;
139 
141 
142 typedef struct
143 {
144  // Output pins
145 
146  digital_out_t rst;
147  digital_out_t slp;
148  digital_out_t cs;
149 
150  // Input pins
151 
152  digital_in_t rdy;
153 
154  // Modules
155 
156  spi_master_t spi;
161  pin_name_t chip_select;
162 
163 } matrixrgb_t;
164 
168 typedef struct
169 {
170  // Communication gpio pins
171 
172  pin_name_t miso;
173  pin_name_t mosi;
174  pin_name_t sck;
175  pin_name_t cs;
176 
177  // Additional gpio pins
178 
179  pin_name_t rst;
180  pin_name_t slp;
181  pin_name_t rdy;
182 
183  // static variable
184 
185  uint32_t spi_speed;
186  uint8_t spi_mode;
187  spi_master_chip_select_polarity_t cs_polarity;
189 
191  // End types group
193 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
194 
199 #ifdef __cplusplus
200 extern "C"{
201 #endif
202 
212 
221 
231 void matrixrgb_pattern_settings ( matrixrgb_t *ctx, uint8_t pattern_type, uint16_t pattern_delay_us );
232 
245 (
246  matrixrgb_t *ctx,
247  uint8_t *wr_buf,
248  uint16_t wr_len,
249  uint8_t *rd_buf,
250  uint16_t rd_len
251 );
252 
260 void matrixrgb_device_reset ( matrixrgb_t *ctx );
261 
270 uint8_t matrixrgb_device_settings ( matrixrgb_t *ctx, uint8_t pattern_id );
271 
279 void matrixrgb_set_power ( matrixrgb_t *ctx, uint8_t power_state );
280 
291 void matrixrgb_set_brightness ( matrixrgb_t *ctx, uint8_t brightness );
292 
307 uint8_t matrixrgb_write_pixel ( matrixrgb_t *ctx, uint16_t x, uint16_t y, uint16_t color );
308 
316 void matrixrgb_fill_screen ( matrixrgb_t *ctx, uint16_t color );
317 
327 void matrixrgb_draw_image ( matrixrgb_t *ctx, uint8_t *device_img );
328 
337 void matrixrgb_set_font ( matrixrgb_t *ctx, matrixrgb_font_t *font_cfg );
338 
356 uint8_t matrixrgb_write_text ( matrixrgb_t *ctx, char *text, uint16_t x, uint16_t y );
357 
358 
359 #ifdef __cplusplus
360 }
361 #endif
362 #endif // _MATRIXRGB_H_
363  // End public_function group
366 
367 // ------------------------------------------------------------------------- END
void matrixrgb_device_reset(matrixrgb_t *ctx)
Hard reset of the Matrix RGB click.
spi_master_t spi
Definition: matrixrgb.h:156
void matrixrgb_generic_transfer(matrixrgb_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
Generic transfer function.
pin_name_t miso
Definition: matrixrgb.h:172
pin_name_t chip_select
Definition: matrixrgb.h:161
pin_name_t cs
Definition: matrixrgb.h:175
uint16_t y_cord
Definition: matrixrgb.h:138
uint16_t height
Definition: matrixrgb.h:123
Definition: matrixrgb.h:127
uint16_t x_cord
Definition: matrixrgb.h:137
uint8_t matrixrgb_write_pixel(matrixrgb_t *ctx, uint16_t x, uint16_t y, uint16_t color)
Write Pixel.
uint16_t last_char
Definition: matrixrgb.h:122
spi_master_chip_select_polarity_t cs_polarity
Definition: matrixrgb.h:187
uint16_t pixel_height
Definition: matrixrgb.h:130
uint16_t pixel_width
Definition: matrixrgb.h:129
Definition: matrixrgb.h:135
void matrixrgb_set_power(matrixrgb_t *ctx, uint8_t power_state)
Set Power.
matrixrgb_font_t dev_font
Definition: matrixrgb.h:188
uint8_t spi_mode
Definition: matrixrgb.h:186
pin_name_t rst
Definition: matrixrgb.h:179
digital_out_t rst
Definition: matrixrgb.h:146
Click configuration structure definition.
Definition: matrixrgb.h:168
uint8_t matrixrgb_device_settings(matrixrgb_t *ctx, uint8_t pattern_id)
Firmware Initialization.
Definition: matrixrgb.h:142
uint16_t device_pattern_delay
Definition: matrixrgb.h:160
pin_name_t mosi
Definition: matrixrgb.h:173
uint32_t spi_speed
Definition: matrixrgb.h:185
#define MATRIXRGB_RETVAL
Definition: matrixrgb.h:68
uint8_t * p_font
Definition: matrixrgb.h:118
uint16_t first_char
Definition: matrixrgb.h:121
digital_out_t slp
Definition: matrixrgb.h:147
void matrixrgb_cfg_setup(matrixrgb_cfg_t *cfg)
Config Object Initialization function.
void matrixrgb_set_font(matrixrgb_t *ctx, matrixrgb_font_t *font_cfg)
Set Font Function.
pin_name_t slp
Definition: matrixrgb.h:180
Click ctx object definition.
Definition: matrixrgb.h:116
uint8_t matrixrgb_write_text(matrixrgb_t *ctx, char *text, uint16_t x, uint16_t y)
Writes Text.
void matrixrgb_pattern_settings(matrixrgb_t *ctx, uint8_t pattern_type, uint16_t pattern_delay_us)
Click Pattern settings ( Default Configuration ) function.
pin_name_t sck
Definition: matrixrgb.h:174
digital_in_t rdy
Definition: matrixrgb.h:152
void matrixrgb_draw_image(matrixrgb_t *ctx, uint8_t *device_img)
Draw Image on Panel.
pin_name_t rdy
Definition: matrixrgb.h:181
uint16_t color
Definition: matrixrgb.h:119
void matrixrgb_set_brightness(matrixrgb_t *ctx, uint8_t brightness)
Set Brightness.
MATRIXRGB_RETVAL matrixrgb_init(matrixrgb_t *ctx, matrixrgb_cfg_t *cfg)
Initialization function.
matrixrgb_font_t device_font
Definition: matrixrgb.h:157
uint8_t orientation
Definition: matrixrgb.h:120
digital_out_t cs
Definition: matrixrgb.h:148
uint16_t ram_size
Definition: matrixrgb.h:131
matrixrgb_cord_t device_font_cord
Definition: matrixrgb.h:159
matrixrgb_pixel_t device_pixel
Definition: matrixrgb.h:158
void matrixrgb_fill_screen(matrixrgb_t *ctx, uint16_t color)
Fill Screen.