eink290inch  2.0.0.0
eink290inch.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 EINK290INCH_H
36 #define EINK290INCH_H
37 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 #include "drv_spi_master.h"
55 
56 // -------------------------------------------------------------- PUBLIC MACROS
66 #define EINK290INCH_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
68  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
69  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
70  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
71  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
72  cfg.dc = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
73  cfg.bsy = MIKROBUS( mikrobus, MIKROBUS_INT )
74 
80 #define EINK290INCH_OK 0
81 #define EINK290INCH_ERROR -1
82 
88 #define EINK290INCH_DISPLAY_WIDTH 128
89 #define EINK290INCH_DISPLAY_HEIGHT 296
90 #define EINK290INCH_DISPLAY_RESOLUTIONS 4736
91 
97 #define EINK290INCH_SCREEN_COLOR_WHITE 0xFF
98 #define EINK290INCH_SCREEN_COLOR_BLACK 0x00
99 #define EINK290INCH_SCREEN_COLOR_LIGHT_GREY 0xAA
100 #define EINK290INCH_SCREEN_COLOR_DARK_GREY 0x55
101 
102 #define EINK290INCH_FO_HORIZONTAL 0x00
103 #define EINK290INCH_FO_VERTICAL 0x01
104 #define EINK290INCH_FO_VERTICAL_COLUMN 0x02
105 
111 #define EINK290INCH_CMD_DRIVER_OUTPUT_CONTROL 0x01
112 #define EINK290INCH_CMD_BOOSTER_SOFT_START_CONTROL 0x0C
113 #define EINK290INCH_CMD_GATE_SCAN_START_POSITION 0x0F
114 #define EINK290INCH_CMD_DEEP_SLEEP_MODE 0x10
115 #define EINK290INCH_CMD_DATA_ENTRY_MODE_SETTING 0x11
116 #define EINK290INCH_CMD_SW_RESET 0x12
117 #define EINK290INCH_CMD_TEMPERATURE_SENSOR_CONTROL 0x1A
118 #define EINK290INCH_CMD_MASTER_ACTIVATION 0x20
119 #define EINK290INCH_CMD_DISPLAY_UPDATE_CONTROL_1 0x21
120 #define EINK290INCH_CMD_DISPLAY_UPDATE_CONTROL_2 0x22
121 #define EINK290INCH_CMD_WRITE_RAM 0x24
122 #define EINK290INCH_CMD_WRITE_VCOM_REGISTER 0x2C
123 #define EINK290INCH_CMD_WRITE_LUT_REGISTER 0x32
124 #define EINK290INCH_CMD_SET_DUMMY_LINE_PERIOD 0x3A
125 #define EINK290INCH_CMD_SET_GATE_TIME 0x3B
126 #define EINK290INCH_CMD_BORDER_WAVEFORM_CONTROL 0x3C
127 #define EINK290INCH_CMD_SET_RAM_X_ADDRESS_START_END_POSITION 0x44
128 #define EINK290INCH_CMD_SET_RAM_Y_ADDRESS_START_END_POSITION 0x45
129 #define EINK290INCH_CMD_SET_RAM_X_ADDRESS_COUNTER 0x4E
130 #define EINK290INCH_CMD_SET_RAM_Y_ADDRESS_COUNTER 0x4F
131 #define EINK290INCH_CMD_TERMINATE_FRAME_READ_WRITE 0xFF
132  // End group macro
135 // --------------------------------------------------------------- PUBLIC TYPES
141 typedef struct
142 {
143  const uint8_t *p_font;
144  uint16_t color;
145  uint8_t orientation;
146  uint16_t first_char;
147  uint16_t last_char;
148  uint16_t height;
149 
151 
152 typedef struct
153 {
154  uint16_t x;
155  uint16_t y;
156 
158 
159 typedef struct
160 {
161  uint16_t x_start;
162  uint16_t y_start;
163  uint16_t x_end;
164  uint16_t y_end;
165 
167 
168 typedef struct
169 {
170  uint8_t n_char;
171  uint16_t text_x;
172  uint16_t text_y;
173 
175 
179 typedef struct
180 {
181  // Output pins
182  digital_out_t cs;
183  digital_out_t rst;
184  digital_out_t dc;
185 
186  // Input pins
187  digital_in_t bsy;
188 
189  // Modules
190  spi_master_t spi;
191  pin_name_t chip_select;
192 
193 #ifndef IMAGE_MODE_ONLY
194  uint8_t frame[ 4736 ];
195 #endif
196 
199 
200 } eink290inch_t;
201 
205 typedef struct
206 {
207  // Communication gpio pins
208  pin_name_t miso;
209  pin_name_t mosi;
210  pin_name_t sck;
211  pin_name_t cs;
212 
213  // Additional gpio pins
214  pin_name_t rst;
215  pin_name_t dc;
216  pin_name_t bsy;
217 
218  // static variable
219  uint32_t spi_speed;
220  spi_master_mode_t spi_mode;
221  spi_master_chip_select_polarity_t cs_polarity;
222 
224  // End types group
226 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
227 
232 #ifdef __cplusplus
233 extern "C"{
234 #endif
235 
245 
255 
262 void eink290inch_send_cmd ( eink290inch_t *ctx, uint8_t command );
263 
270 void eink290inch_send_data ( eink290inch_t *ctx, uint8_t c_data );
271 
278 
285 
295 void eink290inch_set_lut ( eink290inch_t *ctx, const uint8_t *lut, uint8_t lut_cnt );
296 
303 
311 void eink290inch_set_mem_pointer ( eink290inch_t *ctx, uint16_t x, uint16_t y );
312 
320 
327 
340 void eink290inch_fill_screen ( eink290inch_t *ctx, uint8_t color );
341 
351 void eink290inch_display_image ( eink290inch_t *ctx, const uint8_t* image_buffer );
352 
361 void eink290inch_text ( eink290inch_t *ctx, uint8_t *text, eink290inch_set_text_t *text_set );
362 
370 
371 #ifdef __cplusplus
372 }
373 #endif
374 #endif // _EINK290INCH_H_
375  // End public_function group
378 
379 // ------------------------------------------------------------------------- END
eink290inch_set_font
void eink290inch_set_font(eink290inch_t *ctx, eink290inch_font_t *cfg_font)
Set font function.
eink290inch_font_t::p_font
const uint8_t * p_font
Definition: eink290inch.h:143
eink290inch_cfg_t::cs
pin_name_t cs
Definition: eink290inch.h:211
eink290inch_fill_screen
void eink290inch_fill_screen(eink290inch_t *ctx, uint8_t color)
Function that fills the screen.
eink290inch_cfg_t::rst
pin_name_t rst
Definition: eink290inch.h:214
eink290inch_cfg_t::bsy
pin_name_t bsy
Definition: eink290inch.h:216
eink290inch_font_t::first_char
uint16_t first_char
Definition: eink290inch.h:146
eink290inch_t
Click ctx object definition.
Definition: eink290inch.h:180
eink290inch_set_mem_pointer
void eink290inch_set_mem_pointer(eink290inch_t *ctx, uint16_t x, uint16_t y)
Function for setting pointers in memory.
eink290inch_t::bsy
digital_in_t bsy
Definition: eink290inch.h:187
eink290inch_cfg_t::spi_speed
uint32_t spi_speed
Definition: eink290inch.h:219
eink290inch_update_display
void eink290inch_update_display(eink290inch_t *ctx)
Functions for update dispaly.
eink290inch_set_lut
void eink290inch_set_lut(eink290inch_t *ctx, const uint8_t *lut, uint8_t lut_cnt)
Set LUT table.
eink290inch_t::dc
digital_out_t dc
Definition: eink290inch.h:184
eink290inch_text
void eink290inch_text(eink290inch_t *ctx, uint8_t *text, eink290inch_set_text_t *text_set)
Function for draw text on the screen.
eink290inch_cord_t::y
uint16_t y
Definition: eink290inch.h:155
eink290inch_t::dev_font
eink290inch_font_t dev_font
Definition: eink290inch.h:197
eink290inch_sleep_mode
void eink290inch_sleep_mode(eink290inch_t *ctx)
Function for go to sleep mode.
eink290inch_send_cmd
void eink290inch_send_cmd(eink290inch_t *ctx, uint8_t command)
Function for sending a command.
eink290inch_font_t::orientation
uint8_t orientation
Definition: eink290inch.h:145
eink290inch_cfg_setup
void eink290inch_cfg_setup(eink290inch_cfg_t *cfg)
Config Object Initialization function.
eink290inch_set_text_t
Definition: eink290inch.h:169
eink290inch_cfg_t::sck
pin_name_t sck
Definition: eink290inch.h:210
eink290inch_t::chip_select
pin_name_t chip_select
Definition: eink290inch.h:191
eink290inch_init
err_t eink290inch_init(eink290inch_t *ctx, eink290inch_cfg_t *cfg)
Initialization function.
eink290inch_t::spi
spi_master_t spi
Definition: eink290inch.h:190
eink290inch_xy_t::y_start
uint16_t y_start
Definition: eink290inch.h:162
eink290inch_cord_t::x
uint16_t x
Definition: eink290inch.h:154
eink290inch_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: eink290inch.h:221
eink290inch_set_text_t::text_y
uint16_t text_y
Definition: eink290inch.h:172
eink290inch_cfg_t::dc
pin_name_t dc
Definition: eink290inch.h:215
eink290inch_xy_t::y_end
uint16_t y_end
Definition: eink290inch.h:164
eink290inch_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: eink290inch.h:220
eink290inch_font_t::last_char
uint16_t last_char
Definition: eink290inch.h:147
eink290inch_t::cs
digital_out_t cs
Definition: eink290inch.h:182
eink290inch_font_t::height
uint16_t height
Definition: eink290inch.h:148
eink290inch_cfg_t::mosi
pin_name_t mosi
Definition: eink290inch.h:209
eink290inch_set_text_t::n_char
uint8_t n_char
Definition: eink290inch.h:170
eink290inch_reset
void eink290inch_reset(eink290inch_t *ctx)
Function for reset chip.
eink290inch_xy_t::x_end
uint16_t x_end
Definition: eink290inch.h:163
eink290inch_set_text_t::text_x
uint16_t text_x
Definition: eink290inch.h:171
eink290inch_font_t
Definition: eink290inch.h:142
eink290inch_font_t::color
uint16_t color
Definition: eink290inch.h:144
eink290inch_start_config
void eink290inch_start_config(eink290inch_t *ctx)
Start configuration display.
eink290inch_set_mem_area
void eink290inch_set_mem_area(eink290inch_t *ctx, eink290inch_xy_t *xy)
Function for setting area in memory.
eink290inch_t::dev_cord
eink290inch_cord_t dev_cord
Definition: eink290inch.h:198
eink290inch_cfg_t
Click configuration structure definition.
Definition: eink290inch.h:206
eink290inch_xy_t
Definition: eink290inch.h:160
eink290inch_cfg_t::miso
pin_name_t miso
Definition: eink290inch.h:208
eink290inch_t::rst
digital_out_t rst
Definition: eink290inch.h:183
eink290inch_xy_t::x_start
uint16_t x_start
Definition: eink290inch.h:161
eink290inch_display_image
void eink290inch_display_image(eink290inch_t *ctx, const uint8_t *image_buffer)
Display image function.
eink290inch_cord_t
Definition: eink290inch.h:153
eink290inch_send_data
void eink290inch_send_data(eink290inch_t *ctx, uint8_t c_data)
Function for sending data.