VEX EDR Python API
Public Member Functions | List of all members
vex.LcdDisplay Class Reference

Config LCD Display device for Vex with 2 line display and 3 buttons. More...

Public Member Functions

def __init__ (self, scroll_enabled=False)
 
def is_scroll_enabled (self)
 True if scroll history buffer is enabled (i.e. More...
 
def write_top (self, text)
 Write text to the top line of the LCD. More...
 
def write_bottom (self, text)
 Write text to the bottom line of the LCD. More...
 
def write (self, text)
 Write scrollable text to the LCD. More...
 
def scroll_move (self, num_lines)
 Move screen by given number of lines (negative: up, positive: down). More...
 
def scroll_clear (self)
 Clear the scroll history. More...
 
def button_left (self)
 Get whether the LEFT button is pressed. More...
 
def button_mid (self)
 Get whether the MID button is pressed. More...
 
def button_right (self)
 Get whether the RIGHT button is pressed. More...
 

Detailed Description

Config LCD Display device for Vex with 2 line display and 3 buttons.

Parameters
scroll_enabledif True, use in scroll history mode, otherwise buttons are available. Default False.

Constructor & Destructor Documentation

◆ __init__()

def vex.LcdDisplay.__init__ (   self,
  scroll_enabled = False 
)

Member Function Documentation

◆ is_scroll_enabled()

def vex.LcdDisplay.is_scroll_enabled (   self)

True if scroll history buffer is enabled (i.e.

buttons disabled)

Returns
bool

◆ write_top()

def vex.LcdDisplay.write_top (   self,
  text 
)

Write text to the top line of the LCD.

Parameters
texttext to write

◆ write_bottom()

def vex.LcdDisplay.write_bottom (   self,
  text 
)

Write text to the bottom line of the LCD.

Parameters
texttext to write

◆ write()

def vex.LcdDisplay.write (   self,
  text 
)

Write scrollable text to the LCD.

Parameters
texttext to write

◆ scroll_move()

def vex.LcdDisplay.scroll_move (   self,
  num_lines 
)

Move screen by given number of lines (negative: up, positive: down).

Parameters
num_linesnumber of lines to move (negative: up, positive: down).

◆ scroll_clear()

def vex.LcdDisplay.scroll_clear (   self)

Clear the scroll history.

◆ button_left()

def vex.LcdDisplay.button_left (   self)

Get whether the LEFT button is pressed.

Returns
bool

◆ button_mid()

def vex.LcdDisplay.button_mid (   self)

Get whether the MID button is pressed.

Returns
bool

◆ button_right()

def vex.LcdDisplay.button_right (   self)

Get whether the RIGHT button is pressed.

Returns
bool