eink154inch  2.0.0.0
eink154inch.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 EINK154INCH_H
36 #define EINK154INCH_H
37 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_spi_master.h"
51 
52 // -------------------------------------------------------------- PUBLIC MACROS
63 #define EINK154INCH_MAP_MIKROBUS( cfg, mikrobus ) \
64  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
65  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
66  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
67  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
68  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
69  cfg.dc = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
70  cfg.bsy = MIKROBUS( mikrobus, MIKROBUS_INT )
71 
77 #define EINK154INCH_OK 0
78 #define EINK154INCH_ERROR -1
79 
85 #define EINK154INCH_DISPLAY_WIDTH 200
86 #define EINK154INCH_DISPLAY_HEIGHT 200
87 #define EINK154INCH_DISPLAY_RESOLUTIONS 5000
88 
94 #define EINK154INCH_COMMUNICATION_SPI 0
95 #define EINK154INCH_COMMUNICATION_I2C 1
96 
102 #define EINK154INCH_SCREEN_COLOR_WHITE 0xFF
103 #define EINK154INCH_SCREEN_COLOR_BLACK 0x00
104 #define EINK154INCH_SCREEN_COLOR_LIGHT_GREY 0xAA
105 #define EINK154INCH_SCREEN_COLOR_DARK_GREY 0x55
106 
107 #define EINK154INCH_FO_HORIZONTAL 0x00
108 #define EINK154INCH_FO_VERTICAL 0x01
109 #define EINK154INCH_FO_VERTICAL_COLUMN 0x02
110 
116 #define EINK154INCH_CMD_DRIVER_OUTPUT_CONTROL 0x01
117 #define EINK154INCH_CMD_BOOSTER_SOFT_START_CONTROL 0x0C
118 #define EINK154INCH_CMD_GATE_SCAN_START_POSITION 0x0F
119 #define EINK154INCH_CMD_DEEP_SLEEP_MODE 0x10
120 #define EINK154INCH_CMD_DATA_ENTRY_MODE_SETTING 0x11
121 #define EINK154INCH_CMD_SW_RESET 0x12
122 #define EINK154INCH_CMD_TEMPERATURE_SENSOR_CONTROL 0x1A
123 #define EINK154INCH_CMD_MASTER_ACTIVATION 0x20
124 #define EINK154INCH_CMD_DISPLAY_UPDATE_CONTROL_1 0x21
125 #define EINK154INCH_CMD_DISPLAY_UPDATE_CONTROL_2 0x22
126 #define EINK154INCH_CMD_WRITE_RAM 0x24
127 #define EINK154INCH_CMD_WRITE_VCOM_REGISTER 0x2C
128 #define EINK154INCH_CMD_WRITE_LUT_REGISTER 0x32
129 #define EINK154INCH_CMD_SET_DUMMY_LINE_PERIOD 0x3A
130 #define EINK154INCH_CMD_SET_GATE_TIME 0x3B
131 #define EINK154INCH_CMD_BORDER_WAVEFORM_CONTROL 0x3C
132 #define EINK154INCH_CMD_SET_RAM_X_ADDRESS_START_END_POSITION 0x44
133 #define EINK154INCH_CMD_SET_RAM_Y_ADDRESS_START_END_POSITION 0x45
134 #define EINK154INCH_CMD_SET_RAM_X_ADDRESS_COUNTER 0x4E
135 #define EINK154INCH_CMD_SET_RAM_Y_ADDRESS_COUNTER 0x4F
136 #define EINK154INCH_CMD_TERMINATE_FRAME_READ_WRITE 0xFF
137 
143 #define EINK154INCH_DEVICE_SLAVE_ADDRESS_000 0x28
144 #define EINK154INCH_DEVICE_SLAVE_ADDRESS_001 0x29
145 #define EINK154INCH_DEVICE_SLAVE_ADDRESS_010 0x2A
146 #define EINK154INCH_DEVICE_SLAVE_ADDRESS_011 0x2B
147 #define EINK154INCH_DEVICE_SLAVE_ADDRESS_100 0x2C
148 #define EINK154INCH_DEVICE_SLAVE_ADDRESS_101 0x2D
149 #define EINK154INCH_DEVICE_SLAVE_ADDRESS_110 0x2E
150 #define EINK154INCH_DEVICE_SLAVE_ADDRESS_111 0x2F
151  // End group macro
154 // --------------------------------------------------------------- PUBLIC TYPES
160 typedef struct
161 {
162  const uint8_t *p_font;
163  uint16_t color;
164  uint8_t orientation;
165  uint16_t first_char;
166  uint16_t last_char;
167  uint16_t height;
168 
170 
171 typedef struct
172 {
173  uint16_t x;
174  uint16_t y;
175 
177 
178 typedef struct
179 {
180  uint8_t x_start;
181  uint8_t y_start;
182  uint8_t x_end;
183  uint8_t y_end;
184 
186 
187 typedef struct
188 {
189  uint8_t text_x;
190  uint8_t text_y;
191  uint8_t n_char;
192 
194 
198 typedef struct
199 {
200  // Output pins
201  digital_out_t cs;
202  digital_out_t rst;
203  digital_out_t dc;
204 
205  // Input pins
206  digital_in_t bsy;
207 
208  // Modules
209  spi_master_t spi;
210  pin_name_t chip_select;
211 
214 #ifndef IMAGE_MODE_ONLY
215  uint8_t p_frame[5000];
216 #endif
217 } eink154inch_t;
218 
222 typedef struct
223 {
224  // Communication gpio pins
225  pin_name_t miso;
226  pin_name_t mosi;
227  pin_name_t sck;
228  pin_name_t cs;
229 
230  // Additional gpio pins
231  pin_name_t rst;
232  pin_name_t dc;
233  pin_name_t bsy;
234 
235  // static variable
236 
237  uint32_t spi_speed;
238  spi_master_mode_t spi_mode;
239  spi_master_chip_select_polarity_t cs_polarity;
240 
242 
244  // End types group
246 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
247 
252 #ifdef __cplusplus
253 extern "C"{
254 #endif
255 
265 
275 
282 void eink154inch_send_cmd ( eink154inch_t *ctx, uint8_t command );
283 
290 void eink154inch_send_data ( eink154inch_t *ctx, uint8_t c_data );
291 
298 
305 
312 
322 void eink154inch_set_lut ( eink154inch_t *ctx, const uint8_t *lut, uint8_t n_bytes );
323 
331 void eink154inch_set_mem_pointer ( eink154inch_t *ctx, uint8_t x, uint8_t y );
332 
340 
347 
360 void eink154inch_fill_screen ( eink154inch_t *ctx, uint8_t color );
361 
370 void eink154inch_image ( eink154inch_t *ctx, const uint8_t* image_buffer );
371 
380 void eink154inch_text ( eink154inch_t *ctx, char *text, eink154inch_text_set_t *text_set );
381 
389 
390 #ifdef __cplusplus
391 }
392 #endif
393 #endif // _EINK154INCH_H_
394  // End public_function group
397 
398 // ------------------------------------------------------------------------- END
eink154inch_font_t::orientation
uint8_t orientation
Definition: eink154inch.h:164
eink154inch_text
void eink154inch_text(eink154inch_t *ctx, char *text, eink154inch_text_set_t *text_set)
Draw text on the screen.
eink154inch_xy_t::x_start
uint8_t x_start
Definition: eink154inch.h:180
eink154inch_t::rst
digital_out_t rst
Definition: eink154inch.h:202
eink154inch_cordinate_t::x
uint16_t x
Definition: eink154inch.h:173
eink154inch_cfg_t::rst
pin_name_t rst
Definition: eink154inch.h:231
eink154inch_t::dev_font
eink154inch_font_t dev_font
Definition: eink154inch.h:212
eink154inch_sleep_mode
void eink154inch_sleep_mode(eink154inch_t *ctx)
Sleep mode.
eink154inch_cfg_t::font_cfg
eink154inch_font_t font_cfg
Definition: eink154inch.h:241
eink154inch_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: eink154inch.h:239
eink154inch_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: eink154inch.h:238
eink154inch_cfg_t::sck
pin_name_t sck
Definition: eink154inch.h:227
eink154inch_t::bsy
digital_in_t bsy
Definition: eink154inch.h:206
eink154inch_set_lut
void eink154inch_set_lut(eink154inch_t *ctx, const uint8_t *lut, uint8_t n_bytes)
Set LUT table.
eink154inch_xy_t::y_start
uint8_t y_start
Definition: eink154inch.h:181
eink154inch_cfg_t::mosi
pin_name_t mosi
Definition: eink154inch.h:226
eink154inch_set_font
void eink154inch_set_font(eink154inch_t *ctx, eink154inch_font_t *cfg_font)
Set text font.
eink154inch_cfg_t
Click configuration structure definition.
Definition: eink154inch.h:223
eink154inch_xy_t
Definition: eink154inch.h:179
eink154inch_set_mem_pointer
void eink154inch_set_mem_pointer(eink154inch_t *ctx, uint8_t x, uint8_t y)
Setting pointers in memory.
eink154inch_send_data
void eink154inch_send_data(eink154inch_t *ctx, uint8_t c_data)
Sending data.
eink154inch_image
void eink154inch_image(eink154inch_t *ctx, const uint8_t *image_buffer)
Displays image.
eink154inch_send_cmd
void eink154inch_send_cmd(eink154inch_t *ctx, uint8_t command)
Sending a command.
eink154inch_text_set_t
Definition: eink154inch.h:188
eink154inch_cfg_t::dc
pin_name_t dc
Definition: eink154inch.h:232
eink154inch_cfg_t::cs
pin_name_t cs
Definition: eink154inch.h:228
eink154inch_font_t::color
uint16_t color
Definition: eink154inch.h:163
eink154inch_font_t::last_char
uint16_t last_char
Definition: eink154inch.h:166
eink154inch_t
Click ctx object definition.
Definition: eink154inch.h:199
eink154inch_cfg_t::spi_speed
uint32_t spi_speed
Definition: eink154inch.h:237
eink154inch_t::dev_cord
eink154inch_cordinate_t dev_cord
Definition: eink154inch.h:213
eink154inch_cfg_setup
void eink154inch_cfg_setup(eink154inch_cfg_t *cfg)
Config Object Initialization function.
eink154inch_font_t
Definition: eink154inch.h:161
eink154inch_font_t::height
uint16_t height
Definition: eink154inch.h:167
eink154inch_t::chip_select
pin_name_t chip_select
Definition: eink154inch.h:210
eink154inch_t::cs
digital_out_t cs
Definition: eink154inch.h:201
eink154inch_set_mem_area
void eink154inch_set_mem_area(eink154inch_t *ctx, eink154inch_xy_t *xy)
Setting area in memory.
eink154inch_xy_t::x_end
uint8_t x_end
Definition: eink154inch.h:182
eink154inch_cfg_t::miso
pin_name_t miso
Definition: eink154inch.h:225
eink154inch_fill_screen
void eink154inch_fill_screen(eink154inch_t *ctx, uint8_t color)
Function that fills the screen.
eink154inch_text_set_t::n_char
uint8_t n_char
Definition: eink154inch.h:191
eink154inch_reset
void eink154inch_reset(eink154inch_t *ctx)
Reset chip.
eink154inch_init
err_t eink154inch_init(eink154inch_t *ctx, eink154inch_cfg_t *cfg)
Initialization function.
eink154inch_update_display
void eink154inch_update_display(eink154inch_t *ctx)
Update dispaly.
eink154inch_font_t::p_font
const uint8_t * p_font
Definition: eink154inch.h:162
eink154inch_t::dc
digital_out_t dc
Definition: eink154inch.h:203
eink154inch_t::spi
spi_master_t spi
Definition: eink154inch.h:209
eink154inch_start_config
void eink154inch_start_config(eink154inch_t *ctx)
Configuration display.
eink154inch_font_t::first_char
uint16_t first_char
Definition: eink154inch.h:165
eink154inch_cordinate_t
Definition: eink154inch.h:172
eink154inch_cfg_t::bsy
pin_name_t bsy
Definition: eink154inch.h:233
eink154inch_text_set_t::text_x
uint8_t text_x
Definition: eink154inch.h:189
eink154inch_text_set_t::text_y
uint8_t text_y
Definition: eink154inch.h:190
eink154inch_xy_t::y_end
uint8_t y_end
Definition: eink154inch.h:183
eink154inch_cordinate_t::y
uint16_t y
Definition: eink154inch.h:174