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 "drv_digital_out.h"
32 #include "drv_i2c_master.h"
33 #include "drv_spi_master.h"
34 #include "oledb_resources.h"
35 
36 // -------------------------------------------------------------- PUBLIC MACROS
46 #define OLEDB_SSD1306_WIDTH 128
47 #define OLEDB_DISPLAY_WIDTH 96
48 #define OLEDB_DISPLAY_HEIGHT 39
49 #define OLEDB_DISPLAY_ROWS 5
50 #define OLEDB_FONT_5X7 0
51 #define OLEDB_FONT_6X8 1
52 #define OLEDB_DISPLAYOFF 0xAE
53 #define OLEDB_SETDISPLAYCLOCKDIV 0xD5
54 #define OLEDB_SETMULTIPLEX 0xA8
55 #define OLEDB_SETDISPLAYOFFSET 0xD3
56 #define OLEDB_SETSTARTLINE 0x40
57 #define OLEDB_CHARGEPUMP 0x8D
58 #define OLEDB_SETSEGMENTREMAP 0xA1
59 #define OLEDB_SEGREMAP 0xA0
60 #define OLEDB_COMSCANDEC 0xC8
61 #define OLEDB_SETCOMPINS 0xDA
62 #define OLEDB_SETCONTRAST 0x81
63 #define OLEDB_SETPRECHARGE 0xD9
64 #define OLEDB_SETVCOMDETECT 0xDB
65 #define OLEDB_DISPLAYALLON_RESUME 0xA4
66 #define OLEDB_NORMALDISPLAY 0xA6
67 #define OLEDB_DISPLAYON 0xAF
68 #define OLEDB_DISPLAYALLON 0xA5
69 #define OLEDB_INVERTDISPLAY 0xA7
70 #define OLEDB_SETLOWCOLUMN 0x00
71 #define OLEDB_SETHIGHCOLUMN 0x10
72 #define OLEDB_MEMORYMODE 0x20
73 #define OLEDB_COLUMNADDR 0x21
74 #define OLEDB_PAGEADDR 0x22
75 #define OLEDB_COMSCANINC 0xC0
76 #define OLEDB_EXTERNALVCC 0x01
77 #define OLEDB_SWITCHCAPVCC 0x02
78 #define OLEDB_ACTIVATE_SCROLL 0x2F
79 #define OLEDB_DEACTIVATE_SCROLL 0x2E
80 #define OLEDB_SET_VERTICAL_SCROLL_AREA 0xA3
81 #define OLEDB_RIGHT_HORIZONTAL_SCROLL 0x26
82 #define OLEDB_LEFT_HORIZONTAL_SCROLL 0x27
83 #define OLEDB_VERTICAL_AND_RIGHT_HORIZONTAL_SCROLL 0x29
84 #define OLEDB_VERTICAL_AND_LEFT_HORIZONTAL_SCROLL 0x2A
85 
91 #define OLEDB_COMMAND 0x3C
92 #define OLEDB_DATA 0x3D
93 
99 #define OLEDB_MASTER_I2C 0
100 #define OLEDB_MASTER_SPI 1
101 
112 #define err_t uint8_t
113 
119 #define OLEDB_OK 0x00
120 #define OLEDB_INIT_ERROR 0xFF
121 #define OLEDB_INVALID_DATA_MODE 0xFE
122 #define OLEDB_INVALID_DRIVER_SELECTOR 0xFD
123  // End error group
126 
131 #define OLEDB_MAP_MIKROBUS( cfg, mikrobus ) \
132  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
133  cfg.dc = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
134  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
135  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
136  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
137  cfg.sdi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
138  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
139  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
140  // End macros group
143 // --------------------------------------------------------------- PUBLIC TYPES
149 typedef uint8_t oledb_drv_select_t;
150 
151 typedef uint8_t oledb_data_t;
152 
153 typedef const uint8_t oledb_resources_t;
154 
155 typedef void ( *oledb_master_write_t )( struct oledb_s *, oledb_data_t *, uint8_t );
159 typedef uint8_t oledb_select_t;
160 
164 typedef struct oledb_s
165 {
166  // Click mikrobus DRV objects.
167  digital_out_t cs;
168  digital_out_t rst;
169  digital_out_t dc;
170 
171  // Modules
172  spi_master_t spi;
173  i2c_master_t i2c;
174 
175  // ctx variable
176 
177  uint8_t slave_address;
178  pin_name_t chip_select;
179 
180  // Click send function pointer.
183 
185 
189 typedef struct
190 {
191  // Used mikrobus pins.
192  pin_name_t rst;
193  pin_name_t dc;
194  pin_name_t cs;
195  pin_name_t sck;
196  pin_name_t sdi;
197  pin_name_t scl;
198  pin_name_t sda;
199  pin_name_t miso;
200 
201  // static variable
202 
203  uint32_t i2c_speed;
204  uint8_t i2c_address;
205  uint32_t spi_speed;
206  spi_master_mode_t spi_mode;
207  spi_master_chip_select_polarity_t cs_polarity;
208 
215 
216 } oledb_cfg_t;
217  // End types group
219 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
225 #ifdef __cplusplus
226 extern "C"{
227 #endif
228 
240 
254 
262 void oledb_send_cmd( oledb_t *ctx, oledb_data_t tx_cmd );
263 
272 void oledb_send_data( oledb_t *ctx, oledb_data_t *tx_data, uint8_t data_len );
273 
282 
291 void oledb_set_page( oledb_t *ctx, oledb_data_t page_addr );
292 
301 void oledb_set_column( oledb_t *ctx, oledb_data_t col_addr );
302 
312 
321 
333 void oledb_write_char( oledb_t *ctx, uint8_t font, uint8_t row, uint8_t position, uint8_t data_in );
334 
346 void oledb_write_string( oledb_t *ctx, uint8_t font, uint8_t row, uint8_t position, uint8_t *data_in );
347 
357 
367 void oledb_scroll_right( oledb_t *ctx, oledb_data_t start_page_addr, oledb_data_t end_page_addr );
368 
378 void oledb_scroll_left( oledb_t *ctx, oledb_data_t start_page_addr, oledb_data_t end_page_addr );
379 
389 void oledb_scroll_diag_right( oledb_t *ctx, oledb_data_t start_page_addr, oledb_data_t end_page_addr );
390 
400 void oledb_scroll_diag_left( oledb_t *ctx, oledb_data_t start_page_addr, oledb_data_t end_page_addr );
401 
410 
411 #ifdef __cplusplus
412 }
413 #endif
414 #endif // OLEDB_H
415  // oledb
417 
418 // ------------------------------------------------------------------------ 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:172
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:177
oledb_s::dc
digital_out_t dc
Definition: oledb.h:169
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:205
oledb_data_t
uint8_t oledb_data_t
Definition: oledb.h:151
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:206
oledb_cfg_t::sel
oledb_select_t sel
Definition: oledb.h:214
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:178
oledb_cfg_t
Click configuration structure definition.
Definition: oledb.h:190
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:198
oledb_cfg_t::scl
pin_name_t scl
Definition: oledb.h:197
oledb_s::cs
digital_out_t cs
Definition: oledb.h:167
oledb_s::master_sel
oledb_select_t master_sel
Definition: oledb.h:182
oledb_cfg_t::sdi
pin_name_t sdi
Definition: oledb.h:196
oledb_cfg_t::dc
pin_name_t dc
Definition: oledb.h:193
oledb_cfg_t::miso
pin_name_t miso
Definition: oledb.h:199
oledb_select_t
uint8_t oledb_select_t
Communication type.
Definition: oledb.h:159
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:165
oledb_s::send
oledb_master_write_t send
Definition: oledb.h:181
oledb_cfg_t::i2c_address
uint8_t i2c_address
Definition: oledb.h:204
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:203
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:149
oledb_s::rst
digital_out_t rst
Definition: oledb.h:168
oledb_cfg_t::cs
pin_name_t cs
Definition: oledb.h:194
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:195
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:192
err_t
#define err_t
Definition: oledb.h:112
oledb_s::i2c
i2c_master_t i2c
Definition: oledb.h:173
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:153
oledb_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: oledb.h:207
oledb_master_write_t
void(* oledb_master_write_t)(struct oledb_s *, oledb_data_t *, uint8_t)
Definition: oledb.h:155