src/lcd/jhd1313m1.h

   1 /*
   2  * Author: Yevgeniy Kiveisha <yevgeniy.kiveisha@intel.com>
   3  * Copyright (c) 2014 Intel Corporation.
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining
   6  * a copy of this software and associated documentation files (the
   7  * "Software"), to deal in the Software without restriction, including
   8  * without limitation the rights to use, copy, modify, merge, publish,
   9  * distribute, sublicense, and/or sell copies of the Software, and to
  10  * permit persons to whom the Software is furnished to do so, subject to
  11  * the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be
  14  * included in all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  19  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  20  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  21  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  22  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23  */
  24 #pragma once
  25
  26 #include <string>
  27 #include "i2clcd.h"
  28
  29 namespace upm {
  30
  31 /**
  32  * @brief C++ API for Jhd1313m1 i2c controller for HD44780 based displays with
  33  * an RGB backlight such as the Grove RGB i2c LCD display
  34  *
  35  * @snippet rgb-lcd.cxx Interesting
  36  */
  37 class Jhd1313m1 : public I2CLcd {
  38     public:
  39        /**
  40         * Jhd1313m1 constructor
  41         *
  42         * @param bus i2c bus to use
  43         * @param address the slave address the lcd is registered on
  44         * @param address the slave address the rgb backlight is on
  45         */
  46         Jhd1313m1(int bus, int lcdAddress, int rgbAddress);
  47        /**
  48         * Jhd1313m1 destructor
  49         */
  50         ~Jhd1313m1();
  51        /**
  52         * Make the LCD scroll text
  53         *
  54         * @param direction, true is typical scrolling to the right
  55         * @return Result of operation
  56         */
  57         mraa_result_t scroll (bool direction);
  58        /**
  59         * Set the color of the backlight
  60         *
  61         * @param r 0-255 value for red
  62         * @param g 0-255 value for green
  63         * @param b 0-255 value for blue
  64         * @return Result of operation
  65         */
  66         mraa_result_t setColor(uint8_t r, uint8_t g, uint8_t b);
  67        /**
  68         * Write a string to LCD
  69         *
  70         * @param msg The std::string to write to display, note only ascii
  71         *     chars are supported
  72         * @return Result of operation
  73         */
  74         mraa_result_t write(std::string msg);
  75        /**
  76         * Set cursor to a coordinate
  77         *
  78         * @param row The row to set cursor to
  79         * @param column The column to set cursor to
  80         * @return Result of operation
  81         */
  82         mraa_result_t setCursor(int row, int column);
  83        /**
  84         * Clear display from characters
  85         *
  86         * @return Result of operatio
  87         */
  88         mraa_result_t clear();
  89        /**
  90         * Return to coordinate 0,0
  91         *
  92         * @return Result of operation
  93         */
  94         mraa_result_t home();
  95
  96     private:
  97         int m_rgb_address;
  98         mraa_i2c_context m_i2c_lcd_rgb;
  99 };
 100
 101 }