oledw  2.0.0.0
oledw.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 _OLEDW_H_
29 #define _OLEDW_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 
45 // -------------------------------------------------------------- PUBLIC MACROS
55 #define OLEDW_LCDWIDTH 96
56 #define OLEDW_LCDHEIGHT 39
57 #define OLEDW_DISPLAYOFF 0xAE
58 #define OLEDW_SETDISPLAYCLOCKDIV 0xD5
59 #define OLEDW_SETMULTIPLEX 0xA8
60 #define OLEDW_SETDISPLAYOFFSET 0xD3
61 #define OLEDW_SETSTARTLINE 0x40
62 #define OLEDW_CHARGEPUMP 0x8D
63 #define OLEDW_SETSEGMENTREMAP 0xA1
64 #define OLEDW_SEGREMAP 0xA0
65 #define OLEDW_COMSCANDEC 0xC8
66 #define OLEDW_SETCOMPINS 0xDA
67 #define OLEDW_SETCONTRAST 0x81
68 #define OLEDW_SETPRECHARGE 0xD9
69 #define OLEDW_SETVCOMDETECT 0xDB
70 #define OLEDW_DISPLAYALLON_RESUME 0xA4
71 #define OLEDW_NORMALDISPLAY 0xA6
72 #define OLEDW_DISPLAYON 0xAF
73 #define OLEDW_DISPLAYALLON 0xA5
74 #define OLEDW_INVERTDISPLAY 0xA7
75 #define OLEDW_SETLOWCOLUMN 0x00
76 #define OLEDW_SETHIGHCOLUMN 0x10
77 #define OLEDW_MEMORYMODE 0x20
78 #define OLEDW_COLUMNADDR 0x21
79 #define OLEDW_PAGEADDR 0x22
80 #define OLEDW_COMSCANINC 0xC0
81 #define OLEDW_EXTERNALVCC 0x1
82 #define OLEDW_SWITCHCAPVCC 0x2
83 #define OLEDW_ACTIVATE_SCROLL 0x2F
84 #define OLEDW_DEACTIVATE_SCROLL 0x2E
85 #define OLEDW_SET_VERTICAL_SCROLL_AREA 0xA3
86 #define OLEDW_RIGHT_HORIZONTAL_SCROLL 0x26
87 #define OLEDW_LEFT_HORIZONTAL_SCROLL 0x27
88 #define OLEDW_VERTICAL_AND_RIGHT_HORIZONTAL_SCROLL 0x29
89 #define OLEDW_VERTICAL_AND_LEFT_HORIZONTAL_SCROLL 0x2A
90 
96 #define OLEDW_COMMAND 0x3C
97 #define OLEDW_DATA 0x3D
98 
104 #define OLEDW_MASTER_I2C 0
105 #define OLEDW_MASTER_SPI 1
106 
117 #define err_t uint8_t
118 
124 #define OLEDW_OK 0x00
125 #define OLEDW_INIT_ERROR 0xFF
126 #define OLEDW_INVALID_DATA_MODE 0xFE
127 #define OLEDW_INVALID_DRIVER_SELECTOR 0xFD
128  // End error group
131 
136 #define OLEDW_MAP_MIKROBUS( cfg, mikrobus ) \
137  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
138  cfg.dc = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
139  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
140  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
141  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
142  cfg.sdi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
143  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
144  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
145  // End macros group
148 // --------------------------------------------------------------- PUBLIC TYPES
154 typedef uint8_t oledw_drv_select_t;
155 
156 typedef uint8_t oledw_data_t;
157 typedef uint8_t oledw_data_mode_t;
158 
159 typedef const uint8_t oledw_resources_t;
160 
165 typedef uint8_t oledw_select_t;
166 
170 typedef struct oledw_s
171 {
172  // Click mikrobus DRV objects.
173  digital_out_t cs;
174  digital_out_t rst;
175  digital_out_t dc;
176 
177  // Modules
178  spi_master_t spi;
179  i2c_master_t i2c;
180 
181  // ctx variable
182 
183  uint8_t slave_address;
184  pin_name_t chip_select;
185 
186  // Click send function pointer.
189 
191 
195 typedef struct
196 {
197  // Used mikrobus pins.
198  pin_name_t rst;
199  pin_name_t dc;
200  pin_name_t cs;
201  pin_name_t sck;
202  pin_name_t sdi;
203  pin_name_t scl;
204  pin_name_t sda;
205  pin_name_t miso;
206 
207  // static variable
208 
209  uint32_t i2c_speed;
210  uint8_t i2c_address;
211  uint32_t spi_speed;
212  spi_master_mode_t spi_mode;
213  spi_master_chip_select_polarity_t cs_polarity;
214 
221 
222 } oledw_cfg_t;
223  // End types group
225 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
231 #ifdef __cplusplus
232 extern "C"{
233 #endif
234 
246 
260 
274 
283 
292 void oledw_set_page( oledw_t *ctx, oledw_data_t page_addr );
293 
302 void oledw_set_column( oledw_t *ctx, oledw_data_t col_addr );
303 
314 
324 
334 void oledw_scroll_right( oledw_t *ctx, oledw_data_t start_page_addr, oledw_data_t end_page_addr );
335 
345 void oledw_scroll_left( oledw_t *ctx, oledw_data_t start_page_addr, oledw_data_t end_page_addr );
346 
356 void oledw_scroll_diag_right( oledw_t *ctx, oledw_data_t start_page_addr, oledw_data_t end_page_addr );
357 
367 void oledw_scroll_diag_left( oledw_t *ctx, oledw_data_t start_page_addr, oledw_data_t end_page_addr );
368 
377 
378 #ifdef __cplusplus
379 }
380 #endif
381 #endif // OLEDW_H
382  // oledw
384 
385 // ------------------------------------------------------------------------ END
oledw_cfg_t::miso
pin_name_t miso
Definition: oledw.h:205
oledw_scroll_left
void oledw_scroll_left(oledw_t *ctx, oledw_data_t start_page_addr, oledw_data_t end_page_addr)
Scroll Left function.
oledw_cfg_setup
void oledw_cfg_setup(oledw_cfg_t *cfg)
Configuration Object Setup function.
oledw_set_contrast
void oledw_set_contrast(oledw_t *ctx, oledw_data_t value)
Contrast Setting function.
oledw_s::spi
spi_master_t spi
Definition: oledw.h:178
oledw_data_t
uint8_t oledw_data_t
Definition: oledw.h:156
oledw_t
struct oledw_s oledw_t
Click context object definition.
oledw_cfg_t::cs
pin_name_t cs
Definition: oledw.h:200
oledw_s
Click context object definition.
Definition: oledw.h:171
oledw_drv_select_t
uint8_t oledw_drv_select_t
Definition: oledw.h:154
oledw_cfg_t::spi_speed
uint32_t spi_speed
Definition: oledw.h:211
oledw_resources_t
const uint8_t oledw_resources_t
Definition: oledw.h:159
oledw_display_picture
void oledw_display_picture(oledw_t *ctx, oledw_resources_t *pic)
Display Picture function.
oledw_s::send
oledw_master_write_t send
Definition: oledw.h:187
oledw_master_write_t
err_t(* oledw_master_write_t)(struct oledw_s *, oledw_data_t, oledw_data_mode_t)
Definition: oledw.h:161
oledw_s::master_sel
oledw_select_t master_sel
Definition: oledw.h:188
oledw_cfg_t::rst
pin_name_t rst
Definition: oledw.h:198
oledw_default_cfg
void oledw_default_cfg(oledw_t *ctx)
Click Default Configuration function.
oledw_cfg_t::scl
pin_name_t scl
Definition: oledw.h:203
oledw_cfg_t::sdi
pin_name_t sdi
Definition: oledw.h:202
oledw_s::chip_select
pin_name_t chip_select
Definition: oledw.h:184
oledw_scroll_diag_right
void oledw_scroll_diag_right(oledw_t *ctx, oledw_data_t start_page_addr, oledw_data_t end_page_addr)
Scroll Diagonally Right function.
oledw_s::slave_address
uint8_t slave_address
Definition: oledw.h:183
oledw_cfg_t
Click configuration structure definition.
Definition: oledw.h:196
oledw_cfg_t::dc
pin_name_t dc
Definition: oledw.h:199
oledw_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: oledw.h:209
oledw_init
err_t oledw_init(oledw_t *ctx, oledw_cfg_t *cfg)
Click Initialization function.
oledw_scroll_diag_left
void oledw_scroll_diag_left(oledw_t *ctx, oledw_data_t start_page_addr, oledw_data_t end_page_addr)
Scroll Diagonally Left function.
oledw_data_mode_t
uint8_t oledw_data_mode_t
Definition: oledw.h:157
oledw_scroll_right
void oledw_scroll_right(oledw_t *ctx, oledw_data_t start_page_addr, oledw_data_t end_page_addr)
Scroll Right function.
oledw_select_t
uint8_t oledw_select_t
Communication type.
Definition: oledw.h:165
oledw_set_column
void oledw_set_column(oledw_t *ctx, oledw_data_t col_addr)
Column Setting function.
oledw_s::cs
digital_out_t cs
Definition: oledw.h:173
oledw_cfg_t::sel
oledw_select_t sel
Definition: oledw.h:220
oledw_cfg_t::sda
pin_name_t sda
Definition: oledw.h:204
oledw_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: oledw.h:213
oledw_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: oledw.h:212
oledw_set_page
void oledw_set_page(oledw_t *ctx, oledw_data_t page_addr)
Page Setting function.
oledw_s::rst
digital_out_t rst
Definition: oledw.h:174
err_t
#define err_t
Definition: oledw.h:117
oledw_cfg_t::sck
pin_name_t sck
Definition: oledw.h:201
oledw_cfg_t::i2c_address
uint8_t i2c_address
Definition: oledw.h:210
oledw_s::i2c
i2c_master_t i2c
Definition: oledw.h:179
oledw_s::dc
digital_out_t dc
Definition: oledw.h:175
oledw_stop_scroll
void oledw_stop_scroll(oledw_t *ctx)
Stop Scrolling function.
oledw_send
err_t oledw_send(oledw_t *ctx, oledw_data_t tx_data, oledw_data_mode_t data_mode)
Send function.