se/SE/stuff/P5_Automation-library-dev/jm_LiquidCrystal_I2C/fm_LiquidCrystal_I2C.h

// ---------------------------------------------------------------------------
// Created by Francisco Malpartida on 20/08/11.
// Copyright 2011 - Under creative commons license 3.0:
//		  Attribution-ShareAlike CC BY-SA
//
// This software is furnished "as is", without technical support, and with no
// warranty, express or implied, as to its usefulness for any purpose.
//
// Thread Safe: No
// Extendable: Yes
//
// @file fm_LiquidCrystal_I2C.h
// This file implements a basic liquid crystal library that comes as standard
// in the Arduino SDK but using an I2C IO extension board.
//
// @brief
// This is a basic implementation of the LiquidCrystal library of the
// Arduino SDK. The original library has been reworked in such a way that
// this class implements the all methods to command an fm_LCD based
// on the Hitachi HD44780 and compatible chipsets using I2C extension
// backpacks such as the I2CLCDextraIO with the PCF8574* I2C IO Expander ASIC.
//
// The functionality provided by this class and its base class is identical
// to the original functionality of the Arduino LiquidCrystal library.
//
//
// @author F. Malpartida - fmalpartida@gmail.com
// ---------------------------------------------------------------------------
#ifndef fm_LiquidCrystal_I2C_h
#define fm_LiquidCrystal_I2C_h

//#include <inttypes.h>
//#include <Print.h>

#include "fm_I2CIO.h"
#include "fm_LCD.h"


class fm_LiquidCrystal_I2C : public fm_LCD
{

public:

	/*!
	 @method
	 @abstract	Class constructor.
	 @discussion Initializes class variables and defines the I2C address of the
	 fm_LCD. The constructor does not initialize the fm_LCD.

	 @param		lcd_Addr[in] I2C address of the IO expansion module. For I2CLCDextraIO,
	 the address can be configured using the on board jumpers.
	 */
	fm_LiquidCrystal_I2C (uint8_t lcd_Addr);
	// Constructor with backlight control
	fm_LiquidCrystal_I2C (uint8_t lcd_Addr, uint8_t backlighPin, t_backlighPol pol);

	/*!
	 @method
	 @abstract	Class constructor.
	 @discussion Initializes class variables and defines the I2C address of the
	 fm_LCD. The constructor does not initialize the fm_LCD.

	 @param		lcd_Addr[in] I2C address of the IO expansion module. For I2CLCDextraIO,
	 the address can be configured using the on board jumpers.
	 @param		En[in] fm_LCD En (Enable) pin connected to the IO extender module
	 @param		Rw[in] fm_LCD Rw (Read/write) pin connected to the IO extender module
	 @param		Rs[in] fm_LCD Rs (Reset) pin connected to the IO extender module
	 */
	fm_LiquidCrystal_I2C( uint8_t lcd_Addr, uint8_t En, uint8_t Rw, uint8_t Rs);
	// Constructor with backlight control
	fm_LiquidCrystal_I2C(uint8_t lcd_Addr, uint8_t En, uint8_t Rw, uint8_t Rs,
							uint8_t backlighPin, t_backlighPol pol);

	/*!
	 @method
	 @abstract	Class constructor.
	 @discussion Initializes class variables and defines the I2C address of the
	 fm_LCD. The constructor does not initialize the fm_LCD.

	 @param		lcd_Addr[in] I2C address of the IO expansion module. For I2CLCDextraIO,
	 the address can be configured using the on board jumpers.
	 @param		En[in] fm_LCD En (Enable) pin connected to the IO extender module
	 @param		Rw[in] fm_LCD Rw (Read/write) pin connected to the IO extender module
	 @param		Rs[in] fm_LCD Rs (Reset) pin connected to the IO extender module
	 @param		d4[in] fm_LCD data 0 pin map on IO extender module
	 @param		d5[in] fm_LCD data 1 pin map on IO extender module
	 @param		d6[in] fm_LCD data 2 pin map on IO extender module
	 @param		d7[in] fm_LCD data 3 pin map on IO extender module
	 */
	fm_LiquidCrystal_I2C(uint8_t lcd_Addr, uint8_t En, uint8_t Rw, uint8_t Rs,
							uint8_t d4, uint8_t d5, uint8_t d6, uint8_t d7 );
	// Constructor with backlight control
	fm_LiquidCrystal_I2C(uint8_t lcd_Addr, uint8_t En, uint8_t Rw, uint8_t Rs,
							uint8_t d4, uint8_t d5, uint8_t d6, uint8_t d7,
							uint8_t backlighPin, t_backlighPol pol);
	/*!
	 @function
	 @abstract	fm_LCD initialization and associated HW.
	 @discussion Initializes the fm_LCD to a given size (col, row). This methods
	 initializes the fm_LCD, therefore, it MUST be called prior to using any other
	 method from this class or parent class.

	 The begin method can be overloaded if necessary to initialize any HW that
	 is implemented by a library and can't be done during construction, here
	 we use the Wire class.

	 @param		cols[in] the number of columns that the display has
	 @param		rows[in] the number of rows that the display has
	 @param		charsize[in] size of the characters of the fm_LCD: LCD_5x8DOTS or
	 LCD_5x10DOTS.
	 */
	virtual void begin(uint8_t cols, uint8_t rows, uint8_t charsize = LCD_5x8DOTS);

	/*!
	 @function
	 @abstract	Send a particular value to the fm_LCD.
	 @discussion Sends a particular value to the fm_LCD for writing to the fm_LCD or
	 as an fm_LCD command.

	 Users should never call this method.

	 @param		value[in] Value to send to the fm_LCD.
	 @param		mode[in] LCD_SEND_DATA - write to the fm_LCD CGRAM, LCD_SEND_CMD - write a
	 command to the fm_LCD.
	 */
	virtual void send(uint8_t value, uint8_t mode);

	virtual void wait(uint16_t us);

	/*!
	 @function
	 @abstract	Sets the pin to control the backlight.
	 @discussion Sets the pin in the device to control the backlight. This device
	 doesn't support dimming backlight capability.

	 @param		0: backlight off, 1..255: backlight on.
	 */
	void setBacklightPin ( uint8_t value, t_backlighPol pol );

	/*!
	 @function
	 @abstract	Switch-on/off the fm_LCD backlight.
	 @discussion Switch-on/off the fm_LCD backlight.
	 The setBacklightPin has to be called before setting the backlight for
	 this method to work. @see setBacklightPin.

	 @param		value: backlight mode (HIGH|LOW)
	 */
	void setBacklight ( uint8_t value );

//private:

	/*!
	 @method
	 @abstract	Initializes the fm_LCD class
	 @discussion Initializes the fm_LCD class and IO expansion module.
	 */
	int  init();

	/*!
	 @function
	 @abstract	Initialises class private variables
	 @discussion This is the class single point for initialising private variables.

	 @param		lcd_Addr[in] I2C address of the IO expansion module. For I2CLCDextraIO,
	 the address can be configured using the on board jumpers.
	 @param		En[in] fm_LCD En (Enable) pin connected to the IO extender module
	 @param		Rw[in] fm_LCD Rw (Read/write) pin connected to the IO extender module
	 @param		Rs[in] fm_LCD Rs (Reset) pin connected to the IO extender module
	 @param		d4[in] fm_LCD data 0 pin map on IO extender module
	 @param		d5[in] fm_LCD data 1 pin map on IO extender module
	 @param		d6[in] fm_LCD data 2 pin map on IO extender module
	 @param		d7[in] fm_LCD data 3 pin map on IO extender module
	 */
	void config (uint8_t lcd_Addr, uint8_t En, uint8_t Rw, uint8_t Rs,
					 uint8_t d4, uint8_t d5, uint8_t d6, uint8_t d7 );

	/*!
	 @method
	 @abstract	Writes an 4 bit value to the fm_LCD.
	 @discussion Writes 4 bits (the least significant) to the fm_LCD control data lines.
	 @param		value[in] Value to write to the fm_LCD
	 @param		more[in]  Value to distinguish between command and data.
	 LCD_SEND_CMD == command, LCD_SEND_DATA == data.
	 */
	void write4bits(uint8_t value, uint8_t mode);

	/*!
	 @method
	 @abstract	Pulse the fm_LCD enable line (En).
	 @discussion Sends a pulse of 1 uS to the Enable pin to execute an command
	 or write operation.
	 */
	void pulseEnable(uint8_t);


	uint8_t _Addr;				 // I2C Address of the IO expander
	uint8_t _backlightPinMask; // Backlight IO pin mask
	uint8_t _backlightStsMask; // Backlight status mask
	fm_I2CIO	_i2cio;				// fm_I2CIO PCF8574* expansion module driver I2CLCDextraIO
	uint8_t _En;					// fm_LCD expander word for enable pin
	uint8_t _Rw;					// fm_LCD expander word for R/W pin
	uint8_t _Rs;					// fm_LCD expander word for Register Select pin
	uint8_t _data_pins[4];	  // fm_LCD data lines

};

#endif