eink  2.0.0.0
eink.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 EINK_H
36 #define EINK_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 EINK_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 EINK_OK 0
68 #define EINK_ERROR -1
69 
75 #define EINK_DISPLAY_WIDTH 72
76 #define EINK_DISPLAY_HEIGHT 172
77 #define EINK_DISPLAY_RESOLUTION 3096
78 
84 #define EINK_COMMUNICATION_SPI 0
85 #define EINK_COMMUNICATION_I2C 1
86 
92 #define EINK_SCREEN_COLOR_WHITE 0xFF
93 #define EINK_SCREEN_COLOR_BLACK 0x00
94 #define EINK_SCREEN_COLOR_LIGHT_GREY 0xAA
95 #define EINK_SCREEN_COLOR_DARK_GREY 0x55
96 
97 #define EINK_FO_HORIZONTAL 0x00
98 #define EINK_FO_VERTICAL 0x01
99 #define EINK_FO_VERTICAL_COLUMN 0x02
100 
106 #define EINK_CMD_DRIVER_OUTPUT_CONTROL 0x01
107 #define EINK_CMD_GATE_VOLTAGE_CONTROL 0x03
108 #define EINK_CMD_SOURCE_VOLTAGE_CONTROL 0x04
109 #define EINK_CMD_DISPLAY_CONTROL 0x07
110 #define EINK_CMD_NONOVERLAP_PERIOD 0x0B
111 #define EINK_CMD_GATE_SCAN_START_POSITION 0x0F
112 #define EINK_CMD_DEEP_SLEEP_MODE 0x10
113 #define EINK_CMD_DATA_ENTRY_MODE_SETTING 0x11
114 #define EINK_CMD_SW_RESET 0x12
115 #define EINK_CMD_TEMPERATURE_SENSOR_CONTROL 0x1A
116 #define EINK_CMD_TEMPERATURE_LOAD 0x1D
117 #define EINK_CMD_MASTER_ACTIVATION 0x20
118 #define EINK_CMD_DISPLAY_UPDATE_CONTROL_1 0x21
119 #define EINK_CMD_DISPLAY_UPDATE_CONTROL_2 0x22
120 #define EINK_CMD_WRITE_RAM 0x24
121 #define EINK_CMD_VCOM_SENSE 0x28
122 #define EINK_CMD_VCOM_SENSE_DURATION 0x29
123 #define EINK_CMD_VCOM_PROG_OTP 0x2A
124 #define EINK_CMD_WRITE_VCOM_REGISTER 0x2C
125 #define EINK_CMD_OTP_WAVEFORM_SETTINGS 0x30
126 #define EINK_CMD_WRITE_LUT_REGISTER 0x32
127 #define EINK_CMD_OTP_PROGRAM 0x36
128 #define EINK_CMD_OTP_SELECTION 0x37
129 #define EINK_CMD_SET_DUMMY_LINE_PERIOD 0x3A
130 #define EINK_CMD_SET_GATE_TIME 0x3B
131 #define EINK_CMD_BORDER_WAVEFORM_CONTROL 0x3C
132 #define EINK_CMD_SET_RAM_X_ADDRESS_START_END_POSITION 0x44
133 #define EINK_CMD_SET_RAM_Y_ADDRESS_START_END_POSITION 0x45
134 #define EINK_CMD_SET_RAM_X_ADDRESS_COUNTER 0x4E
135 #define EINK_CMD_SET_RAM_Y_ADDRESS_COUNTER 0x4F
136 #define EINK_CMD_BOOSTER_FEEDBACK_SELECTION 0xF0
137 #define EINK_CMD_TERMINATE_FRAME_READ_WRITE 0xFF
138 
144 #define EINK_DEVICE_SLAVE_ADDRESS_000 0x28
145 #define EINK_DEVICE_SLAVE_ADDRESS_001 0x29
146 #define EINK_DEVICE_SLAVE_ADDRESS_010 0x2A
147 #define EINK_DEVICE_SLAVE_ADDRESS_011 0x2B
148 #define EINK_DEVICE_SLAVE_ADDRESS_100 0x2C
149 #define EINK_DEVICE_SLAVE_ADDRESS_101 0x2D
150 #define EINK_DEVICE_SLAVE_ADDRESS_110 0x2E
151 #define EINK_DEVICE_SLAVE_ADDRESS_111 0x2F
152  // End group macro
155 // --------------------------------------------------------------- PUBLIC TYPES
161 typedef struct
162 {
163  const uint8_t *p_font;
164  uint16_t color;
165  uint8_t orientation;
166  uint16_t first_char;
167  uint16_t last_char;
168  uint16_t height;
169 
171 
172 typedef struct
173 {
174  uint16_t x;
175  uint16_t y;
176 
178 
179 typedef struct
180 {
181  uint8_t x_start;
182  uint8_t y_start;
183  uint8_t x_end;
184  uint8_t y_end;
185 
186 } eink_xy_t;
187 
188 typedef struct
189 {
190  uint8_t text_x;
191  uint8_t text_y;
192  uint8_t n_char;
193 
195 
199 typedef struct
200 {
201  // Output pins
202  digital_out_t cs;
203  digital_out_t rst;
204  digital_out_t dc;
205 
206  // Input pins
207  digital_in_t bsy;
208 
209  // Modules
210  spi_master_t spi;
211  pin_name_t chip_select;
212 
215 #ifndef IMAGE_MODE_ONLY
216  uint8_t p_frame[EINK_DISPLAY_RESOLUTION];
217 #endif
218 } eink_t;
219 
223 typedef struct
224 {
225  // Communication gpio pins
226  pin_name_t miso;
227  pin_name_t mosi;
228  pin_name_t sck;
229  pin_name_t cs;
230 
231  // Additional gpio pins
232  pin_name_t rst;
233  pin_name_t dc;
234  pin_name_t bsy;
235 
236  // static variable
237  uint32_t spi_speed;
238  spi_master_mode_t spi_mode;
239  spi_master_chip_select_polarity_t cs_polarity;
240 
242 
243 } eink_cfg_t;
244  // End types group
246 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
247 
252 #ifdef __cplusplus
253 extern "C"{
254 #endif
255 
265 
274 err_t eink_init ( eink_t *ctx, eink_cfg_t *cfg );
275 
282 void eink_send_cmd ( eink_t *ctx, uint8_t command );
283 
290 void eink_send_data ( eink_t *ctx, uint8_t c_data );
291 
297 void eink_reset( eink_t *ctx );
298 
304 void eink_sleep_mode ( eink_t *ctx );
305 
311 void eink_start_config ( eink_t *ctx );
312 
322 void eink_set_lut ( eink_t *ctx, const uint8_t *lut, uint8_t n_bytes );
323 
331 void eink_set_mem_pointer ( eink_t *ctx, uint8_t x, uint8_t y );
332 
339 void eink_set_mem_area ( eink_t *ctx, eink_xy_t *xy );
340 
347 
360 void eink_fill_screen ( eink_t *ctx, uint8_t color );
361 
370 void eink_display_image ( eink_t *ctx, const uint8_t* image_buffer );
371 
380 void eink_text ( eink_t *ctx, uint8_t *text, eink_text_set_t *text_set );
381 
388 void eink_set_font ( eink_t *ctx, eink200inch_font_t *cfg_font );
389 
390 #ifdef __cplusplus
391 }
392 #endif
393 #endif // _EINK_H_
394  // End public_function group
397 
398 // ------------------------------------------------------------------------- END
eink200inch_font_t::orientation
uint8_t orientation
Definition: eink.h:165
eink_cordinate_t
Definition: eink.h:173
eink_set_mem_pointer
void eink_set_mem_pointer(eink_t *ctx, uint8_t x, uint8_t y)
Setting pointers in memory.
eink_fill_screen
void eink_fill_screen(eink_t *ctx, uint8_t color)
Function that fills the screen.
eink_cfg_t::font_cfg
eink200inch_font_t font_cfg
Definition: eink.h:241
eink_text_set_t::text_x
uint8_t text_x
Definition: eink.h:190
eink_cfg_t::spi_speed
uint32_t spi_speed
Definition: eink.h:237
eink200inch_font_t::last_char
uint16_t last_char
Definition: eink.h:167
eink_cfg_t::sck
pin_name_t sck
Definition: eink.h:228
eink_t::dev_font
eink200inch_font_t dev_font
Definition: eink.h:213
eink_t::spi
spi_master_t spi
Definition: eink.h:210
eink_update_display
void eink_update_display(eink_t *ctx)
Update dispaly.
eink_reset
void eink_reset(eink_t *ctx)
Reset chip.
eink_cfg_t::mosi
pin_name_t mosi
Definition: eink.h:227
eink_t::dc
digital_out_t dc
Definition: eink.h:204
eink_cordinate_t::x
uint16_t x
Definition: eink.h:174
EINK_DISPLAY_RESOLUTION
#define EINK_DISPLAY_RESOLUTION
Definition: eink.h:77
eink_t::chip_select
pin_name_t chip_select
Definition: eink.h:211
eink_xy_t
Definition: eink.h:180
eink_cfg_setup
void eink_cfg_setup(eink_cfg_t *cfg)
Config Object Initialization function.
eink_t::dev_cord
eink_cordinate_t dev_cord
Definition: eink.h:214
eink_cfg_t::rst
pin_name_t rst
Definition: eink.h:232
eink_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: eink.h:238
eink_text_set_t::text_y
uint8_t text_y
Definition: eink.h:191
eink200inch_font_t::p_font
const uint8_t * p_font
Definition: eink.h:163
eink_xy_t::x_start
uint8_t x_start
Definition: eink.h:181
eink_send_data
void eink_send_data(eink_t *ctx, uint8_t c_data)
Sending data.
eink_set_lut
void eink_set_lut(eink_t *ctx, const uint8_t *lut, uint8_t n_bytes)
Set LUT table.
eink_init
err_t eink_init(eink_t *ctx, eink_cfg_t *cfg)
Initialization function.
eink_sleep_mode
void eink_sleep_mode(eink_t *ctx)
Sleep mode.
eink_set_mem_area
void eink_set_mem_area(eink_t *ctx, eink_xy_t *xy)
Setting area in memory.
eink200inch_font_t::height
uint16_t height
Definition: eink.h:168
eink_start_config
void eink_start_config(eink_t *ctx)
Configuration display.
eink_set_font
void eink_set_font(eink_t *ctx, eink200inch_font_t *cfg_font)
Set text font.
eink_display_image
void eink_display_image(eink_t *ctx, const uint8_t *image_buffer)
Displays image.
eink_xy_t::y_start
uint8_t y_start
Definition: eink.h:182
eink_xy_t::x_end
uint8_t x_end
Definition: eink.h:183
eink_t::rst
digital_out_t rst
Definition: eink.h:203
eink_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: eink.h:239
eink200inch_font_t::color
uint16_t color
Definition: eink.h:164
eink_t::cs
digital_out_t cs
Definition: eink.h:202
eink_text_set_t::n_char
uint8_t n_char
Definition: eink.h:192
eink200inch_font_t
Definition: eink.h:162
eink_cfg_t::bsy
pin_name_t bsy
Definition: eink.h:234
eink_text
void eink_text(eink_t *ctx, uint8_t *text, eink_text_set_t *text_set)
Draw text on the screen.
eink_t::bsy
digital_in_t bsy
Definition: eink.h:207
eink_text_set_t
Definition: eink.h:189
eink_cfg_t
Click configuration structure definition.
Definition: eink.h:224
eink_t
Click ctx object definition.
Definition: eink.h:200
eink_cordinate_t::y
uint16_t y
Definition: eink.h:175
eink_cfg_t::miso
pin_name_t miso
Definition: eink.h:226
eink_cfg_t::dc
pin_name_t dc
Definition: eink.h:233
eink200inch_font_t::first_char
uint16_t first_char
Definition: eink.h:166
eink_cfg_t::cs
pin_name_t cs
Definition: eink.h:229
eink_xy_t::y_end
uint8_t y_end
Definition: eink.h:184
eink_send_cmd
void eink_send_cmd(eink_t *ctx, uint8_t command)
Sending a command.