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 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_spi_master.h"
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
52 #define EINK290INCH_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
54  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
55  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
56  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
57  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
58  cfg.dc = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
59  cfg.bsy = MIKROBUS( mikrobus, MIKROBUS_INT )
60 
66 #define EINK290INCH_OK 0
67 #define EINK290INCH_ERROR -1
68 
74 #define EINK290INCH_DISPLAY_WIDTH 128
75 #define EINK290INCH_DISPLAY_HEIGHT 296
76 #define EINK290INCH_DISPLAY_RESOLUTIONS 4736
77 
83 #define EINK290INCH_SCREEN_COLOR_WHITE 0xFF
84 #define EINK290INCH_SCREEN_COLOR_BLACK 0x00
85 #define EINK290INCH_SCREEN_COLOR_LIGHT_GREY 0xAA
86 #define EINK290INCH_SCREEN_COLOR_DARK_GREY 0x55
87 
88 #define EINK290INCH_FO_HORIZONTAL 0x00
89 #define EINK290INCH_FO_VERTICAL 0x01
90 #define EINK290INCH_FO_VERTICAL_COLUMN 0x02
91 
97 #define EINK290INCH_CMD_DRIVER_OUTPUT_CONTROL 0x01
98 #define EINK290INCH_CMD_BOOSTER_SOFT_START_CONTROL 0x0C
99 #define EINK290INCH_CMD_GATE_SCAN_START_POSITION 0x0F
100 #define EINK290INCH_CMD_DEEP_SLEEP_MODE 0x10
101 #define EINK290INCH_CMD_DATA_ENTRY_MODE_SETTING 0x11
102 #define EINK290INCH_CMD_SW_RESET 0x12
103 #define EINK290INCH_CMD_TEMPERATURE_SENSOR_CONTROL 0x1A
104 #define EINK290INCH_CMD_MASTER_ACTIVATION 0x20
105 #define EINK290INCH_CMD_DISPLAY_UPDATE_CONTROL_1 0x21
106 #define EINK290INCH_CMD_DISPLAY_UPDATE_CONTROL_2 0x22
107 #define EINK290INCH_CMD_WRITE_RAM 0x24
108 #define EINK290INCH_CMD_WRITE_VCOM_REGISTER 0x2C
109 #define EINK290INCH_CMD_WRITE_LUT_REGISTER 0x32
110 #define EINK290INCH_CMD_SET_DUMMY_LINE_PERIOD 0x3A
111 #define EINK290INCH_CMD_SET_GATE_TIME 0x3B
112 #define EINK290INCH_CMD_BORDER_WAVEFORM_CONTROL 0x3C
113 #define EINK290INCH_CMD_SET_RAM_X_ADDRESS_START_END_POSITION 0x44
114 #define EINK290INCH_CMD_SET_RAM_Y_ADDRESS_START_END_POSITION 0x45
115 #define EINK290INCH_CMD_SET_RAM_X_ADDRESS_COUNTER 0x4E
116 #define EINK290INCH_CMD_SET_RAM_Y_ADDRESS_COUNTER 0x4F
117 #define EINK290INCH_CMD_TERMINATE_FRAME_READ_WRITE 0xFF
118  // End group macro
121 // --------------------------------------------------------------- PUBLIC TYPES
127 typedef struct
128 {
129  const uint8_t *p_font;
130  uint16_t color;
131  uint8_t orientation;
132  uint16_t first_char;
133  uint16_t last_char;
134  uint16_t height;
135 
137 
138 typedef struct
139 {
140  uint16_t x;
141  uint16_t y;
142 
144 
145 typedef struct
146 {
147  uint16_t x_start;
148  uint16_t y_start;
149  uint16_t x_end;
150  uint16_t y_end;
151 
153 
154 typedef struct
155 {
156  uint8_t n_char;
157  uint16_t text_x;
158  uint16_t text_y;
159 
161 
165 typedef struct
166 {
167  // Output pins
168  digital_out_t cs;
169  digital_out_t rst;
170  digital_out_t dc;
171 
172  // Input pins
173  digital_in_t bsy;
174 
175  // Modules
176  spi_master_t spi;
177  pin_name_t chip_select;
178 
179 #ifndef IMAGE_MODE_ONLY
180  uint8_t frame[ 4736 ];
181 #endif
182 
185 
186 } eink290inch_t;
187 
191 typedef struct
192 {
193  // Communication gpio pins
194  pin_name_t miso;
195  pin_name_t mosi;
196  pin_name_t sck;
197  pin_name_t cs;
198 
199  // Additional gpio pins
200  pin_name_t rst;
201  pin_name_t dc;
202  pin_name_t bsy;
203 
204  // static variable
205  uint32_t spi_speed;
206  spi_master_mode_t spi_mode;
207  spi_master_chip_select_polarity_t cs_polarity;
208 
210  // End types group
212 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
213 
218 #ifdef __cplusplus
219 extern "C"{
220 #endif
221 
231 
241 
248 void eink290inch_send_cmd ( eink290inch_t *ctx, uint8_t command );
249 
256 void eink290inch_send_data ( eink290inch_t *ctx, uint8_t c_data );
257 
264 
271 
281 void eink290inch_set_lut ( eink290inch_t *ctx, const uint8_t *lut, uint8_t lut_cnt );
282 
289 
297 void eink290inch_set_mem_pointer ( eink290inch_t *ctx, uint16_t x, uint16_t y );
298 
306 
313 
326 void eink290inch_fill_screen ( eink290inch_t *ctx, uint8_t color );
327 
337 void eink290inch_display_image ( eink290inch_t *ctx, const uint8_t* image_buffer );
338 
347 void eink290inch_text ( eink290inch_t *ctx, uint8_t *text, eink290inch_set_text_t *text_set );
348 
356 
357 #ifdef __cplusplus
358 }
359 #endif
360 #endif // _EINK290INCH_H_
361  // End public_function group
364 
365 // ------------------------------------------------------------------------- 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:129
eink290inch_cfg_t::cs
pin_name_t cs
Definition: eink290inch.h:197
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:200
eink290inch_cfg_t::bsy
pin_name_t bsy
Definition: eink290inch.h:202
eink290inch_font_t::first_char
uint16_t first_char
Definition: eink290inch.h:132
eink290inch_t
Click ctx object definition.
Definition: eink290inch.h:166
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:173
eink290inch_cfg_t::spi_speed
uint32_t spi_speed
Definition: eink290inch.h:205
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:170
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:141
eink290inch_t::dev_font
eink290inch_font_t dev_font
Definition: eink290inch.h:183
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:131
eink290inch_cfg_setup
void eink290inch_cfg_setup(eink290inch_cfg_t *cfg)
Config Object Initialization function.
eink290inch_set_text_t
Definition: eink290inch.h:155
eink290inch_cfg_t::sck
pin_name_t sck
Definition: eink290inch.h:196
eink290inch_t::chip_select
pin_name_t chip_select
Definition: eink290inch.h:177
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:176
eink290inch_xy_t::y_start
uint16_t y_start
Definition: eink290inch.h:148
eink290inch_cord_t::x
uint16_t x
Definition: eink290inch.h:140
eink290inch_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: eink290inch.h:207
eink290inch_set_text_t::text_y
uint16_t text_y
Definition: eink290inch.h:158
eink290inch_cfg_t::dc
pin_name_t dc
Definition: eink290inch.h:201
eink290inch_xy_t::y_end
uint16_t y_end
Definition: eink290inch.h:150
eink290inch_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: eink290inch.h:206
eink290inch_font_t::last_char
uint16_t last_char
Definition: eink290inch.h:133
eink290inch_t::cs
digital_out_t cs
Definition: eink290inch.h:168
eink290inch_font_t::height
uint16_t height
Definition: eink290inch.h:134
eink290inch_cfg_t::mosi
pin_name_t mosi
Definition: eink290inch.h:195
eink290inch_set_text_t::n_char
uint8_t n_char
Definition: eink290inch.h:156
eink290inch_reset
void eink290inch_reset(eink290inch_t *ctx)
Function for reset chip.
eink290inch_xy_t::x_end
uint16_t x_end
Definition: eink290inch.h:149
eink290inch_set_text_t::text_x
uint16_t text_x
Definition: eink290inch.h:157
eink290inch_font_t
Definition: eink290inch.h:128
eink290inch_font_t::color
uint16_t color
Definition: eink290inch.h:130
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:184
eink290inch_cfg_t
Click configuration structure definition.
Definition: eink290inch.h:192
eink290inch_xy_t
Definition: eink290inch.h:146
eink290inch_cfg_t::miso
pin_name_t miso
Definition: eink290inch.h:194
eink290inch_t::rst
digital_out_t rst
Definition: eink290inch.h:169
eink290inch_xy_t::x_start
uint16_t x_start
Definition: eink290inch.h:147
eink290inch_display_image
void eink290inch_display_image(eink290inch_t *ctx, const uint8_t *image_buffer)
Display image function.
eink290inch_cord_t
Definition: eink290inch.h:139
eink290inch_send_data
void eink290inch_send_data(eink290inch_t *ctx, uint8_t c_data)
Function for sending data.