dotmatrixr  2.0.0.0
dotmatrixr.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 DOTMATRIXR_H
36 #define DOTMATRIXR_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_spi_master.h"
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
53 #define DOTMATRIXR_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
55  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
56  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
57  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
58  cfg.rs = MIKROBUS( mikrobus, MIKROBUS_AN ); \
59  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
60  cfg.bl = MIKROBUS( mikrobus, MIKROBUS_PWM )
61 
67 #define DOTMATRIXR_RETVAL uint8_t
68 
69 #define DOTMATRIXR_OK 0x00
70 #define DOTMATRIXR_INIT_ERROR 0xFF
71 
77 #define DOTMATRIXR_CTRL_BYTE_0_BRIGHTNESS_0 0x00
78 #define DOTMATRIXR_CTRL_BYTE_0_BRIGHTNESS_1p7 0x01
79 #define DOTMATRIXR_CTRL_BYTE_0_BRIGHTNESS_3p3 0x02
80 #define DOTMATRIXR_CTRL_BYTE_0_BRIGHTNESS_5 0x03
81 #define DOTMATRIXR_CTRL_BYTE_0_BRIGHTNESS_6p7 0x04
82 #define DOTMATRIXR_CTRL_BYTE_0_BRIGHTNESS_8p3 0x05
83 #define DOTMATRIXR_CTRL_BYTE_0_BRIGHTNESS_11p7 0x06
84 #define DOTMATRIXR_CTRL_BYTE_0_BRIGHTNESS_15 0x07
85 #define DOTMATRIXR_CTRL_BYTE_0_BRIGHTNESS_18 0x08
86 #define DOTMATRIXR_CTRL_BYTE_0_BRIGHTNESS_23 0x09
87 #define DOTMATRIXR_CTRL_BYTE_0_BRIGHTNESS_30 0x0A
88 #define DOTMATRIXR_CTRL_BYTE_0_BRIGHTNESS_37 0x0B
89 #define DOTMATRIXR_CTRL_BYTE_0_BRIGHTNESS_47 0x0C
90 #define DOTMATRIXR_CTRL_BYTE_0_BRIGHTNESS_60 0x0D
91 #define DOTMATRIXR_CTRL_BYTE_0_BRIGHTNESS_80 0x0E
92 #define DOTMATRIXR_CTRL_BYTE_0_BRIGHTNESS_100 0x0F
93 #define DOTMATRIXR_CTRL_BYTE_0_PIXEL_PEAK_CURRENT_4mA 0x20
94 #define DOTMATRIXR_CTRL_BYTE_0_PIXEL_PEAK_CURRENT_6p4mA 0x10
95 #define DOTMATRIXR_CTRL_BYTE_0_PIXEL_PEAK_CURRENT_9p3mA 0x00
96 #define DOTMATRIXR_CTRL_BYTE_0_PIXEL_PEAK_CURRENT_12p8mA 0x30
97 #define DOTMATRIXR_CTRL_BYTE_0_MODE_SLEEP 0x00
98 #define DOTMATRIXR_CTRL_BYTE_0_MODE_NORMAL 0x40
99 
105 #define DOTMATRIXR_CTRL_BYTE_1_OSC_PRESCALER_1 0x80
106 #define DOTMATRIXR_CTRL_BYTE_1_OSC_PRESCALER_8 0x82
107 #define DOTMATRIXR_CTRL_BYTE_1_DOUT_D7 0x80
108 #define DOTMATRIXR_CTRL_BYTE_1_DOUT_DIN 0x81
109  // End group macro
112 // --------------------------------------------------------------- PUBLIC TYPES
121 typedef struct
122 {
123  // Output pins
124 
125  digital_out_t cs;
126  digital_out_t rs;
127  digital_out_t rst;
128  digital_out_t bl;
129 
130  // Modules
131 
132  spi_master_t spi;
133  pin_name_t chip_select;
134 
135 } dotmatrixr_t;
136 
140 typedef struct
141 {
142  // Communication gpio pins
143 
144  pin_name_t miso;
145  pin_name_t mosi;
146  pin_name_t sck;
147  pin_name_t cs;
148 
149  // Additional gpio pins
150 
151  pin_name_t rs;
152  pin_name_t rst;
153  pin_name_t bl;
154 
155  // static variable
156 
157  uint32_t spi_speed;
158  spi_master_mode_t spi_mode;
159  spi_master_chip_select_polarity_t cs_polarity;
160 
162  // End types group
164 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
165 
170 #ifdef __cplusplus
171 extern "C"{
172 #endif
173 
183 
193 
205 void dotmatrixr_generic_transfer ( dotmatrixr_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len );
206 
213 void dotmatrixr_set_bl_pin_state ( dotmatrixr_t *ctx, uint8_t state );
214 
221 void dotmatrixr_set_rs_pin_state ( dotmatrixr_t *ctx, uint8_t state );
222 
229 void dotmatrixr_set_rst_pin_state ( dotmatrixr_t *ctx, uint8_t state );
230 
237 
244 void dotmatrixr_ctrl_0 ( dotmatrixr_t *ctx, uint8_t ctrl_byte );
245 
252 void dotmatrixr_ctrl_1 ( dotmatrixr_t *ctx, uint8_t ctrl_byte );
253 
260 void dotmatrixr_write_ascii ( dotmatrixr_t *ctx, char *ascii_data );
261 
262 #ifdef __cplusplus
263 }
264 #endif
265 #endif // _DOTMATRIXR_H_
266  // End public_function group
269 
270 // ------------------------------------------------------------------------- END
dotmatrixr_cfg_t::miso
pin_name_t miso
Definition: dotmatrixr.h:144
dotmatrixr_write_ascii
void dotmatrixr_write_ascii(dotmatrixr_t *ctx, char *ascii_data)
Sets display to written value.
dotmatrixr_t::rs
digital_out_t rs
Definition: dotmatrixr.h:126
dotmatrixr_cfg_t::sck
pin_name_t sck
Definition: dotmatrixr.h:146
dotmatrixr_cfg_t::spi_speed
uint32_t spi_speed
Definition: dotmatrixr.h:157
dotmatrixr_t
Click ctx object definition.
Definition: dotmatrixr.h:122
dotmatrixr_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: dotmatrixr.h:159
dotmatrixr_t::chip_select
pin_name_t chip_select
Definition: dotmatrixr.h:133
dotmatrixr_t::spi
spi_master_t spi
Definition: dotmatrixr.h:132
dotmatrixr_cfg_t::rs
pin_name_t rs
Definition: dotmatrixr.h:151
dotmatrixr_init
DOTMATRIXR_RETVAL dotmatrixr_init(dotmatrixr_t *ctx, dotmatrixr_cfg_t *cfg)
Initialization function.
dotmatrixr_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: dotmatrixr.h:158
dotmatrixr_ctrl_1
void dotmatrixr_ctrl_1(dotmatrixr_t *ctx, uint8_t ctrl_byte)
Function for writing control word 1.
dotmatrixr_set_rs_pin_state
void dotmatrixr_set_rs_pin_state(dotmatrixr_t *ctx, uint8_t state)
Sets RS pin to high or low state.
dotmatrixr_generic_transfer
void dotmatrixr_generic_transfer(dotmatrixr_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
Generic transfer function.
dotmatrixr_cfg_setup
void dotmatrixr_cfg_setup(dotmatrixr_cfg_t *cfg)
Config Object Initialization function.
dotmatrixr_restart
void dotmatrixr_restart(dotmatrixr_t *ctx)
Restart device.
dotmatrixr_set_bl_pin_state
void dotmatrixr_set_bl_pin_state(dotmatrixr_t *ctx, uint8_t state)
Sets BL pin to high or low state.
dotmatrixr_t::cs
digital_out_t cs
Definition: dotmatrixr.h:125
dotmatrixr_cfg_t::cs
pin_name_t cs
Definition: dotmatrixr.h:147
dotmatrixr_set_rst_pin_state
void dotmatrixr_set_rst_pin_state(dotmatrixr_t *ctx, uint8_t state)
Sets RST pin to high or low state.
dotmatrixr_cfg_t::bl
pin_name_t bl
Definition: dotmatrixr.h:153
dotmatrixr_cfg_t::rst
pin_name_t rst
Definition: dotmatrixr.h:152
DOTMATRIXR_RETVAL
#define DOTMATRIXR_RETVAL
Definition: dotmatrixr.h:67
dotmatrixr_t::rst
digital_out_t rst
Definition: dotmatrixr.h:127
dotmatrixr_cfg_t
Click configuration structure definition.
Definition: dotmatrixr.h:141
dotmatrixr_cfg_t::mosi
pin_name_t mosi
Definition: dotmatrixr.h:145
dotmatrixr_ctrl_0
void dotmatrixr_ctrl_0(dotmatrixr_t *ctx, uint8_t ctrl_byte)
Function for writing control word 0.
dotmatrixr_t::bl
digital_out_t bl
Definition: dotmatrixr.h:128