aip31068.h File Reference

#include "stdbool.h"
#include "periph/i2c.h"
#include "aip31068_regs.h"

Include dependency graph for aip31068.h:

Go to the source code of this file.

Data Structures
struct	aip31068_params_t
	AIP31068 device initialization parameters. More...
struct	aip31068_t
	AIP31068 PWM device data structure type. More...

Enumerations
enum	aip31068_custom_symbol_t {   CUSTOM_SYMBOL_1 = 0 , CUSTOM_SYMBOL_2 = 1 , CUSTOM_SYMBOL_3 = 2 , CUSTOM_SYMBOL_4 = 3 ,   CUSTOM_SYMBOL_5 = 4 , CUSTOM_SYMBOL_6 = 5 , CUSTOM_SYMBOL_7 = 6 , CUSTOM_SYMBOL_8 = 7 }
	Keys for custom symbols. More...
enum	aip31068_text_insertion_mode_t { LEFT_TO_RIGHT , RIGHT_TO_LEFT }
	Defines the direction of the text insertion. More...
enum	aip31068_font_size_t { FONT_SIZE_5x8 , FONT_SIZE_5x10 }
	Size of a character of the display in dots/pixels. More...
enum	aip31068_bit_mode_t { BITMODE_4_BIT , BITMODE_8_BIT }
	Bit mode for the display. More...

Functions
int	aip31068_init (aip31068_t *dev, const aip31068_params_t *params)
	Initialization.
int	aip31068_turn_on (aip31068_t *dev)
	Turn on the display.
int	aip31068_turn_off (aip31068_t *dev)
	Turn off the display.
int	aip31068_clear (aip31068_t *dev)
	Clear the display and set the cursor to position (0, 0).
int	aip31068_return_home (aip31068_t *dev)
	Reset cursor position to (0, 0) and scroll display to original position.
int	aip31068_set_auto_scroll_enabled (aip31068_t *dev, bool enabled)
	Enable or disable automated scrolling.
int	aip31068_set_cursor_blinking_enabled (aip31068_t *dev, bool enabled)
	Enable or disable cursor blinking.
int	aip31068_set_cursor_visible (aip31068_t *dev, bool visible)
	Show or hide the cursor.
int	aip31068_set_cursor_position (aip31068_t *dev, uint8_t row, uint8_t col)
	Move the cursor to a given position.
int	aip31068_set_text_insertion_mode (aip31068_t *dev, aip31068_text_insertion_mode_t mode)
	Set the direction from which the text is inserted, starting from the cursor.
int	aip31068_move_cursor_left (aip31068_t *dev)
	Move the cursor one unit to the left.
int	aip31068_move_cursor_right (aip31068_t *dev)
	Move the cursor one unit to the right.
int	aip31068_scroll_display_left (aip31068_t *dev)
	Scroll the entire display content (all lines) one unit to the left.
int	aip31068_scroll_display_right (aip31068_t *dev)
	Scroll the entire display content (all lines) one unit to the right.
int	aip31068_set_custom_symbol (aip31068_t *dev, aip31068_custom_symbol_t customSymbol, const uint8_t charmap[])
	Create a custom symbol.
int	aip31068_print_custom_symbol (aip31068_t *dev, aip31068_custom_symbol_t customSymbol)
	Print a custom symbol by key reference.
int	aip31068_print (aip31068_t *dev, const char *data)
	Print a string.
int	aip31068_print_char (aip31068_t *dev, char c)
	Print a single character.