Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| " 2013 FRC Java API "
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## edu.wpi.first.wpilibj
Class DriverStationLCD

    java.lang.Object
      edu.wpi.first.wpilibj.SensorBase
          edu.wpi.first.wpilibj.DriverStationLCD

All Implemented Interfaces:
  IDevice, IInputOutput

    public class DriverStationLCD

extends SensorBase
implements IInputOutput

Provide access to "LCD" on the Driver Station. This is the Messages box on the DS Operation tab. Buffer the printed data locally and then send it when UpdateLCD is called.

Nested Class Summary
`static class` | `DriverStationLCD.Line` The line number on the Driver Station LCD

Field Summary
`static int` | `kFullDisplayTextCommand` Command to display text
`static int` | `kLineLength` Maximum line length for Driver Station display
`static int` | `kNumLines` Total number of lines available
`static int` | `kSyncTimeout_ms` Driver station timeout in milliseconds

Fields inherited from class edu.wpi.first.wpilibj.SensorBase
`kAnalogChannels, kAnalogModules, kDigitalChannels, kPwmChannels, kRelayChannels, kSolenoidChannels, kSolenoidModules, kSystemClockTicksPerMicrosecond`

Method Summary
`void` | `clear()` Clear User Messages box on DS Operations Tab This method will clear all text currently displayed in the message box
`static DriverStationLCD` | `getInstance()` Get an instance of the DriverStationLCD
`void` | `println(DriverStationLCD.Line line, int startingColumn, String text)` Print formatted text to the Driver Station LCD text buffer.
`void` | `println(DriverStationLCD.Line line, int startingColumn, StringBuffer text)` Print formatted text to the Driver Station LCD text buffer.
`void` | `updateLCD()` Send the text data to the Driver Station.

Methods inherited from class edu.wpi.first.wpilibj.SensorBase
`checkAnalogChannel, checkAnalogModule, checkDigitalChannel, checkDigitalModule, checkPWMChannel, checkPWMModule, checkRelayChannel, checkRelayModule, checkSolenoidChannel, checkSolenoidModule, free, getDefaultAnalogModule, getDefaultDigitalModule, getDefaultSolenoidModule, setDefaultAnalogModule, setDefaultDigitalModule, setDefaultSolenoidModule`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### kSyncTimeout_ms

    public static final int kSyncTimeout_ms

  Driver station timeout in milliseconds

  See Also:
    Constant Field Values

### kFullDisplayTextCommand

    public static final int kFullDisplayTextCommand

  Command to display text

  See Also:
    Constant Field Values

### kLineLength

    public static final int kLineLength

  Maximum line length for Driver Station display

  See Also:
    Constant Field Values

### kNumLines

    public static final int kNumLines

  Total number of lines available

  See Also:
    Constant Field Values

Method Detail

### getInstance

    public static DriverStationLCD getInstance()

  Get an instance of the DriverStationLCD

  Returns:
    an instance of the DriverStationLCD

### updateLCD

    public void updateLCD()

  Send the text data to the Driver Station.

### println

    public void println(DriverStationLCD.Line line,
                        int startingColumn,
                        String text)

  Print formatted text to the Driver Station LCD text buffer. Use UpdateLCD() periodically to actually send the test to the Driver Station.

  Parameters:
    `line` - The line on the LCD to print to.
    `startingColumn` - The column to start printing to. This is a 1-based number.
    `text` - the text to print

### println

    public void println(DriverStationLCD.Line line,
                        int startingColumn,
                        StringBuffer text)

  Print formatted text to the Driver Station LCD text buffer. Use UpdateLCD() periodically to actually send the test to the Driver Station.

  Parameters:
    `line` - The line on the LCD to print to.
    `startingColumn` - The column to start printing to. This is a 1-based number.
    `text` - the text to print

### clear

    public void clear()

  Clear User Messages box on DS Operations Tab This method will clear all text currently displayed in the message box

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| " 2013 FRC Java API "
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

"
For updated information see the Java FRC site
"