jhd1313m1.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: Yevgeniy Kiveisha <yevgeniy.kiveisha@intel.com>
 * Copyright (c) 2014 Intel Corporation.
 *
 * 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 _jhd1313m1_context {
        // I2C LCD command (lcm1602-like)
        mraa_i2c_context         i2cLCD;
        // I2C RGB backlight control
        mraa_i2c_context         i2cRGB;

        // display command
        uint8_t                  displayControl;
        uint8_t                  entryDisplayMode;
    } *jhd1313m1_context;

    typedef char jhd1313m1_custom_char_t[8];

    jhd1313m1_context jhd1313m1_init(int bus, int lcd_addr, int rgb_addr);

    void jhd1313m1_close(jhd1313m1_context dev);

    upm_result_t jhd1313m1_write(const jhd1313m1_context dev, char *buffer,
                                 int len);

    upm_result_t jhd1313m1_set_cursor(const jhd1313m1_context dev,
                                      unsigned int row, unsigned int column);

    upm_result_t jhd1313m1_clear(const jhd1313m1_context dev);

    upm_result_t jhd1313m1_home(const jhd1313m1_context dev);

    upm_result_t jhd1313m1_set_color(const jhd1313m1_context dev,
                                     uint8_t r, uint8_t g, uint8_t b);

    upm_result_t jhd1313m1_create_char(const jhd1313m1_context dev,
                                       unsigned int slot,
                                       jhd1313m1_custom_char_t data);

    upm_result_t jhd1313m1_display_on(const jhd1313m1_context dev, bool on);

    upm_result_t jhd1313m1_cursor_on(const jhd1313m1_context dev, bool on);

    upm_result_t jhd1313m1_cursor_blink_on(const jhd1313m1_context dev,
                                           bool on);

    upm_result_t jhd1313m1_backlight_on(const jhd1313m1_context dev, bool on);

    upm_result_t jhd1313m1_scroll(const jhd1313m1_context dev, bool direction);

    upm_result_t jhd1313m1_scroll_display_left(const jhd1313m1_context dev);

    upm_result_t jhd1313m1_scroll_display_right(const jhd1313m1_context dev);

    upm_result_t jhd1313m1_entry_left_to_right(const jhd1313m1_context dev,
                                               bool on);

    upm_result_t jhd1313m1_autoscroll_on(const jhd1313m1_context dev, bool on);

    upm_result_t jhd1313m1_command(const jhd1313m1_context dev, uint8_t cmd);

    upm_result_t jhd1313m1_data(const jhd1313m1_context dev, uint8_t data);


#ifdef __cplusplus
}
#endif