lcdks.hpp

/*
 * 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>
 *
 * 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 <string>
#include <vector>
#include "lcdks.h"

namespace upm
{
    class LCDKS
    {
    public:
        LCDKS(int rs=8, int enable=9,
              int d0=4, int d1=5, int d2=6, int d3=7,
              int keypad=0, int backlight=-1);
        ~LCDKS();

        upm_result_t write(std::string msg);

        upm_result_t setCursor(int row, int column);

        upm_result_t clear();

        upm_result_t home();

        upm_result_t createChar(uint8_t charSlot,
                                std::vector<uint8_t> charData);

        upm_result_t displayOn();

        upm_result_t displayOff();

        upm_result_t cursorOn();

        upm_result_t cursorOff();

        upm_result_t cursorBlinkOn();

        upm_result_t cursorBlinkOff();

        upm_result_t backlightOn();

        upm_result_t backlightOff();

        upm_result_t scrollDisplayLeft();

        upm_result_t scrollDisplayRight();

        upm_result_t entryLeftToRight();

        upm_result_t entryRightToLeft();

        upm_result_t autoscrollOn();

        upm_result_t autoscrollOff();

        float getKeyValue();

        float getRawKeyValue()
        {
            return getKeyValue();
        }


    protected:
        lcdks_context m_lcdks;

    private:
        /* Disable implicit copy and assignment operators */
        LCDKS(const LCDKS&) = delete;
        LCDKS &operator=(const LCDKS&) = delete;

    };
}