Loading...
Searching...
No Matches
hd44780.h
Go to the documentation of this file.
1/*
2 * SPDX-FileCopyrightText: 2017 HAW Hamburg
3 * SPDX-License-Identifier: LGPL-2.1-only
4 */
5
6#pragma once
7
23
24#include <stdint.h>
25
26#include "periph/gpio.h"
27
28#ifdef __cplusplus
29extern "C" {
30#endif
31
35#define HD44780_MAX_COLS (40U)
36
40#define HD44780_MAX_ROWS (4U)
41
45#define HD44780_MAX_PINS (8U)
46
53#define HD44780_CGRAM_SIZE (8U)
54
58typedef struct {
59 uint8_t cols;
60 uint8_t rows;
61 gpio_t rs;
62 gpio_t rw;
63 gpio_t enable;
66
70typedef struct {
72 uint8_t flag;
73 uint8_t ctrl;
74 uint8_t mode;
76} hd44780_t;
77
85
94int hd44780_init(hd44780_t *dev, const hd44780_params_t *params);
95
101void hd44780_clear(const hd44780_t *dev);
102
108void hd44780_home(const hd44780_t *dev);
109
117void hd44780_set_cursor(const hd44780_t *dev, uint8_t col, uint8_t row);
118
126
134
142
149
156
163
170
178
188void hd44780_create_char(const hd44780_t *dev, uint8_t location, uint8_t charmap[]);
189
196void hd44780_write(const hd44780_t *dev, uint8_t value);
197
204void hd44780_print(const hd44780_t *dev, const char *data);
205
206#ifdef __cplusplus
207}
208#endif
209
Low-level GPIO peripheral driver interface definitions.
void hd44780_right2left(hd44780_t *dev)
Set display direction right to left.
void hd44780_scroll_left(const hd44780_t *dev)
Enable left scrolling.
hd44780_state_t
Simple state values.
Definition hd44780.h:81
void hd44780_autoscroll(hd44780_t *dev, hd44780_state_t state)
Display autoscroll on or off.
void hd44780_cursor(hd44780_t *dev, hd44780_state_t state)
Show cursor, on or off.
void hd44780_scroll_right(const hd44780_t *dev)
Enable right scrolling.
#define HD44780_MAX_ROWS
Maximal number of rows supported by the driver.
Definition hd44780.h:40
void hd44780_left2right(hd44780_t *dev)
Set display direction left to right.
#define HD44780_MAX_PINS
Number of data pins for communication 4 or 8.
Definition hd44780.h:45
void hd44780_set_cursor(const hd44780_t *dev, uint8_t col, uint8_t row)
Set cursor to specific position in column and row.
void hd44780_write(const hd44780_t *dev, uint8_t value)
Write a single character on the LCD.
void hd44780_clear(const hd44780_t *dev)
Clear display, delete all chars.
void hd44780_print(const hd44780_t *dev, const char *data)
Write a string on the LCD.
void hd44780_home(const hd44780_t *dev)
Reset cursor to row 0 and column 0.
int hd44780_init(hd44780_t *dev, const hd44780_params_t *params)
Initialize the given driver.
void hd44780_create_char(const hd44780_t *dev, uint8_t location, uint8_t charmap[])
Create and store a custom character on display memory.
void hd44780_blink(hd44780_t *dev, hd44780_state_t state)
Blink cursor, on or off.
void hd44780_display(hd44780_t *dev, hd44780_state_t state)
Turn display on or off.
@ HD44780_ON
enable feature
Definition hd44780.h:83
@ HD44780_OFF
disable feature
Definition hd44780.h:82
Parameters needed for device initialization.
Definition hd44780.h:58
gpio_t rw
rw gpio pin
Definition hd44780.h:62
gpio_t rs
rs gpio pin
Definition hd44780.h:61
uint8_t cols
number of LCD cols
Definition hd44780.h:59
gpio_t enable
enable gpio pin
Definition hd44780.h:63
gpio_t data[HD44780_MAX_PINS]
data gpio pins
Definition hd44780.h:64
uint8_t rows
number of LCD rows
Definition hd44780.h:60
Device descriptor for HD44780 LCD.
Definition hd44780.h:70
hd44780_params_t p
LCD config parameters.
Definition hd44780.h:71
uint8_t flag
LCD functional flags.
Definition hd44780.h:72
uint8_t roff[HD44780_MAX_ROWS]
offsets for LCD rows
Definition hd44780.h:75
uint8_t mode
LCD mode flags.
Definition hd44780.h:74
uint8_t ctrl
LCD control flags.
Definition hd44780.h:73