pyupm_lcdks module

class pyupm_lcdks.LCDKS(rs=8, enable=9, d0=4, d1=5, d2=6, d3=7, keypad=0, backlight=-1)

Bases: object

API for the generic LCD Keypad Shield.

ID: lcdks

Name: LCD Keypad Shield

Category: display

Manufacturer: sainsmart dfrobot sparkfun

Link:http://www.sainsmart.com/sainsmart-1602-lcd-keypad-shield-for- arduino- duemilanove-uno-mega2560-mega1280.html

Link:http://www.dfrobot.com/index.php?route=product/product&product_id=51

Link:https://www.sparkfun.com/products/13293

Connection: gpio analog The LCD Keypad Shield uses 7 digital outputs and 1 analog input (for the keypad). The outputs are used to drive an attached LCM1602 LCD controller. This driver should be compatible with the similar LCD keypad shields from Sainsmart, DFRobot and Sparkfun.

C++ includes: lcdks.hpp

autoscrollOff()

upm_result_t autoscrollOff()

Left justify text entered from the cursor

Result of operation

autoscrollOn()

upm_result_t autoscrollOn()

Right justify text entered from the cursor

Result of operation

backlightOff()

upm_result_t backlightOff()

Turn backlight off

Result of operation

backlightOn()

upm_result_t backlightOn()

Turn backlight on

Result of operation

clear()

upm_result_t clear()

Clears the display of all characters

Result of the operation

createChar(charSlot, charData)

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

Create a custom character

charSlot: the character slot to write, only 8 are available

charData: A vector containing 8 bytes making up the character

Result of operation

cursorBlinkOff()

upm_result_t cursorBlinkOff()

Turn cursor blink off

Result of operation

cursorBlinkOn()

upm_result_t cursorBlinkOn()

Turn cursor blink on

Result of operation

cursorOff()

upm_result_t cursorOff()

Turn the cursor off

Result of operation

cursorOn()

upm_result_t cursorOn()

Turn the cursor on

Result of operation

displayOff()

upm_result_t displayOff()

Turn the display off

Result of operation

displayOn()

upm_result_t displayOn()

Turn the display on

Result of operation

entryLeftToRight()

upm_result_t entryLeftToRight()

set the entry mode so that characters are added left to right

Result of operation

entryRightToLeft()

upm_result_t entryRightToLeft()

set the entry mode so that characters are added right to left

Result of operation

getKeyValue()

float getKeyValue()

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.

The floating point value representing a key.

getRawKeyValue()

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.

Deprecated This function is deprecated. Use getKeyValue() instead.

The floating point value representing a key.

home()

upm_result_t home()

Returns to the original coordinates (0,0)

Result of the operation

scrollDisplayLeft()

upm_result_t scrollDisplayLeft()

Scroll the display left, without changing the character RAM

Result of operation

scrollDisplayRight()

upm_result_t scrollDisplayRight()

Scroll the display right, without changing the character RAM

Result of operation

setCursor(row, column)

upm_result_t setCursor(int row, int column)

Sets the cursor to specified coordinates

row: Row to set the cursor to

column: Column to set the cursor to

Result of the operation

write(msg)

upm_result_t write(std::string msg)

Writes a string to the LCD

msg: std::string to write to the display; note: only ASCII characters are supported

Result of the operation

class pyupm_lcdks.SwigPyIterator(*args, **kwargs)

Bases: object

advance(n)

copy()

decr(n=1)

distance(x)

equal(x)

incr(n=1)

next()

previous()

value()

class pyupm_lcdks.byteVector(*args)

Bases: object

append(x)

assign(n, x)

back()

begin()

capacity()

clear()

empty()

end()

erase(*args)

front()

get_allocator()

insert(*args)

iterator()

pop()

pop_back()

push_back(x)

rbegin()

rend()

reserve(n)

resize(*args)

size()

swap(v)

class pyupm_lcdks.doubleVector(*args)

Bases: object

append(x)

assign(n, x)

back()

begin()

capacity()

clear()

empty()

end()

erase(*args)

front()

get_allocator()

insert(*args)

iterator()

pop()

pop_back()

push_back(x)

rbegin()

rend()

reserve(n)

resize(*args)

size()

swap(v)

class pyupm_lcdks.floatVector(*args)

Bases: object

append(x)

assign(n, x)

back()

begin()

capacity()

clear()

empty()

end()

erase(*args)

front()

get_allocator()

insert(*args)

iterator()

pop()

pop_back()

push_back(x)

rbegin()

rend()

reserve(n)

resize(*args)

size()

swap(v)

class pyupm_lcdks.int16Vector(*args)

Bases: object

append(x)

assign(n, x)

back()

begin()

capacity()

clear()

empty()

end()

erase(*args)

front()

get_allocator()

insert(*args)

iterator()

pop()

pop_back()

push_back(x)

rbegin()

rend()

reserve(n)

resize(*args)

size()

swap(v)

class pyupm_lcdks.intVector(*args)

Bases: object

append(x)

assign(n, x)

back()

begin()

capacity()

clear()

empty()

end()

erase(*args)

front()

get_allocator()

insert(*args)

iterator()

pop()

pop_back()

push_back(x)

rbegin()

rend()

reserve(n)

resize(*args)

size()

swap(v)