2014-05-08 20:44:07 +01:00
|
|
|
/*
|
|
|
|
* The MIT License (MIT)
|
|
|
|
*
|
|
|
|
* Author: Daniel Mosquera
|
|
|
|
* Copyright (c) 2013 Daniel Mosquera
|
|
|
|
*
|
|
|
|
* Author: Thomas Ingleby <thomas.c.ingleby@intel.com>
|
|
|
|
* Copyright (c) 2014 Intel Corporation.
|
|
|
|
*
|
2014-05-23 14:21:10 +01:00
|
|
|
* Permission is hereby granted, free of uint8_tge, to any person obtaining a copy of
|
2014-05-08 20:44:07 +01:00
|
|
|
* 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>
|
2015-07-09 12:25:04 -06:00
|
|
|
#include "lcd.h"
|
2014-05-08 20:44:07 +01:00
|
|
|
|
2015-04-08 14:06:49 +01:00
|
|
|
namespace upm
|
|
|
|
{
|
2014-08-07 19:15:49 +01:00
|
|
|
/**
|
2015-04-13 16:34:57 -07:00
|
|
|
* @library i2clcd
|
|
|
|
* @sensor lcm1602
|
|
|
|
* @comname LCM1602 Display
|
|
|
|
* @type display
|
|
|
|
* @man adafruit sparkfun
|
|
|
|
* @web https://www.adafruit.com/datasheets/TC1602A-01T.pdf
|
|
|
|
* @con i2c
|
2015-04-08 14:06:49 +01:00
|
|
|
*
|
2015-06-01 10:56:03 -07:00
|
|
|
* @brief API for LCM1602 i2c controller for HD44780 based displays
|
2014-08-07 19:15:49 +01:00
|
|
|
*
|
|
|
|
* This supports all sizes of HD44780 displays from 16x2 to 4x20, the
|
|
|
|
* controller has no idea of the actual display hardware so will let you write
|
2014-09-01 15:31:55 +01:00
|
|
|
* further than you can see. These displays with such controllers are available
|
|
|
|
* from various manufacturers with different i2c addresses. The adafruit
|
2015-04-13 16:34:57 -07:00
|
|
|
* TC1602A-01T seems to be a well documented example.
|
2014-08-07 19:15:49 +01:00
|
|
|
*
|
2014-09-01 15:31:55 +01:00
|
|
|
* @image html lcm1602.jpeg
|
2015-04-13 16:34:57 -07:00
|
|
|
* @snippet lcm1602-lcd.cxx Interesting
|
2014-08-07 19:15:49 +01:00
|
|
|
*/
|
2015-07-09 12:38:22 -06:00
|
|
|
class Lcm1602 : public LCD
|
2015-04-08 14:06:49 +01:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
/**
|
|
|
|
* Lcm1602 Constructor, calls libmraa initialisation functions
|
|
|
|
*
|
|
|
|
* @param bus i2c bus to use
|
|
|
|
* @param address the slave address the lcd is registered on
|
|
|
|
*/
|
|
|
|
Lcm1602(int bus, int address);
|
|
|
|
/**
|
|
|
|
* Lcm1602 Destructor
|
|
|
|
*/
|
|
|
|
~Lcm1602();
|
|
|
|
/**
|
|
|
|
* Write a string to LCD
|
|
|
|
*
|
|
|
|
* @param msg The std::string to write to display, note only ascii
|
|
|
|
* chars are supported
|
|
|
|
* @return Result of operation
|
|
|
|
*/
|
|
|
|
mraa_result_t write(std::string msg);
|
|
|
|
/**
|
|
|
|
* Set cursor to a coordinate
|
|
|
|
*
|
|
|
|
* @param row The row to set cursor to
|
|
|
|
* @param column The column to set cursor to
|
|
|
|
* @return Result of operation
|
|
|
|
*/
|
|
|
|
mraa_result_t setCursor(int row, int column);
|
|
|
|
/**
|
|
|
|
* Clear display from characters
|
|
|
|
*
|
|
|
|
* @return Result of operatio
|
|
|
|
*/
|
|
|
|
mraa_result_t clear();
|
|
|
|
/**
|
|
|
|
* Return to coordinate 0,0
|
|
|
|
*
|
|
|
|
* @return Result of operation
|
|
|
|
*/
|
|
|
|
mraa_result_t home();
|
2014-05-08 20:44:07 +01:00
|
|
|
|
2015-04-08 14:06:49 +01:00
|
|
|
private:
|
|
|
|
mraa_result_t send(uint8_t value, int mode);
|
|
|
|
mraa_result_t write4bits(uint8_t value);
|
|
|
|
mraa_result_t expandWrite(uint8_t value);
|
|
|
|
mraa_result_t pulseEnable(uint8_t value);
|
|
|
|
};
|
2014-05-08 20:44:07 +01:00
|
|
|
}
|