lcdks.h

Go to the documentation of this file.

/*
 * Author: Jon Trulson <jtrulson@ics.com>
 * Copyright (c) 2017 Intel Corporation.
 *
 * Based on UPM C++ drivers originally developed by:
 * Author: Yevgeniy Kiveisha <yevgeniy.kiveisha@intel.com>
 * Copyright (c) 2014 Intel Corporation.
 *
 * The MIT License
 *
 * 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 <unistd.h>
#include <stdlib.h>
#include <stdio.h>

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

#include <upm.h>
#include "lcm1602.h"

#ifdef __cplusplus
extern "C" {
#endif


    typedef struct _lcdks_context {
        // LCM1602 context - does most of the work
        lcm1602_context lcm1602;
        // aio context for keypad
        mraa_aio_context aio;
        // optional GPIO context for backlight pin
        mraa_gpio_context gpio;
    } *lcdks_context;

    lcdks_context lcdks_init(int rs, int enable,
                             int d0, int d1, int d2, int d3,
                             int keypad, int backlight);

    void lcdks_close(lcdks_context dev);

    upm_result_t lcdks_write(const lcdks_context dev, char *buffer,
                                 int len);

    upm_result_t lcdks_set_cursor(const lcdks_context dev,
                                      unsigned int row, unsigned int column);

    upm_result_t lcdks_clear(const lcdks_context dev);

    upm_result_t lcdks_home(const lcdks_context dev);

    upm_result_t lcdks_create_char(const lcdks_context dev,
                                       unsigned int slot,
                                       char *data);

    upm_result_t lcdks_display_on(const lcdks_context dev, bool on);

    upm_result_t lcdks_cursor_on(const lcdks_context dev, bool on);

    upm_result_t lcdks_cursor_blink_on(const lcdks_context dev,
                                           bool on);

    upm_result_t lcdks_backlight_on(const lcdks_context dev, bool on);

    upm_result_t lcdks_scroll_display_left(const lcdks_context dev);

    upm_result_t lcdks_scroll_display_right(const lcdks_context dev);

    upm_result_t lcdks_entry_left_to_right(const lcdks_context dev,
                                               bool on);

    upm_result_t lcdks_autoscroll_on(const lcdks_context dev, bool on);

    float lcdks_get_key_value(const lcdks_context dev);


#ifdef __cplusplus
}
#endif