LocalEV3 (leJOS EV3 API documentation)

java.lang.Object
- lejos.hardware.ev3.LocalEV3

All Implemented Interfaces:

Brick, EV3
```
public class LocalEV3
extends java.lang.Object
implements EV3
```
This class represents the local instance of an EV3 device. It can be used to obtain access to the various system resources (Sensors, Motors etc.).

Author:

andy

Field Summary

Fields
Modifier and Type	Field and Description
`protected Audio`	`audio`
`protected Power`	`battery`
`protected Key`	`down`
`protected Key`	`enter`
`protected Key`	`escape`
`static LocalEV3`	`ev3`
`protected GraphicsLCD`	`graphicsLCD`
`static int`	`ID_DOWN`
`static int`	`ID_ENTER`
`static int`	`ID_ESCAPE`
`static int`	`ID_LEFT`
`static int`	`ID_RIGHT`
`static int`	`ID_UP`
`protected Key[]`	`keyArray`
`protected lejos.internal.ev3.EV3Keys`	`keys`
`protected lejos.internal.ev3.EV3LCDManager`	`lcdManager`
`protected LED`	`led`
`protected Key`	`left`
`protected java.util.ArrayList<lejos.internal.ev3.EV3Port>`	`ports`
`protected Key`	`right`
`protected TextLCD`	`textLCD`
`protected Key`	`up`
`protected Video`	`video`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static EV3`	`get()`
`Audio`	`getAudio()` return a Audio object which can be used to access the device's audio playback
`LocalBTDevice`	`getBluetoothDevice()` Get the local Bluetooth device
`GraphicsLCD`	`getGraphicsLCD()` Get graphics access to the LCD
`Key`	`getKey(java.lang.String name)` Get access to a specific Key (aka Button)
`Keys`	`getKeys()` Get access to the keys (buttons)
`LED`	`getLED()` Get access to the LED
`java.lang.String`	`getName()` Get he name of the brick
`Port`	`getPort(java.lang.String portName)` Return a port object for the request port name.
`Power`	`getPower()` return a battery object which can be used to obtain battery voltage etc.
`TextLCD`	`getTextLCD()` Get text access to the LCD using the default font
`TextLCD`	`getTextLCD(Font f)` Get text access to the LCD using a specified font
`java.lang.String`	`getType()` Get the type of brick, e.g.
`Video`	`getVideo()`
`LocalWifiDevice`	`getWifiDevice()` Get the local Wifi device
`protected void`	`initLCD()`
`boolean`	`isLocal()` Test whether the brick is a local one
`void`	`setDefault()` Set this brick as the default one for static methods

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

- Field Detail
  - ID_UP
```
public static final int ID_UP
```
    See Also:
    
    Constant Field Values
  - ID_ENTER
```
public static final int ID_ENTER
```
    See Also:
    
    Constant Field Values
  - ID_DOWN
```
public static final int ID_DOWN
```
    See Also:
    
    Constant Field Values
  - ID_RIGHT
```
public static final int ID_RIGHT
```
    See Also:
    
    Constant Field Values
  - ID_LEFT
```
public static final int ID_LEFT
```
    See Also:
    
    Constant Field Values
  - ID_ESCAPE
```
public static final int ID_ESCAPE
```
    See Also:
    
    Constant Field Values
  - ev3
```
public static final LocalEV3 ev3
```
  - lcdManager
```
protected lejos.internal.ev3.EV3LCDManager lcdManager
```
  - battery
```
protected final Power battery
```
  - audio
```
protected final Audio audio
```
  - ports
```
protected java.util.ArrayList<lejos.internal.ev3.EV3Port> ports
```
  - textLCD
```
protected TextLCD textLCD
```
  - graphicsLCD
```
protected GraphicsLCD graphicsLCD
```
  - keys
```
protected lejos.internal.ev3.EV3Keys keys
```
  - led
```
protected final LED led
```
  - video
```
protected Video video
```
  - enter
```
protected final Key enter
```
  - escape
```
protected final Key escape
```
  - left
```
protected final Key left
```
  - right
```
protected final Key right
```
  - up
```
protected final Key up
```
  - down
```
protected final Key down
```
  - keyArray
```
protected final Key[] keyArray
```
- Method Detail
  - get
```
public static EV3 get()
```
  - getPort
```
public Port getPort(java.lang.String portName)
```
    Return a port object for the request port name. This allows access to the hardware associated with the specified port.
    
    Specified by:
    
    getPort in interface Brick
    
    Parameters:
    
    portName - The name of port
    
    Returns:
    
    the request port
  - getPower
```
public Power getPower()
```
    return a battery object which can be used to obtain battery voltage etc.
    
    Specified by:
    
    getPower in interface Brick
    
    Returns:
    
    A battery object
  - initLCD
```
protected void initLCD()
```
  - getTextLCD
```
public TextLCD getTextLCD()
```
    Description copied from interface: Brick
    
    Get text access to the LCD using the default font
    
    Specified by:
    
    getTextLCD in interface Brick
    
    Returns:
    
    the text LCD
  - getGraphicsLCD
```
public GraphicsLCD getGraphicsLCD()
```
    Description copied from interface: Brick
    
    Get graphics access to the LCD
    
    Specified by:
    
    getGraphicsLCD in interface Brick
    
    Returns:
    
    the graphics LCD
  - getTextLCD
```
public TextLCD getTextLCD(Font f)
```
    Description copied from interface: Brick
    
    Get text access to the LCD using a specified font
    
    Specified by:
    
    getTextLCD in interface Brick
    
    Parameters:
    
    f - the font
    
    Returns:
    
    the text LCD
  - getAudio
```
public Audio getAudio()
```
    return a Audio object which can be used to access the device's audio playback
    
    Specified by:
    
    getAudio in interface Brick
    
    Returns:
    
    A Audio device
  - getVideo
```
public Video getVideo()
```
    Specified by:
    
    getVideo in interface Brick
  - isLocal
```
public boolean isLocal()
```
    Description copied from interface: Brick
    
    Test whether the brick is a local one
    
    Specified by:
    
    isLocal in interface Brick
    
    Returns:
    
    true iff brick is local
  - getType
```
public java.lang.String getType()
```
    Description copied from interface: Brick
    
    Get the type of brick, e.g. "EV3", "NXT", "BrickPi"
    
    Specified by:
    
    getType in interface Brick
    
    Returns:
    
    the brick type
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: Brick
    
    Get he name of the brick
    
    Specified by:
    
    getName in interface Brick
    
    Returns:
    
    the name
  - getBluetoothDevice
```
public LocalBTDevice getBluetoothDevice()
```
    Description copied from interface: Brick
    
    Get the local Bluetooth device
    
    Specified by:
    
    getBluetoothDevice in interface Brick
    
    Returns:
    
    the local Bluetooth device
  - getWifiDevice
```
public LocalWifiDevice getWifiDevice()
```
    Description copied from interface: Brick
    
    Get the local Wifi device
    
    Specified by:
    
    getWifiDevice in interface Brick
    
    Returns:
    
    the local Wifi device
  - setDefault
```
public void setDefault()
```
    Description copied from interface: Brick
    
    Set this brick as the default one for static methods
    
    Specified by:
    
    setDefault in interface Brick
  - getKey
```
public Key getKey(java.lang.String name)
```
    Description copied from interface: Brick
    
    Get access to a specific Key (aka Button)
    
    Specified by:
    
    getKey in interface Brick
    
    Parameters:
    
    name - the key name
    
    Returns:
    
    an implementation of the Key interface
  - getLED
```
public LED getLED()
```
    Description copied from interface: Brick
    
    Get access to the LED
    
    Specified by:
    
    getLED in interface Brick
    
    Returns:
    
    an implementation of the LED interface
  - getKeys
```
public Keys getKeys()
```
    Description copied from interface: Brick
    
    Get access to the keys (buttons)
    
    Specified by:
    
    getKeys in interface Brick
    
    Returns:
    
    an implementation of the Keys interface

Class LocalEV3

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ID_UP

ID_ENTER

ID_DOWN

ID_RIGHT

ID_LEFT

ID_ESCAPE

ev3

lcdManager

battery

audio

ports

textLCD

graphicsLCD

keys

led

video

enter

escape

left

right

up

down

keyArray

Method Detail

get

getPort

getPower

initLCD

getTextLCD

getGraphicsLCD

getTextLCD

getAudio

getVideo

isLocal

getType

getName

getBluetoothDevice

getWifiDevice

setDefault

getKey

getLED

getKeys