Home | History | Annotate | Download | only in lcd
      1 /*
      2  * Author: Yevgeniy Kiveisha <yevgeniy.kiveisha (at) 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 <mraa.h>
     28 #include <mraa/types.hpp>
     29 
     30 namespace upm
     31 {
     32 /**
     33  * @brief I2C LCD Display library
     34  * @defgroup i2clcd libupm-i2clcd
     35  * @ingroup seeed sparkfun adafruit i2c gpio display gsk
     36  */
     37 class LCD
     38 {
     39   public:
     40     LCD();
     41     virtual ~LCD();
     42     mraa::Result write(int x, int y, std::string msg);
     43 
     44     virtual mraa::Result write(std::string msg) = 0;
     45     virtual mraa::Result setCursor(int row, int column) = 0;
     46     virtual mraa::Result clear() = 0;
     47     virtual mraa::Result home() = 0;
     48 
     49     std::string name();
     50 
     51   protected:
     52     std::string m_name;
     53 };
     54 }
     55