lcm1602.h

Go to the documentation of this file.

/*
 * Author: Jon Trulson <jtrulson@ics.com>
 * Copyright (c) 2016 Intel Corporation.
 *
 * Based on UPM C++ drivers originally developed by:
 * Author: Daniel Mosquera
 * Copyright (c) 2013 Daniel Mosquera
 *
 * Author: Thomas Ingleby <thomas.c.ingleby@intel.com>
 * Copyright (c) 2014 Intel Corporation.
 *
 * Contributions: Sergey Kiselev <sergey.kiselev@intel.com>
 *
 * 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.
 */

#pragma once

#include <stdlib.h>
#include <stdio.h>
#include <upm.h>

#include <mraa/i2c.h>
#include <mraa/gpio.h>

#ifdef __cplusplus
extern "C" {
#endif


    typedef struct _lcm1602_context {
        // A large number of GPIOs
        mraa_gpio_context        gpioRS;
        mraa_gpio_context        gpioEN;
        mraa_gpio_context        gpioD0;
        mraa_gpio_context        gpioD1;
        mraa_gpio_context        gpioD2;
        mraa_gpio_context        gpioD3;

        // I2C command control
        mraa_i2c_context         i2c;

        // what interface are we using?
        bool                     isI2C;

        // configuration
        unsigned int             columns;
        unsigned int             rows;

        // display command
        uint8_t                  displayControl;
        uint8_t                  entryDisplayMode;
        uint8_t                  backlight;
    } *lcm1602_context;

    lcm1602_context lcm1602_i2c_init(int bus, int address, bool is_expander,
                                     uint8_t num_columns, uint8_t num_rows);

    lcm1602_context lcm1602_gpio_init(uint8_t rs, uint8_t enable,
                                      uint8_t d0, uint8_t d1, uint8_t d2,
                                      uint8_t d3, uint8_t num_columns,
                                      uint8_t num_rows);

    void lcm1602_close(lcm1602_context dev);

    upm_result_t lcm1602_write(const lcm1602_context dev, char *buffer,
                               int len);

    upm_result_t lcm1602_set_cursor(const lcm1602_context dev,
                                    unsigned int row, unsigned int column);

    upm_result_t lcm1602_clear(const lcm1602_context dev);

    upm_result_t lcm1602_home(const lcm1602_context dev);

    upm_result_t lcm1602_create_char(const lcm1602_context dev,
                                     unsigned int slot,
                                     char *data);

    upm_result_t lcm1602_display_on(const lcm1602_context dev, bool on);

    upm_result_t lcm1602_cursor_on(const lcm1602_context dev, bool on);

    upm_result_t lcm1602_cursor_blink_on(const lcm1602_context dev, bool on);

    upm_result_t lcm1602_backlight_on(const lcm1602_context dev, bool on);

    upm_result_t lcm1602_scroll_display_left(const lcm1602_context dev);

    upm_result_t lcm1602_scroll_display_right(const lcm1602_context dev);

    upm_result_t lcm1602_entry_left_to_right(const lcm1602_context dev,
                                             bool on);

    upm_result_t lcm1602_autoscroll_on(const lcm1602_context dev, bool on);

    upm_result_t lcm1602_command(const lcm1602_context dev, uint8_t cmd);

    upm_result_t lcm1602_data(const lcm1602_context dev, uint8_t data);


#ifdef __cplusplus
}
#endif