af16x2lcd.h

Go to the documentation of this file.

/*
 * This file is part of the Ultibo project, https://ultibo.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2026 Garry Wood <garry@softoz.com.au>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#ifndef _ULTIBO_AF16X2LCD_H
#define _ULTIBO_AF16X2LCD_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "ultibo/gpio.h"
#include "ultibo/i2c.h"
#include "ultibo/console.h"

#define AF16X2LCD_CONSOLE_DESCRIPTION   "Adafruit 16x2 LCD" 
 
#define AF16X2LCD_SIGNATURE 0x000AF162
 
#define AF16X2LCD_MODEL_MONO    0 
#define AF16X2LCD_MODEL_RGB 1 

#define AF16X2LCD_PLATE_RS  GPIO_PIN_15 
#define AF16X2LCD_PLATE_RW  GPIO_PIN_14 
#define AF16X2LCD_PLATE_EN  GPIO_PIN_13 
#define AF16X2LCD_PLATE_D4  GPIO_PIN_12 
#define AF16X2LCD_PLATE_D5  GPIO_PIN_11 
#define AF16X2LCD_PLATE_D6  GPIO_PIN_10 
#define AF16X2LCD_PLATE_D7  GPIO_PIN_9 
#define AF16X2LCD_PLATE_RED GPIO_PIN_6 
#define AF16X2LCD_PLATE_GREEN   GPIO_PIN_7 
#define AF16X2LCD_PLATE_BLUE    GPIO_PIN_8 
 
#define AF16X2LCD_BUTTON_SELECT GPIO_PIN_0 
#define AF16X2LCD_BUTTON_RIGHT  GPIO_PIN_1 
#define AF16X2LCD_BUTTON_DOWN   GPIO_PIN_2 
#define AF16X2LCD_BUTTON_UP GPIO_PIN_3 
#define AF16X2LCD_BUTTON_LEFT   GPIO_PIN_4 

typedef struct _AF16X2LCD_PLATE AF16X2LCD_PLATE;
struct _AF16X2LCD_PLATE
{
    uint32_t signature; 
    uint32_t model; 
    LONGBOOL invert; 
    I2C_DEVICE *i2c; 
    GPIO_DEVICE *gpio; 
    CONSOLE_DEVICE *console; 
};
 


HANDLE STDCALL af16x2lcd_start(uint32_t model, BOOL invert, char *device, uint16_t address);

BOOL STDCALL af16x2lcd_stop(HANDLE handle);

uint32_t STDCALL af16x2lcd_get_button(HANDLE handle, uint32_t button);

BOOL STDCALL af16x2lcd_backlight_on(HANDLE handle);

BOOL STDCALL af16x2lcd_backlight_off(HANDLE handle);

BOOL STDCALL af16x2lcd_backlight_color(HANDLE handle, uint8_t red, uint8_t green, uint8_t blue);
 
#ifdef __cplusplus
}
#endif
 
#endif // _ULTIBO_AF16X2LCD_H