SAINSMARTKS Class Reference

API for Sainsmart LCD Keypad Shield. More...

Detailed Description

• ID: sainsmartks
• Name: SainSmart LCD Keypad Shield
• Category: display
• Manufacturer: sainsmart
• Link: http://www.sainsmart.com/sainsmart-1602-lcd-keypad-shield-for-arduino-duemilanove-uno-mega2560-mega1280.html
• Connection: gpio analog

The Sainsmart LCD Keypad Shield uses 6 digital outputs and 1 analog input (for the keypad). The outputs are used to drive an attached LCM1602 LCD controller.

  // use default pins
  upm::SAINSMARTKS* lcd = new upm::SAINSMARTKS();
  lcd->setCursor(0,0);
  lcd->write("Sainsmart KS");
  lcd->setCursor(1,2);
  lcd->write("Hello World");

  // output current key value every second.
   while (shouldRun)
     {
       cout << "Button value: " << lcd->getRawKeyValue() << endl;
       sleep(1);
     }

Public Member Functions
	SAINSMARTKS (uint8_t rs=8, uint8_t enable=9, uint8_t d0=4, uint8_t d1=5, uint8_t d2=6, uint8_t d3=7, uint8_t keypad=0)
	~SAINSMARTKS ()
float	getRawKeyValue ()
Public Member Functions inherited from Lcm1602
	Lcm1602 (int bus, int address, bool isExpander=true, uint8_t numColumns=16, uint8_t numRows=4)
	Lcm1602 (uint8_t rs, uint8_t enable, uint8_t d0, uint8_t d1, uint8_t d2, uint8_t d3, uint8_t numColumns=16, uint8_t numRows=4)
	~Lcm1602 ()
mraa::Result	write (std::string msg)
mraa::Result	setCursor (int row, int column)
mraa::Result	clear ()
mraa::Result	home ()
mraa::Result	createChar (uint8_t charSlot, uint8_t charData[])
mraa::Result	displayOn ()
mraa::Result	displayOff ()
mraa::Result	cursorOn ()
mraa::Result	cursorOff ()
mraa::Result	cursorBlinkOn ()
mraa::Result	cursorBlinkOff ()
mraa::Result	scrollDisplayLeft ()
mraa::Result	scrollDisplayRight ()
mraa::Result	entryLeftToRight ()
mraa::Result	entryRightToLeft ()
mraa::Result	autoscrollOn ()
mraa::Result	autoscrollOff ()
Public Member Functions inherited from LCD
mraa::Result	write (int x, int y, std::string msg)
std::string	name ()

Additional Inherited Members
Protected Member Functions inherited from Lcm1602
mraa::Result	send (uint8_t value, int mode)
mraa::Result	write4bits (uint8_t value)
mraa::Result	expandWrite (uint8_t value)
mraa::Result	pulseEnable (uint8_t value)
virtual mraa::Result	command (uint8_t cmd)
virtual mraa::Result	data (uint8_t data)
Protected Attributes inherited from Lcm1602
uint8_t	m_displayControl
uint8_t	m_entryDisplayMode
uint8_t	m_numColumns
uint8_t	m_numRows
int	m_lcd_control_address
mraa::I2c *	m_i2c_lcd_control
Protected Attributes inherited from LCD
std::string	m_name

Constructor & Destructor Documentation

SAINSMARTKS	(	uint8_t	rs = 8,
		uint8_t	enable = 9,
		uint8_t	d0 = 4,
		uint8_t	d1 = 5,
		uint8_t	d2 = 6,
		uint8_t	d3 = 7,
		uint8_t	keypad = 0
	)

SAINSMARTKS constructor

As this is a shield, you will not likely have any choice over the pins that are used. For this reason, we provide defaults for all of them – of course they can be changed if your device is different.

Parameters

rs	register select pin
enable	enable pin
d0	data 0 pin
d1	data 1 pin
d2	data 2 pin
d3	data 3 pin
keypad	analog pin of the keypad

~SAINSMARTKS

(

)

SAINSMARTKS destructor

Member Function Documentation

float getRawKeyValue

(

)

returns the floating point representation of the key that is being pushed. Each key produces a different value between 0.0 and 1.0, and only one key can be read at a time.

Returns

the floating point value representing a key

Inheritance diagram for SAINSMARTKS:

Collaboration diagram for SAINSMARTKS:

---

The documentation for this class was generated from the following files:

• /var/lib/jenkins/workspace/upm-doc-stable/src/lcd/sainsmartks.h
• /var/lib/jenkins/workspace/upm-doc-stable/src/lcd/sainsmartks.cxx