lcdmini 2.0.0.0
lcdmini.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 LCDMINI_H
29#define LCDMINI_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37#include "drv_spi_master.h"
38#include "spi_specifics.h"
39#include "drv_pwm.h"
40
61#define LCDMINI_IODIRB_BANK0 0x01
62#define LCDMINI_OLATB_BANK0 0x15
63#define LCDMINI_IOCON_BANK0 0x0A
64#define LCDMINI_ADDRESS_CODE 0x40
65#define LCDMINI_GPIO_REGISTER 0x09
66 // lcdmini_reg
68
83#define LCDMINI_ENABLE 0x08
84#define LCDMINI_RESET 0x04
85
86#define LCDMINI_OP_CODE_READ 0x01
87#define LCDMINI_OP_CODE_WRITE 0xFE
88
93#define LCDMINI_CLEAR 0x01
94#define LCDMINI_RETURN_HOME 0x02
95#define LCDMINI_DISPLAY_OFF_CURSOR_OFF 0x08
96#define LCDMINI_CURSOR_OFF 0x0C
97#define LCDMINI_UNDERLINE_ON 0x0E
98#define LCDMINI_BLINK_CURSOR_ON 0x0F
99#define LCDMINI_MOVE_CURSOR_LEFT 0x10
100#define LCDMINI_MOVE_CURSOR_RIGHT 0x14
101#define LCDMINI_TURN_ON 0x0A
102#define LCDMINI_TURN_OFF 0x0C
103#define LCDMINI_SHIFT_LEFT 0x18
104#define LCDMINI_SHIFT_RIGHT 0x1C
105#define LCDMINI_2_LINE_5X7 0x28
106
107#define LCDMINI_FIRST_ROW 0x80
108#define LCDMINI_SECOND_ROW 0xC0
109#define LCDMINI_THIRD_ROW 0x94
110#define LCDMINI_FOURTH_ROW 0xD4
111
112
117#define LCDMINI_DEF_FREQ 500
118
127#define LCDMINI_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
128#define LCDMINI_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
129 // lcdmini_set
131
146#define LCDMINI_MAP_MIKROBUS( cfg, mikrobus ) \
147 cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
148 cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
149 cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
150 cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
151 cfg.cs2 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
152 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
153 cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
154 cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
155 // lcdmini_map // lcdmini
158
163typedef struct
164{
165 // Output pins
166 digital_out_t cs2;
167 digital_out_t rst;
169 // Input pins
170 digital_in_t int_pin;
172 // Modules
173 pwm_t pwm;
175 spi_master_t spi;
177 pin_name_t chip_select;
178 uint32_t pwm_freq;
180} lcdmini_t;
181
186typedef struct
187{
188 // Communication gpio pins
189 pin_name_t miso;
190 pin_name_t mosi;
191 pin_name_t sck;
192 pin_name_t cs;
194 // Additional gpio pins
195 pin_name_t cs2;
196 pin_name_t rst;
197 pin_name_t pwm;
198 pin_name_t int_pin;
200 // Static variables
201 uint32_t dev_pwm_freq;
203 uint32_t spi_speed;
204 spi_master_mode_t spi_mode;
205 spi_master_chip_select_polarity_t cs_polarity;
208
213typedef enum
214{
216 LCDMINI_ERROR = -1
217
219
236
251
266
281err_t lcdmini_generic_write ( lcdmini_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
282
297err_t lcdmini_generic_read ( lcdmini_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
298
310err_t lcdmini_set_duty_cycle ( lcdmini_t *ctx, float duty_cycle );
311
323
335
345void lcdmini_set_backlight ( lcdmini_t *ctx, float backlight_value );
346
356void lcdmini_set_contrast( lcdmini_t *ctx, uint8_t contrast_value );
357
366
375
389err_t lcdmini_read_register ( lcdmini_t *ctx, uint8_t reg , uint8_t *data_out );
390
404err_t lcdmini_write_register ( lcdmini_t *ctx, uint8_t reg , uint8_t data_in );
405
414void lcdmini_send_cmd ( lcdmini_t *ctx, uint8_t command );
415
424void lcdmini_send_char ( lcdmini_t *ctx, uint8_t character );
425
436void lcdmini_display_char ( lcdmini_t *ctx, uint8_t row, uint8_t column, char character );
437
450void lcdmini_display_text ( lcdmini_t *ctx, uint8_t row, uint8_t column, char *data_in );
451
452#ifdef __cplusplus
453}
454#endif
455#endif // LCDMINI_H
456 // lcdmini
458
459// ------------------------------------------------------------------------ END
void lcdmini_set_contrast(lcdmini_t *ctx, uint8_t contrast_value)
Set contrast function.
void lcdmini_display_text(lcdmini_t *ctx, uint8_t row, uint8_t column, char *data_in)
LCD mini display text.
void lcdmini_send_char(lcdmini_t *ctx, uint8_t character)
LCD mini send character.
err_t lcdmini_pwm_stop(lcdmini_t *ctx)
LCD mini stop PWM module.
void lcdmini_hw_reset(lcdmini_t *ctx)
Hardware reset function.
err_t lcdmini_read_register(lcdmini_t *ctx, uint8_t reg, uint8_t *data_out)
LCD mini register data reading function.
err_t lcdmini_generic_write(lcdmini_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
LCD mini data writing function.
void lcdmini_cfg_setup(lcdmini_cfg_t *cfg)
LCD mini configuration object setup function.
err_t lcdmini_write_register(lcdmini_t *ctx, uint8_t reg, uint8_t data_in)
LCD mini register data writing function.
void lcdmini_send_cmd(lcdmini_t *ctx, uint8_t command)
LCD mini send command.
err_t lcdmini_default_cfg(lcdmini_t *ctx)
LCD mini default configuration function.
err_t lcdmini_set_duty_cycle(lcdmini_t *ctx, float duty_cycle)
LCD mini sets PWM duty cycle.
err_t lcdmini_generic_read(lcdmini_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
LCD mini data reading function.
void lcdmini_set_backlight(lcdmini_t *ctx, float backlight_value)
Set backlight function.
err_t lcdmini_init(lcdmini_t *ctx, lcdmini_cfg_t *cfg)
LCD mini initialization function.
uint8_t lcdmini_get_interrupt(lcdmini_t *ctx)
Get interrupt.
void lcdmini_display_char(lcdmini_t *ctx, uint8_t row, uint8_t column, char character)
LCD mini display character.
err_t lcdmini_pwm_start(lcdmini_t *ctx)
LCD mini start PWM module.
lcdmini_return_value_t
LCD mini Click return value data.
Definition: lcdmini.h:214
@ LCDMINI_ERROR
Definition: lcdmini.h:216
@ LCDMINI_OK
Definition: lcdmini.h:215
This file contains SPI specific macros, functions, etc.
LCD mini Click configuration object.
Definition: lcdmini.h:187
pin_name_t cs2
Definition: lcdmini.h:195
spi_master_chip_select_polarity_t cs_polarity
Definition: lcdmini.h:205
pin_name_t sck
Definition: lcdmini.h:191
spi_master_mode_t spi_mode
Definition: lcdmini.h:204
pin_name_t mosi
Definition: lcdmini.h:190
uint32_t spi_speed
Definition: lcdmini.h:203
uint32_t dev_pwm_freq
Definition: lcdmini.h:201
pin_name_t int_pin
Definition: lcdmini.h:198
pin_name_t pwm
Definition: lcdmini.h:197
pin_name_t miso
Definition: lcdmini.h:189
pin_name_t rst
Definition: lcdmini.h:196
pin_name_t cs
Definition: lcdmini.h:192
LCD mini Click context object.
Definition: lcdmini.h:164
spi_master_t spi
Definition: lcdmini.h:175
uint32_t pwm_freq
Definition: lcdmini.h:178
digital_in_t int_pin
Definition: lcdmini.h:170
digital_out_t rst
Definition: lcdmini.h:167
digital_out_t cs2
Definition: lcdmini.h:166
pin_name_t chip_select
Definition: lcdmini.h:177
pwm_t pwm
Definition: lcdmini.h:173