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 "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 #include "drv_spi_master.h"
51 
52 
53 // -------------------------------------------------------------- PUBLIC MACROS
64 #define MATRIXRGB_MAP_MIKROBUS( cfg, mikrobus ) \
65  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
66  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
67  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
68  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
69  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
70  cfg.slp = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
71  cfg.rdy = MIKROBUS( mikrobus, MIKROBUS_INT );
72 
78 #define MATRIXRGB_RETVAL uint8_t
79 
80 #define MATRIXRGB_OK 0x00
81 #define MATRIXRGB_INIT_ERROR 0xFF
82 
88 #define MATRIXRGB_FONT_HORIZONTAL 0
89 #define MATRIXRGB_FONT_VERTICAL 1
90 #define MATRIXRGB_FONT_VERTICAL_COLUMN 2
91 
97 #define MATRIXRGB_PATTERN_1_MAP_5MM 0x00
98 #define MATRIXRGB_PATTERN_1_MAP_6MM 0x01
99 #define MATRIXRGB_PATTERN_2H_MAP_5MM 0x02
100 #define MATRIXRGB_PATTERN_2H_MAP_6MM 0x03
101 #define MATRIXRGB_PATTERN_2V_MAP_5MM 0x04
102 #define MATRIXRGB_PATTERN_2V_MAP_6MM 0x05
103 #define MATRIXRGB_PATTERN_3H_MAP_5MM 0x06
104 #define MATRIXRGB_PATTERN_3H_MAP_6MM 0x07
105 #define MATRIXRGB_PATTERN_3V_MAP_5MM 0x08
106 #define MATRIXRGB_PATTERN_3V_MAP_6MM 0x09
107 #define MATRIXRGB_PATTERN_4H_MAP_5MM 0x0A
108 #define MATRIXRGB_PATTERN_4H_MAP_6MM 0x0B
109 #define MATRIXRGB_PATTERN_4V_MAP_5MM 0x0C
110 #define MATRIXRGB_PATTERN_4V_MAP_6MM 0x0D
111 #define MATRIXRGB_PATTERN_4S_MAP_5MM 0x0E
112 #define MATRIXRGB_PATTERN_4S_MAP_6MM 0x0F
113  // End group macro
116 // --------------------------------------------------------------- PUBLIC TYPES
126 typedef struct
127 {
128  uint8_t *p_font;
129  uint16_t color;
130  uint8_t orientation;
131  uint16_t first_char;
132  uint16_t last_char;
133  uint16_t height;
134 
136 
137 typedef struct
138 {
139  uint16_t pixel_width;
140  uint16_t pixel_height;
141  uint16_t ram_size;
142 
144 
145 typedef struct
146 {
147  uint16_t x_cord;
148  uint16_t y_cord;
149 
151 
152 typedef struct
153 {
154  // Output pins
155 
156  digital_out_t rst;
157  digital_out_t slp;
158  digital_out_t cs;
159 
160  // Input pins
161 
162  digital_in_t rdy;
163 
164  // Modules
165 
166  spi_master_t spi;
171  pin_name_t chip_select;
172 
173 } matrixrgb_t;
174 
178 typedef struct
179 {
180  // Communication gpio pins
181 
182  pin_name_t miso;
183  pin_name_t mosi;
184  pin_name_t sck;
185  pin_name_t cs;
186 
187  // Additional gpio pins
188 
189  pin_name_t rst;
190  pin_name_t slp;
191  pin_name_t rdy;
192 
193  // static variable
194 
195  uint32_t spi_speed;
196  uint8_t spi_mode;
197  spi_master_chip_select_polarity_t cs_polarity;
199 
201  // End types group
203 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
204 
209 #ifdef __cplusplus
210 extern "C"{
211 #endif
212 
222 
231 
241 void matrixrgb_pattern_settings ( matrixrgb_t *ctx, uint8_t pattern_type, uint16_t pattern_delay_us );
242 
255 (
256  matrixrgb_t *ctx,
257  uint8_t *wr_buf,
258  uint16_t wr_len,
259  uint8_t *rd_buf,
260  uint16_t rd_len
261 );
262 
271 
280 uint8_t matrixrgb_device_settings ( matrixrgb_t *ctx, uint8_t pattern_id );
281 
289 void matrixrgb_set_power ( matrixrgb_t *ctx, uint8_t power_state );
290 
301 void matrixrgb_set_brightness ( matrixrgb_t *ctx, uint8_t brightness );
302 
317 uint8_t matrixrgb_write_pixel ( matrixrgb_t *ctx, uint16_t x, uint16_t y, uint16_t color );
318 
326 void matrixrgb_fill_screen ( matrixrgb_t *ctx, uint16_t color );
327 
337 void matrixrgb_draw_image ( matrixrgb_t *ctx, const uint8_t *device_img );
338 
348 
366 uint8_t matrixrgb_write_text ( matrixrgb_t *ctx, char *text, uint16_t x, uint16_t y );
367 
368 
369 #ifdef __cplusplus
370 }
371 #endif
372 #endif // _MATRIXRGB_H_
373  // End public_function group
376 
377 // ------------------------------------------------------------------------- END
matrixrgb_t::slp
digital_out_t slp
Definition: matrixrgb.h:157
matrixrgb_pixel_t::pixel_width
uint16_t pixel_width
Definition: matrixrgb.h:139
matrixrgb_cfg_t::mosi
pin_name_t mosi
Definition: matrixrgb.h:183
matrixrgb_t::device_pixel
matrixrgb_pixel_t device_pixel
Definition: matrixrgb.h:168
matrixrgb_t
Definition: matrixrgb.h:153
MATRIXRGB_RETVAL
#define MATRIXRGB_RETVAL
Definition: matrixrgb.h:78
matrixrgb_cord_t::y_cord
uint16_t y_cord
Definition: matrixrgb.h:148
matrixrgb_font_t::color
uint16_t color
Definition: matrixrgb.h:129
matrixrgb_write_pixel
uint8_t matrixrgb_write_pixel(matrixrgb_t *ctx, uint16_t x, uint16_t y, uint16_t color)
Write Pixel.
matrixrgb_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: matrixrgb.h:197
matrixrgb_t::spi
spi_master_t spi
Definition: matrixrgb.h:166
matrixrgb_cfg_t::sck
pin_name_t sck
Definition: matrixrgb.h:184
matrixrgb_t::cs
digital_out_t cs
Definition: matrixrgb.h:158
matrixrgb_cfg_t::spi_speed
uint32_t spi_speed
Definition: matrixrgb.h:195
matrixrgb_draw_image
void matrixrgb_draw_image(matrixrgb_t *ctx, const uint8_t *device_img)
Draw Image on Panel.
matrixrgb_pattern_settings
void matrixrgb_pattern_settings(matrixrgb_t *ctx, uint8_t pattern_type, uint16_t pattern_delay_us)
Click Pattern settings ( Default Configuration ) function.
matrixrgb_device_reset
void matrixrgb_device_reset(matrixrgb_t *ctx)
Hard reset of the Matrix RGB click.
matrixrgb_t::rdy
digital_in_t rdy
Definition: matrixrgb.h:162
matrixrgb_t::chip_select
pin_name_t chip_select
Definition: matrixrgb.h:171
matrixrgb_set_font
void matrixrgb_set_font(matrixrgb_t *ctx, matrixrgb_font_t *font_cfg)
Set Font Function.
matrixrgb_set_brightness
void matrixrgb_set_brightness(matrixrgb_t *ctx, uint8_t brightness)
Set Brightness.
matrixrgb_set_power
void matrixrgb_set_power(matrixrgb_t *ctx, uint8_t power_state)
Set Power.
matrixrgb_init
MATRIXRGB_RETVAL matrixrgb_init(matrixrgb_t *ctx, matrixrgb_cfg_t *cfg)
Initialization function.
matrixrgb_cfg_t::spi_mode
uint8_t spi_mode
Definition: matrixrgb.h:196
matrixrgb_cfg_t::cs
pin_name_t cs
Definition: matrixrgb.h:185
matrixrgb_cfg_t::miso
pin_name_t miso
Definition: matrixrgb.h:182
matrixrgb_t::device_font_cord
matrixrgb_cord_t device_font_cord
Definition: matrixrgb.h:169
matrixrgb_cfg_t::dev_font
matrixrgb_font_t dev_font
Definition: matrixrgb.h:198
matrixrgb_font_t::last_char
uint16_t last_char
Definition: matrixrgb.h:132
matrixrgb_cord_t::x_cord
uint16_t x_cord
Definition: matrixrgb.h:147
matrixrgb_cfg_t::rdy
pin_name_t rdy
Definition: matrixrgb.h:191
matrixrgb_font_t::orientation
uint8_t orientation
Definition: matrixrgb.h:130
matrixrgb_t::device_pattern_delay
uint16_t device_pattern_delay
Definition: matrixrgb.h:170
matrixrgb_cord_t
Definition: matrixrgb.h:146
matrixrgb_pixel_t
Definition: matrixrgb.h:138
matrixrgb_font_t::height
uint16_t height
Definition: matrixrgb.h:133
matrixrgb_cfg_t
Click configuration structure definition.
Definition: matrixrgb.h:179
matrixrgb_pixel_t::pixel_height
uint16_t pixel_height
Definition: matrixrgb.h:140
matrixrgb_device_settings
uint8_t matrixrgb_device_settings(matrixrgb_t *ctx, uint8_t pattern_id)
Firmware Initialization.
matrixrgb_write_text
uint8_t matrixrgb_write_text(matrixrgb_t *ctx, char *text, uint16_t x, uint16_t y)
Writes Text.
matrixrgb_pixel_t::ram_size
uint16_t ram_size
Definition: matrixrgb.h:141
matrixrgb_font_t
Click ctx object definition.
Definition: matrixrgb.h:127
matrixrgb_fill_screen
void matrixrgb_fill_screen(matrixrgb_t *ctx, uint16_t color)
Fill Screen.
matrixrgb_t::rst
digital_out_t rst
Definition: matrixrgb.h:156
matrixrgb_generic_transfer
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.
matrixrgb_cfg_setup
void matrixrgb_cfg_setup(matrixrgb_cfg_t *cfg)
Config Object Initialization function.
matrixrgb_font_t::p_font
uint8_t * p_font
Definition: matrixrgb.h:128
matrixrgb_t::device_font
matrixrgb_font_t device_font
Definition: matrixrgb.h:167
matrixrgb_font_t::first_char
uint16_t first_char
Definition: matrixrgb.h:131
matrixrgb_cfg_t::slp
pin_name_t slp
Definition: matrixrgb.h:190
matrixrgb_cfg_t::rst
pin_name_t rst
Definition: matrixrgb.h:189