VEX V5 Python API
Public Member Functions | List of all members
vex.ControllerLcd Class Reference

Public Member Functions

def __init__ (self, parent)
 Use the lcd class to write to the controller's LCD screen. More...
 
def set_cursor (self, row, col)
 Sets the cursor to the row and column number set in the parameters. More...
 
def print_ (self, text, new_line=True)
 Print a string to the controller LCD screen at the cursor location. More...
 
def clear_screen (self)
 Clears the controller's LCD screen. More...
 
def clear_line (self, number=None)
 Clears the rest of the line that is specified as a parameter. More...
 
def new_line (self)
 

Constructor & Destructor Documentation

◆ __init__()

def vex.ControllerLcd.__init__ (   self,
  parent 
)

Use the lcd class to write to the controller's LCD screen.

Member Function Documentation

◆ set_cursor()

def vex.ControllerLcd.set_cursor (   self,
  row,
  col 
)

Sets the cursor to the row and column number set in the parameters.

Parameters
rowSets the row number for where the cursor is placed, range 1-3.
colSets the column number for where the cursor is placed, starting at 1.

◆ print_()

def vex.ControllerLcd.print_ (   self,
  text,
  new_line = True 
)

Print a string to the controller LCD screen at the cursor location.

Note that text can only be sent to the controller every 50ms (wireless) or 10ms (tethered).

Parameters
textobject to print, usually a string. For multiple arguments, use format like "x: %g y: %g" % (x, y) -> "x: 123 y: 456" Supported format flags are g (all) x (hex) d (int) f (float)
new_line

◆ clear_screen()

def vex.ControllerLcd.clear_screen (   self)

Clears the controller's LCD screen.

Note that screen commands can only be sent to the controller every 50ms (wireless) or 10ms (tethered).

◆ clear_line()

def vex.ControllerLcd.clear_line (   self,
  number = None 
)

Clears the rest of the line that is specified as a parameter.

If no line number is specified, it will clear the rest of the line of where the cursor is set to. Note that screen commands can only be sent to the controller every 50ms (wireless) or 10ms (tethered).

Parameters
numberthe line number to be cleared.

◆ new_line()

def vex.ControllerLcd.new_line (   self)