aip31068.h

Go to the documentation of this file.

/*
 * Copyright (C) 2020 Freie Universität Berlin
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#ifndef AIP31068_H
#define AIP31068_H
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include "stdbool.h"
#include "periph/i2c.h"
 
#include "aip31068_regs.h"
 
typedef enum {
    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,    
} aip31068_custom_symbol_t;
 
typedef enum {
    LEFT_TO_RIGHT,  
    RIGHT_TO_LEFT,  
} aip31068_text_insertion_mode_t;
 
typedef enum {
    FONT_SIZE_5x8,  
    FONT_SIZE_5x10, 
} aip31068_font_size_t;
 
typedef enum {
    BITMODE_4_BIT,  
    BITMODE_8_BIT,  
} aip31068_bit_mode_t;
 
typedef struct {
    i2c_t i2c_dev;                     
    uint16_t i2c_addr;                 
    uint8_t row_count;                 
    uint8_t col_count;                 
    aip31068_font_size_t font_size;    
    aip31068_bit_mode_t bit_mode;      
} aip31068_params_t;
 
typedef struct {
    aip31068_params_t params;        
    uint8_t _curr_display_control;   
    uint8_t _curr_entry_mode_set;    
} aip31068_t;
 
int aip31068_init(aip31068_t *dev, const aip31068_params_t *params);
 
int aip31068_turn_on(aip31068_t *dev);
 
int aip31068_turn_off(aip31068_t *dev);
 
int aip31068_clear(aip31068_t *dev);
 
int aip31068_return_home(aip31068_t *dev);
 
int aip31068_set_auto_scroll_enabled(aip31068_t *dev, bool enabled);
 
int aip31068_set_cursor_blinking_enabled(aip31068_t *dev, bool enabled);
 
int aip31068_set_cursor_visible(aip31068_t *dev, bool visible);
 
int aip31068_set_cursor_position(aip31068_t *dev, uint8_t row, uint8_t col);
 
int aip31068_set_text_insertion_mode(aip31068_t *dev,
                                     aip31068_text_insertion_mode_t mode);
 
int aip31068_move_cursor_left(aip31068_t *dev);
 
int aip31068_move_cursor_right(aip31068_t *dev);
 
int aip31068_scroll_display_left(aip31068_t *dev);
 
int aip31068_scroll_display_right(aip31068_t *dev);
 
int aip31068_set_custom_symbol(aip31068_t *dev,
                               aip31068_custom_symbol_t customSymbol,
                               const uint8_t charmap[]);
 
int aip31068_print_custom_symbol(aip31068_t *dev,
                                 aip31068_custom_symbol_t customSymbol);
 
int aip31068_print(aip31068_t *dev, const char *data);
 
int aip31068_print_char(aip31068_t *dev, char c);
 
#ifdef __cplusplus
}
#endif
 
#endif /* AIP31068_H */