oledb  2.0.0.0
oledb.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef _OLEDB_H_
29 #define _OLEDB_H_
30 
31 #include "mikrosdk_version.h"
32 
33 #ifdef __GNUC__
34 #if mikroSDK_GET_VERSION < 20800ul
35 #include "rcu_delays.h"
36 #else
37 #include "delays.h"
38 #endif
39 #endif
40 
41 #include "drv_digital_out.h"
42 #include "drv_i2c_master.h"
43 #include "drv_spi_master.h"
44 #include "oledb_resources.h"
45 
46 // -------------------------------------------------------------- PUBLIC MACROS
56 #define OLEDB_SSD1306_WIDTH 128
57 #define OLEDB_DISPLAY_WIDTH 96
58 #define OLEDB_DISPLAY_HEIGHT 39
59 #define OLEDB_DISPLAY_ROWS 5
60 #define OLEDB_FONT_5X7 0
61 #define OLEDB_FONT_6X8 1
62 #define OLEDB_DISPLAYOFF 0xAE
63 #define OLEDB_SETDISPLAYCLOCKDIV 0xD5
64 #define OLEDB_SETMULTIPLEX 0xA8
65 #define OLEDB_SETDISPLAYOFFSET 0xD3
66 #define OLEDB_SETSTARTLINE 0x40
67 #define OLEDB_CHARGEPUMP 0x8D
68 #define OLEDB_SETSEGMENTREMAP 0xA1
69 #define OLEDB_SEGREMAP 0xA0
70 #define OLEDB_COMSCANDEC 0xC8
71 #define OLEDB_SETCOMPINS 0xDA
72 #define OLEDB_SETCONTRAST 0x81
73 #define OLEDB_SETPRECHARGE 0xD9
74 #define OLEDB_SETVCOMDETECT 0xDB
75 #define OLEDB_DISPLAYALLON_RESUME 0xA4
76 #define OLEDB_NORMALDISPLAY 0xA6
77 #define OLEDB_DISPLAYON 0xAF
78 #define OLEDB_DISPLAYALLON 0xA5
79 #define OLEDB_INVERTDISPLAY 0xA7
80 #define OLEDB_SETLOWCOLUMN 0x00
81 #define OLEDB_SETHIGHCOLUMN 0x10
82 #define OLEDB_MEMORYMODE 0x20
83 #define OLEDB_COLUMNADDR 0x21
84 #define OLEDB_PAGEADDR 0x22
85 #define OLEDB_COMSCANINC 0xC0
86 #define OLEDB_EXTERNALVCC 0x01
87 #define OLEDB_SWITCHCAPVCC 0x02
88 #define OLEDB_ACTIVATE_SCROLL 0x2F
89 #define OLEDB_DEACTIVATE_SCROLL 0x2E
90 #define OLEDB_SET_VERTICAL_SCROLL_AREA 0xA3
91 #define OLEDB_RIGHT_HORIZONTAL_SCROLL 0x26
92 #define OLEDB_LEFT_HORIZONTAL_SCROLL 0x27
93 #define OLEDB_VERTICAL_AND_RIGHT_HORIZONTAL_SCROLL 0x29
94 #define OLEDB_VERTICAL_AND_LEFT_HORIZONTAL_SCROLL 0x2A
95 
101 #define OLEDB_COMMAND 0x3C
102 #define OLEDB_DATA 0x3D
103 
109 #define OLEDB_MASTER_I2C 0
110 #define OLEDB_MASTER_SPI 1
111 
122 #define err_t uint8_t
123 
129 #define OLEDB_OK 0x00
130 #define OLEDB_INIT_ERROR 0xFF
131 #define OLEDB_INVALID_DATA_MODE 0xFE
132 #define OLEDB_INVALID_DRIVER_SELECTOR 0xFD
133  // End error group
136 
141 #define OLEDB_MAP_MIKROBUS( cfg, mikrobus ) \
142  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
143  cfg.dc = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
144  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
145  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
146  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
147  cfg.sdi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
148  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
149  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
150  // End macros group
153 // --------------------------------------------------------------- PUBLIC TYPES
159 typedef uint8_t oledb_drv_select_t;
160 
161 typedef uint8_t oledb_data_t;
162 
163 typedef const uint8_t oledb_resources_t;
164 
165 typedef void ( *oledb_master_write_t )( struct oledb_s *, oledb_data_t *, uint8_t );
169 typedef uint8_t oledb_select_t;
170 
174 typedef struct oledb_s
175 {
176  // Click mikrobus DRV objects.
177  digital_out_t cs;
178  digital_out_t rst;
179  digital_out_t dc;
180 
181  // Modules
182  spi_master_t spi;
183  i2c_master_t i2c;
184 
185  // ctx variable
186 
187  uint8_t slave_address;
188  pin_name_t chip_select;
189 
190  // Click send function pointer.
193 
195 
199 typedef struct
200 {
201  // Used mikrobus pins.
202  pin_name_t rst;
203  pin_name_t dc;
204  pin_name_t cs;
205  pin_name_t sck;
206  pin_name_t sdi;
207  pin_name_t scl;
208  pin_name_t sda;
209  pin_name_t miso;
210 
211  // static variable
212 
213  uint32_t i2c_speed;
214  uint8_t i2c_address;
215  uint32_t spi_speed;
216  spi_master_mode_t spi_mode;
217  spi_master_chip_select_polarity_t cs_polarity;
218 
225 
226 } oledb_cfg_t;
227  // End types group
229 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
235 #ifdef __cplusplus
236 extern "C"{
237 #endif
238 
250 
264 
272 void oledb_send_cmd( oledb_t *ctx, oledb_data_t tx_cmd );
273 
282 void oledb_send_data( oledb_t *ctx, oledb_data_t *tx_data, uint8_t data_len );
283 
292 
301 void oledb_set_page( oledb_t *ctx, oledb_data_t page_addr );
302 
311 void oledb_set_column( oledb_t *ctx, oledb_data_t col_addr );
312 
322 
331 
343 void oledb_write_char( oledb_t *ctx, uint8_t font, uint8_t row, uint8_t position, uint8_t data_in );
344 
356 void oledb_write_string( oledb_t *ctx, uint8_t font, uint8_t row, uint8_t position, uint8_t *data_in );
357 
367 
377 void oledb_scroll_right( oledb_t *ctx, oledb_data_t start_page_addr, oledb_data_t end_page_addr );
378 
388 void oledb_scroll_left( oledb_t *ctx, oledb_data_t start_page_addr, oledb_data_t end_page_addr );
389 
399 void oledb_scroll_diag_right( oledb_t *ctx, oledb_data_t start_page_addr, oledb_data_t end_page_addr );
400 
410 void oledb_scroll_diag_left( oledb_t *ctx, oledb_data_t start_page_addr, oledb_data_t end_page_addr );
411 
420 
421 #ifdef __cplusplus
422 }
423 #endif
424 #endif // OLEDB_H
425  // oledb
427 
428 // ------------------------------------------------------------------------ END
oledb_init
err_t oledb_init(oledb_t *ctx, oledb_cfg_t *cfg)
Click Initialization function.
oledb_resources.h
oledb_s::spi
spi_master_t spi
Definition: oledb.h:182
oledb_set_column
void oledb_set_column(oledb_t *ctx, oledb_data_t col_addr)
Column Setting function.
oledb_scroll_left
void oledb_scroll_left(oledb_t *ctx, oledb_data_t start_page_addr, oledb_data_t end_page_addr)
Scroll Left function.
oledb_s::slave_address
uint8_t slave_address
Definition: oledb.h:187
oledb_s::dc
digital_out_t dc
Definition: oledb.h:179
oledb_send_data
void oledb_send_data(oledb_t *ctx, oledb_data_t *tx_data, uint8_t data_len)
Send data function.
oledb_cfg_t::spi_speed
uint32_t spi_speed
Definition: oledb.h:215
oledb_data_t
uint8_t oledb_data_t
Definition: oledb.h:161
oledb_t
struct oledb_s oledb_t
Click context object definition.
oledb_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: oledb.h:216
oledb_cfg_t::sel
oledb_select_t sel
Definition: oledb.h:224
oledb_cfg_setup
void oledb_cfg_setup(oledb_cfg_t *cfg)
Configuration Object Setup function.
oledb_s::chip_select
pin_name_t chip_select
Definition: oledb.h:188
oledb_cfg_t
Click configuration structure definition.
Definition: oledb.h:200
oledb_display_picture
void oledb_display_picture(oledb_t *ctx, oledb_resources_t *pic)
Display Picture function.
oledb_cfg_t::sda
pin_name_t sda
Definition: oledb.h:208
oledb_cfg_t::scl
pin_name_t scl
Definition: oledb.h:207
oledb_s::cs
digital_out_t cs
Definition: oledb.h:177
oledb_s::master_sel
oledb_select_t master_sel
Definition: oledb.h:192
oledb_cfg_t::sdi
pin_name_t sdi
Definition: oledb.h:206
oledb_cfg_t::dc
pin_name_t dc
Definition: oledb.h:203
oledb_cfg_t::miso
pin_name_t miso
Definition: oledb.h:209
oledb_select_t
uint8_t oledb_select_t
Communication type.
Definition: oledb.h:169
oledb_scroll_diag_left
void oledb_scroll_diag_left(oledb_t *ctx, oledb_data_t start_page_addr, oledb_data_t end_page_addr)
Scroll Diagonally Left function.
oledb_write_char
void oledb_write_char(oledb_t *ctx, uint8_t font, uint8_t row, uint8_t position, uint8_t data_in)
Write Char function.
oledb_scroll_right
void oledb_scroll_right(oledb_t *ctx, oledb_data_t start_page_addr, oledb_data_t end_page_addr)
Scroll Right function.
oledb_set_page
void oledb_set_page(oledb_t *ctx, oledb_data_t page_addr)
Page Setting function.
oledb_stop_scroll
void oledb_stop_scroll(oledb_t *ctx)
Stop Scrolling function.
oledb_s
Click context object definition.
Definition: oledb.h:175
oledb_s::send
oledb_master_write_t send
Definition: oledb.h:191
oledb_cfg_t::i2c_address
uint8_t i2c_address
Definition: oledb.h:214
oledb_write_string
void oledb_write_string(oledb_t *ctx, uint8_t font, uint8_t row, uint8_t position, uint8_t *data_in)
Write String function.
oledb_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: oledb.h:213
oledb_send_cmd
void oledb_send_cmd(oledb_t *ctx, oledb_data_t tx_cmd)
Send cmd function.
oledb_drv_select_t
uint8_t oledb_drv_select_t
Definition: oledb.h:159
oledb_s::rst
digital_out_t rst
Definition: oledb.h:178
oledb_cfg_t::cs
pin_name_t cs
Definition: oledb.h:204
oledb_scroll_diag_right
void oledb_scroll_diag_right(oledb_t *ctx, oledb_data_t start_page_addr, oledb_data_t end_page_addr)
Scroll Diagonally Right function.
oledb_cfg_t::sck
pin_name_t sck
Definition: oledb.h:205
oledb_clear_display
void oledb_clear_display(oledb_t *ctx)
Clear Display function.
oledb_default_cfg
void oledb_default_cfg(oledb_t *ctx)
Click Default Configuration function.
oledb_cfg_t::rst
pin_name_t rst
Definition: oledb.h:202
err_t
#define err_t
Definition: oledb.h:122
oledb_s::i2c
i2c_master_t i2c
Definition: oledb.h:183
oledb_set_contrast
void oledb_set_contrast(oledb_t *ctx, oledb_data_t value)
Contrast Setting function.
oledb_resources_t
const uint8_t oledb_resources_t
Definition: oledb.h:163
oledb_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: oledb.h:217
oledb_master_write_t
void(* oledb_master_write_t)(struct oledb_s *, oledb_data_t *, uint8_t)
Definition: oledb.h:165