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 "drv_digital_out.h"
32 #include "drv_i2c_master.h"
33 #include "drv_spi_master.h"
34 
35 // -------------------------------------------------------------- PUBLIC MACROS
45 #define OLEDW_LCDWIDTH 96
46 #define OLEDW_LCDHEIGHT 39
47 #define OLEDW_DISPLAYOFF 0xAE
48 #define OLEDW_SETDISPLAYCLOCKDIV 0xD5
49 #define OLEDW_SETMULTIPLEX 0xA8
50 #define OLEDW_SETDISPLAYOFFSET 0xD3
51 #define OLEDW_SETSTARTLINE 0x40
52 #define OLEDW_CHARGEPUMP 0x8D
53 #define OLEDW_SETSEGMENTREMAP 0xA1
54 #define OLEDW_SEGREMAP 0xA0
55 #define OLEDW_COMSCANDEC 0xC8
56 #define OLEDW_SETCOMPINS 0xDA
57 #define OLEDW_SETCONTRAST 0x81
58 #define OLEDW_SETPRECHARGE 0xD9
59 #define OLEDW_SETVCOMDETECT 0xDB
60 #define OLEDW_DISPLAYALLON_RESUME 0xA4
61 #define OLEDW_NORMALDISPLAY 0xA6
62 #define OLEDW_DISPLAYON 0xAF
63 #define OLEDW_DISPLAYALLON 0xA5
64 #define OLEDW_INVERTDISPLAY 0xA7
65 #define OLEDW_SETLOWCOLUMN 0x00
66 #define OLEDW_SETHIGHCOLUMN 0x10
67 #define OLEDW_MEMORYMODE 0x20
68 #define OLEDW_COLUMNADDR 0x21
69 #define OLEDW_PAGEADDR 0x22
70 #define OLEDW_COMSCANINC 0xC0
71 #define OLEDW_EXTERNALVCC 0x1
72 #define OLEDW_SWITCHCAPVCC 0x2
73 #define OLEDW_ACTIVATE_SCROLL 0x2F
74 #define OLEDW_DEACTIVATE_SCROLL 0x2E
75 #define OLEDW_SET_VERTICAL_SCROLL_AREA 0xA3
76 #define OLEDW_RIGHT_HORIZONTAL_SCROLL 0x26
77 #define OLEDW_LEFT_HORIZONTAL_SCROLL 0x27
78 #define OLEDW_VERTICAL_AND_RIGHT_HORIZONTAL_SCROLL 0x29
79 #define OLEDW_VERTICAL_AND_LEFT_HORIZONTAL_SCROLL 0x2A
80 
86 #define OLEDW_COMMAND 0x3C
87 #define OLEDW_DATA 0x3D
88 
94 #define OLEDW_MASTER_I2C 0
95 #define OLEDW_MASTER_SPI 1
96 
107 #define err_t uint8_t
108 
114 #define OLEDW_OK 0x00
115 #define OLEDW_INIT_ERROR 0xFF
116 #define OLEDW_INVALID_DATA_MODE 0xFE
117 #define OLEDW_INVALID_DRIVER_SELECTOR 0xFD
118  // End error group
121 
126 #define OLEDW_MAP_MIKROBUS( cfg, mikrobus ) \
127  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
128  cfg.dc = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
129  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
130  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
131  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
132  cfg.sdi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
133  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
134  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
135  // End macros group
138 // --------------------------------------------------------------- PUBLIC TYPES
144 typedef uint8_t oledw_drv_select_t;
145 
146 typedef uint8_t oledw_data_t;
147 typedef uint8_t oledw_data_mode_t;
148 
149 typedef const uint8_t oledw_resources_t;
150 
155 typedef uint8_t oledw_select_t;
156 
160 typedef struct oledw_s
161 {
162  // Click mikrobus DRV objects.
163  digital_out_t cs;
164  digital_out_t rst;
165  digital_out_t dc;
166 
167  // Modules
168  spi_master_t spi;
169  i2c_master_t i2c;
170 
171  // ctx variable
172 
173  uint8_t slave_address;
174  pin_name_t chip_select;
175 
176  // Click send function pointer.
179 
180 } oledw_t;
181 
185 typedef struct
186 {
187  // Used mikrobus pins.
188  pin_name_t rst;
189  pin_name_t dc;
190  pin_name_t cs;
191  pin_name_t sck;
192  pin_name_t sdi;
193  pin_name_t scl;
194  pin_name_t sda;
195  pin_name_t miso;
196 
197  // static variable
198 
199  uint32_t i2c_speed;
200  uint8_t i2c_address;
201  uint32_t spi_speed;
202  spi_master_mode_t spi_mode;
203  spi_master_chip_select_polarity_t cs_polarity;
204 
210  oledw_select_t sel;
211 
212 } oledw_cfg_t;
213  // End types group
215 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
221 #ifdef __cplusplus
222 extern "C"{
223 #endif
224 
235 void oledw_cfg_setup( oledw_cfg_t *cfg );
236 
249 err_t oledw_init( oledw_t *ctx, oledw_cfg_t *cfg );
250 
263 err_t oledw_send( oledw_t *ctx, oledw_data_t tx_data, oledw_data_mode_t data_mode );
264 
272 void oledw_default_cfg( oledw_t *ctx );
273 
282 void oledw_set_page( oledw_t *ctx, oledw_data_t page_addr );
283 
292 void oledw_set_column( oledw_t *ctx, oledw_data_t col_addr );
293 
304 
313 void oledw_set_contrast( oledw_t *ctx, oledw_data_t value );
314 
324 void oledw_scroll_right( oledw_t *ctx, oledw_data_t start_page_addr, oledw_data_t end_page_addr );
325 
335 void oledw_scroll_left( oledw_t *ctx, oledw_data_t start_page_addr, oledw_data_t end_page_addr );
336 
346 void oledw_scroll_diag_right( oledw_t *ctx, oledw_data_t start_page_addr, oledw_data_t end_page_addr );
347 
357 void oledw_scroll_diag_left( oledw_t *ctx, oledw_data_t start_page_addr, oledw_data_t end_page_addr );
358 
366 void oledw_stop_scroll( oledw_t *ctx );
367 
368 #ifdef __cplusplus
369 }
370 #endif
371 #endif // OLEDW_H
372  // oledw
374 
375 // ------------------------------------------------------------------------ END
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:167
oledw_data_t
uint8_t oledw_data_t
Definition: oledw.h:145
oledw_s
Click context object definition.
Definition: oledw.h:159
oledw_drv_select_t
uint8_t oledw_drv_select_t
Definition: oledw.h:143
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:176
oledw_master_write_t
err_t(* oledw_master_write_t)(struct oledw_s *, oledw_data_t, oledw_data_mode_t)
Definition: oledw.h:150
oledw_resources_t
const typedef uint8_t oledw_resources_t
Definition: oledw.h:148
oledw_s::master_sel
oledw_select_t master_sel
Definition: oledw.h:177
oledw_default_cfg
void oledw_default_cfg(oledw_t *ctx)
Click Default Configuration function.
oledw_s::chip_select
pin_name_t chip_select
Definition: oledw.h:173
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:172
oledw_cfg_t
Click configuration structure definition.
Definition: oledw.h:184
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:146
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:154
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:162
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:163
oledw_t
struct oledw_s oledw_t
Click context object definition.
err_t
#define err_t
Definition: oledw.h:106
oledw_s::i2c
i2c_master_t i2c
Definition: oledw.h:168
oledw_s::dc
digital_out_t dc
Definition: oledw.h:164
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.