eink213inch  2.0.0.0
eink213inch.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 EINK213INCH_H
36 #define EINK213INCH_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 EINK213INCH_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.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
59  cfg.dc = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
60  cfg.bsy = MIKROBUS( mikrobus, MIKROBUS_INT )
61 
67 #define EINK213INCH_OK 0
68 #define EINK213INCH_ERROR -1
69 
75 #define EINK213INCH_DISPLAY_WIDTH 128
76 #define EINK213INCH_DISPLAY_HEIGHT 250
77 #define EINK213INCH_DISPLAY_RESOLUTIONS 4000
78 
84 #define EINK213INCH_COMMUNICATION_SPI 0
85 #define EINK213INCH_COMMUNICATION_I2C 1
86 
92 #define EINK213INCH_SCREEN_COLOR_WHITE 0xFF
93 #define EINK213INCH_SCREEN_COLOR_BLACK 0x00
94 #define EINK213INCH_SCREEN_COLOR_LIGHT_GREY 0xAA
95 #define EINK213INCH_SCREEN_COLOR_DARK_GREY 0x55
96 
97 #define EINK213INCH_FO_HORIZONTAL 0x00
98 #define EINK213INCH_FO_VERTICAL 0x01
99 #define EINK213INCH_FO_VERTICAL_COLUMN 0x02
100 
106 #define EINK213INCH_CMD_DRIVER_OUTPUT_CONTROL 0x01
107 #define EINK213INCH_CMD_BOOSTER_SOFT_START_CONTROL 0x0C
108 #define EINK213INCH_CMD_GATE_SCAN_START_POSITION 0x0F
109 #define EINK213INCH_CMD_DEEP_SLEEP_MODE 0x10
110 #define EINK213INCH_CMD_DATA_ENTRY_MODE_SETTING 0x11
111 #define EINK213INCH_CMD_SW_RESET 0x12
112 #define EINK213INCH_CMD_TEMPERATURE_SENSOR_CONTROL 0x1A
113 #define EINK213INCH_CMD_MASTER_ACTIVATION 0x20
114 #define EINK213INCH_CMD_DISPLAY_UPDATE_CONTROL_1 0x21
115 #define EINK213INCH_CMD_DISPLAY_UPDATE_CONTROL_2 0x22
116 #define EINK213INCH_CMD_WRITE_RAM 0x24
117 #define EINK213INCH_CMD_WRITE_VCOM_REGISTER 0x2C
118 #define EINK213INCH_CMD_WRITE_LUT_REGISTER 0x32
119 #define EINK213INCH_CMD_SET_DUMMY_LINE_PERIOD 0x3A
120 #define EINK213INCH_CMD_SET_GATE_TIME 0x3B
121 #define EINK213INCH_CMD_BORDER_WAVEFORM_CONTROL 0x3C
122 #define EINK213INCH_CMD_SET_RAM_X_ADDRESS_START_END_POSITION 0x44
123 #define EINK213INCH_CMD_SET_RAM_Y_ADDRESS_START_END_POSITION 0x45
124 #define EINK213INCH_CMD_SET_RAM_X_ADDRESS_COUNTER 0x4E
125 #define EINK213INCH_CMD_SET_RAM_Y_ADDRESS_COUNTER 0x4F
126 #define EINK213INCH_CMD_TERMINATE_FRAME_READ_WRITE 0xFF
127  // End group macro
130 // --------------------------------------------------------------- PUBLIC TYPES
136 typedef struct
137 {
138  const uint8_t *p_font;
139  uint16_t color;
140  uint8_t orientation;
141  uint16_t first_char;
142  uint16_t last_char;
143  uint16_t height;
144 
146 
147 typedef struct
148 {
149  uint16_t x;
150  uint16_t y;
151 
153 
154 typedef struct
155 {
156  uint16_t x_start;
157  uint16_t y_start;
158  uint16_t x_end;
159  uint16_t y_end;
160 
162 
163 typedef struct
164 {
165  uint8_t n_char;
166  uint16_t text_x;
167  uint16_t text_y;
168 
170 
174 typedef struct
175 {
176  // Output pins
177  digital_out_t cs;
178  digital_out_t rst;
179  digital_out_t dc;
180 
181  // Input pins
182  digital_in_t bsy;
183 
184  // Modules
185  spi_master_t spi;
186  pin_name_t chip_select;
187 
188 #ifndef IMAGE_MODE_ONLY
189  uint8_t frame[ 4000 ];
190 #endif
191 
194 
195 } eink213inch_t;
196 
200 typedef struct
201 {
202  // Communication gpio pins
203  pin_name_t miso;
204  pin_name_t mosi;
205  pin_name_t sck;
206  pin_name_t cs;
207 
208  // Additional gpio pins
209  pin_name_t rst;
210  pin_name_t dc;
211  pin_name_t bsy;
212 
213  // static variable
214  uint32_t spi_speed;
215  spi_master_mode_t spi_mode;
216  spi_master_chip_select_polarity_t cs_polarity;
217 
219  // End types group
221 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
222 
227 #ifdef __cplusplus
228 extern "C"{
229 #endif
230 
240 
250 
257 void eink213inch_send_cmd ( eink213inch_t *ctx, uint8_t command );
258 
265 void eink213inch_send_data ( eink213inch_t *ctx, uint8_t c_data );
266 
273 
280 
290 void eink213inch_set_lut ( eink213inch_t *ctx, const uint8_t *lut, uint8_t n_bytes );
291 
298 
306 void eink213inch_set_mem_pointer ( eink213inch_t *ctx, uint16_t x, uint16_t y );
307 
315 
322 
335 void eink213inch_fill_screen ( eink213inch_t *ctx, uint8_t color );
336 
346 void eink213inch_display_image ( eink213inch_t *ctx, const uint8_t* image_buffer );
347 
356 void eink213inch_text ( eink213inch_t *ctx, uint8_t *text, eink213inch_set_text_t *text_set );
357 
365 
366 #ifdef __cplusplus
367 }
368 #endif
369 #endif // _EINK213INCH_H_
370  // End public_function group
373 
374 // ------------------------------------------------------------------------- END
eink213inch_cfg_t::dc
pin_name_t dc
Definition: eink213inch.h:210
eink213inch_t::dev_font
eink213inch_font_t dev_font
Definition: eink213inch.h:192
eink213inch_cfg_t::miso
pin_name_t miso
Definition: eink213inch.h:203
eink213inch_t::dev_cord
eink213inch_cord_t dev_cord
Definition: eink213inch.h:193
eink213inch_cord_t::y
uint16_t y
Definition: eink213inch.h:150
eink213inch_init
err_t eink213inch_init(eink213inch_t *ctx, eink213inch_cfg_t *cfg)
Initialization function.
eink213inch_fill_screen
void eink213inch_fill_screen(eink213inch_t *ctx, uint8_t color)
Function that fills the screen.
eink213inch_cfg_t::mosi
pin_name_t mosi
Definition: eink213inch.h:204
eink213inch_text
void eink213inch_text(eink213inch_t *ctx, uint8_t *text, eink213inch_set_text_t *text_set)
Function for draw text on the screen.
eink213inch_t::bsy
digital_in_t bsy
Definition: eink213inch.h:182
eink213inch_t::cs
digital_out_t cs
Definition: eink213inch.h:177
eink213inch_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: eink213inch.h:216
eink213inch_font_t::height
uint16_t height
Definition: eink213inch.h:143
eink213inch_t
Click ctx object definition.
Definition: eink213inch.h:175
eink213inch_send_data
void eink213inch_send_data(eink213inch_t *ctx, uint8_t c_data)
Function for sending data.
eink213inch_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: eink213inch.h:215
eink213inch_t::chip_select
pin_name_t chip_select
Definition: eink213inch.h:186
eink213inch_start_config
void eink213inch_start_config(eink213inch_t *ctx)
Start configuration display.
eink213inch_t::dc
digital_out_t dc
Definition: eink213inch.h:179
eink213inch_xy_t::y_end
uint16_t y_end
Definition: eink213inch.h:159
eink213inch_update_display
void eink213inch_update_display(eink213inch_t *ctx)
Functions for update display.
eink213inch_cfg_t::sck
pin_name_t sck
Definition: eink213inch.h:205
eink213inch_set_text_t::text_x
uint16_t text_x
Definition: eink213inch.h:166
eink213inch_display_image
void eink213inch_display_image(eink213inch_t *ctx, const uint8_t *image_buffer)
Display image function.
eink213inch_font_t::last_char
uint16_t last_char
Definition: eink213inch.h:142
eink213inch_set_text_t::n_char
uint8_t n_char
Definition: eink213inch.h:165
eink213inch_cfg_setup
void eink213inch_cfg_setup(eink213inch_cfg_t *cfg)
Config Object Initialization function.
eink213inch_cfg_t::rst
pin_name_t rst
Definition: eink213inch.h:209
eink213inch_set_text_t
Definition: eink213inch.h:164
eink213inch_xy_t::x_end
uint16_t x_end
Definition: eink213inch.h:158
eink213inch_cfg_t::bsy
pin_name_t bsy
Definition: eink213inch.h:211
eink213inch_font_t::p_font
const uint8_t * p_font
Definition: eink213inch.h:138
eink213inch_font_t
Definition: eink213inch.h:137
eink213inch_xy_t::y_start
uint16_t y_start
Definition: eink213inch.h:157
eink213inch_sleep_mode
void eink213inch_sleep_mode(eink213inch_t *ctx)
Function for go to sleep mode.
eink213inch_set_font
void eink213inch_set_font(eink213inch_t *ctx, eink213inch_font_t *cfg_font)
Set font function.
eink213inch_set_mem_area
void eink213inch_set_mem_area(eink213inch_t *ctx, eink213inch_xy_t *xy)
Function for setting area in memory.
eink213inch_font_t::first_char
uint16_t first_char
Definition: eink213inch.h:141
eink213inch_send_cmd
void eink213inch_send_cmd(eink213inch_t *ctx, uint8_t command)
Function for sending a command.
eink213inch_reset
void eink213inch_reset(eink213inch_t *ctx)
Function for reset chip.
eink213inch_cfg_t::cs
pin_name_t cs
Definition: eink213inch.h:206
eink213inch_font_t::color
uint16_t color
Definition: eink213inch.h:139
eink213inch_set_text_t::text_y
uint16_t text_y
Definition: eink213inch.h:167
eink213inch_cord_t
Definition: eink213inch.h:148
eink213inch_cfg_t::spi_speed
uint32_t spi_speed
Definition: eink213inch.h:214
eink213inch_font_t::orientation
uint8_t orientation
Definition: eink213inch.h:140
eink213inch_xy_t
Definition: eink213inch.h:155
eink213inch_cfg_t
Click configuration structure definition.
Definition: eink213inch.h:201
eink213inch_t::spi
spi_master_t spi
Definition: eink213inch.h:185
eink213inch_set_lut
void eink213inch_set_lut(eink213inch_t *ctx, const uint8_t *lut, uint8_t n_bytes)
Set LUT table.
eink213inch_cord_t::x
uint16_t x
Definition: eink213inch.h:149
eink213inch_t::rst
digital_out_t rst
Definition: eink213inch.h:178
eink213inch_set_mem_pointer
void eink213inch_set_mem_pointer(eink213inch_t *ctx, uint16_t x, uint16_t y)
Function for setting pointers in memory.
eink213inch_xy_t::x_start
uint16_t x_start
Definition: eink213inch.h:156